IMongoCollectionTDocumentWatchTResult Method (IClientSessionHandle, PipelineDefinitionChangeStreamDocumentTDocument, TResult, ChangeStreamOptions, CancellationToken) |
Watches changes on the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
SyntaxIChangeStreamCursor<TResult> Watch<TResult>(
IClientSessionHandle session,
PipelineDefinition<ChangeStreamDocument<TDocument>, TResult> pipeline,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = default
)
Function Watch(Of TResult) (
session As IClientSessionHandle,
pipeline As PipelineDefinition(Of ChangeStreamDocument(Of TDocument), TResult),
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IChangeStreamCursor(Of TResult)
abstract Watch :
session : IClientSessionHandle *
pipeline : PipelineDefinition<ChangeStreamDocument<'TDocument>, 'TResult> *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IChangeStreamCursor<'TResult>
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:
IChangeStreamCursorTResult
A change stream.
See Also