PipelineDefinitionBuilderFacetTInput, TIntermediate, TOutput Method (PipelineDefinitionTInput, TIntermediate, IEnumerableAggregateFacetTIntermediate, AggregateFacetOptionsTOutput) |
Appends a $facet stage to the pipeline.
Namespace: MongoDB.DriverAssembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.4.1
Syntax public static PipelineDefinition<TInput, TOutput> Facet<TInput, TIntermediate, TOutput>(
this PipelineDefinition<TInput, TIntermediate> pipeline,
IEnumerable<AggregateFacet<TIntermediate>> facets,
AggregateFacetOptions<TOutput> options = null
)
<ExtensionAttribute>
Public Shared Function Facet(Of TInput, TIntermediate, TOutput) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
facets As IEnumerable(Of AggregateFacet(Of TIntermediate)),
Optional options As AggregateFacetOptions(Of TOutput) = Nothing
) As PipelineDefinition(Of TInput, TOutput)
[<ExtensionAttribute>]
static member Facet :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
facets : IEnumerable<AggregateFacet<'TIntermediate>> *
?options : AggregateFacetOptions<'TOutput>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, 'TOutput>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - facets
- Type: System.Collections.GenericIEnumerableAggregateFacetTIntermediate
The facets. - options (Optional)
- Type: MongoDB.DriverAggregateFacetOptionsTOutput
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