PipelineDefinitionBuilder.Bucket<TInput, TIntermediate, TValue> Method (PipelineDefinition<TInput, TIntermediate>, Expression<Func<TIntermediate, TValue>>, IEnumerable<TValue>, AggregateBucketOptions<TValue>, ExpressionTranslationOptions) |
Appends a $bucket stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntaxpublic 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.Driver.PipelineDefinition<TInput, TIntermediate>
The pipeline. - groupBy
- Type: System.Linq.Expressions.Expression<Func<TIntermediate, TValue>>
The group by expression. - boundaries
- Type: System.Collections.Generic.IEnumerable<TValue>
The boundaries. - options (Optional)
- Type: MongoDB.Driver.AggregateBucketOptions<TValue>
The options. - translationOptions (Optional)
- Type: MongoDB.Driver.ExpressionTranslationOptions
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:
PipelineDefinition<TInput,
AggregateBucketResult<TValue>>
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).
See Also