Referência - Package Manager Console no Visual Studio das ferramentas do Entity Framework CoreEntity Framework Core tools reference - Package Manager Console in Visual Studio

As ferramentas do Console de Gerenciador de pacote (PMC) para o Entity Framework Core realizar tarefas de desenvolvimento de tempo de design.The Package Manager Console (PMC) tools for Entity Framework Core perform design-time development tasks. Por exemplo, eles criam migrações, aplicar as migrações e gerar código para um modelo com base em um banco de dados existente.For example, they create migrations, apply migrations, and generate code for a model based on an existing database. Os comandos são executados dentro do Visual Studio usando o Package Manager Console.The commands run inside of Visual Studio using the Package Manager Console. Essas ferramentas funcionam com projetos do .NET Framework e o do .NET Core.These tools work with both .NET Framework and .NET Core projects.

Se você não estiver usando o Visual Studio, é recomendável o ferramentas de linha de comando do EF Core em vez disso.If you aren't using Visual Studio, we recommend the EF Core Command-line Tools instead. As ferramentas da CLI são multiplataforma e execução dentro de um prompt de comando.The CLI tools are cross-platform and run inside a command prompt.

Instalando as ferramentasInstalling the tools

Os procedimentos para instalar e atualizar as ferramentas são diferentes entre o ASP.NET Core 2.1 + e versões anteriores ou outros tipos de projeto.The procedures for installing and updating the tools differ between ASP.NET Core 2.1+ and earlier versions or other project types.

ASP.NET Core versão 2.1 e posteriorASP.NET Core version 2.1 and later

As ferramentas são incluídas automaticamente em um projeto ASP.NET Core 2.1 + porque o Microsoft.EntityFrameworkCore.Tools pacote está incluído na metapacote Microsoft.The tools are automatically included in an ASP.NET Core 2.1+ project because the Microsoft.EntityFrameworkCore.Tools package is included in the Microsoft.AspNetCore.App metapackage.

Portanto, você não precisa fazer nada para instalar as ferramentas, mas você precisa:Therefore, you don't have to do anything to install the tools, but you do have to:

  • Restaure os pacotes antes de usar as ferramentas em um novo projeto.Restore packages before using the tools in a new project.
  • Instale um pacote para atualizar as ferramentas para uma versão mais recente.Install a package to update the tools to a newer version.

Para certificar-se de que você obtenha a versão mais recente das ferramentas, é recomendável que você também pode fazer a seguinte etapa:To make sure that you're getting the latest version of the tools, we recommend that you also do the following step:

  • Editar seu . csproj arquivo e adicione uma linha especificando a versão mais recente do entityframeworkcore pacote.Edit your .csproj file and add a line specifying the latest version of the Microsoft.EntityFrameworkCore.Tools package. Por exemplo, o . csproj arquivo pode incluir um ItemGroup parecido com este:For example, the .csproj file might include an ItemGroup that looks like this:

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

Atualize as ferramentas quando você receber uma mensagem semelhante ao seguinte exemplo:Update the tools when you get a message like the following example:

A versão das ferramentas do EF Core '2.1.1-rtm-30846' é mais antiga do que o tempo de execução '2.1.3-rtm-32065'.The EF Core tools version '2.1.1-rtm-30846' is older than that of the runtime '2.1.3-rtm-32065'. Atualize as ferramentas para os últimos recursos e correções de bugs.Update the tools for the latest features and bug fixes.

Para atualizar as ferramentas:To update the tools:

  • Instale o SDK do .NET Core mais recentes.Install the latest .NET Core SDK.
  • Atualize o Visual Studio para a versão mais recente.Update Visual Studio to the latest version.
  • Editar o . csproj de arquivo para que ele inclua uma referência de pacote para o pacote de ferramentas mais recente, conforme mostrado anteriormente.Edit the .csproj file so that it includes a package reference to the latest tools package, as shown earlier.

Outras versões e tipos de projetoOther versions and project types

