PipelineDefinitionBuilder.Documents<TDocument> Method (PipelineDefinition<NoPipelineInput, NoPipelineInput>, AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>>, IBsonSerializer<TDocument>) |
Appends a $documents stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntaxpublic static PipelineDefinition<NoPipelineInput, TDocument> Documents<TDocument>(
this PipelineDefinition<NoPipelineInput, NoPipelineInput> pipeline,
AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>> documents,
IBsonSerializer<TDocument> documentSerializer = null
)
<ExtensionAttribute>
Public Shared Function Documents(Of TDocument) (
pipeline As PipelineDefinition(Of NoPipelineInput, NoPipelineInput),
documents As AggregateExpressionDefinition(Of NoPipelineInput, IEnumerable(Of TDocument)),
Optional documentSerializer As IBsonSerializer(Of TDocument) = Nothing
) As PipelineDefinition(Of NoPipelineInput, TDocument)
[<ExtensionAttribute>]
static member Documents :
pipeline : PipelineDefinition<NoPipelineInput, NoPipelineInput> *
documents : AggregateExpressionDefinition<NoPipelineInput, IEnumerable<'TDocument>> *
?documentSerializer : IBsonSerializer<'TDocument>
(* Defaults:
let _documentSerializer = defaultArg documentSerializer null
*)
-> PipelineDefinition<NoPipelineInput, 'TDocument>
Parameters
- pipeline
- Type: MongoDB.Driver.PipelineDefinition<NoPipelineInput, NoPipelineInput>
The pipeline. - documents
- Type: MongoDB.Driver.AggregateExpressionDefinition<NoPipelineInput, IEnumerable<TDocument>>
The documents. - documentSerializer (Optional)
- Type: MongoDB.Bson.Serialization.IBsonSerializer<TDocument>
The document serializer.
Type Parameters
- TDocument
- The type of the documents.
Return Value
Type:
PipelineDefinition<NoPipelineInput,
TDocument>
A new pipeline with an additional stage.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
PipelineDefinition<NoPipelineInput,
NoPipelineInput>. 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