IMongoCollection<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.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax Task<IChangeStreamCursor<TResult>> WatchAsync<TResult>(
IClientSessionHandle session,
PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = default
)
Function WatchAsync(Of TResult) (
session As IClientSessionHandle,
pipeline As PipelineDefinition(Of ChangeStreamDocument(Of TDocument), TResult),
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IChangeStreamCursor(Of TResult))
abstract WatchAsync :
session : IClientSessionHandle *
pipeline : PipelineDefinition<ChangeStreamDocument<'TDocument>, 'TResult> *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IChangeStreamCursor<'TResult>>
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.
See Also