SharedOptions interface
Opções que podem ser especificadas para uma solicitação emitida para os servidores do Azure Cosmos DB.=
Propriedades
abort |
abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Visualizar https://developer.mozilla.org/en-US/docs/Web/API/AbortController Exemplo Cancelar um pedido de leitura
|
bypass |
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 |
initial |
(Caso de uso avançado) Cabeçalhos iniciais para começar ao enviar solicitações para o Cosmos |
max |
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. |
priority |
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 |
session |
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. |
Detalhes de Propriedade
abortSignal
abortSignal para passar para todas as solicitações de rede subjacentes criadas por essa chamada de método. Visualizar https://developer.mozilla.org/en-US/docs/Web/API/AbortController
Exemplo
Cancelar um pedido de leitura
const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
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
initialHeaders
(Caso de uso avançado) Cabeçalhos iniciais para começar ao enviar solicitações para o Cosmos
initialHeaders?: CosmosHeaders
Valor de Propriedade
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
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