ConnectionPolicy interface

パッケージ:

@azure/cosmos

Azure Cosmos DB データベース サービスの CosmosClient に関連付けられている接続ポリシーを表します。

プロパティ

connectionMode	Cosmos に接続するモードを決定します。 (現在、ゲートウェイ オプションのみがサポートされています)
enableBackgroundEndpointRefreshing	エンドポイントのバックグラウンド更新を有効または無効にするフラグ。 既定値は true です。 enableEndpointsDiscovery を使用したエンドポイント検出は、失敗した要求に対しても引き続き機能します。
enableEndpointDiscovery	読み取り/書き込み操作に基づいて要求の自動リダイレクトを有効または無効にするフラグ。 デフォルトはtrueです。 別のプロセスまたはブラウザー内で CosmosClient を破棄した後にこれが true に設定されている場合は、client.dispose() を呼び出すために必要です。
enablePartitionLevelCircuitBreaker	パーティションレベルごとのサーキットブレーカー(PPCB)を有効/無効にするフラグ。 既定は false です。 注: enableEndpointDiscovery が trueされている必要があります。 エンドポイント検出が無効になっている場合、この設定は無効です。
enablePartitionLevelFailover	パーティション レベルごとのフェールオーバー (PPAF) を有効/無効にするフラグ。 既定値は true です。 パーティションが使用できなくなったときに、他の使用可能なパーティションに自動的にフェイルオーバーします。 有効にすると、enablePartitionLevelCircuitBreaker も true に設定されます。 注: 動的有効化には、 enableEndpointDiscovery と enableBackgroundEndpointRefreshing の両方が trueされている必要があります。 エンドポイント検出が無効になっている場合、この設定は無効です。
endpointRefreshRateInMs	クライアントがバックグラウンドでエンドポイントの一覧を更新する時間 (ミリ秒単位)
preferredLocations	読み取り要求の優先場所として使用する Azure リージョンの一覧。
requestTimeout	要求タイムアウト (ネットワーク ピアからの応答を待機する時間)。 ミリ秒単位で表されます。
retryOptions	再試行中に使用される構成可能なプロパティをいくつか定義する RetryOptions オブジェクト。
useMultipleWriteLocations	Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にするフラグ。 既定値は trueです。

プロパティの詳細

connectionMode

Cosmos に接続するモードを決定します。 (現在、ゲートウェイ オプションのみがサポートされています)

connectionMode?: Gateway

プロパティ値

Gateway

enableBackgroundEndpointRefreshing

エンドポイントのバックグラウンド更新を有効または無効にするフラグ。 既定値は true です。 enableEndpointsDiscovery を使用したエンドポイント検出は、失敗した要求に対しても引き続き機能します。

enableBackgroundEndpointRefreshing?: boolean

プロパティ値

boolean

enableEndpointDiscovery

読み取り/書き込み操作に基づいて要求の自動リダイレクトを有効または無効にするフラグ。 デフォルトはtrueです。 別のプロセスまたはブラウザー内で CosmosClient を破棄した後にこれが true に設定されている場合は、client.dispose() を呼び出すために必要です。

enableEndpointDiscovery?: boolean

プロパティ値

boolean

enablePartitionLevelCircuitBreaker

パーティションレベルごとのサーキットブレーカー(PPCB)を有効/無効にするフラグ。 既定は false です。 注: enableEndpointDiscovery が trueされている必要があります。 エンドポイント検出が無効になっている場合、この設定は無効です。

enablePartitionLevelCircuitBreaker?: boolean

プロパティ値

boolean

enablePartitionLevelFailover

パーティション レベルごとのフェールオーバー (PPAF) を有効/無効にするフラグ。 既定値は true です。 パーティションが使用できなくなったときに、他の使用可能なパーティションに自動的にフェイルオーバーします。 有効にすると、enablePartitionLevelCircuitBreaker も true に設定されます。 注: 動的有効化には、 enableEndpointDiscovery と enableBackgroundEndpointRefreshing の両方が trueされている必要があります。 エンドポイント検出が無効になっている場合、この設定は無効です。

enablePartitionLevelFailover?: boolean

プロパティ値

boolean

endpointRefreshRateInMs

クライアントがバックグラウンドでエンドポイントの一覧を更新する時間 (ミリ秒単位)

endpointRefreshRateInMs?: number

プロパティ値

number

preferredLocations

読み取り要求の優先場所として使用する Azure リージョンの一覧。

preferredLocations?: string[]

プロパティ値

string[]

requestTimeout

要求タイムアウト (ネットワーク ピアからの応答を待機する時間)。 ミリ秒単位で表されます。

requestTimeout?: number

プロパティ値

number

retryOptions

再試行中に使用される構成可能なプロパティをいくつか定義する RetryOptions オブジェクト。

retryOptions?: RetryOptions

プロパティ値

RetryOptions

useMultipleWriteLocations

Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの任意の場所 (リージョン) に対する書き込みを有効にするフラグ。 既定値は trueです。

useMultipleWriteLocations?: boolean

プロパティ値

boolean