IMongoDatabaseExtensions.Watch Method (IMongoDatabase, ChangeStreamOptions, CancellationToken) |
Watches changes on all collection in a database.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntaxpublic static IAsyncCursor<ChangeStreamDocument<BsonDocument>> Watch(
this IMongoDatabase database,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function Watch (
database As IMongoDatabase,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of ChangeStreamDocument(Of BsonDocument))
[<ExtensionAttribute>]
static member Watch :
database : IMongoDatabase *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> IAsyncCursor<ChangeStreamDocument<BsonDocument>>
Parameters
- database
- Type: MongoDB.Driver.IMongoDatabase
The database. - options (Optional)
- Type: MongoDB.Driver.ChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
IAsyncCursor<ChangeStreamDocument<BsonDocument>>
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