Table of Contents

Class ChangeStreamDocument<TDocument>

Namespace
MongoDB.Driver
Assembly
MongoDB.Driver.Core.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<TDocument>
Inherited Members

Constructors

ChangeStreamDocument(BsonDocument, IBsonSerializer<TDocument>)

Initializes a new instance of the ChangeStreamDocument<TDocument> class.

public ChangeStreamDocument(BsonDocument backingDocument, IBsonSerializer<TDocument> documentSerializer)

Parameters

backingDocument BsonDocument

The backing document.

documentSerializer IBsonSerializer<TDocument>

The document serializer.

Properties

BackingDocument

Gets the backing document.

public BsonDocument BackingDocument { get; }

Property Value

BsonDocument

ClusterTime

Gets the cluster time.

public BsonTimestamp ClusterTime { get; }

Property Value

BsonTimestamp

The cluster time.

CollectionNamespace

Gets the namespace of the collection.

public CollectionNamespace CollectionNamespace { get; }

Property Value

CollectionNamespace

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):

public Guid? CollectionUuid { get; }

Property Value

Guid?

The UUID of the collection.

DatabaseNamespace

Gets the database namespace.

public DatabaseNamespace DatabaseNamespace { get; }

Property Value

DatabaseNamespace

The database namespace.

DisambiguatedPaths

Gets the disambiguated paths if present.

public BsonDocument DisambiguatedPaths { get; }

Property Value

BsonDocument

The disambiguated paths.

Remarks

A document containing a map that associates an update path to an array containing the path components used in the update document. This data can be used in combination with the other fields in an UpdateDescription to determine the actual path in the document that was updated. This is necessary in cases where a key contains dot-separated strings (i.e. { "a.b": "c" }) or a document contains a numeric literal string key (i.e. { "a": { "0": "a" } }). Note that in this scenario, the numeric key can't be the top level key because { "0": "a" } is not ambiguous - update paths would simply be '0' which is unambiguous because BSON documents cannot have arrays at the top level. Each entry in the document maps an update path to an array which contains the actual path used when the document was updated. For example, given a document with the following shape { "a": { "0": 0 } } and an update of { $inc: { "a.0": 1 } }, DisambiguatedPaths would look like the following: 

{
   "a.0": ["a", "0"]
}

In each array, all elements will be returned as strings with the exception of array indices, which will be returned as 32-bit integers.

Added in MongoDB version 6.1.0.

DocumentKey

Gets the document key.

public BsonDocument DocumentKey { get; }

Property Value

BsonDocument

The document key.

FullDocument

Gets the full document.

public TDocument FullDocument { get; }

Property Value

TDocument

The full document.

FullDocumentBeforeChange

Gets the full document before change.

public TDocument FullDocumentBeforeChange { get; }

Property Value

TDocument

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):

public BsonDocument OperationDescription { get; }

Property Value

BsonDocument

The description of the operation.

OperationType

Gets the type of the operation.

public ChangeStreamOperationType OperationType { get; }

Property Value

ChangeStreamOperationType

The type of the operation.

RenameTo

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

public CollectionNamespace RenameTo { get; }

Property Value

CollectionNamespace

The new namespace of the ns collection.

ResumeToken

Gets the resume token.

public BsonDocument ResumeToken { get; }

Property Value

BsonDocument

The resume token.

UpdateDescription

Gets the update description.

public ChangeStreamUpdateDescription UpdateDescription { get; }

Property Value

ChangeStreamUpdateDescription

The update description.

WallTime

Gets the wall time of the change stream event.

public DateTime? WallTime { get; }

Property Value

DateTime?

The wall time.