IFindFluentExtensionsSingleTDocument, TProjection Method

Gets a single result.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed

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.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: 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 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