IMongoClientExtensionsWatch Method (IMongoClient, IClientSessionHandle, ChangeStreamOptions, CancellationToken) |
Watches changes on all collections in all databases.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public static IAsyncCursor<ChangeStreamDocument<BsonDocument>> Watch(
this IMongoClient client,
IClientSessionHandle session,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function Watch (
client As IMongoClient,
session As IClientSessionHandle,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of ChangeStreamDocument(Of BsonDocument))
[<ExtensionAttribute>]
static member Watch :
client : IMongoClient *
session : IClientSessionHandle *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncCursor<ChangeStreamDocument<BsonDocument>>
Parameters
- client
- Type: MongoDB.DriverIMongoClient
The client. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
IAsyncCursorChangeStreamDocumentBsonDocument
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