IAggregateFluentExtensionsSingleAsyncTResult Method

Returns the only document of the aggregate result. Throws an exception if the result set does not contain exactly one document.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2

Syntax

Copy

public static Task<TResult> SingleAsync<TResult>(
	this IAggregateFluent<TResult> aggregate,
	CancellationToken cancellationToken = default
)

<ExtensionAttribute>
Public Shared Function SingleAsync(Of TResult) ( 
	aggregate As IAggregateFluent(Of TResult),
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TResult)

[<ExtensionAttribute>]
static member SingleAsync : 
        aggregate : IAggregateFluent<'TResult> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TResult>

Parameters

aggregate: Type: MongoDB.DriverIAggregateFluentTResult
The aggregate.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TResult: The type of the result.

Return Value

Type: TaskTResult
The fluent aggregate interface.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAggregateFluentTResult. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

IAggregateFluentExtensions Class