DatabaseFacade.EnsureCreatedAsync(CancellationToken) 方法

定义

命名空间:

Microsoft.EntityFrameworkCore.Infrastructure

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

确保上下文的数据库存在。

[System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Migrations operations require building the design-time model which is not supported with NativeAOT Use a migration bundle or an alternate way of executing migration operations.")]
public virtual System.Threading.Tasks.Task<bool> EnsureCreatedAsync (System.Threading.CancellationToken cancellationToken = default);

[<System.Diagnostics.CodeAnalysis.RequiresDynamicCode("Migrations operations require building the design-time model which is not supported with NativeAOT Use a migration bundle or an alternate way of executing migration operations.")>]
abstract member EnsureCreatedAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.EnsureCreatedAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

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

参数

cancellationToken

CancellationToken

等待 CancellationToken 任务完成时要观察的 。

返回

Task<Boolean>

表示异步保存操作的任务。 如果数据库已创建，false则任务结果包含true该数据库（如果已存在）。

属性

RequiresDynamicCodeAttribute

例外

OperationCanceledException

如果已取消 CancellationToken。

注解

• 如果数据库存在并且包含任何表，则不执行任何操作。 没有执行任何操作来确保数据库架构与实体框架模型兼容。
• 如果数据库存在但没有任何表，则使用 Entity Framework 模型创建数据库架构。
• 如果数据库不存在，则会创建数据库，并使用 Entity Framework 模型创建数据库架构。

使用 Entity Framework 进行测试或制作原型时，通常立即使用 EnsureCreatedAsync(CancellationToken) 以下 EnsureDeletedAsync(CancellationToken) 代码。 这可确保数据库在每次执行测试/原型之前处于干净状态。 但请注意，数据库中的数据不会保留。

请注意，此 API 不会使用迁移来创建数据库。 此外，以后无法使用迁移来更新所创建的数据库。 如果以关系数据库为目标并使用迁移，则可以使用 Microsoft.EntityFrameworkCore.RelationalDatabaseFacadeExtensions.MigrateAsync 来确保使用迁移创建数据库，并且已应用所有迁移。

Entity Framework Core 不支持在同一 DbContext 实例上运行多个并行操作。 这包括异步查询的并行执行以及从多个线程进行的任何显式并发使用。 因此，请始终立即等待异步调用，或者对并行执行的操作使用单独的 DbContext 实例。 有关详细信息和示例 ，请参阅避免 DbContext 线程问题 。

有关详细信息和示例 ，请参阅使用 EF Core 和 数据库创建 API 管理数据库 架构。