Delen via


SharedOptions interface

Opties die kunnen worden opgegeven voor een aangevraagde aanvraag die is uitgegeven aan de Azure Cosmos DB-servers.=

Eigenschappen

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Voorbeeld

Een leesaanvraag annuleren

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

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld

consistencyLevel

Consistentieniveau dat door de client is vereist.

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen om de aanvraag te verwerken als de reguliere ingerichte RU's/seconde uitgeput zijn.

initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos

maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.

priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit

sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

throughputBucket

Doorvoerbucket voor een aanvraag.

De standaardwaarde is null. In dit geval kan de aanvraag 100% van de partitiedoorvoer gebruiken.

Ga voor meer informatie naar [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

Eigenschapdetails

abortSignal

abortSignal om alle onderliggende netwerkaanvragen door te geven die door deze methodeaanroep zijn gemaakt. Zie https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Voorbeeld

Een leesaanvraag annuleren

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

Waarde van eigenschap

AbortSignal

bypassIntegratedCache

Sets als geïntegreerde cache moet worden overgeslagen of ingeschakeld voor de aanvraag in de Azure CosmosDB-service.

De standaardwaarde is onwaar. Standaard is geïntegreerde cache ingeschakeld

bypassIntegratedCache?: boolean

Waarde van eigenschap

boolean

consistencyLevel

Consistentieniveau dat door de client is vereist.

consistencyLevel?: string

Waarde van eigenschap

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage wordt gebruikt om aanvraageenheden (RU's)/minuutcapaciteit in te schakelen om de aanvraag te verwerken als de reguliere ingerichte RU's/seconde uitgeput zijn.

disableRUPerMinuteUsage?: boolean

Waarde van eigenschap

boolean

initialHeaders

(Geavanceerd gebruiksvoorbeeld) Eerste headers om mee te beginnen bij het verzenden van aanvragen naar Cosmos

initialHeaders?: CosmosHeaders

Waarde van eigenschap

maxIntegratedCacheStalenessInMs

Hiermee stelt u de verouderingswaarde in die is gekoppeld aan de aanvraag in de Azure CosmosDB-service. Voor aanvragen waarbij de <xref:com.azure.cosmos.ConsistencyLevel> is <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> of <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, zijn reacties van de geïntegreerde cache gegarandeerd niet verlopen dan de waarde die wordt aangegeven door deze maxIntegratedCacheStaleness. Als het consistentieniveau niet is ingesteld, wordt deze eigenschap genegeerd.

De standaardwaarde is null

Cache veroudering wordt ondersteund in milliseconden granulariteit. Alles wat kleiner is dan milliseconden, wordt genegeerd.

maxIntegratedCacheStalenessInMs?: number

Waarde van eigenschap

number

priorityLevel

Prioriteitsniveau (laag/hoog) voor elke aanvraag. Aanvragen met een lage prioriteit worden altijd beperkt voordat aanvragen met een hoge prioriteit worden ingediend.

De standaardwaarde is null. Standaard hebben alle aanvragen een hoge prioriteit

priorityLevel?: PriorityLevel

Waarde van eigenschap

sessionToken

Hiermee schakelt u het ophalen van aan documentcontainerquotum gerelateerde statistieken voor leesaanvragen voor documentcontainers in of uit.

sessionToken?: string

Waarde van eigenschap

string

throughputBucket

Doorvoerbucket voor een aanvraag.

De standaardwaarde is null. In dit geval kan de aanvraag 100% van de partitiedoorvoer gebruiken.

Ga voor meer informatie naar [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).
throughputBucket?: number

Waarde van eigenschap

number