PipelineDefinitionBuilderChangeStreamTInput, TIntermediate Method |
Appends a $changeStream stage to the pipeline.
Normally you would prefer to use the Watch method of
IMongoCollectionTDocument.
Only use this method if subsequent stages project away the resume token (the _id)
or you don't want the resulting cursor to automatically resume.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntax public static PipelineDefinition<TInput, ChangeStreamDocument<TIntermediate>> ChangeStream<TInput, TIntermediate>(
this PipelineDefinition<TInput, TIntermediate> pipeline,
ChangeStreamStageOptions options = null
)
<ExtensionAttribute>
Public Shared Function ChangeStream(Of TInput, TIntermediate) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
Optional options As ChangeStreamStageOptions = Nothing
) As PipelineDefinition(Of TInput, ChangeStreamDocument(Of TIntermediate))
[<ExtensionAttribute>]
static member ChangeStream :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
?options : ChangeStreamStageOptions
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, ChangeStreamDocument<'TIntermediate>>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - options (Optional)
- Type: MongoDB.DriverChangeStreamStageOptions
The options.
Type Parameters
- TInput
- The type of the input documents.
- TIntermediate
- The type of the intermediate documents.
Return Value
Type:
PipelineDefinitionTInput,
ChangeStreamDocumentTIntermediate
The fluent aggregate interface.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
PipelineDefinitionTInput,
TIntermediate. 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