EntityEntry.GetDatabaseValuesAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.EntityFrameworkCore.ChangeTracking

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v8.0.0

Queries the database for copies of the values of the tracked entity as they currently exist in the database. If the entity is not found in the database, then null is returned.

public virtual System.Threading.Tasks.Task<Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues?> GetDatabaseValuesAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member GetDatabaseValuesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues>
override this.GetDatabaseValuesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.EntityFrameworkCore.ChangeTracking.PropertyValues>

Public Overridable Function GetDatabaseValuesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of PropertyValues)

Parameters

cancellationToken

CancellationToken

A CancellationToken to observe while waiting for the task to complete.

Returns

Task<PropertyValues>

A task that represents the asynchronous operation. The task result contains the store values, or null if the entity does not exist in the database.

Exceptions

OperationCanceledException

If the CancellationToken is canceled.

Remarks

Note that changing the values in the returned dictionary will not update the values in the database.

Multiple active operations on the same context instance are not supported. Use await to ensure that any asynchronous operations have completed before calling another method on this context.

See Accessing tracked entities in EF Core for more information and examples.