Sdílet prostřednictvím

SharedOptions interface

Balíček:
@azure/cosmos

Možnosti, které lze zadat pro požadované vydané servery Azure Cosmos DB.=

Vlastnosti

abortSignal

abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Podívejte se na https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Příklad

Zrušení žádosti o čtení

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

Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB.

Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť.
consistencyLevel

Úroveň konzistence vyžadovaná klientem
disableRUPerMinuteUsage

DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.
excludedLocations

Vyloučí jednu nebo více oblastí Azure pro operaci.

Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.
initialHeaders

(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos
maxIntegratedCacheStalenessInMs

Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována.

Výchozí hodnota je null

Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy.
priorityLevel

Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.
sessionToken

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.
throughputBucket

Kontejner propustnosti pro požadavek.

Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu.

Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

Podrobnosti vlastnosti

abortSignal

abortSignal předat všem podkladovým síťovým požadavkům vytvořeným tímto voláním metody. Podívejte se na https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Příklad

Zrušení žádosti o čtení

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

Hodnota vlastnosti

AbortSignal

bypassIntegratedCache

Nastaví, jestli se má integrovaná mezipaměť obejít nebo povolit pro požadavek ve službě Azure CosmosDB.

Výchozí hodnota je false. Ve výchozím nastavení je povolená integrovaná mezipaměť.

bypassIntegratedCache?: boolean

Hodnota vlastnosti

boolean

consistencyLevel

Úroveň konzistence vyžadovaná klientem

consistencyLevel?: string

Hodnota vlastnosti

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage se používá k povolení nebo zakázání kapacity jednotek žádostí (RU) nebo minut, aby se žádost obsloužila, pokud dojde k vyčerpání pravidelných zřízených RU za sekundu.

disableRUPerMinuteUsage?: boolean

Hodnota vlastnosti

boolean

excludedLocations

Vyloučí jednu nebo více oblastí Azure pro operaci.

Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.

excludedLocations?: string[]

Hodnota vlastnosti

string[]

initialHeaders

(Případ rozšířeného použití) Počáteční hlavičky, se kterými začnete při odesílání požadavků do Cosmos

initialHeaders?: CosmosHeaders

Hodnota vlastnosti

CosmosHeaders

maxIntegratedCacheStalenessInMs

Nastaví hodnotu zastaralosti přidruženou k požadavku ve službě Azure CosmosDB. U požadavků, kde je <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> nebo <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, jsou zaručeny, že odpovědi z integrované mezipaměti nebudou zastaralé než hodnota určená tímto maxIntegratedCacheStaleness. Pokud úroveň konzistence není nastavena, bude tato vlastnost ignorována.

Výchozí hodnota je null

Zastaralost mezipaměti se podporuje v milisekundách členitosti. Bude ignorováno cokoli menšího než milisekundy.

maxIntegratedCacheStalenessInMs?: number

Hodnota vlastnosti

number

priorityLevel

Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.

priorityLevel?: PriorityLevel

Hodnota vlastnosti

PriorityLevel

sessionToken

Povolí nebo zakáže získání statistik souvisejících s kvótou kontejneru dokumentů pro požadavky na čtení kontejneru dokumentů.

sessionToken?: string

Hodnota vlastnosti

string

throughputBucket

Kontejner propustnosti pro požadavek.

Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu.

Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

Hodnota vlastnosti

number