SharedOptions interface
Azure Cosmos DB サーバーに発行された要求に対して指定できるオプション。=
プロパティ
| abort |
abortSignal: このメソッド呼び出しによって作成されたすべての基になるネットワーク要求に渡します。 「https://developer.mozilla.org/en-US/docs/Web/API/AbortController」を参照してください。 例 読み取り要求を取り消す |
| initial |
(高度なユース ケース)Cosmos に要求を送信するときに開始する初期ヘッダー |
| max |
Azure CosmosDB サービスの要求に関連付けられている古さの値を設定します。 が <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> または <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>である要求の場合、統合キャッシュからの応答は、この maxIntegratedCacheStaleness で示される値よりも古くないことを保証されます。 整合性レベルが設定されていない場合、このプロパティは無視されます。 既定値は null です キャッシュの古さはミリ秒単位でサポートされます。 ミリ秒より小さいものは無視されます。 |
| priority |
各要求の優先度レベル (低/高)。 優先度の低い要求は、優先度の高い要求の前に常に調整されます。 既定値は null です。 既定では、すべての要求の優先度が高い |
| session |
ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。 |
プロパティの詳細
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
initialHeaders
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プロパティ値
sessionToken
ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。
sessionToken?: stringプロパティ値
string