DatabaseExtensionsLoadByKeyAsyncTEntity Method

Load all entities of the given type asynchronously using a stored procedure defined on the entity type using the given key value(s).

Definition

Namespace: EWSoftware.EntityFramework
Assembly: EWSoftware.EntityFramework (in EWSoftware.EntityFramework.dll) Version: 2025.11.12.0

C#View Source Request Example

public static IAsyncEnumerable<TEntity> LoadByKeyAsync<TEntity>(
	this DbContext dataContext,
	Object?[] parameters,
	CancellationToken cancellationToken = default
)
where TEntity : class, new()

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function LoadByKeyAsync(Of TEntity As {Class, New}) ( 
	dataContext As DbContext,
	parameters As Object(),
	Optional cancellationToken As CancellationToken = Nothing
) As IAsyncEnumerable(Of TEntity)

C++View Source Request Example

public:
[ExtensionAttribute]
generic<typename TEntity>
where TEntity : ref class, gcnew()
static IAsyncEnumerable<TEntity>^ LoadByKeyAsync(
	DbContext^ dataContext, 
	array<Object^>^ parameters, 
	CancellationToken cancellationToken = CancellationToken()
)

F#View Source Request Example

[<ExtensionAttribute>]
static member LoadByKeyAsync : 
        dataContext : DbContext * 
        parameters : Object[] * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncEnumerable<'TEntity>  when 'TEntity : not struct, new()

Parameters

dataContext DbContext: The data context to use when loading the entities
parameters Object: One or more parameter values that will be passed to the stored procedure. The parameter order must match the declared key order on the entity but does not have to match the parameter order in the stored procedure.
cancellationToken CancellationToken (Optional): An optional cancellation token

Type Parameters

TEntity: The entity type to load

Return Value

IAsyncEnumerableTEntity
An enumerable list of the TEntity entities matching the key values. Typically, there will only be one entity but there could be others if a non-primary key is used.

Usage Note

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

Remarks

The stored procedure name is determined by looking for the LoadByKeyStoredProcedureAttribute on the entity type. If the attribute is not present, the stored procedure name is assumed to be the same as the entity type name without the ResultSetSuffix property value. The stored procedure must have a parameter for each of the passed key values in parameters.

If the connection is not in an open state, it is opened temporarily while loading the entities. If change tracking is enabled on the data context, changes to the entities will be tracked. If not, they will not be tracked.

Example

C#

using var dataContext = new MyDbContext();

var assetInfo = await dataContext.LoadByKeyAsync<Asset>(assetKey).SingleAsync();