PipelineDefinitionBuilderUnwindTInput, TIntermediate, TOutput Method (PipelineDefinitionTInput, TIntermediate, FieldDefinitionTIntermediate, AggregateUnwindOptionsTOutput) |
Appends an $unwind stage to the pipeline.
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, TOutput> Unwind<TInput, TIntermediate, TOutput>(
this PipelineDefinition<TInput, TIntermediate> pipeline,
FieldDefinition<TIntermediate> field,
AggregateUnwindOptions<TOutput> options = null
)
<ExtensionAttribute>
Public Shared Function Unwind(Of TInput, TIntermediate, TOutput) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
field As FieldDefinition(Of TIntermediate),
Optional options As AggregateUnwindOptions(Of TOutput) = Nothing
) As PipelineDefinition(Of TInput, TOutput)
[<ExtensionAttribute>]
static member Unwind :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
field : FieldDefinition<'TIntermediate> *
?options : AggregateUnwindOptions<'TOutput>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, 'TOutput>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - field
- Type: MongoDB.DriverFieldDefinitionTIntermediate
The field. - options (Optional)
- Type: MongoDB.DriverAggregateUnwindOptionsTOutput
The options.
Type Parameters
- TInput
- The type of the input documents.
- TIntermediate
- The type of the intermediate documents.
- TOutput
- The type of the output documents.
Return Value
Type:
PipelineDefinitionTInput,
TOutput
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
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