Class ChangeFeedEstimator

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Used to estimate the pending work remaining to be read by a ChangeFeedProcessor deployment.

public abstract class ChangeFeedEstimator

Inheritance

object

ChangeFeedEstimator

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Remarks

The estimator is meant to monitor an existing deployment of ChangeFeedProcessor instances that are currently running.

Constructors

ChangeFeedEstimator()

protected ChangeFeedEstimator()

See Also

https://docs.microsoft.com/azure/cosmos-db/change-feed-processor

https://docs.microsoft.com/azure/cosmos-db/how-to-use-change-feed-estimator

Methods

GetCurrentStateIterator(ChangeFeedEstimatorRequestOptions)

Gets the estimation per lease in the lease container.

public abstract FeedIterator<ChangeFeedProcessorState> GetCurrentStateIterator(ChangeFeedEstimatorRequestOptions changeFeedEstimatorRequestOptions = null)

Parameters

changeFeedEstimatorRequestOptions ChangeFeedEstimatorRequestOptions

(Optional) Customize the estimation iterator.

Returns

FeedIterator<ChangeFeedProcessorState>

An iterator that yields an estimation of pending work in amount of transactions per distributed lease token.

Remarks

The estimation over the Change Feed identifies volumes of transactions. If operations in the container are performed through stored procedures, transactional batch or bulk, a group of operations may share the same transaction scope and represented by a single transaction. In those cases, the estimation might not exactly represent number of items, but it is still valid to understand if the pending volume is increasing, decreasing, or on a steady state.

See Also

https://docs.microsoft.com/azure/cosmos-db/change-feed-processor

https://docs.microsoft.com/azure/cosmos-db/how-to-use-change-feed-estimator

See Also

https://docs.microsoft.com/azure/cosmos-db/change-feed-processor

https://docs.microsoft.com/azure/cosmos-db/how-to-use-change-feed-estimator