Click or drag to resize

IMongoClientExtensionsWatch Method (IMongoClient, IClientSessionHandle, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
public static IAsyncCursor<ChangeStreamDocument<BsonDocument>> Watch(
	this IMongoClient client,
	IClientSessionHandle session,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

client
Type: MongoDB.DriverIMongoClient
The client.
session
Type: MongoDB.DriverIClientSessionHandle
The session.
options (Optional)
Type: MongoDB.DriverChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: IAsyncCursorChangeStreamDocumentBsonDocument
A change stream.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoClient. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
See Also