IMongoDatabaseExtensionsWatchAsync Method (IMongoDatabase, IClientSessionHandle, ChangeStreamOptions, CancellationToken) |
Watches changes on all collection in a database.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax public static Task<IChangeStreamCursor<ChangeStreamDocument<BsonDocument>>> WatchAsync(
this IMongoDatabase database,
IClientSessionHandle session,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function WatchAsync (
database As IMongoDatabase,
session As IClientSessionHandle,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IChangeStreamCursor(Of ChangeStreamDocument(Of BsonDocument)))
[<ExtensionAttribute>]
static member WatchAsync :
database : IMongoDatabase *
session : IClientSessionHandle *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IChangeStreamCursor<ChangeStreamDocument<BsonDocument>>>
Parameters
- database
- Type: MongoDB.DriverIMongoDatabase
The database. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIChangeStreamCursorChangeStreamDocumentBsonDocument
A change stream.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoDatabase. 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