Cualquiera que haya desarrollado alguna vez aplicaciones que usan una base de datos probablemente haya enfrentado el problema de actualizar la estructura de la base de datos cuando la aplicación se implementa y actualiza.
El enfoque más común es crear un conjunto de secuencias de comandos SQL para modificar la estructura de la base de datos de una versión a otra. Por supuesto, existen herramientas de pago, pero no siempre resuelven el problema de la automatización completa de la actualización.
La tecnología de migración, introducida por primera vez en Hibernate ORM e implementada en Linq, es muy buena y conveniente, pero implica una estrategia de "primero el código" para desarrollar una estructura de base de datos, lo cual es muy laborioso para los proyectos existentes, y el uso de disparadores, procedimientos almacenados y funciones en una base de datos hace que la transición a la estrategia de "primero el código" sea casi imposible.
Este artículo sugiere un enfoque alternativo para resolver este problema:almacenar una estructura de base de datos de referencia en un archivo XML y generar automáticamente un script SQL basado en la comparación de la referencia y el estructura existente. Entonces, comencemos...
Generando archivo XML con estructura de base de datos
Usaremos la base de datos DbSyncSample. El script para crear la base de datos se muestra a continuación.
USE [DbSyncSample] GO /****** Object: Table [dbo].[Orders] Script Date: 06/01/2017 10:37:43 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE TABLE [dbo].[Orders]( [Id] [int] IDENTITY(1,1) NOT NULL, [OrderNumber] [nvarchar](50) NULL, [OrderTime] [datetime] NULL, [TotalCost] [decimal](18, 2) NOT NULL, CONSTRAINT [PK_Orders] PRIMARY KEY CLUSTERED ( [Id] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] GO CREATE NONCLUSTERED INDEX [IX_Orders_OrderNumber] ON [dbo].[Orders] ( [OrderNumber] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, SORT_IN_TEMPDB = OFF, IGNORE_DUP_KEY = OFF, DROP_EXISTING = OFF, ONLINE = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] GO /****** Object: Table [dbo].[Details] Script Date: 06/01/2017 10:37:43 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE TABLE [dbo].[Details]( [Id] [int] IDENTITY(1,1) NOT NULL, [Descript] [nvarchar](150) NULL, [OrderId] [int] NULL, [Cost] [decimal](18, 2) NOT NULL, CONSTRAINT [PK_Details] PRIMARY KEY CLUSTERED ( [Id] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] GO /****** Object: Trigger [Details_Modify] Script Date: 06/01/2017 10:37:43 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE TRIGGER [dbo].[Details_Modify] ON [dbo].[Details] AFTER INSERT,UPDATE AS BEGIN UPDATE Orders SET TotalCost = s.Total FROM ( SELECT i.OrderId OId, SUM(d.Cost) Total FROM Details d JOIN inserted i ON d.OrderId=i.OrderId GROUP BY i.OrderId ) s WHERE Id=s.OId END GO /****** Object: Trigger [Details_Delete] Script Date: 06/01/2017 10:37:43 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO CREATE TRIGGER [dbo].[Details_Delete] ON [dbo].[Details] AFTER DELETE AS BEGIN UPDATE Orders SET TotalCost = s.Total FROM ( SELECT i.OrderId OId, SUM(d.Cost) Total FROM Details d JOIN deleted i ON d.OrderId=i.OrderId GROUP BY i.OrderId ) s WHERE Id=s.OId END GO /****** Object: Default [DF_Details_Cost] Script Date: 06/01/2017 10:37:43 ******/ ALTER TABLE [dbo].[Details] ADD CONSTRAINT [DF_Details_Cost] DEFAULT ((0)) FOR [Cost] GO /****** Object: Default [DF_Orders_TotalCost] Script Date: 06/01/2017 10:37:43 ******/ ALTER TABLE [dbo].[Orders] ADD CONSTRAINT [DF_Orders_TotalCost] DEFAULT ((0)) FOR [TotalCost] GO /****** Object: ForeignKey [FK_Details_Orders] Script Date: 06/01/2017 10:37:43 ******/ ALTER TABLE [dbo].[Details] WITH CHECK ADD CONSTRAINT [FK_Details_Orders] FOREIGN KEY([OrderId]) REFERENCES [dbo].[Orders] ([Id]) GO ALTER TABLE [dbo].[Details] CHECK CONSTRAINT [FK_Details_Orders] GO
Cree una aplicación de consola y vincúlela con el paquete nuget Shed.DbSync.
La estructura de la base de datos XML es la siguiente:
class Program
{
private const string OrigConnString = "data source=.;initial catalog=FiocoKb;integrated security=True;MultipleActiveResultSets=True;App=EntityFramework";
static void Main(string[] args)
{
// getting XML with the database structure
var db = new Shed.DbSync.DataBase(OrigConnString);
var xml = db.GetXml();
File.WriteAllText("DbStructure.xml", xml);
}
} Después de ejecutar el programa, vemos lo siguiente en el archivo DbStructure.xml:
<?xml version="1.0"?>
<DataBase xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Version>0</Version>
<Tables>
<Table Name="Orders" ObjectId="2137058649" ParentObjectId="0">
<Columns>
<Column Name="Id">
<ColumnId>1</ColumnId>
<Type>int</Type>
<MaxLength>4</MaxLength>
<IsNullable>false</IsNullable>
<IsIdentity>true</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="OrderNumber">
<ColumnId>2</ColumnId>
<Type>nvarchar</Type>
<MaxLength>100</MaxLength>
<IsNullable>true</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="OrderTime">
<ColumnId>3</ColumnId>
<Type>datetime</Type>
<MaxLength>8</MaxLength>
<IsNullable>true</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="TotalCost">
<ColumnId>4</ColumnId>
<Type>decimal</Type>
<MaxLength>9</MaxLength>
<IsNullable>false</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
</Columns>
<Indexes>
<Index Name="PK_Orders">
<IndexId>1</IndexId>
<Type>CLUSTERED</Type>
<IsUnique>true</IsUnique>
<IsPrimaryKey>true</IsPrimaryKey>
<IsUniqueConstraint>false</IsUniqueConstraint>
<Columns>
<IndexColumn>
<TableColumnId>1</TableColumnId>
<KeyOrdinal>1</KeyOrdinal>
<IsDescendingKey>false</IsDescendingKey>
</IndexColumn>
</Columns>
</Index>
<Index Name="IX_Orders_OrderNumber">
<IndexId>2</IndexId>
<Type>NONCLUSTERED</Type>
<IsUnique>false</IsUnique>
<IsPrimaryKey>false</IsPrimaryKey>
<IsUniqueConstraint>false</IsUniqueConstraint>
<Columns>
<IndexColumn>
<TableColumnId>2</TableColumnId>
<KeyOrdinal>1</KeyOrdinal>
<IsDescendingKey>false</IsDescendingKey>
</IndexColumn>
</Columns>
</Index>
</Indexes>
<PrimaryKey Name="PK_Orders" ObjectId="5575058" ParentObjectId="2137058649">
<UniqueIndexId>1</UniqueIndexId>
</PrimaryKey>
<ForeignKeys />
<Defaults>
<Default Name="DF_Orders_TotalCost" ObjectId="69575286" ParentObjectId="2137058649">
<ParentColumnId>4</ParentColumnId>
<Definition>((0))</Definition>
</Default>
</Defaults>
</Table>
<Table Name="Details" ObjectId="85575343" ParentObjectId="0">
<Columns>
<Column Name="Id">
<ColumnId>1</ColumnId>
<Type>int</Type>
<MaxLength>4</MaxLength>
<IsNullable>false</IsNullable>
<IsIdentity>true</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="Descript">
<ColumnId>2</ColumnId>
<Type>nvarchar</Type>
<MaxLength>300</MaxLength>
<IsNullable>true</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="OrderId">
<ColumnId>3</ColumnId>
<Type>int</Type>
<MaxLength>4</MaxLength>
<IsNullable>true</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
<Column Name="Cost">
<ColumnId>4</ColumnId>
<Type>decimal</Type>
<MaxLength>9</MaxLength>
<IsNullable>false</IsNullable>
<IsIdentity>false</IsIdentity>
<IsComputed>false</IsComputed>
</Column>
</Columns>
<Indexes>
<Index Name="PK_Details">
<IndexId>1</IndexId>
<Type>CLUSTERED</Type>
<IsUnique>true</IsUnique>
<IsPrimaryKey>true</IsPrimaryKey>
<IsUniqueConstraint>false</IsUniqueConstraint>
<Columns>
<IndexColumn>
<TableColumnId>1</TableColumnId>
<KeyOrdinal>1</KeyOrdinal>
<IsDescendingKey>false</IsDescendingKey>
</IndexColumn>
</Columns>
</Index>
</Indexes>
<PrimaryKey Name="PK_Details" ObjectId="117575457" ParentObjectId="85575343">
<UniqueIndexId>1</UniqueIndexId>
</PrimaryKey>
<ForeignKeys>
<ForeignKey Name="FK_Details_Orders" ObjectId="149575571" ParentObjectId="85575343">
<ReferenceTableId>2137058649</ReferenceTableId>
<References>
<Reference>
<ColumnId>1</ColumnId>
<ParentColumnId>3</ParentColumnId>
<ReferenceColumnId>1</ReferenceColumnId>
</Reference>
</References>
<DeleteAction>NO_ACTION</DeleteAction>
<UpdateAction>NO_ACTION</UpdateAction>
</ForeignKey>
</ForeignKeys>
<Defaults>
<Default Name="DF_Details_Cost" ObjectId="101575400" ParentObjectId="85575343">
<ParentColumnId>4</ParentColumnId>
<Definition>((0))</Definition>
</Default>
</Defaults>
</Table>
</Tables>
<Views />
<ProgrammedObjects>
<ProgObject Name="Details_Modify" ObjectId="165575628" ParentObjectId="0">
<Definition>CREATE TRIGGER [dbo].[Details_Modify]
ON dbo.Details
AFTER INSERT,UPDATE
AS
BEGIN
UPDATE Orders
SET TotalCost = s.Total
FROM (
SELECT i.OrderId OId, SUM(d.Cost) Total
FROM Details d
JOIN inserted i ON d.OrderId=i.OrderId
GROUP BY i.OrderId
) s
WHERE Id=s.OId
END</Definition>
<Type>SQL_TRIGGER</Type>
</ProgObject>
<ProgObject Name="Details_Delete" ObjectId="181575685" ParentObjectId="0">
<Definition>CREATE TRIGGER [dbo].[Details_Delete]
ON dbo.Details
AFTER DELETE
AS
BEGIN
UPDATE Orders
SET TotalCost = s.Total
FROM (
SELECT i.OrderId OId, SUM(d.Cost) Total
FROM Details d
JOIN deleted i ON d.OrderId=i.OrderId
GROUP BY i.OrderId
) s
WHERE Id=s.OId
END</Definition>
<Type>SQL_TRIGGER</Type>
</ProgObject>
</ProgrammedObjects>
</DataBase> Despliegue/actualización de la estructura de la base de datos usando XML
Cree otra base de datos DbSyncSampleCopy vacía, agregue el siguiente código al código del programa de la consola:
class Program
{
private const string OrigConnString = "data source=.;initial catalog=DbSyncSample;integrated security=True;MultipleActiveResultSets=True;App=EntityFramework";
private const string TargetConnString = "data source=.;initial catalog=DbSyncSampleCopy;integrated security=True;MultipleActiveResultSets=True;App=EntityFramework";
static void Main(string[] args)
{
// getting XML with the structure of the reference database
var dborig = new Shed.DbSync.DataBase(OrigConnString);
var xml = dborig.GetXml();
File.WriteAllText("DbStructure.xml", xml);
// if you need to clear the structure of the target database, use
// Shed.DbSync.DataBase.ClearDb(TargetConnString);
// update the structure of the target database
var dbcopy = Shed.DbSync.DataBase.CreateFromXml(xml);
dbcopy.UpdateDb(TargetConnString);
// in fact, you can use one line:
// dborig.UpdateDb(TargetConnString);
// create dbcopy only to demonstrate the creation of a database object from XML
}
} Después de ejecutar el programa, puede verificar que DbSyncSampleCopy ahora tiene una estructura de tabla idéntica a la base de datos de referencia. Siéntase libre de experimentar cambiando la estructura de referencia y actualizando la de destino.
En escenarios de prueba, es posible que deba crear una base de datos de prueba cada vez desde cero. En este caso, será útil utilizar la función Shed.DbSync.DataBase.ClearDb(string connString).
Seguimiento automático de la estructura de la base de datos
El seguimiento de la estructura se convierte en una función separada, que debe llamarse al inicio/reinicio de la aplicación, o en otro lugar a pedido de un desarrollador.
static void SyncDb()
{
// autotracking of database structure
Shed.DbSync.DataBase.Syncronize(OrigConnString,
@"Struct\DbStructure.xml", // path to the structure file
@"Struct\Logs", // path to synchronization log folder
@"Struct\update_script.sql" // (optional) in case of defining this parameter
// the script generated for the database update
// will be stored within it
);
}SCRIPT El seguimiento se realiza utilizando el parámetro Versión (etiqueta) en XML. El escenario para usar el procedimiento es el siguiente:
Asigne una versión a una base de datos. En Microsoft SQL Server Management Studio, haga clic con el botón derecho en el nodo de la base de datos necesaria y seleccione Propiedades.
A continuación, haga clic en Propiedades extendidas y agregue la propiedad Versión con el valor 1 a la tabla de propiedades. Con cada modificación posterior de la estructura, esta propiedad debe incrementarse en 1.
Cuando inicie la aplicación, se creará el archivo, si no hay un archivo XML o su versión es más pequeña que la de la base de datos.
Si la versión del archivo XML es mayor que la de la base de datos, se genera y ejecuta un script para actualizar la base de datos.
Si se producen errores durante la ejecución del script, todos los cambios se revierten.
Los resultados de la sincronización se escriben en el archivo de registro creado en la carpeta especificada por el parámetro logDitPath.
Si se especifica el parámetro SqlScriptPath, se crea un archivo con el script del elemento 4.
