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

PipelineDefinitionBuilder.Facet<TInput, TIntermediate> Method (PipelineDefinition<TInput, TIntermediate>, IEnumerable<AggregateFacet<TIntermediate>>)

Appends a $facet stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

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

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

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

Parameters

pipeline: Type: MongoDB.Driver.PipelineDefinition<TInput, TIntermediate>
The pipeline.
facets: Type: System.Collections.Generic.IEnumerable<AggregateFacet<TIntermediate>>
The facets.

Type Parameters

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

Return Value

Type: PipelineDefinition<TInput, AggregateFacetResults>
The fluent aggregate interface.

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).

Reference

PipelineDefinitionBuilder Class

Facet Overload

MongoDB.Driver Namespace