Entity Framework Core-eszközökre vonatkozó referencia – .NET Core CLI

Az Entity Framework Core parancssori felületi eszközei tervezési idejű fejlesztési feladatokat hajtanak végre. Például létrehoznak migrálásokat, migrálásokat alkalmaznak, és kódokat hoznak létre egy modellhez egy meglévő adatbázis alapján. A parancsok a platformfüggetlen dotnet parancs bővítményei, amely a .NET Core SDK része. Ezek az eszközök .NET Core-projektekkel működnek.

A Visual Studio használatakor fontolja meg a Package Manager konzoleszközök használatát a CLI-eszközök helyett. A Package Manager konzol eszközei automatikusan:

• A Package Manager konzol kiválasztott aktuális projekttel működik anélkül, hogy manuálisan kellene könyvtárat váltania.
• Megnyitja a parancs által létrehozott fájlokat a parancs befejezése után.
• A parancsok, paraméterek, projektnevek, környezettípusok és áttelepítési nevek lapkiegészítését tartalmazza.

Az eszközök telepítése

dotnet ef globális vagy helyi eszközként is telepíthető. A fejlesztők többsége inkább az alábbi paranccsal telepíti a dotnet ef globális eszközként:

dotnet tool install --global dotnet-ef

Ha helyi eszközként szeretné használni, állítsa vissza egy olyan projekt függőségeit, amelyek eszközfüggőségként deklarálják azt egy eszközjegyzékfájlhasználatával.

Frissítse az eszközt a következő paranccsal:

dotnet tool update --global dotnet-ef

Ahhoz, hogy egy adott projekt eszközeit használni tudja, hozzá kell adnia a Microsoft.EntityFrameworkCore.Design csomagot.

dotnet add package Microsoft.EntityFrameworkCore.Design

Telepítés ellenőrzése

Futtassa a következő parancsokat annak ellenőrzéséhez, hogy az EF Core CLI-eszközök megfelelően vannak-e telepítve:

dotnet ef

A parancs kimenete azonosítja a használt eszközök verzióját:

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

Entity Framework Core .NET Command-line Tools 2.1.3-rtm-32065

<Usage documentation follows, not shown.>

Az eszközök frissítése

A dotnet tool update --global dotnet-ef használatával frissítse a globális eszközöket a legújabb elérhető verzióra. Ha a projektben helyileg telepített eszközökkel rendelkezik, használja a dotnet tool update dotnet-ef. Telepítsen egy adott verziót úgy, hogy hozzáfűzi --version <VERSION> a parancshoz. További részletekért tekintse meg a dotnet eszköz dokumentációjának Frissítés szakaszát.

Az eszközök használata

Az eszközök használata előtt előfordulhat, hogy létre kell hoznia egy indítási projektet, vagy be kell állítania a környezetet.

Célprojekt és indítási projekt

A parancsok egy projekt és egy indítási projektrevonatkoznak.

• A projektcélprojektként is ismert, mert a parancsok fájlokat adnak hozzá vagy távolítanak el. Alapértelmezés szerint az aktuális könyvtárban lévő projekt a célprojekt. A --project lehetőséggel megadhat egy másik projektet célprojektként.

• Az startup projekt az, amelyet az eszközök létrehoznak és futtatnak. Az eszközöknek a tervezéskor végre kell hajtaniuk az alkalmazáskódot, hogy információt szerezzenek a projektről, például az adatbázis kapcsolati sztringjéről és a modell konfigurációjáról. Alapértelmezés szerint az aktuális könyvtárban lévő projekt az indítási projekt. A --startup-project beállítással megadhat egy másik projektet indítási projektként.

Az indítási projekt és a célprojekt gyakran ugyanaz a projekt. Egy tipikus forgatókönyv, amikor különálló projektekről van szó, amikor:

• Az EF Core-környezet és az entitásosztályok egy .NET Core-osztálytárban találhatók.
• A .NET Core-konzolalkalmazás vagy -webalkalmazás az osztálytárra hivatkozik.

A migrálási kódokat az EF Core-környezettől is el lehet helyezni egy osztálytárban.

Egyéb cél-keretrendszerek

A CLI-eszközök .NET Core- és .NET-keretrendszerprojektekkel működnek. Előfordulhat, hogy azok az alkalmazások, amelyeknél az EF Core-modell egy .NET Standard osztálytárban található, nem rendelkeznek .NET Core- vagy .NET-keretrendszerprojektekkel. Ez igaz például a Xamarin és az Univerzális Windows Platform-alkalmazásokra. Ilyen esetekben létrehozhat egy .NET Core-konzolalkalmazás-projektet, amelynek egyetlen célja, hogy indítási projektként működjön az eszközökhöz. A projekt lehet egy valós kód nélküli, hamis projekt – csak az eszközkezelés céljának megadására van szükség.

Miért van szükség próbaprojektre? Ahogy korábban említettük, az eszközöknek a tervezéskor végre kell hajtaniuk az alkalmazáskódot. Ehhez a .NET Core-futtatókörnyezetet kell használniuk. Ha az EF Core-modell olyan projektben van, amely a .NET Core-t vagy a .NET-keretrendszert célozza, az EF Core-eszközök kölcsönkérik a futtatókörnyezetet a projektből. Ezt nem tehetik meg, ha az EF Core-modell egy .NET Standard osztálykódtárban található. A .NET Standard nem tényleges .NET-implementáció; ez olyan API-k specifikációja, amelyeket a .NET-implementációknak támogatniuk kell. Ezért a .NET Standard nem elegendő az EF Core-eszközök számára az alkalmazáskód végrehajtásához. Az indítási projektként létrehozott próbaprojekt egy konkrét célplatformot biztosít, amelybe az eszközök betölthetik a .NET Standard osztálytárat.

