PipelineDefinitionBuilderBucketTInput, TIntermediate, TValue Method (PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, IEnumerableTValue, AggregateBucketOptionsTValue) |
Appends a $bucket stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
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
)
<ExtensionAttribute>
Public Shared Function Bucket(Of TInput, TIntermediate, TValue) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
groupBy As AggregateExpressionDefinition(Of TIntermediate, TValue),
boundaries As IEnumerable(Of TValue),
Optional options As AggregateBucketOptions(Of TValue) = Nothing
) As PipelineDefinition(Of TInput, AggregateBucketResult(Of TValue))
[<ExtensionAttribute>]
static member Bucket :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
groupBy : AggregateExpressionDefinition<'TIntermediate, 'TValue> *
boundaries : IEnumerable<'TValue> *
?options : AggregateBucketOptions<'TValue>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, AggregateBucketResult<'TValue>>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - groupBy
- Type: MongoDB.DriverAggregateExpressionDefinitionTIntermediate, TValue
The group by expression. - boundaries
- Type: System.Collections.GenericIEnumerableTValue
The boundaries. - options (Optional)
- Type: MongoDB.DriverAggregateBucketOptionsTValue
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:
PipelineDefinitionTInput,
AggregateBucketResultTValue
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