SharedOptions interface

Paquete:

@azure/cosmos

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

Propiedades

abortSignal	abortSignal para pasar a todas las solicitudes de red subyacentes creadas por esta llamada de método. Consulte https://developer.mozilla.org/en-US/docs/Web/API/AbortController de ejemplo de Cancelación de una solicitud de lectura const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
bypassIntegratedCache	Establece si se debe omitir o habilitar la caché integrada para la solicitud en el servicio Azure CosmosDB. El valor predeterminado es false. De forma predeterminada, la caché integrada está habilitada
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 las que el <xref:com.azure.cosmos.ConsistencyLevel> 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 las solicitudes 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

abortSignal

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

de ejemplo de

Cancelación de 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

bypassIntegratedCache

Establece si se debe omitir o habilitar la caché integrada para la solicitud en el servicio Azure CosmosDB.

El valor predeterminado es false. De forma predeterminada, la caché integrada está habilitada

bypassIntegratedCache?: boolean

Valor de propiedad

boolean

initialHeaders

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

initialHeaders?: CosmosHeaders

Valor de propiedad

CosmosHeaders

maxIntegratedCacheStalenessInMs

Establece el valor de obsolescencia asociado a la solicitud en el servicio Azure CosmosDB. En el caso de las solicitudes en las que el <xref:com.azure.cosmos.ConsistencyLevel> 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

priorityLevel

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

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

priorityLevel?: PriorityLevel

Valor de propiedad

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