Instalar as ferramentas do Console do Gerenciador de pacotes, executando o seguinte comando em Package Manager Console:Install the Package Manager Console tools by running the following command in Package Manager Console:

Install-Package Microsoft.EntityFrameworkCore.Tools

Atualizar as ferramentas, executando o seguinte comando em Package Manager Console.Update the tools by running the following command in Package Manager Console.

Update-Package Microsoft.EntityFrameworkCore.Tools

Verificar a instalaçãoVerify the installation

Verifique se que as ferramentas são instaladas executando este comando:Verify that the tools are installed by running this command:

Get-Help about_EntityFrameworkCore

A saída fica assim (ela não informa qual versão das ferramentas que você está usando):The output looks like this (it doesn't tell you which version of the tools you're using):


                     _/\__
               ---==/    \\
         ___  ___   |.    \|\
        | __|| __|  |  )   \\\
        | _| | _|   \_/ |  //|\\
        |___||_|       /   \\\/\\

TOPIC
    about_EntityFrameworkCore

SHORT DESCRIPTION
    Provides information about the Entity Framework Core Package Manager Console Tools.

<A list of available commands follows, omitted here.>

Usando as ferramentasUsing the tools

Antes de usar as ferramentas:Before using the tools:

  • Compreenda a diferença entre o projeto de inicialização e de destino.Understand the difference between target and startup project.
  • Saiba como usar as ferramentas com as bibliotecas de classes .NET Standard.Learn how to use the tools with .NET Standard class libraries.
  • Para projetos ASP.NET Core, defina o ambiente.For ASP.NET Core projects, set the environment.

Projeto de inicialização e de destinoTarget and startup project

Os comandos se referir a um project e uma projeto de inicialização.The commands refer to a project and a startup project.

  • O project também é conhecido como o projeto de destino porque é onde os comandos Adicionar ou remover arquivos.The project is also known as the target project because it's where the commands add or remove files. Por padrão, o projeto padrão selecionado no Package Manager Console é o projeto de destino.By default, the Default project selected in Package Manager Console is the target project. Você pode especificar um projeto diferente como projeto de destino usando o --project opção.You can specify a different project as target project by using the --project option.

  • O projeto de inicialização é aquele que as ferramentas de compilar e executar.The startup project is the one that the tools build and run. Tem as ferramentas executar o código do aplicativo em tempo de design para obter informações sobre o projeto, como a cadeia de caracteres de conexão de banco de dados e a configuração do modelo.The tools have to execute application code at design time to get information about the project, such as the database connection string and the configuration of the model. Por padrão, o projeto de inicialização na Gerenciador de soluções é o projeto de inicialização.By default, the Startup Project in Solution Explorer is the startup project. Você pode especificar um projeto diferente como projeto de inicialização usando o --startup-project opção.You can specify a different project as startup project by using the --startup-project option.

O projeto de inicialização e o projeto de destino geralmente são o mesmo projeto.The startup project and target project are often the same project. Um cenário típico no qual eles são projetos separados é que quando:A typical scenario where they are separate projects is when:

  • As classes de entidade e de contexto do EF Core estão em uma biblioteca de classes do .NET Core.The EF Core context and entity classes are in a .NET Core class library.
  • Um aplicativo de console .NET Core ou aplicativo web faz referência a biblioteca de classes.A .NET Core console app or web app references the class library.

Também é possível coloque o código de migrações em uma biblioteca de classes separada do contexto do EF Core.It's also possible to put migrations code in a class library separate from the EF Core context.

Outras estruturas de destinoOther target frameworks

