Click or drag to resize

IMongoClientExtensionsWatchAsync Method (IMongoClient, ChangeStreamOptions, CancellationToken)

Watches changes on all collections in all databases.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax
public static Task<IChangeStreamCursor<ChangeStreamDocument<BsonDocument>>> WatchAsync(
	this IMongoClient client,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

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

Return Value

Type: TaskIChangeStreamCursorChangeStreamDocumentBsonDocument
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