Entity Framework Core 工具参考-Visual Studio 中的包管理器控制台Entity Framework Core tools reference - Package Manager Console in Visual Studio

适用于 Entity Framework Core 的包管理器控制台（PMC）工具执行设计时开发任务。 例如，他们基于现有数据库创建迁移、应用迁移和生成模型的代码。 命令使用包管理器控制台在 Visual Studio 中运行。 这些工具同时适用于 .NET Framework 和 .NET Core 项目。

如果未使用 Visual Studio，则建议改为使用EF Core 命令行工具。 .NET Core CLI 工具是跨平台的，在命令提示符下运行。

安装工具Installing the tools

用于安装和更新这些工具的过程在 ASP.NET Core 2.1 及更早版本或其他项目类型之间有所不同。

ASP.NET Core 版本2.1 及更高版本ASP.NET Core version 2.1 and later

工具将自动包含在 ASP.NET Core 2.1 + 项目中，因为 Microsoft.EntityFrameworkCore.Tools 包包含在AspNetCore 元包中。

因此，您无需执行任何操作来安装这些工具，但必须执行以下操作：

• 在新项目中使用这些工具之前还原包。
• 安装包以将工具更新到较新版本。

为了确保获得最新版本的工具，我们建议您也执行以下步骤：

• 编辑 .csproj文件，并添加一行以指定最新版本的microsoft.entityframeworkcore包。 例如， .csproj文件可能包含如下所示 ItemGroup 的：

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.App" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="3.1.3" />
    <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="3.1.2" />
  </ItemGroup>

在收到类似于以下示例的消息时更新工具：

EF Core 工具版本 “2.1.1-30846” 早于运行时 “2.1.3-32065”。 更新工具以获取最新功能和 bug 修复。

更新工具：

• 安装最新的 .NET Core SDK。
• 将 Visual Studio 更新到最新版本。
• 编辑 .csproj文件，使其包含对最新工具包的包引用，如前文所述。

其他版本和项目类型Other versions and project types

在Package Manager console中运行以下命令，安装包管理器控制台工具：

Install-Package Microsoft.EntityFrameworkCore.Tools

在Package Manager Console中运行以下命令，更新这些工具。

Update-Package Microsoft.EntityFrameworkCore.Tools

验证安装Verify the installation

通过运行以下命令验证是否已安装这些工具：

Get-Help about_EntityFrameworkCore

输出如下所示（不告诉您正在使用的工具的版本）：

                     _/\__
               ---==/    \\
         ___  ___   |.    \|\
        | __|| __|  |  )   \\\
        | _| | _|   \_/ |  //|\\
        |___||_|       /   \\\/\\
TOPIC
    about_EntityFrameworkCore
SHORT DESCRIPTION
    Provides information about the Entity Framework Core Package Manager Console Tools.
<A list of available commands follows, omitted here.>

使用工具Using the tools

使用这些工具之前：

• 了解目标项目和启动项目之间的差异。
• 了解如何将工具与 .NET Standard 类库一起使用。
• 对于 ASP.NET Core 项目，请设置环境。

目标和启动项目Target and startup project

命令引用项目和启动项目。

• 该项目也称为目标项目，因为它是命令在其中添加或删除文件的位置。 默认情况下，在 “程序包管理器控制台“ 中选择的默认项目是目标项目。 可以使用选项指定其他项目作为目标项目 --project 。

• 启动项目是工具生成和运行的项目。 这些工具必须在设计时执行应用程序代码，以获取有关项目的信息，例如数据库连接字符串和模型的配置。 默认情况下，解决方案资源管理器中的启动项目是启动项目。 您可以使用选项指定其他项目作为启动项目 --startup-project 。

启动项目和目标项目通常是同一个项目。 它们是不同的项目的典型方案是：

• EF Core 的上下文和实体类位于 .NET Core 类库中。
• .NET Core 控制台应用程序或 web 应用程序引用类库。

还可以将迁移代码放在与 EF Core 上下文分离的类库中。

其他目标框架Other target frameworks

包管理器控制台工具适用于 .NET Core 或 .NET Framework 项目。 .NET Standard 类库中具有 EF Core 模型的应用可能没有 .NET Core 或 .NET Framework 项目。 例如，这适用于 Xamarin 和通用 Windows 平台应用。 在这种情况下，你可以创建一个 .NET Core 或 .NET Framework 的控制台应用程序项目，该项目的唯一用途是充当工具的启动项目。 项目可以是不包含实际代码的虚拟项目， — 只需为工具提供目标。

为什么需要虚拟项目？ 如前文所述，这些工具必须在设计时执行应用程序代码。 为此，需要使用 .NET Core 或 .NET Framework 运行时。 当 EF Core 模型位于面向 .NET Core 或 .NET Framework 的项目中时，EF Core 工具会借用项目中的运行时。 如果 EF Core 模型在 .NET Standard 类库中，则无法执行此操作。 .NET Standard 不是实际的 .NET 实现;它是 .NET 实现所必须支持的一组 Api 的规范。 因此 .NET Standard 不足以执行应用程序代码 EF Core 工具。 你创建的用于启动项目的虚拟项目提供了一个具体的目标平台，工具可在其中加载 .NET Standard 类库。

ASP.NET Core 环境ASP.NET Core environment

若要为 ASP.NET Core 项目指定环境，请在运行命令之前设置env： ASPNETCORE_ENVIRONMENT 。

通用参数Common parameters

下表显示了所有 EF Core 命令共有的参数：

若要显示有关命令的帮助信息，请使用 PowerShell Get-Help 命令。

提示

上下文、项目和 StartupProject 参数支持选项卡扩展。

添加-迁移Add-Migration

添加新的迁移。

参数：

Drop 数据库Drop-Database

删除数据库。

参数：

DbContextGet-DbContext

获取有关类型的信息 DbContext 。

Remove-MigrationRemove-Migration

删除上一次迁移（回滚针对迁移进行的代码更改）。

参数：

基架-DbContextScaffold-DbContext

为 DbContext 数据库的和实体类型生成代码。 为了使 Scaffold-DbContext 生成实体类型，数据库表必须具有主键。

参数：

示例：

Scaffold-DbContext "Server=(localdb)\mssqllocaldb;Database=Blogging;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models

示例：仅基架选定的表，并在具有指定名称和命名空间的单独文件夹中创建上下文：

Scaffold-DbContext "Server=(localdb)\mssqllocaldb;Database=Blogging;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models -Tables "Blog","Post" -ContextDir Context -Context BlogContext -ContextNamespace New.Namespace

脚本迁移Script-Migration

生成一个 SQL 脚本，该脚本将所选迁移中的所有更改应用于另一个选定的迁移。

参数：

提示

To、From 和 Output 参数支持选项卡扩展。

以下示例使用迁移名称创建用于 InitialCreate 迁移的脚本。

Script-Migration -To InitialCreate

以下示例使用迁移 ID，为 InitialCreate 迁移后的所有迁移创建一个脚本。

Script-Migration -From 20180904195021_InitialCreate

Update-DatabaseUpdate-Database

将数据库更新到上次迁移或指定迁移。

提示

迁移参数支持选项卡扩展。

下面的示例将还原所有迁移。

Update-Database -Migration 0

下面的示例将数据库更新为指定的迁移。 第一个使用迁移名称，第二个使用迁移 ID 和指定的连接：

Update-Database -Migration InitialCreate
Update-Database -Migration 20180904195021_InitialCreate -Connection your_connection_string

其他资源Additional resources

• 迁移
• 反向工程