As ferramentas do Console do Gerenciador de pacotes funcionam com projetos do .NET Core ou .NET Framework.The Package Manager Console tools work with .NET Core or .NET Framework projects. Os aplicativos que têm o modelo do EF Core em uma biblioteca de classes .NET Standard não podem ter um projeto de .NET Framework ou .NET Core.Apps that have the EF Core model in a .NET Standard class library might not have a .NET Core or .NET Framework project. Por exemplo, isso é verdadeiro para aplicativos Xamarin e plataforma Universal do Windows.For example, this is true of Xamarin and Universal Windows Platform apps. Nesses casos, você pode criar um projeto de aplicativo de console .NET Core ou .NET Framework cuja única finalidade é atuar como projeto de inicialização para as ferramentas.In such cases, you can create a .NET Core or .NET Framework console app project whose only purpose is to act as startup project for the tools. O projeto pode ser um projeto fictício, sem nenhum código real — só é necessário fornecer um destino para as ferramentas.The project can be a dummy project with no real code — it is only needed to provide a target for the tooling.

Por que é um projeto fictício necessário?Why is a dummy project required? Como mencionado anteriormente, as ferramentas de tem que executar o código do aplicativo em tempo de design.As mentioned earlier, the tools have to execute application code at design time. Para fazer isso, eles precisam usar o tempo de execução do .NET Core ou .NET Framework.To do that, they need to use the .NET Core or .NET Framework runtime. Quando o modelo do EF Core está em um projeto que tem como alvo o .NET Core ou .NET Framework, as ferramentas do EF Core emprestam o tempo de execução do projeto.When the EF Core model is in a project that targets .NET Core or .NET Framework, the EF Core tools borrow the runtime from the project. E não é possível fazer isso se o modelo do EF Core está em uma biblioteca de classes .NET Standard.They can't do that if the EF Core model is in a .NET Standard class library. O .NET Standard não é uma implementação real do .NET; é uma especificação de um conjunto de APIs que devem dar suporte a implementações do .NET.The .NET Standard is not an actual .NET implementation; it's a specification of a set of APIs that .NET implementations must support. Portanto, .NET Standard não é suficiente para as ferramentas do EF Core executar o código do aplicativo.Therefore .NET Standard is not sufficient for the EF Core tools to execute application code. O projeto fictício, que você cria para usar como projeto de inicialização fornece uma plataforma de destino concreta na qual as ferramentas podem carregar a biblioteca de classes .NET Standard.The dummy project you create to use as startup project provides a concrete target platform into which the tools can load the .NET Standard class library.

Ambiente do ASP.NET CoreASP.NET Core environment

Para especificar o ambiente para projetos do ASP.NET Core, defina env:ASPNETCORE_ENVIRONMENT antes de executar comandos.To specify the environment for ASP.NET Core projects, set env:ASPNETCORE_ENVIRONMENT before running commands.

Parâmetros comunsCommon parameters

A tabela a seguir mostra os parâmetros que são comuns a todos os comandos do EF Core:The following table shows parameters that are common to all of the EF Core commands:

ParâmetroParameter DescriçãoDescription
-O contexto <cadeia de caracteres >-Context <String> O DbContext classe a ser usada.The DbContext class to use. Nome de classe totalmente qualificado com namespaces ou única.Class name only or fully qualified with namespaces. Se esse parâmetro for omitido, o EF Core encontra a classe de contexto.If this parameter is omitted, EF Core finds the context class. Se houver várias classes de contexto, esse parâmetro é necessário.If there are multiple context classes, this parameter is required.
-Projeto <cadeia de caracteres >-Project <String> O projeto de destino.The target project. Se esse parâmetro for omitido, o projeto padrão para Package Manager Console é usado como o projeto de destino.If this parameter is omitted, the Default project for Package Manager Console is used as the target project.
O projeto de inicialização - <cadeia de caracteres >-StartupProject <String> O projeto de inicialização.The startup project. Se esse parâmetro for omitido, o projeto de inicialização na propriedades da solução é usado como o projeto de destino.If this parameter is omitted, the Startup project in Solution properties is used as the target project.
-Verbose-Verbose Mostra saída detalhada.Show verbose output.

Para mostrar informações de ajuda sobre um comando, use o PowerShell Get-Help comando.To show help information about a command, use PowerShell's Get-Help command.

Dica

Os parâmetros de contexto, o projeto e o projeto de inicialização oferecem suporte a expansão da tabulação.The Context, Project, and StartupProject parameters support tab-expansion.

