Personalizar la compilación de bases de datos y la implementación con colaboradores de implementación y compilación

 

Visual Studio proporciona puntos de extensibilidad que puede utilizar para modificar el comportamiento de las acciones de compilación e implementación de los proyectos de base de datos.

Puede crear una extensión de los puntos de extensibilidad, como se muestra en la siguiente tabla:

Acción

Tipo de colaborador

Comentarios

Compilar

BuildContributor

Este tipo de extensión se ejecuta al compilar el proyecto de SQL después de que el modelo de proyecto se ha validado por completo.El colaborador de compilación puede tener acceso al modelo completado, además de a todas las propiedades de la Tarea de compilación y cualquier argumento personalizado.

Implementación

DeploymentPlanModifier

Este tipo de extensión se ejecuta al implementar el proyecto de SQL, como parte de la canalización de implementación, después de generar el plan de implementación, pero antes de que este se ejecute.Puede utilizar un DeploymentPlanModifier para modificar el plan de implementación agregando o quitando pasos.Los colaboradores de implementación pueden tener acceso al plan de implementación, a los resultados de la comparación y a modelos de origen y de destino.

Implementación

DeploymentPlanExecutor

Este tipo de extensión se ejecuta cuando el plan de implementación se ejecuta y proporciona acceso de solo lectura al plan de implementación.El DeploymentPlanExectutor realiza las acciones con base en el plan de implementación.

Puede implementar colaboradores de compilación o de implementación para habilitar los siguientes escenarios de ejemplo:

  • Generar la documentación de esquema durante la compilación de un proyecto - Para admitir este escenario, se implementa un BuildContributor y se invalida el método OnExecute para generar la documentación de esquema.Puede crear un archivo de destino que defina los argumentos predeterminados que controlan si la extensión se ejecuta y para especificar el nombre del archivo de salida.

  • Generar un informe de diferencias al implementar un proyecto de SQL - Para admitir este escenario, se implementa un DeploymentPlanExecutor que genera el archivo XML al implementar el proyecto de SQL.

  • Modificar el plan de implementación para cambiar se produce un movimiento de datos - Para admitir este escenario, se implementa un DeploymentPlanModifier y se efectúa una iteración sobre el plan de implementación.Para cada SqlTableMigrationStep de ese plan, examine el resultado de la comparación para determinar si el paso debe realizarse u omitirse.

  • Copiar archivos del dacpac generado al implementar un proyecto de SQL - Para admitir este escenario, se implementa un colaborador de implementación y se invalida el método OnEstablishDeploymentConfiguration para especificar qué archivos están marcados como DeploymentExtensionConfiguration por el sistema del proyecto.Estos archivos se deben copiar en la carpeta de resultados y agregar al dacpac generado.También puede modificar el colaborador para fusionar varios archivos en un nuevo archivo que se copia a la carpeta de resultados y se agrega al manifiesto de implementación.Durante la implementación, puede implementar el método OnApplyDeploymentConfiguration para extraer esos archivos del dacpac y prepararlos para usarlos en el método OnExecute.

Además, puede exponer pares personalizados de argumentos de nombre/valor desde su colaborador que se escriben en el archivo de proyecto de base de datos.Puede utilizar estos argumentos para permitir que el colaborador extraiga información de MSBuild o para permitir al usuario final de su colaborador que personalice su comportamiento.Por ejemplo, puede permitir a los usuarios especificar el nombre de un archivo de entrada o de salida.

Tareas comunes

Contenido relacionado

Obtenga más información acerca de los puntos de extensibilidad: Puede obtener información acerca de las clases base que se utilizan para implementar colaboradores de compilación y de implementación.

BuildContributor

DeploymentContributor

Crear colaboradores de ejemplo: Aprenda los pasos necesarios para crear un colaborador de compilación o de implementación.Si sigue estos tutoriales, debe:

  • Crear un colaborador de compilación que genere un informe que enumera todos los elementos del modelo.

  • Crear un colaborador de implementación que cambie el plan de implementación antes de que se ejecute.

  • Crear un colaborador de implementación que genere un informe de implementación al implementar un proyecto de SQL.

Puede crear todos los colaboradores en un único ensamblado o en varios ensamblados, dependiendo de cómo desee que estén distribuidos los colaboradores en el equipo.

Tutorial: Ampliar la compilación del proyecto de base de datos para generar estadísticas de modelo

Tutorial: Ampliar la implementación del proyecto de base de datos para modificar el plan de implementación

Tutorial: Ampliar la implementación del proyecto de base de datos para analizar el plan de implementación

Mostrar: