IDatabaseCreator.EnsureCreatedAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.EntityFrameworkCore.Storage

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v8.0.0

Asynchronously ensures that the database for the context exists. If it exists, no action is taken. If it does not exist then the database and all its schema are created. If the database exists, then no effort is made to ensure it is compatible with the model for this context.

public System.Threading.Tasks.Task<bool> EnsureCreatedAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member EnsureCreatedAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Function EnsureCreatedAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

cancellationToken

CancellationToken

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

Returns

Task<Boolean>

A task that represents the asynchronous save operation. The task result contains true if the database is created, false if it already existed.

Exceptions

OperationCanceledException

If the CancellationToken is canceled.