Add-MigrationAdd-Migration

Adiciona uma nova migração.Adds a new migration.

Parâmetros:Parameters:

ParâmetroParameter DescriçãoDescription
-Nome <cadeia de caracteres >-Name <String> O nome da migração.The name of the migration. Isso é um parâmetro posicional e é necessário.This is a positional parameter and is required.
-OutputDir <cadeia de caracteres >-OutputDir <String> O diretório (e sub-namespace) para usar.The directory (and sub-namespace) to use. Caminhos são relativos ao diretório de projeto de destino.Paths are relative to the target project directory. O padrão é "Migrações".Defaults to "Migrations".

Banco de dados de destinoDrop-Database

Descarta o banco de dados.Drops the database.

Parâmetros:Parameters:

ParâmetroParameter DescriçãoDescription
-WhatIf-WhatIf Mostrar qual banco de dados deve ser descartado, mas não o remova.Show which database would be dropped, but don't drop it.

Get-DbContextGet-DbContext

Listas disponíveis DbContext tipos.Lists available DbContext types.

Remove-MigrationRemove-Migration

Remove a última migração (reverte as alterações de código que foram feitas para a migração).Removes the last migration (rolls back the code changes that were done for the migration).

Parâmetros:Parameters:

ParâmetroParameter DescriçãoDescription
-Force-Force Reverter a migração (reverter as alterações que foram aplicadas ao banco de dados).Revert the migration (roll back the changes that were applied to the database).

Scaffold-DbContextScaffold-DbContext

Gera código para um DbContext e tipos de entidade para um banco de dados.Generates code for a DbContext and entity types for a database. Para que Scaffold-DbContext para gerar um tipo de entidade, a tabela de banco de dados deve ter uma chave primária.In order for Scaffold-DbContext to generate an entity type, the database table must have a primary key.

Parâmetros:Parameters:

ParâmetroParameter DescriçãoDescription
-Conexão <cadeia de caracteres >-Connection <String> A cadeia de conexão para o banco de dados.The connection string to the database. Para projetos do ASP.NET Core 2.x, o valor pode ser nome =<nome da cadeia de caracteres de conexão >.For ASP.NET Core 2.x projects, the value can be name=<name of connection string>. Nesse caso, o nome vem de fontes de configuração que são configuradas para o projeto.In that case the name comes from the configuration sources that are set up for the project. Isso é um parâmetro posicional e é necessário.This is a positional parameter and is required.
-Provedor <cadeia de caracteres >-Provider <String> O provedor a ser usado.The provider to use. Normalmente isso é o nome do pacote do NuGet, por exemplo: Microsoft.EntityFrameworkCore.SqlServer.Typically this is the name of the NuGet package, for example: Microsoft.EntityFrameworkCore.SqlServer. Isso é um parâmetro posicional e é necessário.This is a positional parameter and is required.
-OutputDir <cadeia de caracteres >-OutputDir <String> O diretório para colocar os arquivos.The directory to put files in. Caminhos são relativos ao diretório do projeto.Paths are relative to the project directory.
-ContextDir <cadeia de caracteres >-ContextDir <String> O diretório para colocar o DbContext de arquivo no.The directory to put the DbContext file in. Caminhos são relativos ao diretório do projeto.Paths are relative to the project directory.
-O contexto <cadeia de caracteres >-Context <String> O nome da DbContext classe gerar.The name of the DbContext class to generate.
-Esquemas <String [] >-Schemas <String[]> Os esquemas de tabelas para gerar tipos de entidade para.The schemas of tables to generate entity types for. Se esse parâmetro for omitido, todos os esquemas são incluídos.If this parameter is omitted, all schemas are included.
-Tabelas <String [] >-Tables <String[]> As tabelas para gerar tipos de entidade para.The tables to generate entity types for. Se esse parâmetro for omitido, todas as tabelas são incluídas.If this parameter is omitted, all tables are included.
-DataAnnotations-DataAnnotations Use atributos para configurar o modelo (quando possível).Use attributes to configure the model (where possible). Se esse parâmetro for omitido, somente a API fluente é usada.If this parameter is omitted, only the fluent API is used.
-UseDatabaseNames-UseDatabaseNames Use nomes de tabela e coluna exatamente como aparecem no banco de dados.Use table and column names exactly as they appear in the database. Se esse parâmetro for omitido, os nomes de banco de dados são alterados de acordo com mais de perto para convenções de estilo de nome em C#.If this parameter is omitted, database names are changed to more closely conform to C# name style conventions.
-Force-Force Substitua arquivos existentes.Overwrite existing files.

