Class ChangeFeedMode

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Base class for the change feed mode ChangeFeedRequestOptions.

public abstract class ChangeFeedMode

Inheritance

object

ChangeFeedMode

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

Remarks

Use one of the static constructors to generate a ChangeFeedMode option.

Properties

AllVersionsAndDeletes

Creates a ChangeFeedMode to receive notifications for creations, deletes, as well as all intermediary snapshots for updates.

public static ChangeFeedMode AllVersionsAndDeletes { get; }

Property Value

ChangeFeedMode

A ChangeFeedMode to receive notifications for insertions, updates, and delete operations.

Remarks

A container with a ChangeFeedPolicy configured is required. The delete operations will be included only within the configured retention period. When enabling full fidelity mode you will only be able to process change feed events within the retention window configured in the change feed policy of the container. If you attempt to process a change feed after more than the retention window an error(Status Code 400) will be returned because the events for intermediary updates and deletes have vanished. It would still be possible to process changes using Incremental mode even when configuring a full fidelity change feed policy with retention window on the container and when using Incremental mode it doesn't matter whether your are out of the retention window or not - but no events for deletes or intermediary updates would be included.

Incremental

Creates a ChangeFeedMode to receive incremental item changes.

public static ChangeFeedMode Incremental { get; }

Property Value

ChangeFeedMode

A ChangeFeedMode to receive incremental item changes.

Remarks

Incremental mode includes item creations and updates, not deletions.

LatestVersion

Creates a ChangeFeedMode to receive latest version item changes.

public static ChangeFeedMode LatestVersion { get; }

Property Value

ChangeFeedMode

A ChangeFeedMode to receive latest version item changes.

Remarks

Latest version mode includes item creations and updates, not deletions.