Uno delle cose più complesse da gestire nello sviluppo di qualsiasi applicazione, dalle semplici applicazioni client alle più complesse soluzioni enterprise, riguarda la gestione della persistenza.

In ambiente .NET parte di questa complessità può essere gestita attraverso l’utilizzo delle migrazioni implementate internamente in Entity Framework.

Spesso questa funzionalità è vista come una utilità prettamente ad uso e consumo degli sviluppatori per aggiornare lo schema del database.

Quando pensiamo di essere arrivati ad una situazione stabile eliminiamo tutte le migrazioni e partiamo da una situazione pulita.

Questa è una frase che ho sentito davvero troppo spesso da molti colleghi, utilizzata in modo più o meno consapevole, spesso i motivi che portano ad una esternalizzazione in tal senso è una non sufficiente analisi del problema che genera molti cambiamenti, anche distruttivi, delle base dati.

Altre volte più consapevole e guidata dalla volontà di non mantenere versioni precedenti a quella che supponiamo conterrà dati “reali”, spesso questo coincide con il primo rilascio in produzione.

In realtà quello che il tool ci offre è un sistema di versionamento incrementale cosa che va ben oltre l’ambito di competenza dello sviluppatore coinvolgendo anche DBA o più propriamente DBRE, consiglio l’ascolto dell’episodio Da DBA a DBRE, il nuovo approccio DevOps nel mondo database, con Alessandro Alpi di dotNETpodcast se volete approfondire le sottili differenze fra i due ruoli.

Come posso effettuare operazioni sui dati?

Questa cosa è una di quelle operazioni che non è possibile istruire in una migrazione attraverso le API che Entity Framework ci mette a disposizione in quanto è molto dipendente dal dominio e cercare di formalizzare ciò attraverso delle API sarebbe stato molto complesso se non impossibile ed è per questi casi che è stata prevista la scappatoia per l’esecuzione di script SQL grezzi.

 1public partial class InitialWithSeed : Migration
 2{
 3    protected override void Up(MigrationBuilder migrationBuilder)
 4    {
 5        migrationBuilder.Sql(@"CREATE TABLE Persons (
 6    Id int,
 7    LastName varchar(255),
 8    FirstName varchar(255),
 9    Address varchar(255),
10    City varchar(255)
11);
12
13INSERT INTO Persons (Id, LastName, FirstName, Address, City)
14VALUES 
15    (1, 'Nesfield', 'Carmelia', '802 Knutson Drive', 'Krajan Dua Putukrejo'),
16    (2, 'Valentino', 'Daune', '1464 Forest Dale Road', 'Prozor'),
17    (3, 'Chrstine', 'Gus', '817 Bonner Park', 'Lukunor'),
18    (4, 'Tebb', 'Stearne', '63138 Colorado Plaza', 'Sanjiang'),
19    (5, 'Dyne', 'Gibby', '39613 Pond Road', 'Thành Phố Hạ Long'),
20    (6, 'MacShane', 'Sandra', '02617 Continental Parkway', 'Cihambali'),
21    (7, 'Lissandri', 'Sidney', '61 Talmadge Circle', 'Langarūd'),
22    (8, 'O'' Quirk', 'Marc', '828 Ohio Avenue', 'Farafangana'),
23    (9, 'Mabee', 'Man', '79 Crownhardt Street', 'Kembang'),
24    (10, 'Izak', 'Bertie', '7 High Crossing Junction', 'Taodian');");
25    }
26}

L’esempio appena fatto potrebbe far storcere il naso ad entrambe le categorie.
Agli sviluppatori perché sono presenti stringhe all’interno del sorgente e al DBRE perché si troverebbe a lavorare “scomodo” senza completamento automatico.

Come far felici i due mondi?

Una caratteristica del tool è quella di generare delle classi parziali che vengono abbinate a classi contente in file denominati {MigrationId}.Design.cs

1[DbContext(typeof(DesignContext))]
2[Migration("20220624071324_InitialWithSeed")]
3partial class InitialWithSeed
4{
5    ...
6}

che contengono l’altra parte della classe parziale decorata con un attributo che ne identifica il contesto al quale è legata ed uno che ne rappresenta l’identificativo.

Possiamo quindi pensare di estrarre lo script SQL all’interno di un file con estensione .sql e sfruttare l’identificativo della migrazione a runtime per leggerlo ed integrarlo all’interno della migrazione.

La nostra migrazione avrà quindi questo contenuto

 1public partial class InitialWithSeed : Migration
 2{
 3    protected override void Up(MigrationBuilder migrationBuilder)
 4    {
 5        var migrationAttribute = (MigrationAttribute)this.GetType()
 6            .GetCustomAttributes(typeof(MigrationAttribute), false)
 7            .Single();
 8
 9        migrationBuilder.Sql(File.ReadAllText(string.Format(
10            CultureInfo.InvariantCulture,
11            "{1}{0}RawMigrations{0}{2}",
12            Path.DirectorySeparatorChar,
13            AppContext.BaseDirectory,
14            $"{migrationAttribute.Id}.sql")));
15    }
16}

e lo script SQL potrà quindi essere letto dal percorso relativo alla directory di esecuzione /RawMigrations/20220624071324_InitialWithSeed.sql

Ricordiamoci inoltre di aggiungere l’istruzione

1<ItemGroup>
2  <None Include="RawMigrations\*.sql" CopyToOutputDirectory="PreserveNewest" />
3</ItemGroup>

all’interno del .csproj per istruire MSBuild a pubblicare i file nella cartella di destinazione.

Come sempre potete consultare il progetto dell’intero esempio su