ChangeFeedIteratorOptions interface

Package:

@azure/cosmos

Specifies options for the change feed

If none of those options are set, it will start reading changes from now for the entire container.

Properties

changeFeedMode	Signals the mode in which the change feed needs to start.
changeFeedStartFrom	Signals where to start from in the change feed.
excludedLocations	Excludes one or more Azure regions for the operation. This option is only applied when enableEndPointDiscovery is set to true.
maxItemCount	Max amount of items to return per page
priorityLevel	Priority Level (Low/High) for each request. Low priority requests are always throttled before any high priority requests. Default value is null. By default all requests are of High priority
sessionToken	The session token to use. If not specified, will use the most recent captured session token to start with.
throughputBucket	Throughput Bucket for a request. Default value is null. In this case, the request can use 100% of the partition throughput. For more information, visit [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

Property Details

changeFeedMode

Signals the mode in which the change feed needs to start.

changeFeedMode?: ChangeFeedMode

Property Value

ChangeFeedMode

changeFeedStartFrom

Signals where to start from in the change feed.

changeFeedStartFrom?: ChangeFeedStartFrom

Property Value

ChangeFeedStartFrom

excludedLocations

Excludes one or more Azure regions for the operation.

This option is only applied when enableEndPointDiscovery is set to true.

excludedLocations?: string[]

Property Value

string[]

maxItemCount

Max amount of items to return per page

maxItemCount?: number

Property Value

number

priorityLevel

Priority Level (Low/High) for each request. Low priority requests are always throttled before any high priority requests.

Default value is null. By default all requests are of High priority

priorityLevel?: PriorityLevel

Property Value

PriorityLevel

sessionToken

The session token to use. If not specified, will use the most recent captured session token to start with.

sessionToken?: string

Property Value

string

throughputBucket

Throughput Bucket for a request.

Default value is null. In this case, the request can use 100% of the partition throughput.

For more information, visit [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Property Value

number