Click or drag to resize

IMongoCollectionTDocumentAggregateAsyncTResult Method (PipelineDefinitionTDocument, TResult, AggregateOptions, CancellationToken)

Runs an aggregation pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax
Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(
	PipelineDefinition<TDocument, TResult> pipeline,
	AggregateOptions options = null,
	CancellationToken cancellationToken = default
)

Parameters

pipeline
Type: MongoDB.DriverPipelineDefinitionTDocument, 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