Click or drag to resize

IMongoCollectionExtensions.Aggregate<TDocument> Method (IMongoCollection<TDocument>, IClientSessionHandle, AggregateOptions)

Begins a fluent aggregation interface.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public static IAggregateFluent<TDocument> Aggregate<TDocument>(
	this IMongoCollection<TDocument> collection,
	IClientSessionHandle session,
	AggregateOptions options = null
)

Parameters

collection
Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection.
session
Type: MongoDB.Driver.IClientSessionHandle
The session.
options (Optional)
Type: MongoDB.Driver.AggregateOptions
The options.

Type Parameters

TDocument
The type of the document.

Return Value

Type: IAggregateFluent<TDocument>
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 IMongoCollection<TDocument>. 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