Facet(TInput, TIntermediate, TOutput) Method (PipelineDefinition(TInput, TIntermediate), IEnumerable(AggregateFacet(TIntermediate)), AggregateFacetOptions(TOutput))

PipelineDefinitionBuilderFacetTInput, TIntermediate Method (PipelineDefinitionTInput, TIntermediate, AggregateFacetTIntermediate)

Appends a $facet stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

public static PipelineDefinition<TInput, AggregateFacetResults> Facet<TInput, TIntermediate>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	params AggregateFacet<TIntermediate>[] facets
)

<ExtensionAttribute>
Public Shared Function Facet(Of TInput, TIntermediate) ( 
	pipeline As PipelineDefinition(Of TInput, TIntermediate),
	ParamArray facets As AggregateFacet(Of TIntermediate)()
) As PipelineDefinition(Of TInput, AggregateFacetResults)

[<ExtensionAttribute>]
static member Facet : 
        pipeline : PipelineDefinition<'TInput, 'TIntermediate> * 
        facets : AggregateFacet<'TIntermediate>[] -> PipelineDefinition<'TInput, AggregateFacetResults>

Parameters

pipeline: Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline.
facets: Type: MongoDB.DriverAggregateFacetTIntermediate
The facets.

Type Parameters

TInput: The type of the input documents.
TIntermediate: The type of the intermediate documents.

Return Value

Type: PipelineDefinitionTInput, AggregateFacetResults
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).

Reference

PipelineDefinitionBuilder Class

Facet Overload

MongoDB.Driver Namespace