SharedOptions interface

パッケージ:

@azure/cosmos

Azure Cosmos DB サーバーに対して発行された要求に対して指定できるオプション。=

プロパティ

abortSignal	abortSignal を使用して、このメソッド呼び出しによって作成されたすべての基になるネットワーク要求に渡します。 https://developer.mozilla.org/en-US/docs/Web/API/AbortController を参照してください 例 読み取り要求を取り消す const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()
bypassIntegratedCache	Azure CosmosDB サービスの要求に対して統合キャッシュをバイパスするか有効にするかを設定します。 既定値は false です。 既定では、統合キャッシュが有効になっています
initialHeaders	(高度なユース ケース)Cosmos に要求を送信するときに開始する初期ヘッダー
maxIntegratedCacheStalenessInMs	Azure CosmosDB サービスの要求に関連付けられている制約値を設定します。 <xref:com.azure.cosmos.ConsistencyLevel> が <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> または <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>されている要求の場合、統合キャッシュからの応答は、この maxIntegratedCacheStaleness で示される値よりも古くないことを保証されます。 整合性レベルが設定されていない場合、このプロパティは無視されます。 既定値は null です キャッシュの制約はミリ秒単位の細分性でサポートされます。 ミリ秒未満の値は無視されます。
priorityLevel	各要求の優先度レベル (低/高)。 優先度の低い要求は、優先度の高い要求の前に常に調整されます。 既定値は null です。 既定では、すべての要求の優先度が高い
sessionToken	ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。

プロパティの詳細

abortSignal

abortSignal を使用して、このメソッド呼び出しによって作成されたすべての基になるネットワーク要求に渡します。 https://developer.mozilla.org/en-US/docs/Web/API/AbortController を参照してください

例

読み取り要求を取り消す

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

abortSignal?: AbortSignal

プロパティ値

AbortSignal

bypassIntegratedCache

Azure CosmosDB サービスの要求に対して統合キャッシュをバイパスするか有効にするかを設定します。

既定値は false です。 既定では、統合キャッシュが有効になっています

bypassIntegratedCache?: boolean

プロパティ値

boolean

initialHeaders

(高度なユース ケース)Cosmos に要求を送信するときに開始する初期ヘッダー

initialHeaders?: CosmosHeaders

プロパティ値

CosmosHeaders

maxIntegratedCacheStalenessInMs

Azure CosmosDB サービスの要求に関連付けられている制約値を設定します。 <xref:com.azure.cosmos.ConsistencyLevel> が <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> または <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>されている要求の場合、統合キャッシュからの応答は、この maxIntegratedCacheStaleness で示される値よりも古くないことを保証されます。 整合性レベルが設定されていない場合、このプロパティは無視されます。

既定値は null です

キャッシュの制約はミリ秒単位の細分性でサポートされます。 ミリ秒未満の値は無視されます。

maxIntegratedCacheStalenessInMs?: number

プロパティ値

number

priorityLevel

各要求の優先度レベル (低/高)。 優先度の低い要求は、優先度の高い要求の前に常に調整されます。

既定値は null です。 既定では、すべての要求の優先度が高い

priorityLevel?: PriorityLevel

プロパティ値

PriorityLevel

sessionToken

ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。

sessionToken?: string

プロパティ値

string