MongoCollectionBaseTDocumentAggregateAsyncTResult Method (IClientSessionHandle, PipelineDefinitionTDocument, TResult, AggregateOptions, CancellationToken) |
Runs an aggregation pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax public virtual Task<IAsyncCursor<TResult>> AggregateAsync<TResult>(
IClientSessionHandle session,
PipelineDefinition<TDocument, TResult> pipeline,
AggregateOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function AggregateAsync(Of TResult) (
session As IClientSessionHandle,
pipeline As PipelineDefinition(Of TDocument, TResult),
Optional options As AggregateOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TResult))
abstract AggregateAsync :
session : IClientSessionHandle *
pipeline : PipelineDefinition<'TDocument, 'TResult> *
?options : AggregateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TResult>>
override AggregateAsync :
session : IClientSessionHandle *
pipeline : PipelineDefinition<'TDocument, 'TResult> *
?options : AggregateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TResult>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - 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.
Implements
IMongoCollectionTDocumentAggregateAsyncTResult(IClientSessionHandle, PipelineDefinitionTDocument, TResult, AggregateOptions, CancellationToken)See Also