Click or drag to resize

ChangeStreamDocumentTDocument Class

An output document from a $changeStream pipeline stage.
Inheritance Hierarchy
SystemObject
  MongoDB.Bson.SerializationBsonDocumentBackedClass
    MongoDB.DriverChangeStreamDocumentTDocument

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax
public sealed class ChangeStreamDocument<TDocument> : BsonDocumentBackedClass

Type Parameters

TDocument
The type of the document.

The ChangeStreamDocumentTDocument type exposes the following members.

Constructors
  NameDescription
Public methodChangeStreamDocumentTDocument
Initializes a new instance of the ChangeStreamDocumentTDocument class.
Top
Properties
  NameDescription
Public propertyBackingDocument
Gets the backing document.
Public propertyClusterTime
Gets the cluster time.
Public propertyCollectionNamespace
Gets the namespace of the collection.
Public propertyCollectionUuid
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 propertyDatabaseNamespace
Gets the database namespace.
Public propertyDisambiguatedPaths
Gets the disambiguated paths if present.
Public propertyDocumentKey
Gets the document key.
Public propertyFullDocument
Gets the full document.
Public propertyFullDocumentBeforeChange
Gets the full document before change.
Public propertyOperationDescription
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 propertyOperationType
Gets the type of the operation.
Public propertyRenameTo
Gets the new namespace for the ns collection. This field is omitted for all operation types except "rename".
Public propertyResumeToken
Gets the resume token.
Public propertyUpdateDescription
Gets the update description.
Public propertyWallTime
Gets the wall time of the change stream event.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also