EF 6: Operaciones de migraciones personalizadas

Hace ya un tiempo, el buen amigo @iceoverflow ,hizo un pequeño pero muy interesante pull request que nos habilita la posibilidad de crear y enchufar nuevas operaciones de migración que no tengamos por defecto en Entity Framework. Aunque el proceso es un poco mecánico, abre un montón de posibilidades para hacer nuevas contribuciones, incluso aunque no sea directamente en el código de EF y si en alguna contribución ( tengo una pequeña sorpresa con esto pero ya os la contaré cuando esté más avanzada ). A continuación me gustaría enseñaros un pequeño ejemplo de lo que podemos hacer y, por supuesto, todo aquello que os gustaría tener me encantaría escucharlo e incluso hacerlo…

Bien, empezamos, trataremos de hacer una operación de migración para crear una vista, lo primero por lo tanto es definir la operación, para ello, solamente tenemos que heredar de MigrationOperation, como por ejemplo vemos a continuación:

<span class="kwrd">namespace</span> System.Data.Entity.Migrations.Model
{
    <span class="kwrd">using</span> System.Data.Entity.Utilities;

    <span class="rem">/// &lt;summary&gt;</span>
    <span class="rem">/// Represent a create view in database</span>
    <span class="rem">/// &lt;/summary&gt;</span>
    <span class="kwrd">public</span> <span class="kwrd">class</span> CreateViewOperation
        :MigrationOperation
    {
        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">/// The view name</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">string</span> ViewName { get; <span class="kwrd">private</span> set; }

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">/// The view body sql</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">string</span> BodySql { get; <span class="kwrd">private</span> set; }


        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">/// Create a new instance</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;viewName&quot;&gt;the view name to create&lt;/param&gt;</span>
        <span class="rem">/// &lt;param name=&quot;bodySql&quot;&gt;the view body sql &lt;/param&gt;</span>
        <span class="kwrd">public</span> CreateViewOperation(<span class="kwrd">string</span> viewName, <span class="kwrd">string</span> bodySql)
            :<span class="kwrd">base</span>(<span class="kwrd">null</span>)
        {
            Check.NotEmpty(viewName,<span class="str">&quot;viewName&quot;</span>);
            Check.NotEmpty(bodySql,<span class="str">&quot;bodySql&quot;</span>);

            <span class="kwrd">this</span>.ViewName = viewName;
            <span class="kwrd">this</span>.BodySql = bodySql;
        }

        <span class="rem">/// &lt;inheritdoc/&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">override</span> <span class="kwrd">bool</span> IsDestructiveChange
        {
            get { <span class="kwrd">return</span> <span class="kwrd">false</span>; }
        }

        <span class="rem">/// &lt;inheritdoc/&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">override</span> MigrationOperation Inverse
        {
            get
            {
                <span class="kwrd">return</span> <span class="kwrd">new</span> DropViewOperation(ViewName);
            }
        }
    }
}

namespace System.Data.Entity.Migrations.Model

