AggregateFluentBaseTResultMergeAsyncTOutput Method

Appends a merge stage to the pipeline and executes it, and then returns a cursor to read the contents of the output collection.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.9.0+32b058abcdf2c7e8d9dd3a676d207b31897eee2e

Syntax

Copy

public virtual Task<IAsyncCursor<TOutput>> MergeAsync<TOutput>(
	IMongoCollection<TOutput> outputCollection,
	MergeStageOptions<TOutput> mergeOptions = null,
	CancellationToken cancellationToken = null
)

Public Overridable Function MergeAsync(Of TOutput) ( 
	outputCollection As IMongoCollection(Of TOutput),
	Optional mergeOptions As MergeStageOptions(Of TOutput) = Nothing,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TOutput))

abstract MergeAsync : 
        outputCollection : IMongoCollection<'TOutput> * 
        ?mergeOptions : MergeStageOptions<'TOutput> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _mergeOptions = defaultArg mergeOptions null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TOutput>> 
override MergeAsync : 
        outputCollection : IMongoCollection<'TOutput> * 
        ?mergeOptions : MergeStageOptions<'TOutput> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _mergeOptions = defaultArg mergeOptions null
        let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<'TOutput>>

Parameters

outputCollection: Type: MongoDB.DriverIMongoCollectionTOutput
The output collection.
mergeOptions (Optional): Type: MongoDB.DriverMergeStageOptionsTOutput
The merge options.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TOutput: [Missing <typeparam name="TOutput"/> documentation for "M:MongoDB.Driver.AggregateFluentBase`1.MergeAsync``1(MongoDB.Driver.IMongoCollection{``0},MongoDB.Driver.MergeStageOptions{``0},System.Threading.CancellationToken)"]

Return Value

Type: TaskIAsyncCursorTOutput
A cursor.

Implements

IAggregateFluentTResultMergeAsyncTOutput(IMongoCollectionTOutput, MergeStageOptionsTOutput, CancellationToken)

Reference

AggregateFluentBaseTResult Class

MongoDB.Driver Namespace