PipelineDefinitionBuilderBucketTInput, TIntermediate, TValue Method (PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, IEnumerableTValue, AggregateBucketOptionsTValue, ExpressionTranslationOptions) |
Appends a $bucket stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax public static PipelineDefinition<TInput, AggregateBucketResult<TValue>> Bucket<TInput, TIntermediate, TValue>(
this PipelineDefinition<TInput, TIntermediate> pipeline,
Expression<Func<TIntermediate, TValue>> groupBy,
IEnumerable<TValue> boundaries,
AggregateBucketOptions<TValue> options = null,
ExpressionTranslationOptions translationOptions = null
)
<ExtensionAttribute>
Public Shared Function Bucket(Of TInput, TIntermediate, TValue) (
pipeline As PipelineDefinition(Of TInput, TIntermediate),
groupBy As Expression(Of Func(Of TIntermediate, TValue)),
boundaries As IEnumerable(Of TValue),
Optional options As AggregateBucketOptions(Of TValue) = Nothing,
Optional translationOptions As ExpressionTranslationOptions = Nothing
) As PipelineDefinition(Of TInput, AggregateBucketResult(Of TValue))
[<ExtensionAttribute>]
static member Bucket :
pipeline : PipelineDefinition<'TInput, 'TIntermediate> *
groupBy : Expression<Func<'TIntermediate, 'TValue>> *
boundaries : IEnumerable<'TValue> *
?options : AggregateBucketOptions<'TValue> *
?translationOptions : ExpressionTranslationOptions
(* Defaults:
let _options = defaultArg options null
let _translationOptions = defaultArg translationOptions null
*)
-> PipelineDefinition<'TInput, AggregateBucketResult<'TValue>>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline. - groupBy
- Type: System.Linq.ExpressionsExpressionFuncTIntermediate, TValue
The group by expression. - boundaries
- Type: System.Collections.GenericIEnumerableTValue
The boundaries. - options (Optional)
- Type: MongoDB.DriverAggregateBucketOptionsTValue
The options. - translationOptions (Optional)
- Type: MongoDB.DriverExpressionTranslationOptions
The translation 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
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
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