Partilhar via

SharedOptions interface

Pacote:
@azure/cosmos

Opções que podem ser especificadas para uma solicitação emitida para os servidores do Azure Cosmos DB.=

Propriedades

abortSignal

abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Veja https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemplo

Cancelar um pedido de leitura

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});
bypassIntegratedCache

Define se o cache integrado deve ser ignorado ou habilitado para a solicitação no serviço Azure CosmosDB.

O valor padrão é false. Por padrão, o cache integrado está habilitado
consistencyLevel

Nível de consistência exigido pelo cliente.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage é usado para habilitar/desabilitar a capacidade de Unidades de Solicitação (RUs)/minuto para atender à solicitação se RUs/segundo provisionados regulares estiverem esgotados.
excludedLocations

Exclui uma ou mais regiões do Azure para a operação.

Essa opção só é aplicada quando enableEndPointDiscovery é definido como true.
initialHeaders

(Caso de uso avançado) Cabeçalhos iniciais para começar ao enviar solicitações para o Cosmos
maxIntegratedCacheStalenessInMs

Define o valor de atraso associado à solicitação no serviço Azure CosmosDB. Para solicitações em que o <xref:com.azure.cosmos.ConsistencyLevel> é <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, as respostas do cache integrado têm a garantia de não serem mais estáveis do que o valor indicado por este maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada.

O valor padrão é null

O Cache Staleness é suportado em granularidade de milissegundos. Qualquer coisa menor que milissegundos será ignorada.
priorityLevel

Nível de Prioridade (Baixo/Alto) para cada solicitação. As solicitações de baixa prioridade são sempre limitadas antes de qualquer solicitação de alta prioridade.

O valor padrão é null. Por padrão, todas as solicitações são de alta prioridade
sessionToken

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documentos.
throughputBucket

Bucket de taxa de transferência para uma solicitação.

O valor padrão é null. Nesse caso, a solicitação pode usar 100% da taxa de transferência da partição.

Para obter mais informações, visite [Bucketing de taxa de transferência do Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Detalhes de Propriedade

abortSignal

abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Veja https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Exemplo

Cancelar um pedido de leitura

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Valor de Propriedade

AbortSignal

bypassIntegratedCache

Define se o cache integrado deve ser ignorado ou habilitado para a solicitação no serviço Azure CosmosDB.

O valor padrão é false. Por padrão, o cache integrado está habilitado

bypassIntegratedCache?: boolean

Valor de Propriedade

boolean

consistencyLevel

Nível de consistência exigido pelo cliente.

consistencyLevel?: string

Valor de Propriedade

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage é usado para habilitar/desabilitar a capacidade de Unidades de Solicitação (RUs)/minuto para atender à solicitação se RUs/segundo provisionados regulares estiverem esgotados.

disableRUPerMinuteUsage?: boolean

Valor de Propriedade

boolean

excludedLocations

Exclui uma ou mais regiões do Azure para a operação.

Essa opção só é aplicada quando enableEndPointDiscovery é definido como true.

excludedLocations?: string[]

Valor de Propriedade

string[]

initialHeaders

(Caso de uso avançado) Cabeçalhos iniciais para começar ao enviar solicitações para o Cosmos

initialHeaders?: CosmosHeaders

Valor de Propriedade

CosmosHeaders

maxIntegratedCacheStalenessInMs

Define o valor de atraso associado à solicitação no serviço Azure CosmosDB. Para solicitações em que o <xref:com.azure.cosmos.ConsistencyLevel> é <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> ou <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, as respostas do cache integrado têm a garantia de não serem mais estáveis do que o valor indicado por este maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada.

O valor padrão é null

O Cache Staleness é suportado em granularidade de milissegundos. Qualquer coisa menor que milissegundos será ignorada.

maxIntegratedCacheStalenessInMs?: number

Valor de Propriedade

number

priorityLevel

Nível de Prioridade (Baixo/Alto) para cada solicitação. As solicitações de baixa prioridade são sempre limitadas antes de qualquer solicitação de alta prioridade.

O valor padrão é null. Por padrão, todas as solicitações são de alta prioridade

priorityLevel?: PriorityLevel

Valor de Propriedade

PriorityLevel

sessionToken

Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura de contêiner de documentos.

sessionToken?: string

Valor de Propriedade

string

throughputBucket

Bucket de taxa de transferência para uma solicitação.

O valor padrão é null. Nesse caso, a solicitação pode usar 100% da taxa de transferência da partição.

Para obter mais informações, visite [Bucketing de taxa de transferência do Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valor de Propriedade

number