IAggregateFluentExtensions.SingleAsync<TResult> 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.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax public static Task<TResult> SingleAsync<TResult>(
this IAggregateFluent<TResult> aggregate,
CancellationToken cancellationToken = null
)
<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 null
*)
-> Task<'TResult>
Parameters
- aggregate
- Type: MongoDB.Driver.IAggregateFluent<TResult>
The aggregate. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TResult
- The type of the result.
Return Value
Type:
Task<TResult>
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
IAggregateFluent<TResult>. 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).
See Also