Click or drag to resize

IAsyncCursorSourceExtensions.SingleAsync<TDocument> Method

Returns the only document of a cursor returned by a cursor source. This method throws an exception if the cursor does not contain exactly one document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7
Syntax
public static Task<TDocument> SingleAsync<TDocument>(
	this IAsyncCursorSource<TDocument> source,
	CancellationToken cancellationToken = default
)

Parameters

source
Type: MongoDB.Driver.IAsyncCursorSource<TDocument>
The source.
cancellationToken (Optional)
Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: Task<TDocument>
A Task whose result is the only document of a cursor.

Usage Note

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