ChangeFeedIteratorOptions interface

パッケージ:

@azure/cosmos

変更フィードのオプションを指定します

これらのオプションのいずれも設定されていない場合は、コンテナー全体の変更の読み取りが開始されます。

プロパティ

changeFeedMode	変更フィードを開始する必要があるモードを通知します。
changeFeedStartFrom	変更フィードの開始位置を示します。
excludedLocations	操作の 1 つ以上の Azure リージョンを除外します。 このオプションは、enableEndPointDiscovery が true に設定されている場合にのみ適用されます。
maxItemCount	ページごとに返されるアイテムの最大量
priorityLevel	各要求の優先度レベル (低/高)。 優先度の低い要求は、優先度の高い要求の前に常に調整されます。 既定値は null です。 既定では、すべての要求の優先度が高い
sessionToken	使用するセッション トークン。 指定しない場合は、最初にキャプチャされた最新のセッション トークンを使用します。
throughputBucket	要求のスループットバケット。 既定値は null です。 この場合、要求ではパーティションのスループットの 100% を使用できます。 詳細については、[Cosmos DB スループット バケット](https://aka.ms/cosmsodb-bucketing).

プロパティの詳細

changeFeedMode

変更フィードを開始する必要があるモードを通知します。

changeFeedMode?: ChangeFeedMode

プロパティ値

ChangeFeedMode

changeFeedStartFrom

変更フィードの開始位置を示します。

changeFeedStartFrom?: ChangeFeedStartFrom

プロパティ値

ChangeFeedStartFrom

excludedLocations

操作の 1 つ以上の Azure リージョンを除外します。

このオプションは、enableEndPointDiscovery が true に設定されている場合にのみ適用されます。

excludedLocations?: string[]

プロパティ値

string[]

maxItemCount

ページごとに返されるアイテムの最大量

maxItemCount?: number

プロパティ値

number

priorityLevel

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

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

priorityLevel?: PriorityLevel

プロパティ値

PriorityLevel

sessionToken

使用するセッション トークン。 指定しない場合は、最初にキャプチャされた最新のセッション トークンを使用します。

sessionToken?: string

プロパティ値

string

throughputBucket

要求のスループットバケット。

既定値は null です。 この場合、要求ではパーティションのスループットの 100% を使用できます。

詳細については、[Cosmos DB スループット バケット](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

プロパティ値

number