IMongoCollectionExtensions.Aggregate(TDocument) Method (IMongoCollection(TDocument), IClientSessionHandle, AggregateOptions) (original) (raw)
IMongoCollectionExtensionsAggregateTDocument Method (IMongoCollectionTDocument, IClientSessionHandle, AggregateOptions)
Begins a fluent aggregation interface.
Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntax
public static IAggregateFluent Aggregate( this IMongoCollection collection, IClientSessionHandle session, AggregateOptions options = null )
Public Shared Function Aggregate(Of TDocument) ( collection As IMongoCollection(Of TDocument), session As IClientSessionHandle, Optional options As AggregateOptions = Nothing ) As IAggregateFluent(Of TDocument)[] 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