Click or drag to resize

IMongoCollectionExtensions.Watch<TDocument> Method (IMongoCollection<TDocument>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public static IChangeStreamCursor<ChangeStreamDocument<TDocument>> Watch<TDocument>(
	this IMongoCollection<TDocument> collection,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

collection
Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection.
options (Optional)
Type: MongoDB.Driver.ChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: IChangeStreamCursor<ChangeStreamDocument<TDocument>>
A change stream.

Usage Note

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