Entity Framework Core 工具参考-.NET Core CLIEntity Framework Core tools reference - .NET Core CLI

用于 Entity Framework Core 的命令行接口（CLI）工具执行设计时开发任务。 例如，他们基于现有数据库创建迁移、应用迁移和生成模型的代码。 命令是跨平台dotnet命令的扩展，它是.NET Core SDK的一部分。 这些工具适用于 .NET Core 项目。

如果使用的是 Visual Studio，我们建议改用包管理器控制台工具：

• 它们自动使用在包管理器控制台中选择的当前项目，而无需手动切换目录。
• 在命令完成后，它们会自动打开由命令生成的文件。

安装工具Installing the tools

安装过程取决于项目类型和版本：

• EF Core 1。x
• ASP.NET Core 版本2.1 及更高版本
• EF Core 2。x
• EF Core 1。x

EF Core 1。xEF Core 3.x

• dotnet ef必须安装为全局或本地工具。 大多数开发人员会 dotnet ef 使用以下命令将其安装为全局工具：

  dotnet tool install --global dotnet-ef

  你还可以使用 dotnet ef 作为本地工具。 若要将其用作本地工具，请使用工具清单文件还原项目的依赖项，将该项目声明为工具依赖项。

• 获取 .NET Core SDK。

• 安装最新的 Microsoft.EntityFrameworkCore.Design 包。

  dotnet add package Microsoft.EntityFrameworkCore.Design

ASP.NET Core 2.1 +ASP.NET Core 2.1+

• 安装当前.NET Core SDK。 即使有 Visual Studio 2017 的最新版本，也必须安装 SDK。

  这是 ASP.NET Core 2.1 + 所需的所有项，因为 Microsoft.EntityFrameworkCore.Design 包包含在AspNetCore 元包中。

EF Core 2.x （不 ASP.NET Core）EF Core 2.x (not ASP.NET Core)

dotnet ef命令包含在 .NET Core SDK 中，但要启用这些命令，必须安装 Microsoft.EntityFrameworkCore.Design 包。

• 安装当前.NET Core SDK。 即使使用最新版本的 Visual Studio，也必须安装 SDK。

• 安装最新的稳定 Microsoft.EntityFrameworkCore.Design 包。

  dotnet add package Microsoft.EntityFrameworkCore.Design

EF Core 1。xEF Core 1.x

• 安装 .NET Core SDK 版本2.1.200。 更高版本与用于 EF Core 1.0 和1.1 的 CLI 工具不兼容。

• 通过修改文件global.js ，将应用程序配置为使用 2.1.200 SDK 版本。 此文件通常包含在解决方案目录中（项目上面的一个）。

• 编辑项目文件，并添加 Microsoft.EntityFrameworkCore.Tools.DotNet 为 DotNetCliToolReference 项。 指定最新的1.x 版本，例如：1.1.6。 请参阅本部分末尾的项目文件示例。

• 安装最新版本的 Microsoft.EntityFrameworkCore.Design 包，例如：

  dotnet add package Microsoft.EntityFrameworkCore.Design -v 1.1.6

  添加这两个包引用后，项目文件将如下所示：

  <Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
      <OutputType>Exe</OutputType>
      <TargetFramework>netcoreapp1.1</TargetFramework>
    </PropertyGroup>
    <ItemGroup>
      <PackageReference Include="Microsoft.EntityFrameworkCore.Design"
                        Version="1.1.6"
                         PrivateAssets="All" />
    </ItemGroup>
    <ItemGroup>
       <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet"
                              Version="1.1.6" />
    </ItemGroup>
  </Project>

  PrivateAssets="All"不会向引用此项目的项目公开包含的包引用。 对于通常只在开发过程中使用的包，此限制特别有用。

验证安装Verify installation

运行以下命令以验证是否正确安装了 EF Core CLI 工具：

dotnet restore
dotnet ef

命令的输出标识所使用的工具的版本：

                     _/\__
               ---==/    \\
         ___  ___   |.    \|\
        | __|| __|  |  )   \\\
        | _| | _|   \_/ |  //|\\
        |___||_|       /   \\\/\\
Entity Framework Core .NET Command-line Tools 2.1.3-rtm-32065
<Usage documentation follows, not shown.>

更新工具Updating the tools

dotnet tool update --global dotnet-ef如果你在项目中本地安装了工具，则使用将全局工具更新到最新的可用版本 dotnet tool update dotnet-ef 。 通过追加 --version <VERSION> 到命令来安装特定版本。 有关更多详细信息，请参阅 dotnet 工具文档的更新部分。

使用工具Using the tools

在使用这些工具之前，您可能需要创建一个启动项目或设置环境。

目标项目和启动项目Target project and startup project

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

• 该项目也称为目标项目，因为它是命令在其中添加或删除文件的位置。 默认情况下，当前目录中的项目是目标项目。 可以使用选项指定其他项目作为目标项目 --project 。

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

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

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

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

其他目标框架Other target frameworks

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

为什么需要虚拟项目？ 如前文所述，这些工具必须在设计时执行应用程序代码。 为此，需要使用 .NET Core 运行时。 当 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 项目指定环境，请在运行命令之前设置ASPNETCORE_ENVIRONMENT环境变量。

常用选项Common options

dotnet ef 数据库删除dotnet ef database drop

删除数据库。

选项：

dotnet ef 数据库更新dotnet ef database update

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

参数：

选项：

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

dotnet ef database update InitialCreate
dotnet ef database update 20180904195021_InitialCreate --connection your_connection_string

dotnet ef dbcontext 信息dotnet ef dbcontext info

获取有关类型的信息 DbContext 。

dotnet ef dbcontext 列表dotnet ef dbcontext list

列出可用 DbContext 的类型。

dotnet ef dbcontext 基架dotnet ef dbcontext scaffold

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

参数：

选项：

下面的示例基架所有架构和表，并将新文件放在模型文件夹中。

dotnet ef dbcontext scaffold "Server=(localdb)\mssqllocaldb;Database=Blogging;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -o Models

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

dotnet ef dbcontext scaffold "Server=(localdb)\mssqllocaldb;Database=Blogging;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -o Models -t Blog -t Post --context-dir Context -c BlogContext --context-namespace New.Namespace

dotnet ef 迁移添加dotnet ef migrations add

添加新的迁移。

参数：

选项：

dotnet ef 迁移列表dotnet ef migrations list

列出可用迁移。

dotnet ef 迁移删除dotnet ef migrations remove

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

选项：

dotnet ef 迁移脚本dotnet ef migrations script

从迁移生成 SQL 脚本。

参数：

选项：

以下示例创建用于 InitialCreate 迁移的脚本：

dotnet ef migrations script 0 InitialCreate

以下示例在 InitialCreate 迁移之后为所有迁移创建一个脚本。

dotnet ef migrations script 20180904195021_InitialCreate

其他资源Additional resources

• 迁移
• 反向工程