ChangeStreamDocumentTDocument Class

An output document from a $changeStream pipeline stage.

Inheritance Hierarchy

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a

Syntax

public sealed class ChangeStreamDocument<TDocument> : BsonDocumentBackedClass

Public NotInheritable Class ChangeStreamDocument(Of TDocument)
	Inherits BsonDocumentBackedClass

[<SealedAttribute>]
type ChangeStreamDocument<'TDocument> =  
    class
        inherit BsonDocumentBackedClass
    end

The ChangeStreamDocumentTDocument type exposes the following members.

Constructors

	Name	Description
	ChangeStreamDocumentTDocument	Initializes a new instance of the ChangeStreamDocumentTDocument class.

Properties

	Name	Description
	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.
	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.
	UpdateDescription	Gets the update description.
	WallTime	Gets the wall time of the change stream event.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

ChangeStreamDocumentAddLanguageSpecificTextSet("LSTA6D676CE_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TDocumentAddLanguageSpecificTextSet("LSTA6D676CE_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class