AdapterExtensionMethods.FetchSingleAsync<TEntity> Method (IDataAccessAdapter, EntityQuery<TEntity>, CancellationToken)

Async variant of FetchSingle<TEntity>(IDataAccessAdapter, EntityQuery<TEntity>). Fetches the single entity of the set returned by the query and returns that entity. If there are no elements or more than 1 element, a NotSupportedException will be thrown.

Namespace: SD.LLBLGen.Pro.QuerySpec.Adapter
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.4.0.0 (5.4.0)

Syntax

Copy

public static Task<TEntity> FetchSingleAsync<TEntity>(
	this IDataAccessAdapter adapter,
	EntityQuery<TEntity> query,
	CancellationToken cancellationToken
)
where TEntity : EntityBase2, IEntity2

<ExtensionAttribute>
Public Shared Function FetchSingleAsync(Of TEntity As {EntityBase2, IEntity2}) ( 
	adapter As IDataAccessAdapter,
	query As EntityQuery(Of TEntity),
	cancellationToken As CancellationToken
) As Task(Of TEntity)

Parameters

adapter: Type: SD.LLBLGen.Pro.ORMSupportClasses.IDataAccessAdapter
The adapter.
query: Type: SD.LLBLGen.Pro.QuerySpec.EntityQuery<TEntity>
The query.
cancellationToken: Type: System.Threading.CancellationToken
The cancellation token.

Type Parameters

TEntity: The type of the entity.

Return Value

Type: Task<TEntity>
the first entity in the resultset

Usage Note

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

Exceptions

Exception	Condition
NotSupportedException
NotSupportedException	Thrown if the resultset has 0 or 2 or more elements, as Single requires a single value in the resultset.

Reference

AdapterExtensionMethods Class

FetchSingleAsync Overload

SD.LLBLGen.Pro.QuerySpec.Adapter Namespace