MongoDatabaseBaseWatchAsyncTResult Method (IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken) |
Watches changes on all collections in a database.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public virtual Task<IAsyncCursor<TResult>> WatchAsync<TResult>(
IClientSessionHandle session,
PipelineDefinition<ChangeStreamDocument<BsonDocument>, TResult> pipeline,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function WatchAsync(Of TResult) (
session As IClientSessionHandle,
pipeline As PipelineDefinition(Of ChangeStreamDocument(Of BsonDocument), TResult),
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TResult))
abstract WatchAsync :
session : IClientSessionHandle *
pipeline : PipelineDefinition<ChangeStreamDocument<BsonDocument>, 'TResult> *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TResult>>
override WatchAsync :
session : IClientSessionHandle *
pipeline : PipelineDefinition<ChangeStreamDocument<BsonDocument>, 'TResult> *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TResult>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - pipeline
- Type: MongoDB.DriverPipelineDefinitionChangeStreamDocumentBsonDocument, 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:
TaskIAsyncCursorTResult
A change stream.
Implements
IMongoDatabaseWatchAsyncTResult(IClientSessionHandle, PipelineDefinitionChangeStreamDocumentBsonDocument, TResult, ChangeStreamOptions, CancellationToken)See Also