Class ChangeStreamDocument<TDocument>
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<TDocument>
- Inherited Members
Constructors
- ChangeStreamDocument(BsonDocument, IBsonSerializer<TDocument>)
Initializes a new instance of the ChangeStreamDocument<TDocument> 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):
- 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.
- 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):
- 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.