ASP.NET Core-környezet

A parancssorban megadhatja ASP.NET Core-projektek környezeti. Ezt és minden további argumentumot a Program.CreateHostBuildernek ad át.

dotnet ef database update -- --environment Production

Gyakori beállítások

A rendszer minden további argumentumot továbbít az alkalmazásnak.

dotnet ef database drop

Törli az adatbázist.

Beállítások:

A fenti gyakori lehetőségek láthatók.

dotnet ef database update

Frissíti az adatbázist az utolsó áttelepítésre vagy egy adott migrálásra.

Érvek:

Beállítások:

A fenti általános lehetőségek vannak felsorolva.

Az alábbi példák egy adott migrálásra frissítik az adatbázist. Az első az áttelepítés nevét, a második pedig a migrálási azonosítót és egy megadott kapcsolatot használja:

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

dotnet ef dbcontext info

Információt szerez egy DbContext típusról.

A fenti gyakori lehetőségek láthatók.

dotnet ef dbcontext list

Listázza az elérhető DbContext típusokat.

A közös lehetőségek fent vannak felsorolva.

dotnet ef dbcontext optimize

Létrehozza a DbContext által használt modell lefordított verzióját, és előfordítja a lekérdezéseket.

További információt Kompilált modellek című témakörben talál.

Beállítások:

A fenti gyakori lehetőségek láthatók.

Az alábbi példa az alapértelmezett beállításokat használja, és akkor működik, ha csak egy DbContext van a projektben:

dotnet ef dbcontext optimize

Az alábbi példa a megadott névvel optimalizálja a modellt a környezethez, és egy külön mappába és névtérbe helyezi:

dotnet ef dbcontext optimize -o Models -n BlogModels -c BlogContext

dotnet ef dbcontext scaffold

Egy adatbázis DbContext és entitástípusainak kódját hozza létre. Ahhoz, hogy ez a parancs létrehozhasson egy entitástípust, az adatbázistáblának elsődleges kulccsal kell rendelkeznie.

Érvek:

Beállítások:

A fenti gyakori lehetőségek láthatók.

Az alábbi példa az összes sémát és táblát összefésíti, és az új fájlokat a Modellek mappába helyezi.

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

Az alábbi példa csak a kiválasztott táblákat generálja, és egy külön mappában hoz létre kontextust egy megadott név és névtér használatával.

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

Az alábbi példa beolvassa a kapcsolati karakterláncot a projekt konfigurációs beállításaiból a Secret Manager eszköz használatával.

dotnet user-secrets set ConnectionStrings:Blogging "Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=Blogging"
dotnet ef dbcontext scaffold Name=ConnectionStrings:Blogging Microsoft.EntityFrameworkCore.SqlServer

Az alábbi példa kihagyja egy OnConfiguring metódus sablonjának létrehozását. Ez akkor lehet hasznos, ha a DbContextet az osztályon kívül szeretné konfigurálni. Például ASP.NET Core-alkalmazások általában a Startup.ConfigureServices szolgáltatásban konfigurálják.

dotnet ef dbcontext scaffold "Server=(localdb)\mssqllocaldb;Database=Blogging;User Id=myUsername;Password=myPassword;" Microsoft.EntityFrameworkCore.SqlServer --no-onconfiguring

dotnet ef dbcontext script

SQL-szkriptet hoz létre a DbContextből. Megkerül minden migrálást.

Beállítások:

A fenti gyakori lehetőségek láthatók.

dotnet ef migrations add

Új migrációt ad hozzá.

Érvek:

Beállítások:

A fenti gyakori lehetőségek láthatók.

dotnet ef migrations bundle

Létrehoz egy végrehajtható fájlt az adatbázis frissítéséhez.

Beállítások:

A fenti általános lehetőségek vannak felsorolva.

dotnet ef migrations has-pending-model-changes

Ellenőrzi, hogy történt-e módosítás a modellen a legutóbbi migrálás óta.

Beállítások:

A fenti gyakori lehetőségek láthatók.

dotnet ef migrations list

Listázza az elérhető áttelepítéseket.

Beállítások:

A fenti közös lehetőségek fel vannak sorolva.

dotnet ef migrations remove

Eltávolítja a legutóbbi migrálást, és visszaállítja a legújabb migráláshoz végrehajtott kódmódosításokat.

Beállítások:

A fenti gyakori lehetőségek láthatók.

dotnet ef migrations script

SQL-szkriptet hoz létre a migrálásokból.

Érvek:

Beállítások:

A fenti gyakori lehetőségek láthatók.

Az alábbi példa létrehoz egy szkriptet az InitialCreate migrálásához:

dotnet ef migrations script 0 InitialCreate

Az alábbi példa egy szkriptet hoz létre az InitialCreate migrálása utáni összes áttelepítéshez.

dotnet ef migrations script 20180904195021_InitialCreate

További erőforrások

• migrálások
• Visszafejtés
• Lefordított modellek