Click or drag to resize

IAsyncCursorExtensionsSingleOrDefaultAsyncTDocument Method

Returns the only document of a cursor, or a default value if the cursor contains no documents. This method throws an exception if the cursor contains more than one document.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public static Task<TDocument> SingleOrDefaultAsync<TDocument>(
	this IAsyncCursor<TDocument> cursor,
	CancellationToken cancellationToken = null
)

Parameters

cursor
Type: MongoDB.DriverIAsyncCursorTDocument
The cursor.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument
The type of the document.

Return Value

Type: TaskTDocument
A Task whose result is the only document of a cursor, or a default value if the cursor contains no documents.

Usage Note

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