Click or drag to resize

IMongoClientExtensions.Watch 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.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
public static IAsyncCursor<ChangeStreamDocument<BsonDocument>> Watch(
	this IMongoClient client,
	IClientSessionHandle session,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

client
Type: MongoDB.Driver.IMongoClient
The client.
session
Type: MongoDB.Driver.IClientSessionHandle
The session.
options (Optional)
Type: MongoDB.Driver.ChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: IAsyncCursor<ChangeStreamDocument<BsonDocument>>
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