IFindFluentExtensionsSingleOrDefaultAsyncTDocument, TProjection Method

Gets a single result or null.

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

Syntax

Copy

public static Task<TProjection> SingleOrDefaultAsync<TDocument, TProjection>(
	this IFindFluent<TDocument, TProjection> find,
	CancellationToken cancellationToken = default
)

<ExtensionAttribute>
Public Shared Function SingleOrDefaultAsync(Of TDocument, TProjection) ( 
	find As IFindFluent(Of TDocument, TProjection),
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of TProjection)

[<ExtensionAttribute>]
static member SingleOrDefaultAsync : 
        find : IFindFluent<'TDocument, 'TProjection> * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<'TProjection>

Parameters

find: Type: MongoDB.DriverIFindFluentTDocument, TProjection
The fluent find.
cancellationToken (Optional): Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument: The type of the document.
TProjection: The type of the projection (same as TDocument if there is no projection).

Return Value

Type: TaskTProjection
A Task whose result is the single result or null.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IFindFluentTDocument, TProjection. 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

IFindFluentExtensions Class