Exemplo:Example:

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

Exemplo que usa o Scaffold somente tabelas selecionadas e cria o contexto em uma pasta separada com um nome especificado:Example that scaffolds only selected tables and creates the context in a separate folder with a specified name:

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

Migração do scriptScript-Migration

Gera um script SQL que aplica todas as alterações de uma migração selecionada para outra migração selecionada.Generates a SQL script that applies all of the changes from one selected migration to another selected migration.

Parâmetros:Parameters:

ParâmetroParameter DescriçãoDescription
-From <cadeia de caracteres >-From <String> A migração inicial.The starting migration. As migrações podem ser identificadas por nome ou ID.Migrations may be identified by name or by ID. O número de 0 é um caso especial que significa antes da primeira migração.The number 0 is a special case that means before the first migration. O padrão é 0.Defaults to 0.
-Para <cadeia de caracteres >-To <String> A migração final.The ending migration. O padrão é para a última migração.Defaults to the last migration.
-Idempotentes-Idempotent Gere um script que pode ser usado em um banco de dados em qualquer migração.Generate a script that can be used on a database at any migration.
-Saída <cadeia de caracteres >-Output <String> O arquivo para gravar o resultado.The file to write the result to. Se esse parâmetro for omitido, o arquivo é criado com um nome gerado na mesma pasta, como arquivos de tempo de execução do aplicativo são criados, por exemplo: /obj/Debug/netcoreapp2.1/ghbkztfz.sql/.IF this parameter is omitted, the file is created with a generated name in the same folder as the app's runtime files are created, for example: /obj/Debug/netcoreapp2.1/ghbkztfz.sql/.

Dica

Para, de, e os parâmetros de saída oferecem suporte a expansão da tabulação.The To, From, and Output parameters support tab-expansion.

O exemplo a seguir cria um script para a migração de InitialCreate, usando o nome da migração.The following example creates a script for the InitialCreate migration, using the migration name.

Script-Migration -To InitialCreate

O exemplo a seguir cria um script para todas as migrações após a migração InitialCreate, usando a ID de migração.The following example creates a script for all migrations after the InitialCreate migration, using the migration ID.

Script-Migration -From 20180904195021_InitialCreate

Atualizar banco de dadosUpdate-Database

Atualiza o banco de dados para a última migração ou para uma migração especificada.Updates the database to the last migration or to a specified migration.

ParâmetroParameter DescriçãoDescription
-Migration <cadeia de caracteres >-Migration <String> A migração de destino.The target migration. As migrações podem ser identificadas por nome ou ID.Migrations may be identified by name or by ID. O número de 0 é um caso especial que significa antes da primeira migração e faz com que todas as migrações para ser revertido.The number 0 is a special case that means before the first migration and causes all migrations to be reverted. Se nenhuma migração for especificada, o comando assume como padrão para a última migração.If no migration is specified, the command defaults to the last migration.

Dica

O parâmetro de migração dá suporte à expansão da tabulação.The Migration parameter supports tab-expansion.

O exemplo a seguir reverte todas as migrações.The following example reverts all migrations.

Update-Database -Migration 0

Os exemplos a seguir atualiza o banco de dados para uma migração especificada.The following examples update the database to a specified migration. O primeiro usa o nome da migração e o segundo usa a ID de migração:The first uses the migration name and the second uses the migration ID:

Update-Database -Migration InitialCreate
Update-Database -Migration 20180904195021_InitialCreate