Click or drag to resize

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

Runs an aggregation pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax
public virtual Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(
	IClientSessionHandle session,
	PipelineDefinition<NoPipelineInput, TResult> pipeline,
	AggregateOptions options = null,
	CancellationToken cancellationToken = default
)

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.

Implements

IMongoDatabaseAggregateAsyncTResult(IClientSessionHandle, PipelineDefinitionNoPipelineInput, TResult, AggregateOptions, CancellationToken)
See Also