IMongoClientExtensionsWatchAsync Method (IMongoClient, ChangeStreamOptions, CancellationToken) |
Watches changes on all collections in all databases.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public static Task<IAsyncCursor<ChangeStreamDocument<BsonDocument>>> WatchAsync(
this IMongoClient client,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function WatchAsync (
client As IMongoClient,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of ChangeStreamDocument(Of BsonDocument)))
[<ExtensionAttribute>]
static member WatchAsync :
client : IMongoClient *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<ChangeStreamDocument<BsonDocument>>>
Parameters
- client
- Type: MongoDB.DriverIMongoClient
The client. - options (Optional)
- Type: MongoDB.DriverChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorChangeStreamDocumentBsonDocument
A change stream.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoClient. 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