IMongoCollectionExtensionsAggregateTDocument Method (IMongoCollectionTDocument, AggregateOptions)

Begins a fluent aggregation interface.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242

Syntax

Copy

public static IAggregateFluent<TDocument> Aggregate<TDocument>(
	this IMongoCollection<TDocument> collection,
	AggregateOptions options = null
)

<ExtensionAttribute>
Public Shared Function Aggregate(Of TDocument) ( 
	collection As IMongoCollection(Of TDocument),
	Optional options As AggregateOptions = Nothing
) As IAggregateFluent(Of TDocument)

[<ExtensionAttribute>]
static member Aggregate : 
        collection : IMongoCollection<'TDocument> * 
        ?options : AggregateOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> IAggregateFluent<'TDocument>

Parameters

collection: Type: MongoDB.DriverIMongoCollectionTDocument
The collection.
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).

Reference

IMongoCollectionExtensions Class

Aggregate Overload

MongoDB.Driver Namespace