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.
consistencyLevel	İstemcinin gerektirdiği tutarlılık düzeyi.
disableAutomaticIdGeneration	Otomatik kimlik oluşturmayı devre dışı bırak (kimlik tanımda değilse oluşturmaların başarısız olmasına neden olur)
disableRUPerMinuteUsage	DisableRUPerMinuteUsage, düzenli 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.
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şturulurken 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	abortSignal, bu yöntem çağrısı tarafından oluşturulan tüm temel ağ isteklerine geçirildi. Bkz. https://developer.mozilla.org/en-US/docs/Web/API/AbortController Örnek Okuma isteğini iptal etme const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
initialHeaders	(Gelişmiş kullanım örneği) Cosmos'a istek gönderirken başlangıç olarak ilk üstbilgiler
maxIntegratedCacheStalenessInMs	Azure CosmosDB hizmetindeki istekle ilişkili eskime değerini ayarlar. veya <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>olduğu <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 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 Eskime Durumu 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' dı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.

Özellik Ayrıntıları

accessCondition

İstekle ilişkili koşullar.

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

Özellik Değeri

{ condition: string, type: string }

consistencyLevel

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

consistencyLevel?: string

Özellik Değeri

string

disableAutomaticIdGeneration

Otomatik kimlik oluşturmayı devre dışı bırak (kimlik tanımda değilse oluşturmaların başarısız olmasına neden olur)

disableAutomaticIdGeneration?: boolean

Özellik Değeri

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage, düzenli 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

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şturulurken 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

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

Örnek

Okuma isteğini iptal etme

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

Özellik Değeri

AbortSignal

SharedOptions.abortSignal'danDevralındı

initialHeaders

(Gelişmiş kullanım örneği) Cosmos'a istek gönderirken başlangıç olarak ilk üstbilgiler

initialHeaders?: CosmosHeaders

Özellik Değeri

CosmosHeaders

SharedOptions.initialHeaders'danDevralındı

maxIntegratedCacheStalenessInMs

Azure CosmosDB hizmetindeki istekle ilişkili eskime değerini ayarlar. veya <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>olduğu <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 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 Eskime Durumu milisaniye ayrıntı düzeyinde desteklenir. Milisaniyeden küçük her şey yoksayılır.

maxIntegratedCacheStalenessInMs?: number

Özellik Değeri

number

SharedOptions.maxIntegratedCacheStalenessInMs'denDevralındı

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' dır. Varsayılan olarak tüm istekler Yüksek önceliklidir

priorityLevel?: PriorityLevel

Özellik Değeri

PriorityLevel

SharedOptions.priorityLevel'denDevralındı

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

SharedOptions.sessionToken'danDevralındı