IMongoCollectionExtensionsAggregateTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, AggregateOptions) |
Begins a fluent aggregation interface.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.7.3+Branch.v2.7.x.Sha.2f1f2be13a23b8520cb9c2ee8439c022f9a03efe
Syntax public static IAggregateFluent<TDocument> Aggregate<TDocument>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
AggregateOptions options = null
)
<ExtensionAttribute>
Public Shared Function Aggregate(Of TDocument) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
Optional options As AggregateOptions = Nothing
) As IAggregateFluent(Of TDocument)
[<ExtensionAttribute>]
static member Aggregate :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
?options : AggregateOptions
(* Defaults:
let _options = defaultArg options null
*)
-> IAggregateFluent<'TDocument>
Parameters
- collection
- Type: MongoDB.DriverIMongoCollectionTDocument
The collection. - session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverAggregateOptions
The options.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
IAggregateFluentTDocument
A fluent aggregate interface.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IMongoCollectionTDocument. 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