IMongoCollectionExtensionsWatchTDocument Method (IMongoCollectionTDocument, ChangeStreamOptions, CancellationToken) |
Watches changes on the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public static IAsyncCursor<ChangeStreamDocument<TDocument>> Watch<TDocument>(
this IMongoCollection<TDocument> collection,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function Watch(Of TDocument) (
collection As IMongoCollection(Of TDocument),
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of ChangeStreamDocument(Of TDocument))
[<ExtensionAttribute>]
static member Watch :
collection : IMongoCollection<'TDocument> *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> IAsyncCursor<ChangeStreamDocument<'TDocument>>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - 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:
IAsyncCursorChangeStreamDocumentTDocument
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