PipelineDefinitionBuilder.Facet<TInput, TIntermediate, TOutput> Method (PipelineDefinition<TInput, TIntermediate>, IEnumerable<AggregateFacet<TIntermediate>>, AggregateFacetOptions<TOutput>) |
Appends a $facet 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
Syntaxpublic 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.Driver.PipelineDefinition<TInput, TIntermediate>
The pipeline. - facets
- Type: System.Collections.Generic.IEnumerable<AggregateFacet<TIntermediate>>
The facets. - options (Optional)
- Type: MongoDB.Driver.AggregateFacetOptions<TOutput>
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:
PipelineDefinition<TInput,
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
PipelineDefinition<TInput,
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