Click or drag to resize

MongoCollectionBaseTDocumentWatchAsyncTResult Method (IClientSessionHandle, PipelineDefinitionChangeStreamDocumentTDocument, TResult, ChangeStreamOptions, CancellationToken)

Watches changes on the collection.

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

Parameters

session
Type: MongoDB.DriverIClientSessionHandle
The session.
pipeline
Type: MongoDB.DriverPipelineDefinitionChangeStreamDocumentTDocument, TResult
The pipeline.
options (Optional)
Type: MongoDB.DriverChangeStreamOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TResult
The type of the result.

Return Value

Type: TaskIChangeStreamCursorTResult
A change stream.

Implements

IMongoCollectionTDocumentWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentTDocument, TResult, ChangeStreamOptions, CancellationToken)
See Also