Aracılığıyla paylaş

RequestOptions interface

Paket:
@azure/cosmos

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

Extends
SharedOptions

Özellikler

accessCondition

İstekle ilişkili koşullar.
contentResponseOnWriteEnabled

false olarak ayarlanırsa hizmet yanıtta yük döndürmez. Yükü ağ üzerinden geri göndermeyerek ağ ve CPU yükünü azaltır. Varsayılan değer doğrudur.

NOT: Şu anda bu seçenek yalnızca toplu ve toplu işlemler için desteklenmektedir.
disableAutomaticIdGeneration

Otomatik kimlik oluşturmayı devre dışı bırakma (kimlik tanımda değilse oluşturma işleminin başarısız olmasına neden olur)
enableScriptLogging

JavaScript saklı yordamlarında günlüğe kaydetmeyi etkinleştirir veya devre dışı bırakır.
indexingDirective

Dizin oluşturma yönergelerini belirtir (dizin, dizin oluşturma .. vb.).
offerThroughput

Birim Başına İstekler ölçümünde bir kapsayıcı için sağlanan teklif aktarım hızı.
offerType

Belge kapsayıcıları oluştururken teklif türü.

Bu seçenek yalnızca belge kapsayıcısı oluştururken geçerlidir.
populateQuotaInfo

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

İşlemden sonra çağrılacak post tetikleyicisinin ne olduğunu gösterir.
preTriggerInclude

İşlemden önce çağrılacak ön tetikleyicinin ne olduğunu gösterir.
resourceTokenExpirySeconds

İzinle ilişkili kaynak belirteci için süre sonu süresi (saniye olarak) (yalnızca izinlerdeki istekler için geçerlidir).
urlConnection

(Gelişmiş kullanım örneği) Bağlanacak url.

Devralınan Ö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

İstemcinin gerektirdiği tutarlılık düzeyi.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage, normal sağlanan RU'lar/saniye tükendiğinde 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ı

accessCondition

İstekle ilişkili koşullar.

accessCondition?: { condition: string, type: string }

Özellik Değeri

{ condition: string, type: string }

contentResponseOnWriteEnabled

false olarak ayarlanırsa hizmet yanıtta yük döndürmez. Yükü ağ üzerinden geri göndermeyerek ağ ve CPU yükünü azaltır. Varsayılan değer doğrudur.

NOT: Şu anda bu seçenek yalnızca toplu ve toplu işlemler için desteklenmektedir.

contentResponseOnWriteEnabled?: boolean

Özellik Değeri

boolean

disableAutomaticIdGeneration

Otomatik kimlik oluşturmayı devre dışı bırakma (kimlik tanımda değilse oluşturma işleminin başarısız olmasına neden olur)

disableAutomaticIdGeneration?: boolean

Özellik Değeri

boolean

enableScriptLogging

JavaScript saklı yordamlarında günlüğe kaydetmeyi etkinleştirir veya devre dışı bırakır.

enableScriptLogging?: boolean

Özellik Değeri

boolean

indexingDirective

Dizin oluşturma yönergelerini belirtir (dizin, dizin oluşturma .. vb.).

indexingDirective?: string

Özellik Değeri

string

offerThroughput

Birim Başına İstekler ölçümünde bir kapsayıcı için sağlanan teklif aktarım hızı.

offerThroughput?: number

Özellik Değeri

number

offerType

Belge kapsayıcıları oluştururken teklif türü.

Bu seçenek yalnızca belge kapsayıcısı oluştururken geçerlidir.

offerType?: string

Özellik Değeri

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

Özellik Değeri

boolean

postTriggerInclude

İşlemden sonra çağrılacak post tetikleyicisinin ne olduğunu gösterir.

postTriggerInclude?: string | string[]

Özellik Değeri

string | string[]

preTriggerInclude

İşlemden önce çağrılacak ön tetikleyicinin ne olduğunu gösterir.

preTriggerInclude?: string | string[]

Özellik Değeri

string | string[]

resourceTokenExpirySeconds

İzinle ilişkili kaynak belirteci için süre sonu süresi (saniye olarak) (yalnızca izinlerdeki istekler için geçerlidir).

resourceTokenExpirySeconds?: number

Özellik Değeri

number

urlConnection

(Gelişmiş kullanım örneği) Bağlanacak url.

urlConnection?: string

Özellik Değeri

string

Devralınan Özellik Detayları

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

Devralındığı yer:SharedOptions.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

Devralındığı yer:SharedOptions.bypassIntegratedCache

consistencyLevel

İstemcinin gerektirdiği tutarlılık düzeyi.

consistencyLevel?: string

Özellik Değeri

string

Devralındığı yer:SharedOptions.consistencyLevel

disableRUPerMinuteUsage

DisableRUPerMinuteUsage, normal sağlanan RU'lar/saniye tükendiğinde 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

Devralındığı yer:SharedOptions.disableRUPerMinuteUsage

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[]

SharedOptions.excludedLocations'dandevralınır

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

Devralındığı yer:SharedOptions.initialHeaders

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

Devralındığı yer:SharedOptions.maxIntegratedCacheStalenessInMs

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

Devralındığı yer:SharedOptions.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

Devralındığı yer:SharedOptions.sessionToken

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

Devralındığı yer:SharedOptions.throughputBucket