IMongoCollectionExtensionsWatchAsyncTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, ChangeStreamOptions, CancellationToken) |
Watches changes on the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax public static Task<IChangeStreamCursor<ChangeStreamDocument<TDocument>>> WatchAsync<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function WatchAsync(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IChangeStreamCursor(Of ChangeStreamDocument(Of TDocument)))
[<ExtensionAttribute>]
static member WatchAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IChangeStreamCursor<ChangeStreamDocument<'TDocument>>>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
TaskIChangeStreamCursorChangeStreamDocumentTDocument
A change stream.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollectionTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also