SharedOptions interface

Paket:

@azure/cosmos

Azure Cosmos DB sunucularına verilen istenen bir için belirtilebilen seçenekler.=

Özellikler

abortSignal	bu yöntem çağrısı tarafından oluşturulan tüm temel ağ isteklerine geçirmek için abortSignal. Bkz. https://developer.mozilla.org/en-US/docs/Web/API/AbortController Örnek Okuma isteğini iptal etme 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	Tümleşik önbelleğin Azure CosmosDB hizmetinde istek için atlanması veya etkinleştirilmesi gerekip gerekmediğini ayarlar. Varsayılan değer false'tur. Varsayılan olarak tümleşik önbellek etkindir
consistencyLevel	İstemci tarafından istenen tutarlılık düzeyi.
disableRUPerMinuteUsage	DisableRUPerMinuteUsage, normal sağlanan RU'lar/saniye tükenirse isteğe hizmet vermek üzere İstek Birimleri (RU)/dakika kapasitesini etkinleştirmek/devre dışı bırakmak için kullanılır.
excludedLocations	İşlem için bir veya daha fazla Azure bölgesini dışlar. Bu seçenek yalnızca enableEndPointDiscovery true olarak ayarlandığında uygulanır.
initialHeaders	(Gelişmiş kullanım örneği) Cosmos'a istek gönderirken ilk olarak başlanması gereken üst bilgiler
maxIntegratedCacheStalenessInMs	Azure CosmosDB hizmetindeki istekle ilişkili eskime değerini ayarlar. <xref:com.azure.cosmos.ConsistencyLevel> <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> veya <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>istekler için, tümleşik önbellekten gelen yanıtların bu maxIntegratedCacheStaleness tarafından belirtilen değerden daha eski olmaması garanti edilir. Tutarlılık düzeyi ayarlanmadığında, bu özellik yoksayılır. Varsayılan değer null Önbellek Eskiliği milisaniye ayrıntı düzeyinde desteklenir. Milisaniyeden küçük her şey yoksayılır.
priorityLevel	Her istek için Öncelik Düzeyi (Düşük/Yüksek). Düşük öncelikli istekler, yüksek öncelikli isteklerden önce her zaman kısıtlanmıştır. Varsayılan değer null'tır. Varsayılan olarak tüm istekler Yüksek önceliklidir
sessionToken	Belge kapsayıcısı okuma istekleri için belge kapsayıcısı kotası ile ilgili istatistikleri almayı etkinleştirir/devre dışı bırakır.
throughputBucket	Bir istek için Aktarım Hızı Kovası. Varsayılan değer null'tır. Bu durumda, istek bölüm aktarım hızının% 100'ünü kullanabilir. Daha fazla bilgi için [Cosmos DB aktarım hızı Demleme](https://aka.ms/cosmsodb-bucketing).

Özellik Ayrıntıları

abortSignal

bu yöntem çağrısı tarafından oluşturulan tüm temel ağ isteklerine geçirmek için abortSignal. Bkz. https://developer.mozilla.org/en-US/docs/Web/API/AbortController

Örnek

Okuma isteğini iptal etme

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

Özellik Değeri

AbortSignal

bypassIntegratedCache

Tümleşik önbelleğin Azure CosmosDB hizmetinde istek için atlanması veya etkinleştirilmesi gerekip gerekmediğini ayarlar.

Varsayılan değer false'tur. Varsayılan olarak tümleşik önbellek etkindir

bypassIntegratedCache?: boolean

Özellik Değeri

boolean

consistencyLevel

İstemci tarafından istenen tutarlılık düzeyi.

consistencyLevel?: string

Özellik Değeri

string

disableRUPerMinuteUsage

DisableRUPerMinuteUsage, normal sağlanan RU'lar/saniye tükenirse isteğe hizmet vermek üzere İstek Birimleri (RU)/dakika kapasitesini etkinleştirmek/devre dışı bırakmak için kullanılır.

disableRUPerMinuteUsage?: boolean

Özellik Değeri

boolean

excludedLocations

İşlem için bir veya daha fazla Azure bölgesini dışlar.

Bu seçenek yalnızca enableEndPointDiscovery true olarak ayarlandığında uygulanır.

excludedLocations?: string[]

Özellik Değeri

string[]

initialHeaders

(Gelişmiş kullanım örneği) Cosmos'a istek gönderirken ilk olarak başlanması gereken üst bilgiler

initialHeaders?: CosmosHeaders

Özellik Değeri

CosmosHeaders

maxIntegratedCacheStalenessInMs

Azure CosmosDB hizmetindeki istekle ilişkili eskime değerini ayarlar. <xref:com.azure.cosmos.ConsistencyLevel> <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> veya <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>istekler için, tümleşik önbellekten gelen yanıtların bu maxIntegratedCacheStaleness tarafından belirtilen değerden daha eski olmaması garanti edilir. Tutarlılık düzeyi ayarlanmadığında, bu özellik yoksayılır.

Varsayılan değer null

Önbellek Eskiliği milisaniye ayrıntı düzeyinde desteklenir. Milisaniyeden küçük her şey yoksayılır.

maxIntegratedCacheStalenessInMs?: number

Özellik Değeri

number

priorityLevel

Her istek için Öncelik Düzeyi (Düşük/Yüksek). Düşük öncelikli istekler, yüksek öncelikli isteklerden önce her zaman kısıtlanmıştır.

Varsayılan değer null'tır. Varsayılan olarak tüm istekler Yüksek önceliklidir

priorityLevel?: PriorityLevel

Özellik Değeri

PriorityLevel

sessionToken

Belge kapsayıcısı okuma istekleri için belge kapsayıcısı kotası ile ilgili istatistikleri almayı etkinleştirir/devre dışı bırakır.

sessionToken?: string

Özellik Değeri

string

throughputBucket

Bir istek için Aktarım Hızı Kovası.

Varsayılan değer null'tır. Bu durumda, istek bölüm aktarım hızının% 100'ünü kullanabilir.

Daha fazla bilgi için [Cosmos DB aktarım hızı Demleme](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Özellik Değeri

number