ChangeFeedIteratorOptions interface

包:

@azure/cosmos

指定更改源的选项

如果未设置这些选项，它将从现在开始读取整个容器的更改。

属性

changeFeedMode	向更改源启动的模式发出信号。
changeFeedStartFrom	指示从更改源中开始的位置。
excludedLocations	排除一个或多个 Azure 区域进行作。 仅当 enableEndPointDiscovery 设置为 true 时，才应用此选项。
maxItemCount	每页要返回的最大项目量
priorityLevel	每个请求的优先级（低/高）。 在任何高优先级请求之前，低优先级请求始终受到限制。 默认值为 null。 默认情况下，所有请求都是高优先级请求
sessionToken	要使用的会话令牌。 如果未指定，将使用最新的捕获会话令牌来启动。
throughputBucket	吞吐量 请求 Bucket 的存储段。 默认值为 null。 在这种情况下，请求可以使用 100% 的分区吞吐量。 有关详细信息，请访问 [Cosmos DB 吞吐量分桶]（https://aka.ms/cosmsodb-bucketing).

属性详细信息

changeFeedMode

向更改源启动的模式发出信号。

changeFeedMode?: ChangeFeedMode

属性值

ChangeFeedMode

changeFeedStartFrom

指示从更改源中开始的位置。

changeFeedStartFrom?: ChangeFeedStartFrom

属性值

ChangeFeedStartFrom

excludedLocations

排除一个或多个 Azure 区域进行作。

仅当 enableEndPointDiscovery 设置为 true 时，才应用此选项。

excludedLocations?: string[]

属性值

string[]

maxItemCount

每页要返回的最大项目量

maxItemCount?: number

属性值

number

priorityLevel

每个请求的优先级（低/高）。 在任何高优先级请求之前，低优先级请求始终受到限制。

默认值为 null。 默认情况下，所有请求都是高优先级请求

priorityLevel?: PriorityLevel

属性值

PriorityLevel

sessionToken

要使用的会话令牌。 如果未指定，将使用最新的捕获会话令牌来启动。

sessionToken?: string

属性值

string

throughputBucket

吞吐量 请求 Bucket 的存储段。

默认值为 null。 在这种情况下，请求可以使用 100% 的分区吞吐量。

有关详细信息，请访问 [Cosmos DB 吞吐量分桶]（https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

属性值

number