Click or drag to resize

IMongoDatabaseAggregateAsyncTResult Method (IClientSessionHandle, PipelineDefinitionNoPipelineInput, TResult, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.12.2+a4a3888f4fb51bb518b1eb5002effc2d47f2ea6a
Syntax
Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(
	IClientSessionHandle session,
	PipelineDefinition<NoPipelineInput, TResult> pipeline,
	AggregateOptions options = null,
	CancellationToken cancellationToken = null
)

Parameters

session
Type: MongoDB.DriverIClientSessionHandle
The session.
pipeline
Type: MongoDB.DriverPipelineDefinitionNoPipelineInput, TResult
The pipeline.
options (Optional)
Type: MongoDB.DriverAggregateOptions
The options.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TResult
The type of the result.

Return Value

Type: TaskIAsyncCursorTResult
A Task whose result is a cursor.
See Also