ChangeStreamOptions Class

Options for a change stream operation.

Inheritance Hierarchy

SystemObject
MongoDB.DriverChangeStreamOptions

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

public class ChangeStreamOptions

Public Class ChangeStreamOptions

type ChangeStreamOptions =  class end

The ChangeStreamOptions type exposes the following members.

Constructors

	Name	Description
	ChangeStreamOptions	Initializes a new instance of the ChangeStreamOptions class

Properties

	Name	Description
	BatchSize	Gets or sets the size of the batch.
	Collation	Gets or sets the collation.
	Comment	Gets or sets the comment.
	FullDocument	Gets or sets the full document.
	FullDocumentBeforeChange	Gets or sets the full document before change.
	MaxAwaitTime	Gets or sets the maximum await time.
	ResumeAfter	Gets or sets the resume after.
	ShowExpandedEvents	Gets or sets whether the change stream should show expanded events (MongoDB 6.0 and later). Expanded change stream events include: Create CreateIndexes DropIndexes Modify RefineCollectionShardKey ReshardCollection ShardCollection
	StartAfter	Gets or sets the start after.
	StartAtOperationTime	Gets or sets the start at operation time.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (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.)