Click or drag to resize

IMongoCollectionExtensionsWatchAsyncTDocument Method (IMongoCollectionTDocument, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

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

Parameters

collection
Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
options (Optional)
Type: MongoDB.DriverChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TaskIChangeStreamCursorChangeStreamDocumentTDocument
A change stream.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoCollectionTDocument. 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