Click or drag to resize

MongoCollectionBase<TDocument>.WatchAsync<TResult> Method (IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public virtual Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(
	IClientSessionHandle session,
	PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
	ChangeStreamOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.Driver.IClientSessionHandle
The session.
pipeline
Type: MongoDB.Driver.PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>
The pipeline.
options (Optional)
Type: MongoDB.Driver.ChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TResult
The type of the result.

Return Value

Type: Task<IChangeStreamCursor<TResult>>
A change stream.

Implements

IMongoCollection<TDocument>.WatchAsync<TResult>(IClientSessionHandle, PipelineDefinition<ChangeStreamDocument<TDocument>, TResult>, ChangeStreamOptions, CancellationToken)
See Also