MongoCollectionBaseTDocumentAggregateTResult Method (IClientSessionHandle, PipelineDefinitionTDocument, TResult, AggregateOptions, CancellationToken) | 
 
            Runs an aggregation pipeline.
            
 
    Namespace: 
   MongoDB.Driver
    Assembly:
   MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntaxpublic virtual IAsyncCursor<TResult> Aggregate<TResult>(
	IClientSessionHandle session,
	PipelineDefinition<TDocument, TResult> pipeline,
	AggregateOptions options = null,
	CancellationToken cancellationToken = default
)
Public Overridable Function Aggregate(Of TResult) ( 
	session As IClientSessionHandle,
	pipeline As PipelineDefinition(Of TDocument, TResult),
	Optional options As AggregateOptions = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of TResult)
abstract Aggregate : 
        session : IClientSessionHandle * 
        pipeline : PipelineDefinition<'TDocument, 'TResult> * 
        ?options : AggregateOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncCursor<'TResult> 
override Aggregate : 
        session : IClientSessionHandle * 
        pipeline : PipelineDefinition<'TDocument, 'TResult> * 
        ?options : AggregateOptions * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _options = defaultArg options null
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> 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: 
IAsyncCursorTResult
            A cursor.
            
Implements
IMongoCollectionTDocumentAggregateTResult(IClientSessionHandle, PipelineDefinitionTDocument, TResult, AggregateOptions, CancellationToken)
See Also