ChangeFeedIteratorOptions interface

Balíček:

@azure/cosmos

Určuje možnosti kanálu změn.

Pokud žádná z těchto možností není nastavená, začne se odteď číst změny pro celý kontejner.

Vlastnosti

changeFeedMode	Signalizuje režim, ve kterém je potřeba spustit kanál změn.
changeFeedStartFrom	Signalizuje, odkud začít v kanálu změn.
excludedLocations	Vyloučí jednu nebo více oblastí Azure pro operaci. Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.
maxItemCount	Maximální počet položek, které se mají vrátit na stránku
priorityLevel	Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou. Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.
sessionToken	Token relace, který se má použít. Pokud není zadaný, použije k zahájení nejnovější zachycený token relace.
throughputBucket	Kontejner propustnosti pro požadavek. Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu. Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

Podrobnosti vlastnosti

changeFeedMode

Signalizuje režim, ve kterém je potřeba spustit kanál změn.

changeFeedMode?: ChangeFeedMode

Hodnota vlastnosti

ChangeFeedMode

changeFeedStartFrom

Signalizuje, odkud začít v kanálu změn.

changeFeedStartFrom?: ChangeFeedStartFrom

Hodnota vlastnosti

ChangeFeedStartFrom

excludedLocations

Vyloučí jednu nebo více oblastí Azure pro operaci.

Tato možnost se použije pouze v případě, že je vlastnost enableEndPointDiscovery nastavena na hodnotu true.

excludedLocations?: string[]

Hodnota vlastnosti

string[]

maxItemCount

Maximální počet položek, které se mají vrátit na stránku

maxItemCount?: number

Hodnota vlastnosti

number

priorityLevel

Úroveň priority (nízká/vysoká) pro každý požadavek. Požadavky s nízkou prioritou se vždy omezují před všemi požadavky s vysokou prioritou.

Výchozí hodnota je null. Ve výchozím nastavení mají všechny požadavky vysokou prioritu.

priorityLevel?: PriorityLevel

Hodnota vlastnosti

PriorityLevel

sessionToken

Token relace, který se má použít. Pokud není zadaný, použije k zahájení nejnovější zachycený token relace.

sessionToken?: string

Hodnota vlastnosti

string

throughputBucket

Kontejner propustnosti pro požadavek.

Výchozí hodnota je null. V takovém případě může požadavek využít 100% propustnosti oddílu.

Další informace naleznete na stránce [Cosmos DB throughput Bucketing](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

Hodnota vlastnosti

number