Configuración del control de código fuente y administración de datos de referencia
Un proyecto de base de datos SQL sin control de código fuente es simplemente una carpeta de archivos en la máquina de alguien. En el momento en que el portátil de esa persona se rompe, o dos desarrolladores editan el mismo procedimiento almacenado, vuelve al punto de partida. Colocar el proyecto en Git proporciona un historial de cambios, colaboración a través de la bifurcación y solicitudes de incorporación de cambios, y la base que necesita toda canalización de CI/CD.
Pero el control de código fuente solo no resuelve todo. Es probable que la base de datos tenga tablas de búsqueda, códigos de estado y configuraciones predeterminadas que se encuentran junto con el esquema. También necesita una estrategia para esos datos.
Configuración del control de código fuente para un proyecto de base de datos SQL
Dado que un proyecto de base de datos SQL es simplemente .sql archivos y un .sqlproj archivo, se ajusta naturalmente a Git. Cada objeto de base de datos reside en su propio archivo, por lo que Git realiza un seguimiento de los cambios en el nivel de objeto. Un commit que modifica la Customers tabla y actualiza un procedimiento almacenado muestra exactamente esos dos archivos en el diff, no un script de migración monolítico con docenas de cambios no relacionados.
Para empezar, inicialice un repositorio de Git en la carpeta del proyecto:
cd MyDatabaseProject
git init
git add .
git commit -m "Initial commit of database project"
Organización de la carpeta del proyecto
Una estructura de carpetas coherente hace que el proyecto se pueda navegar de un vistazo. Los archivos de grupos de patrones más comunes por tipo de objeto:
MyDatabaseProject/
├── MyDatabaseProject.sqlproj
├── Tables/
│ ├── Customers.sql
│ └── Orders.sql
├── Views/
│ └── vw_ActiveCustomers.sql
├── StoredProcedures/
│ └── usp_GetCustomerOrders.sql
├── Scripts/
│ ├── PostDeployment/
│ │ └── seed-data.sql
│ └── PreDeployment/
│ └── prep-db.sql
└── PostDeploy.sql
Con los proyectos con estilo SDK, el patrón global predeterminado recoge automáticamente todos los archivos .sql de la carpeta. No se necesitan entradas de archivo manuales.
Agregar un archivo .gitignore
Mantenga el repositorio centrado en los archivos de origen excluyendo las salidas de compilación y la configuración específica del usuario:
bin/
obj/
*.dacpac
*.user
.dacpac se recrea a partir del proyecto en cada compilación de CI/CD, por lo que no hay ninguna razón para registrarlo en Git.
Administración de datos de referencia con scripts previos a la implementación y posteriores a la implementación
El modelo declarativo controla objetos de esquema como tablas, vistas y procedimientos almacenados, pero algunos datos son tan esenciales como el propio esquema. Códigos de estado, tablas de búsqueda, configuraciones predeterminadas, listas de regiones. Si esos datos desaparecen, la aplicación se interrumpe. Pertenece al proyecto y se versiona junto a los objetos de los que depende.
Los scripts previos a la implementación y posteriores a la implementación resuelven este problema. Son scripts SQL que se ejecutan durante la implementación, pero se encuentran fuera del modelo de base de datos compilado:
- Un script previo a la implementación se ejecuta antes del plan de implementación. Úselo para tareas que deben completarse antes de los cambios de esquema, como quitar restricciones o migrar datos.
- Un script posterior a la implementación se ejecuta una vez completado el plan de implementación. Úselo para rellenar datos de referencia y tablas de búsqueda, o para establecer valores predeterminados de la aplicación.
Adición de scripts al proyecto
Un proyecto admite exactamente un script de implementación previa y un script posterior a la implementación. Las declaraciones de elementos se realizan en el archivo .sqlproj con entradas PreDeploy y PostDeploy.
<ItemGroup>
<PreDeploy Include="prep-db.sql" />
</ItemGroup>
<ItemGroup>
<PostDeploy Include="PostDeploy.sql" />
</ItemGroup>
Uso de las inclusiones de SQLCMD para varios archivos de datos
Un archivo de script no significa un archivo gigante. Use la sintaxis SQLCMD :r para extraer varios archivos desde un único punto de entrada. Un aspecto típico PostDeploy.sql es similar al siguiente:
:r .\Scripts\PostDeployment\seed-statuses.sql
:r .\Scripts\PostDeployment\seed-regions.sql
:r .\Scripts\PostDeployment\seed-app-settings.sql
Cada archivo al que se hace referencia debe excluirse de la compilación; de lo contrario, el proceso de compilación intenta compilarlo como un objeto de esquema y produce un error. En el .sqlproj archivo, use Build Remove para evitar la compilación y None Include mantener el archivo visible en el proyecto:
<ItemGroup>
<Build Remove="Scripts\PostDeployment\seed-statuses.sql" />
<None Include="Scripts\PostDeployment\seed-statuses.sql" />
</ItemGroup>
📝 Repita este patrón para cada archivo al que se hace referencia en los scripts previos o posteriores a la implementación.
Escritura de scripts de datos de referencia idempotentes
Los scripts posteriores a la implementación se ejecutan en cada implementación, no solo en el primero. Si utiliza declaraciones simples INSERT, el segundo despliegue falla con violaciones de clave duplicadas. Utilice en su lugar instrucciones MERGE para que los scripts sean seguros de ejecutar repetidamente.
MERGE INTO [dbo].[OrderStatuses] AS target
USING (VALUES
(1, N'Pending'),
(2, N'Processing'),
(3, N'Shipped'),
(4, N'Delivered'),
(5, N'Cancelled')
) AS source ([StatusID], [StatusName])
ON target.[StatusID] = source.[StatusID]
WHEN MATCHED THEN
UPDATE SET [StatusName] = source.[StatusName]
WHEN NOT MATCHED THEN
INSERT ([StatusID], [StatusName])
VALUES (source.[StatusID], source.[StatusName]);
Sugerencia
Puede validar los scripts previos a la implementación y posteriores a la implementación después de la compilación de un proyecto cambiando la extensión de .dacpac archivo a .zip y extrayendola. Un único .sql archivo para cada tipo de script contiene el contenido T-SQL combinado de todos los archivos a los que se hace referencia.
Conclusiones clave
Inicialice un repositorio de Git a nivel de la solución y use un archivo .gitignore para excluir salidas de compilación como archivos bin/, obj/ y .dacpac. Organice los objetos de esquema en carpetas que reflejan la estructura de la base de datos, con un archivo por objeto. Coloque datos de referencia en scripts posteriores a la implementación y use SQLCMD :r incluye para mantener cada script centrado en una sola tabla. Para evitar que los scripts de datos se compilen como objetos de esquema, use Build Remove y None Include en el .sqlproj archivo. Escriba declaraciones MERGE en lugar de declaraciones INSERT simples para que los scripts de los datos de referencia sean idempotentes y se puedan ejecutar de manera segura en cada implementación. A continuación, utilizará este repositorio para trabajar con flujos de trabajo de bifurcación y solicitudes de incorporación de cambios.