RequestOptions interface

Pacote:

@azure/cosmos

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

Extends

SharedOptions

Propriedades

accessCondition	Condições associadas ao pedido.
consistencyLevel	Nível de consistência exigido pelo cliente.
disableAutomaticIdGeneration	Desativar a geração automática de id (fará com que as criações falhem se id não estiver na definição)
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.
enableScriptLogging	Habilita ou desabilita o registro em procedimentos armazenados JavaScript.
indexingDirective	Especifica diretivas de indexação (indexar, não indexar .. etc).
offerThroughput	A taxa de transferência de oferta provisionada para um contêiner na medição de solicitações por unidade.
offerType	Tipo de oferta ao criar contêineres de documentos. Essa opção só é válida ao criar um contêiner de documentos.
populateQuotaInfo	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.
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 token de recurso associado à permissão (aplicável apenas para solicitações de permissões).
urlConnection	(Caso de uso avançado) O url ao qual se conectar.

Propriedades Herdadas

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()
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.

Detalhes de Propriedade

accessCondition

Condições associadas ao pedido.

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

Valor de Propriedade

{ condition: string, type: string }

consistencyLevel

Nível de consistência exigido pelo cliente.

consistencyLevel?: string

Valor de Propriedade

string

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: boolean

Valor de Propriedade

boolean

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

enableScriptLogging

Habilita ou desabilita o registro em procedimentos armazenados JavaScript.

enableScriptLogging?: boolean

Valor de Propriedade

boolean

indexingDirective

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

indexingDirective?: string

Valor de Propriedade

string

offerThroughput

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

offerThroughput?: number

Valor de Propriedade

number

offerType

Tipo de oferta ao criar contêineres de documentos.

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

offerType?: string

Valor de Propriedade

string

populateQuotaInfo

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.

populateQuotaInfo?: boolean

Valor de Propriedade

boolean

postTriggerInclude

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

postTriggerInclude?: string | string[]

Valor de Propriedade

string | string[]

preTriggerInclude

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

preTriggerInclude?: string | string[]

Valor de Propriedade

string | string[]

resourceTokenExpirySeconds

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

resourceTokenExpirySeconds?: number

Valor de Propriedade

number

urlConnection

(Caso de uso avançado) O url ao qual se conectar.

urlConnection?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

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

herdado de SharedOptions.abortSignal

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

herdado deSharedOptions.initialHeaders

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

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 de 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 de contêiner de documentos.

sessionToken?: string

Valor de Propriedade

string

herdado de SharedOptions.sessionToken