Aracılığıyla paylaş

RequestOptions interface

  • Başvuru
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ırakma (kimlik tanımda değilse oluşturma işleminin başarısız olmasına neden olur)
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.
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

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()
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
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.

Ö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ırakma (kimlik tanımda değilse oluşturma işleminin başarısız olmasına neden olur)

disableAutomaticIdGeneration?: boolean

Özellik Değeri

boolean

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

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

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.abortSignalDevralındı

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

SharedOptions.bypassIntegratedCacheDevralındı

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

SharedOptions.initialHeadersDevralındı

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

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

priorityLevel?: PriorityLevel

Özellik Değeri

PriorityLevel

SharedOptions.priorityLevelDevralı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.sessionTokenDevralındı