IMongoCollectionExtensions.Watch<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, ChangeStreamOptions, CancellationToken) |
Watches changes on the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntaxpublic static IAsyncCursor<ChangeStreamDocument<TDocument>> Watch<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
ChangeStreamOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function Watch(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
Optional options As ChangeStreamOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of ChangeStreamDocument(Of TDocument))
[<ExtensionAttribute>]
static member Watch :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
?options : ChangeStreamOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> IAsyncCursor<ChangeStreamDocument<'TDocument>>
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.Driver.ChangeStreamOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
IAsyncCursor<ChangeStreamDocument<TDocument>>
A change stream.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollection<TDocument>. 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