DbSet<TEntity>.GetAsyncEnumerator(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.dll

Package:: Microsoft.EntityFrameworkCore v6.0.0

Package:: Microsoft.EntityFrameworkCore v7.0.0

Package:: Microsoft.EntityFrameworkCore v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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