IMongoDatabaseAggregateAsyncTResult Method (PipelineDefinitionNoPipelineInput, TResult, AggregateOptions, CancellationToken) |
Runs an aggregation pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(
PipelineDefinition<NoPipelineInput, TResult> pipeline,
AggregateOptions options = null,
CancellationToken cancellationToken = default
)
Function AggregateAsync(Of TResult) (
pipeline As PipelineDefinition(Of NoPipelineInput, TResult),
Optional options As AggregateOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TResult))
abstract AggregateAsync :
pipeline : PipelineDefinition<NoPipelineInput, 'TResult> *
?options : AggregateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<'TResult>>
Parameters
- 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:
TaskIAsyncCursorTResultA Task whose result is a cursor.
See Also