Click or drag to resize

PipelineDefinitionBuilder.Bucket<TInput, TIntermediate, TValue> Method (PipelineDefinition<TInput, TIntermediate>, AggregateExpressionDefinition<TIntermediate, TValue>, IEnumerable<TValue>, AggregateBucketOptions<TValue>)

Appends a $bucket stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public static PipelineDefinition<TInput, AggregateBucketResult<TValue>> Bucket<TInput, TIntermediate, TValue>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	AggregateExpressionDefinition<TIntermediate, TValue> groupBy,
	IEnumerable<TValue> boundaries,
	AggregateBucketOptions<TValue> options = null
)

Parameters

pipeline
Type: MongoDB.Driver.PipelineDefinition<TInput, TIntermediate>
The pipeline.
groupBy
Type: MongoDB.Driver.AggregateExpressionDefinition<TIntermediate, TValue>
The group by expression.
boundaries
Type: System.Collections.Generic.IEnumerable<TValue>
The boundaries.
options (Optional)
Type: MongoDB.Driver.AggregateBucketOptions<TValue>
The options.

Type Parameters

TInput
The type of the input documents.
TIntermediate
The type of the intermediate documents.
TValue
The type of the values.

Return Value

Type: PipelineDefinition<TInput, AggregateBucketResult<TValue>>
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