{

using System.Data.Entity.Utilities;

/// <summary>

/// Represent a create view in database

/// </summary>

public class CreateViewOperation

:MigrationOperation

{

/// <summary>

/// The view name

/// </summary>

public string ViewName { get; private set; }

/// <summary>

/// The view body sql

/// </summary>

public string BodySql { get; private set; }

/// <summary>

/// Create a new instance

/// </summary>

/// <param name="viewName">the view name to create</param>

/// <param name="bodySql">the view body sql </param>

public CreateViewOperation(string viewName, string bodySql)

:base(null)

{

Check.NotEmpty(viewName,"viewName");

Check.NotEmpty(bodySql,"bodySql");

this.ViewName = viewName;

this.BodySql = bodySql;

}

/// <inheritdoc/>

public override bool IsDestructiveChange

{

get { return false; }

}

/// <inheritdoc/>

public override MigrationOperation Inverse

{

get

{

return new DropViewOperation(ViewName);

}

Bien, ahora que ya tenemos definida nuestra operación, ya la podemos incluir dentro de nuestras migraciones, para que quede de una forma consistente con las operaciones actuales, podríamos crear un método extensor de de DbMigration como el siguiente:

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">/// Create a new view</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;migration&quot;&gt;The DBMigration&lt;/param&gt;</span>
        <span class="rem">/// &lt;param name=&quot;viewName&quot;&gt;The name of view to create&lt;/param&gt;</span>
        <span class="rem">/// &lt;param name=&quot;bodySql&quot;&gt;The sql body of view to create&lt;/param&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">static</span> <span class="kwrd">void</span> CreateView(<span class="kwrd">this</span> DbMigration migration, <span class="kwrd">string</span> viewName, <span class="kwrd">string</span> bodySql)
        {
            ((IDbMigration)migration)
              .AddOperation(<span class="kwrd">new</span> CreateViewOperation(viewName, bodySql));
        }

/// <summary>

/// Create a new view

/// </summary>

/// <param name="migration">The DBMigration</param>

/// <param name="viewName">The name of view to create</param>

/// <param name="bodySql">The sql body of view to create</param>

public static void CreateView(this DbMigration migration, string viewName, string bodySql)

{

((IDbMigration)migration)

.AddOperation(new CreateViewOperation(viewName, bodySql));

}

Una vez hecho este trabajo, cuando una operación se ejecute, esta operación se enviará al generador sql que tengamos configurado,recuerde que puede establecerlo ahora con nuestro punto central de configuración DbConfiguration. Por lo tanto, este generador debe de estar preparado para procesar estas operaciones, por lo tanto, lo normal será partir de un generador dado como por ejemplo SqlServerMigrationSqlGenerator para extenderlo con esta nueva operación. Para nuestro ejemplo podríamos hacer algo como lo siguiente:

    <span class="rem">/// &lt;summary&gt;</span>
    <span class="rem">/// Extented Sql Server Migrations Sql Generator with more</span>
    <span class="rem">/// operations.</span>
    <span class="rem">/// &lt;remarks&gt;</span>
    <span class="rem">/// For set  this migrations sql generator you need register it in</span>
    <span class="rem">/// your DbMigrationsConfiguration{TContext} using the method </span>
    <span class="rem">/// SetSqlGenerator</span>
    <span class="rem">/// &lt;example&gt;</span>
    <span class="rem">/// SetSqlGenerator(&quot;System.Data.SqlClient&quot;, new AdvancedSqlServerMigrationSqlGenerator());</span>
    <span class="rem">/// &lt;/example&gt;</span>
    <span class="rem">/// &lt;/remarks&gt;</span>
    <span class="rem">/// &lt;/summary&gt;</span>
    <span class="kwrd">public</span> <span class="kwrd">class</span> ExtendedSqlServerMigrationSqlGenerator
        : SqlServerMigrationSqlGenerator
    {
        <span class="rem">/// &lt;inheritdoc/&gt;</span>
        <span class="kwrd">protected</span> <span class="kwrd">override</span> <span class="kwrd">void</span> Generate(MigrationOperation migrationOperation)
        {
            
        }
     }

/// <summary>

/// Extented Sql Server Migrations Sql Generator with more

/// operations.

/// <remarks>

/// For set this migrations sql generator you need register it in

/// your DbMigrationsConfiguration{TContext} using the method

/// SetSqlGenerator

/// <example>

/// SetSqlGenerator("System.Data.SqlClient", new AdvancedSqlServerMigrationSqlGenerator());

/// </example>

/// </remarks>

/// </summary>

public class ExtendedSqlServerMigrationSqlGenerator

: SqlServerMigrationSqlGenerator

{

/// <inheritdoc/>

protected override void Generate(MigrationOperation migrationOperation)

{

}

Ahora, en nuestro Generate deberíamos ver como procesar cada una de las posibles operaciones personalizadas que podamos querer incluir, para facilitar la tarea y no ver demasiada conversión o switch un truquito rápido sería este:

        /// &lt;inheritdoc/&gt;
        <span class="kwrd">protected</span> override void Generate(MigrationOperation migrationOperation)
        {
            this.Generate((dynamic)migrationOperation);
        }

        /// &lt;summary&gt;
        /// Generate a SQL <span class="kwrd">to</span> create a <span class="kwrd">new</span> view <span class="kwrd">in</span> database
        /// &lt;/summary&gt;
        /// &lt;param name=<span class="str">&quot;createViewOperation&quot;</span>&gt;The operation <span class="kwrd">to</span> produce sql <span class="kwrd">for</span>.&lt;/param&gt;
        <span class="kwrd">public</span> virtual void Generate(CreateViewOperation createViewOperation)
        {
            using (var writer = Writer())
            {
                writer.Write(<span class="str">&quot;IF object_id(N'{0}', 'V') IS NOT NULL &quot;</span>,createViewOperation.ViewName);
                writer.WriteLine(<span class="str">&quot;DROP VIEW {0} &quot;</span>,createViewOperation.ViewName);
                writer.WriteLine(<span class="str">&quot;GO &quot;</span>);
                writer.WriteLine(<span class="str">&quot;CREATE VIEW {0} AS {1}&quot;</span>,createViewOperation.ViewName,createViewOperation.BodySql);

                this.Statement(writer);
            }
        }

/// <inheritdoc/>

protected override void Generate(MigrationOperation migrationOperation)

{

this.Generate((dynamic)migrationOperation);

}

/// <summary>

/// Generate a SQL to create a new view in database

/// </summary>

/// <param name="createViewOperation">The operation to produce sql for.</param>

public virtual void Generate(CreateViewOperation createViewOperation)

{

using (var writer = Writer())

{

writer.Write("IF object_id(N'{0}', 'V') IS NOT NULL ",createViewOperation.ViewName);

writer.WriteLine("DROP VIEW {0} ",createViewOperation.ViewName);

writer.WriteLine("GO ");

writer.WriteLine("CREATE VIEW {0} AS {1}",createViewOperation.ViewName,createViewOperation.BodySql);

this.Statement(writer);

}

Al ponerlo como dynamic podemos crear un método para cada una de las operaciones personalizadas y por lo tanto simplificar tanto la lectura como el mantenimiento del código.

Espero que os haya gustado esta posibilidad, por supuesto, para los que os habéis fijado en el código esto forma parte de un proyecto que ya contiene muchas más posibles operaciones de migración que pronto compartiré con todos vosotros, de ahí que os preguntará que os gustaría tener!!, animaros…

Saludos

unai

2 comentarios sobre “EF 6: Operaciones de migraciones personalizadas”

jtorrecilla dice:

22 mayo, 2013 a las 9:21 am

Muy interesante la verdad!

Gracias

Responder
anonymous dice:

18 julio, 2013 a las 5:00 pm

Tal y como hicimos en la entrega anterior vamos a ir poniendo ejemplos completos de algunos de los puntos

Responder

2 comentarios sobre “EF 6: Operaciones de migraciones personalizadas”

Responder a anonymous Cancelar respuesta