ChangeFeedIteratorOptions interface

Пакет:

@azure/cosmos

Указывает параметры канала изменений

Если ни один из этих параметров не задан, он начнет чтение изменений в настоящее время для всего контейнера.

Свойства

changeFeedMode	Сигнализирует о режиме запуска канала изменений.
changeFeedStartFrom	Сигнал о том, откуда начать работу в канале изменений.
excludedLocations	За исключением одного или нескольких регионов Azure для операции. Этот параметр применяется только в том случае, если для enableEndPointDiscovery задано значение true.
maxItemCount	Максимальное количество элементов для возврата на страницу
priorityLevel	Уровень приоритета (низкий или высокий) для каждого запроса. Запросы с низким приоритетом всегда регулируются перед любыми запросами с высоким приоритетом. Значение по умолчанию равно NULL. По умолчанию все запросы имеют высокий приоритет
sessionToken	Используемый маркер сеанса. Если не указано, будет использоваться последний захваченный маркер сеанса для начала.
throughputBucket	Корзина пропускной способности для запроса. Значение по умолчанию равно NULL. В этом случае запрос может использовать 100% пропускной способности секции. Дополнительные сведения см. в разделе [Bucketing Cosmos DB Throughput Bucketing](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

Корзина пропускной способности для запроса.

Значение по умолчанию равно NULL. В этом случае запрос может использовать 100% пропускной способности секции.

Дополнительные сведения см. в разделе [Bucketing Cosmos DB Throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Значение свойства

number