Class ChangeStreamDocument

| MongoDB CSharp Driver API Reference (original) (raw)

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

An output document from a $changeStream pipeline stage.

[BsonSerializer(typeof(ChangeStreamDocumentSerializer<>))]
public sealed class ChangeStreamDocument<TDocument> : BsonDocumentBackedClass

Type Parameters

TDocument

The type of the document.

Inheritance

ChangeStreamDocument

Inherited Members

Constructors

ChangeStreamDocument(BsonDocument, IBsonSerializer)

Initializes a new instance of the ChangeStreamDocument class.

Properties

BackingDocument

Gets the backing document.

ClusterTime

Gets the cluster time.

CollectionNamespace

Gets the namespace of the collection.

CollectionUuid

Gets ui field from the oplog entry corresponding to the change event. Only present when the showExpandedEvents change stream option is enabled and for the following event types (MongoDB 6.0 and later):

• Create
• CreateIndexes
• Delete
• Drop
• DropIndexes
• Insert
• Modify
• RefineCollectionShardKey
• ReshardCollection
• ShardCollection
• Update

DatabaseNamespace

Gets the database namespace.

DisambiguatedPaths

Gets the disambiguated paths if present.

DocumentKey

Gets the document key.

FullDocument

Gets the full document.

FullDocumentBeforeChange

Gets the full document before change.

NamespaceType

The type of the newly created object. Only present when the showExpandedEvents change stream option is enabled and for the following event types (MongoDB 8.1 and later):

• Create

OperationDescription

Gets the description for the operation. Only present when the showExpandedEvents change stream option is enabled and for the following event types (MongoDB 6.0 and later):

• Create
• CreateIndexes
• DropIndexes
• Modify
• RefineCollectionShardKey
• Rename
• ReshardCollection
• ShardCollection

OperationType

Gets the type of the operation.

RenameTo

Gets the new namespace for the ns collection. This field is omitted for all operation types except "rename".

ResumeToken

Gets the resume token.

SplitEvent

Gets the split event.

UpdateDescription

Gets the update description.

WallTime

Gets the wall time of the change stream event.