IFindFluentExtensions.Single<TDocument, TProjection> Method

Gets a single result.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a

Syntax

Copy

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

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

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

Parameters

find: Type: MongoDB.Driver.IFindFluent<TDocument, TProjection>
The fluent find.
cancellationToken (Optional): Type: System.Threading.CancellationToken
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: TProjection
A Task whose result is the single result.

Usage Note

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