Condividi tramite

SharedOptions interface

Pacchetto:
@azure/cosmos

Opzioni che possono essere specificate per un'emissione richiesta ai server Azure Cosmos DB.=

Proprietà

abortSignal

abortSignal per passare a tutte le richieste di rete sottostanti create da questa chiamata al metodo. Fare riferimento a https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Esempio

Annullare una richiesta di lettura

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});
bypassIntegratedCache

Imposta se la cache integrata deve essere ignorata o abilitata per la richiesta nel servizio Azure CosmosDB.

Il valore predefinito è false. Per impostazione predefinita, la cache integrata è abilitata
consistencyLevel

Livello di coerenza richiesto dal client.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage viene usato per abilitare/disabilitare la capacità delle unità richiesta (UR)/minuto per soddisfare la richiesta se le UR con provisioning regolare al secondo sono esaurite.
excludedLocations

Esclude una o più aree di Azure per l'operazione.

Questa opzione viene applicata solo quando enableEndPointDiscovery è impostato su true.
initialHeaders

(Caso d'uso avanzato) Intestazioni iniziali da iniziare con quando si inviano richieste a Cosmos
maxIntegratedCacheStalenessInMs

Imposta il valore di decadimento associato alla richiesta nel servizio Azure CosmosDB. Per le richieste in cui il <xref:com.azure.cosmos.ConsistencyLevel> è <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, le risposte dalla cache integrata non sono necessariamente diverse dal valore indicato da questo valore maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata.

Il valore predefinito è Null

La granularità della cache è supportata in millisecondi di granularità. Qualsiasi valore inferiore a millisecondi verrà ignorato.
priorityLevel

Livello di priorità (basso/alto) per ogni richiesta. Le richieste con priorità bassa vengono sempre limitate prima di qualsiasi richiesta con priorità alta.

Il valore predefinito è Null. Per impostazione predefinita, tutte le richieste hanno priorità alta
sessionToken

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.
throughputBucket

Bucket di velocità effettiva per una richiesta.

Il valore predefinito è Null. In questo caso, la richiesta può utilizzare 100% della velocità effettiva della partizione.

Per altre informazioni, visitare [Bucket della velocità effettiva di Cosmos DB](https://aka.ms/cosmsodb-bucketing).

Dettagli proprietà

abortSignal

abortSignal per passare a tutte le richieste di rete sottostanti create da questa chiamata al metodo. Fare riferimento a https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Esempio

Annullare una richiesta di lettura

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

Valore della proprietà

AbortSignal

bypassIntegratedCache

Imposta se la cache integrata deve essere ignorata o abilitata per la richiesta nel servizio Azure CosmosDB.

Il valore predefinito è false. Per impostazione predefinita, la cache integrata è abilitata

bypassIntegratedCache?: boolean

Valore della proprietà

boolean

consistencyLevel

Livello di coerenza richiesto dal client.

consistencyLevel?: string

Valore della proprietà

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage viene usato per abilitare/disabilitare la capacità delle unità richiesta (UR)/minuto per soddisfare la richiesta se le UR con provisioning regolare al secondo sono esaurite.

disableRUPerMinuteUsage?: boolean

Valore della proprietà

boolean

excludedLocations

Esclude una o più aree di Azure per l'operazione.

Questa opzione viene applicata solo quando enableEndPointDiscovery è impostato su true.

excludedLocations?: string[]

Valore della proprietà

string[]

initialHeaders

(Caso d'uso avanzato) Intestazioni iniziali da iniziare con quando si inviano richieste a Cosmos

initialHeaders?: CosmosHeaders

Valore della proprietà

CosmosHeaders

maxIntegratedCacheStalenessInMs

Imposta il valore di decadimento associato alla richiesta nel servizio Azure CosmosDB. Per le richieste in cui il <xref:com.azure.cosmos.ConsistencyLevel> è <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> o <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, le risposte dalla cache integrata non sono necessariamente diverse dal valore indicato da questo valore maxIntegratedCacheStaleness. Quando il livello di coerenza non è impostato, questa proprietà viene ignorata.

Il valore predefinito è Null

La granularità della cache è supportata in millisecondi di granularità. Qualsiasi valore inferiore a millisecondi verrà ignorato.

maxIntegratedCacheStalenessInMs?: number

Valore della proprietà

number

priorityLevel

Livello di priorità (basso/alto) per ogni richiesta. Le richieste con priorità bassa vengono sempre limitate prima di qualsiasi richiesta con priorità alta.

Il valore predefinito è Null. Per impostazione predefinita, tutte le richieste hanno priorità alta

priorityLevel?: PriorityLevel

Valore della proprietà

PriorityLevel

sessionToken

Abilita/disabilita il recupero delle statistiche correlate alla quota del contenitore di documenti per le richieste di lettura del contenitore di documenti.

sessionToken?: string

Valore della proprietà

string

throughputBucket

Bucket di velocità effettiva per una richiesta.

Il valore predefinito è Null. In questo caso, la richiesta può utilizzare 100% della velocità effettiva della partizione.

Per altre informazioni, visitare [Bucket della velocità effettiva di Cosmos DB](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Valore della proprietà

number