DbSet<TEntity>.GetAsyncEnumerator(CancellationToken) Method

Definition

Returns an IAsyncEnumerator<T> which when enumerated will asynchronously execute a query against the database.

public virtual System.Collections.Generic.IAsyncEnumerator<TEntity> GetAsyncEnumerator (System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsyncEnumerator : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerator<'Entity (requires 'Entity : null)>
override this.GetAsyncEnumerator : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerator<'Entity (requires 'Entity : null)>
Public Overridable Function GetAsyncEnumerator (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerator(Of TEntity)

Parameters

cancellationToken
CancellationToken

A CancellationToken that may be used to cancel the asynchronous iteration.

Returns

IAsyncEnumerator<TEntity>

The query results.

Remarks

See Querying data with EF Core for more information and examples.

Applies to