IAggregateFluentExtensions.Bucket<TResult, TValue> Method (IAggregateFluent<TResult>, Expression<Func<TResult, TValue>>, IEnumerable<TValue>, AggregateBucketOptions<TValue>) |
Appends a $bucket stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e
Syntaxpublic static IAggregateFluent<AggregateBucketResult<TValue>> Bucket<TResult, TValue>(
this IAggregateFluent<TResult> aggregate,
Expression<Func<TResult, TValue>> groupBy,
IEnumerable<TValue> boundaries,
AggregateBucketOptions<TValue> options = null
)
<ExtensionAttribute>
Public Shared Function Bucket(Of TResult, TValue) (
aggregate As IAggregateFluent(Of TResult),
groupBy As Expression(Of Func(Of TResult, TValue)),
boundaries As IEnumerable(Of TValue),
Optional options As AggregateBucketOptions(Of TValue) = Nothing
) As IAggregateFluent(Of AggregateBucketResult(Of TValue))
[<ExtensionAttribute>]
static member Bucket :
aggregate : IAggregateFluent<'TResult> *
groupBy : Expression<Func<'TResult, 'TValue>> *
boundaries : IEnumerable<'TValue> *
?options : AggregateBucketOptions<'TValue>
(* Defaults:
let _options = defaultArg options null
*)
-> IAggregateFluent<AggregateBucketResult<'TValue>>
Parameters
- aggregate
- Type: MongoDB.Driver.IAggregateFluent<TResult>
The aggregate. - groupBy
- Type: System.Linq.Expressions.Expression<Func<TResult, TValue>>
The expression providing the value to group by. - boundaries
- Type: System.Collections.Generic.IEnumerable<TValue>
The bucket boundaries. - options (Optional)
- Type: MongoDB.Driver.AggregateBucketOptions<TValue>
The options.
Type Parameters
- TResult
- The type of the result.
- TValue
- The type of the value.
Return Value
Type:
IAggregateFluent<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
IAggregateFluent<TResult>. 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