PipelineDefinitionBuilderBucketTInput, TIntermediate, TValue, TOutput Method (PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, IEnumerableTValue, ProjectionDefinitionTIntermediate, TOutput, AggregateBucketOptionsTValue) |
Appends a $bucket stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public static PipelineDefinition<TInput, TOutput> Bucket<TInput, TIntermediate, TValue, TOutput>(
this PipelineDefinition<TInput, TIntermediate> pipeline,
AggregateExpressionDefinition<TIntermediate, TValue> groupBy,
IEnumerable<TValue> boundaries,
ProjectionDefinition<TIntermediate, TOutput> output,
AggregateBucketOptions<TValue> options = null
)
<ExtensionAttribute>
Public Shared Function Bucket(Of TInput, TIntermediate, TValue, TOutput) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
groupBy As AggregateExpressionDefinition(Of TIntermediate, TValue),
boundaries As IEnumerable(Of TValue),
output As ProjectionDefinition(Of TIntermediate, TOutput),
Optional options As AggregateBucketOptions(Of TValue) = Nothing
) As PipelineDefinition(Of TInput, TOutput)
[<ExtensionAttribute>]
static member Bucket :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
groupBy : AggregateExpressionDefinition<'TIntermediate, 'TValue> *
boundaries : IEnumerable<'TValue> *
output : ProjectionDefinition<'TIntermediate, 'TOutput> *
?options : AggregateBucketOptions<'TValue>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, 'TOutput>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - groupBy
- Type: MongoDB.DriverAggregateExpressionDefinitionTIntermediate, TValue
The group by expression. - boundaries
- Type: System.Collections.GenericIEnumerableTValue
The boundaries. - output
- Type: MongoDB.DriverProjectionDefinitionTIntermediate, TOutput
The output projection. - 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.
- TOutput
- The type of the output documents.
Return Value
Type:
PipelineDefinitionTInput,
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
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