Click or drag to resize

MongoQueryableSingleOrDefaultAsyncTSource Method (IMongoQueryableTSource, ExpressionFuncTSource, Boolean, CancellationToken)

Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.

Namespace:  MongoDB.Driver.Linq
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
public static Task<TSource> SingleOrDefaultAsync<TSource>(
	this IMongoQueryable<TSource> source,
	Expression<Func<TSource, bool>> predicate,
	CancellationToken cancellationToken = default
)

Parameters

source
Type: MongoDB.Driver.LinqIMongoQueryableTSource
An IMongoQueryableT to return a single element from.
predicate
Type: System.Linq.ExpressionsExpressionFuncTSource, Boolean
A function to test an element for a condition.
cancellationToken (Optional)
Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TSource
The type of the elements of source.

Return Value

Type: TaskTSource
The single element of the input sequence that satisfies the condition in predicate, or default(TSource) if no such element is found.

Usage Note

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