RequestOptions interface

  • リファレンス
パッケージ:
@azure/cosmos

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

Extends
SharedOptions

プロパティ

accessCondition

要求に関連付けられている条件。
consistencyLevel

クライアントに必要な整合性レベル。
disableAutomaticIdGeneration

ID の自動生成を無効にします (id が定義に存在しない場合、作成は失敗します)
disableRUPerMinuteUsage

DisableRUPerMinuteUsage は、通常のプロビジョニング RU/秒が使い果たされた場合に要求を処理するために、要求ユニット (RU)/分の容量を有効または無効にするために使用されます。
enableScriptLogging

JavaScript ストアド プロシージャのログ記録を有効または無効にします。
indexingDirective

インデックス作成ディレクティブを指定します (index、インデックスなしなど)。
offerThroughput

ユニットあたりの要求数の測定でコンテナーにプロビジョニングされたオファースループット。
offerType

ドキュメント コンテナーを作成するときのオファーの種類。

このオプションは、ドキュメント コンテナーを作成する場合にのみ有効です。
populateQuotaInfo

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

操作後に呼び出されるポスト トリガーを示します。
preTriggerInclude

操作の前に呼び出される事前トリガーを示します。
resourceTokenExpirySeconds

アクセス許可に関連付けられているリソース トークンの有効期限 (秒単位) (アクセス許可に対する要求にのみ適用されます)。
urlConnection

(高度なユース ケース)接続する URL。

継承されたプロパティ

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()
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

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

プロパティの詳細

accessCondition

要求に関連付けられている条件。

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

プロパティ値

{ condition: string, type: string }

consistencyLevel

クライアントに必要な整合性レベル。

consistencyLevel?: string

プロパティ値

string

disableAutomaticIdGeneration

ID の自動生成を無効にします (id が定義に存在しない場合、作成は失敗します)

disableAutomaticIdGeneration?: boolean

プロパティ値

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage は、通常のプロビジョニング RU/秒が使い果たされた場合に要求を処理するために、要求ユニット (RU)/分の容量を有効または無効にするために使用されます。

disableRUPerMinuteUsage?: boolean

プロパティ値

boolean

enableScriptLogging

JavaScript ストアド プロシージャのログ記録を有効または無効にします。

enableScriptLogging?: boolean

プロパティ値

boolean

indexingDirective

インデックス作成ディレクティブを指定します (index、インデックスなしなど)。

indexingDirective?: string

プロパティ値

string

offerThroughput

ユニットあたりの要求数の測定でコンテナーにプロビジョニングされたオファースループット。

offerThroughput?: number

プロパティ値

number

offerType

ドキュメント コンテナーを作成するときのオファーの種類。

このオプションは、ドキュメント コンテナーを作成する場合にのみ有効です。

offerType?: string

プロパティ値

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

プロパティ値

boolean

postTriggerInclude

操作後に呼び出されるポスト トリガーを示します。

postTriggerInclude?: string | string[]

プロパティ値

string | string[]

preTriggerInclude

操作の前に呼び出される事前トリガーを示します。

preTriggerInclude?: string | string[]

プロパティ値

string | string[]

resourceTokenExpirySeconds

アクセス許可に関連付けられているリソース トークンの有効期限 (秒単位) (アクセス許可に対する要求にのみ適用されます)。

resourceTokenExpirySeconds?: number

プロパティ値

number

urlConnection

(高度なユース ケース)接続する URL。

urlConnection?: string

プロパティ値

string

継承されたプロパティの詳細

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

SharedOptions.abortSignalから継承

initialHeaders

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

initialHeaders?: CosmosHeaders

プロパティ値

CosmosHeaders

SharedOptions.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

SharedOptions.maxIntegratedCacheStalenessInMsから継承されます

priorityLevel

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

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

priorityLevel?: PriorityLevel

プロパティ値

PriorityLevel

SharedOptions.priorityLevelから継承

sessionToken

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

sessionToken?: string

プロパティ値

string

SharedOptions.sessionTokenから継承