RequestOptions interface

Paquete:

@azure/cosmos

Opciones que se pueden especificar para una solicitud emitida a los servidores de Azure Cosmos DB.=

Extends

SharedOptions

Propiedades

accessCondition	Condiciones asociadas a la solicitud.
consistencyLevel	Nivel de coherencia requerido por el cliente.
disableAutomaticIdGeneration	Deshabilitar la generación automática de identificadores (provocará que se produzca un error en las creaciones si el identificador no está en la definición)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage se usa para habilitar o deshabilitar la capacidad de unidades de solicitud (RU)/minuto para atender la solicitud si se agotan las RU aprovisionadas normales por segundo.
enableScriptLogging	Habilita o deshabilita el registro en procedimientos almacenados de JavaScript.
indexingDirective	Especifica directivas de indexación (indexación, no indexar , etc.).
offerThroughput	Rendimiento de la oferta aprovisionado para un contenedor en la medida de solicitudes por unidad.
offerType	Tipo de oferta al crear contenedores de documentos. Esta opción solo es válida al crear un contenedor de documentos.
populateQuotaInfo	Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.
postTriggerInclude	Indica cuál es el desencadenador posterior que se va a invocar después de la operación.
preTriggerInclude	Indica cuál es el desencadenador previo que se va a invocar antes de la operación.
resourceTokenExpirySeconds	Tiempo de expiración (en segundos) para el token de recurso asociado con el permiso (aplicable solo para las solicitudes de permisos).
urlConnection	(Caso de uso avanzado) Dirección URL a la que se va a conectar.

Propiedades heredadas

abortSignal	abortSignal para pasar a todas las solicitudes de red subyacentes creadas por esta llamada de método. Consulta https://developer.mozilla.org/en-US/docs/Web/API/AbortController. Ejemplo Cancelar una solicitud de lectura const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Caso de uso avanzado) Encabezados iniciales con los que empezar al enviar solicitudes a Cosmos
maxIntegratedCacheStalenessInMs	Establece el valor de obsolescencia asociado a la solicitud en el servicio Azure CosmosDB. En el caso de las solicitudes en <xref:com.azure.cosmos.ConsistencyLevel> las que es <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, se garantiza que las respuestas de la caché integrada no sean obsoletas que el valor indicado por este maxIntegratedCacheStaleness. Cuando no se establece el nivel de coherencia, esta propiedad se omite. El valor predeterminado es NULL La obsolescencia de caché se admite en granularidad de milisegundos. Se omitirá cualquier cosa menor que milisegundos.
priorityLevel	Nivel de prioridad (bajo/alto) para cada solicitud. Las solicitudes de prioridad baja siempre se limitan antes de cualquier solicitud de prioridad alta. El valor predeterminado es null. De forma predeterminada, todas las solicitudes son de prioridad alta
sessionToken	Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.

Detalles de las propiedades

accessCondition

Condiciones asociadas a la solicitud.

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

Valor de propiedad

{ condition: string, type: string }

consistencyLevel

Nivel de coherencia requerido por el cliente.

consistencyLevel?: string

Valor de propiedad

string

disableAutomaticIdGeneration

Deshabilitar la generación automática de identificadores (provocará que se produzca un error en las creaciones si el identificador no está en la definición)

disableAutomaticIdGeneration?: boolean

Valor de propiedad

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage se usa para habilitar o deshabilitar la capacidad de unidades de solicitud (RU)/minuto para atender la solicitud si se agotan las RU aprovisionadas normales por segundo.

disableRUPerMinuteUsage?: boolean

Valor de propiedad

boolean

enableScriptLogging

Habilita o deshabilita el registro en procedimientos almacenados de JavaScript.

enableScriptLogging?: boolean

Valor de propiedad

boolean

indexingDirective

Especifica directivas de indexación (indexación, no indexar , etc.).

indexingDirective?: string

Valor de propiedad

string

offerThroughput

Rendimiento de la oferta aprovisionado para un contenedor en la medida de solicitudes por unidad.

offerThroughput?: number

Valor de propiedad

number

offerType

Tipo de oferta al crear contenedores de documentos.

Esta opción solo es válida al crear un contenedor de documentos.

offerType?: string

Valor de propiedad

string

populateQuotaInfo

Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.

populateQuotaInfo?: boolean

Valor de propiedad

boolean

postTriggerInclude

Indica cuál es el desencadenador posterior que se va a invocar después de la operación.

postTriggerInclude?: string | string[]

Valor de propiedad

string | string[]

preTriggerInclude

Indica cuál es el desencadenador previo que se va a invocar antes de la operación.

preTriggerInclude?: string | string[]

Valor de propiedad

string | string[]

resourceTokenExpirySeconds

Tiempo de expiración (en segundos) para el token de recurso asociado con el permiso (aplicable solo para las solicitudes de permisos).

resourceTokenExpirySeconds?: number

Valor de propiedad

number

urlConnection

(Caso de uso avanzado) Dirección URL a la que se va a conectar.

urlConnection?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

abortSignal

abortSignal para pasar a todas las solicitudes de red subyacentes creadas por esta llamada de método. Consulta https://developer.mozilla.org/en-US/docs/Web/API/AbortController.

Ejemplo

Cancelar una solicitud de lectura

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

abortSignal?: AbortSignal

Valor de propiedad

AbortSignal

Heredado deSharedOptions.abortSignal

initialHeaders

(Caso de uso avanzado) Encabezados iniciales con los que empezar al enviar solicitudes a Cosmos

initialHeaders?: CosmosHeaders

Valor de propiedad

CosmosHeaders

Heredado deSharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

Establece el valor de obsolescencia asociado a la solicitud en el servicio Azure CosmosDB. En el caso de las solicitudes en <xref:com.azure.cosmos.ConsistencyLevel> las que es <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, se garantiza que las respuestas de la caché integrada no sean obsoletas que el valor indicado por este maxIntegratedCacheStaleness. Cuando no se establece el nivel de coherencia, esta propiedad se omite.

El valor predeterminado es NULL

La obsolescencia de caché se admite en granularidad de milisegundos. Se omitirá cualquier cosa menor que milisegundos.

maxIntegratedCacheStalenessInMs?: number

Valor de propiedad

number

Heredado deSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

Nivel de prioridad (bajo/alto) para cada solicitud. Las solicitudes de prioridad baja siempre se limitan antes de cualquier solicitud de prioridad alta.

El valor predeterminado es null. De forma predeterminada, todas las solicitudes son de prioridad alta

priorityLevel?: PriorityLevel

Valor de propiedad

PriorityLevel

Heredado deSharedOptions.priorityLevel

sessionToken

Habilita o deshabilita la obtención de estadísticas relacionadas con la cuota de contenedor de documentos para las solicitudes de lectura del contenedor de documentos.

sessionToken?: string

Valor de propiedad

string

Heredado deSharedOptions.sessionToken