IMongoDatabaseExtensionsAggregate Method (IMongoDatabase, IClientSessionHandle, AggregateOptions)

Begins a fluent aggregation interface.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc

Syntax

Copy

public static IAggregateFluent<NoPipelineInput> Aggregate(
	this IMongoDatabase database,
	IClientSessionHandle session,
	AggregateOptions options = null
)

<ExtensionAttribute>
Public Shared Function Aggregate ( 
	database As IMongoDatabase,
	session As IClientSessionHandle,
	Optional options As AggregateOptions = Nothing
) As IAggregateFluent(Of NoPipelineInput)

[<ExtensionAttribute>]
static member Aggregate : 
        database : IMongoDatabase * 
        session : IClientSessionHandle * 
        ?options : AggregateOptions 
(* Defaults:
        let _options = defaultArg options null
*)
-> IAggregateFluent<NoPipelineInput>

Parameters

database: Type: MongoDB.DriverIMongoDatabase
The database.
session: Type: MongoDB.DriverIClientSessionHandle
The session.
options (Optional): Type: MongoDB.DriverAggregateOptions
The options.

Return Value

Type: IAggregateFluentNoPipelineInput
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 IMongoDatabase. 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

IMongoDatabaseExtensions Class

Aggregate Overload

MongoDB.Driver Namespace

IMongoDatabaseExtensionsAddLanguageSpecificTextSet("LSTC7F81788_0?cpp=::|nu=.");Aggregate Method (IMongoDatabase, IClientSessionHandle, AggregateOptions)

Parameters

Return Value

Usage Note

Reference

IMongoDatabaseExtensionsAggregate Method (IMongoDatabase, IClientSessionHandle, AggregateOptions)