RequestOptions interface

Pacote:

@azure/cosmos

Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.=

Extends

SharedOptions

Propriedades

accessCondition	Condições Associadas à solicitação.
consistencyLevel	Nível de consistência exigido pelo cliente.
disableAutomaticIdGeneration	Desabilitar a geração automática de ID (fará com que as criações falhem se a ID não estiver na definição)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage é usado para habilitar/desabilitar a capacidade de RUs (Unidades de Solicitação)/minuto para atender à solicitação se as RUs/segundo provisionadas regulares estiverem esgotadas.
enableScriptLogging	Habilita ou desabilita o registro em log em procedimentos armazenados do JavaScript.
indexingDirective	Especifica diretivas de indexação (índice, não indexar .. etc. ).
offerThroughput	A taxa de transferência da oferta provisionada para um contêiner na medição de Solicitações por Unidade.
offerType	Tipo de oferta ao criar contêineres de documento. Essa opção só é válida ao criar um contêiner de documento.
populateQuotaInfo	Habilita/desabilita a obtenção de estatísticas relacionadas à cota de contêiner de documentos para solicitações de leitura do contêiner de documentos.
postTriggerInclude	Indica qual é o gatilho de postagem a ser invocado após a operação.
preTriggerInclude	Indica qual é o pré-gatilho a ser invocado antes da operação.
resourceTokenExpirySeconds	Tempo de expiração (em segundos) para o token de recurso associado à permissão (aplicável somente para solicitações em permissões).
urlConnection	(Caso de uso avançado) A URL à qual se conectar.

Propriedades herdadas

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 uma solicitação de leitura const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Caso de uso avançado) Cabeçalhos iniciais a serem iniciados ao enviar solicitações para o Cosmos
maxIntegratedCacheStalenessInMs	Define o valor de desatualização associado à solicitação no serviço do Azure CosmosDB. Para solicitações em <xref:com.azure.cosmos.ConsistencyLevel> que é <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 obsoletas do que o valor indicado por esse maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada. O valor padrão é nulo Há suporte para desatualização de cache na 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 do contêiner de documentos.

Detalhes da propriedade

accessCondition

Condições Associadas à solicitação.

accessCondition?: { condition: string, type: string }

Valor da propriedade

{ condition: string, type: string }

consistencyLevel

Nível de consistência exigido pelo cliente.

consistencyLevel?: string

Valor da propriedade

string

disableAutomaticIdGeneration

Desabilitar a geração automática de ID (fará com que as criações falhem se a ID não estiver na definição)

disableAutomaticIdGeneration?: boolean

Valor da propriedade

boolean

disableRUPerMinuteUsage

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

disableRUPerMinuteUsage?: boolean

Valor da propriedade

boolean

enableScriptLogging

Habilita ou desabilita o registro em log em procedimentos armazenados do JavaScript.

enableScriptLogging?: boolean

Valor da propriedade

boolean

indexingDirective

Especifica diretivas de indexação (índice, não indexar .. etc. ).

indexingDirective?: string

Valor da propriedade

string

offerThroughput

A taxa de transferência da oferta provisionada para um contêiner na medição de Solicitações por Unidade.

offerThroughput?: number

Valor da propriedade

number

offerType

Tipo de oferta ao criar contêineres de documento.

Essa opção só é válida ao criar um contêiner de documento.

offerType?: string

Valor da propriedade

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

Valor da propriedade

boolean

postTriggerInclude

Indica qual é o gatilho de postagem a ser invocado após a operação.

postTriggerInclude?: string | string[]

Valor da propriedade

string | string[]

preTriggerInclude

Indica qual é o pré-gatilho a ser invocado antes da operação.

preTriggerInclude?: string | string[]

Valor da propriedade

string | string[]

resourceTokenExpirySeconds

Tempo de expiração (em segundos) para o token de recurso associado à permissão (aplicável somente para solicitações em permissões).

resourceTokenExpirySeconds?: number

Valor da propriedade

number

urlConnection

(Caso de uso avançado) A URL à qual se conectar.

urlConnection?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

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 uma solicitação de leitura

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

Valor da propriedade

AbortSignal

Herdado deSharedOptions.abortSignal

initialHeaders

(Caso de uso avançado) Cabeçalhos iniciais a serem iniciados ao enviar solicitações para o Cosmos

initialHeaders?: CosmosHeaders

Valor da propriedade

CosmosHeaders

Herdado deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Define o valor de desatualização associado à solicitação no serviço do Azure CosmosDB. Para solicitações em <xref:com.azure.cosmos.ConsistencyLevel> que é <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 obsoletas do que o valor indicado por esse maxIntegratedCacheStaleness. Quando o nível de consistência não é definido, essa propriedade é ignorada.

O valor padrão é nulo

Há suporte para desatualização de cache na granularidade de milissegundos. Qualquer coisa menor que milissegundos será ignorada.

maxIntegratedCacheStalenessInMs?: number

Valor da propriedade

number

Herdado deSharedOptions.maxIntegratedCacheStalenessInMs

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 da propriedade

PriorityLevel

Herdado deSharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

Valor da propriedade

string

Herdado deSharedOptions.sessionToken