Crea una configuración de lanzamiento

En este documento, se muestra cómo crear una configuración de lanzamiento en Dataform para configurar plantillas de parámetros de configuración de compilación, que puedes ejecutar según un programa. Puedes usar configuraciones de lanzamiento para configurar entornos de ejecución, por ejemplo, la etapa de pruebas y producción.

Información acerca de las configuraciones de lanzamiento de Dataform

Para ejecutar flujos de trabajo de SQL en BigQuery, Dataform compila el código del flujo de trabajo de SQL en un resultado de compilación. Este proceso se realiza automáticamente cuando desarrollas un flujo de trabajo de SQL en un lugar de trabajo de Dataform.

Las configuraciones de lanzamiento te permiten personalizar los resultados de la compilación. Puedes usarlos para crear entornos de ejecución, por ejemplo, de etapa de pruebas.

Configuración de la configuración de lanzamiento

En una configuración de lanzamiento, puedes configurar anulaciones de compilación de la configuración del flujo de trabajo, establecer variables de compilación y establecer la frecuencia de creación de resultados de compilación.

Una configuración de lanzamiento de Dataform contiene la siguiente configuración de compilación:

Configuración de la versión
ID de la versión, commitish de git para los resultados de compilación y frecuencia de creación de resultados de compilación. La frecuencia es un parámetro de configuración opcional. Si se establece, la frecuencia mínima es de 1 hora.
Anulaciones de compilación
Anulaciones del proyecto Google Cloud, el prefijo de la tabla, el sufijo del esquema y las variables de compilación definidas en la configuración del flujo de trabajo.

Cómo funciona una configuración de lanzamiento

Dataform crea resultados de compilación a partir de una configuración de lanzamiento con la frecuencia especificada o cuando activas la compilación. La frecuencia es un parámetro de configuración opcional y no es necesario para crear una configuración de lanzamiento. Si se establece, la frecuencia mínima es de 1 hora. Puedes activar la compilación de forma manual en la página Detalles de la configuración de lanzamiento, o activar la compilación con la API de Dataform releaseConfigs.

Durante la compilación, Dataform extrae código del commit de Git especificado de tu repositorio. Luego, Dataform compila el código con las anulaciones de compilación aplicadas (si las hay) y crea el resultado de la compilación. El resultado de compilación más reciente que se creó para la configuración de lanzamiento es el resultado de la compilación en vivo.

Puedes programar ejecuciones de resultados de compilación desde parámetros de configuración de lanzamiento en parámetros de configuración de flujo de trabajo. También puedes ejecutar una configuración de lanzamiento seleccionada fuera de cualquier programa. Durante la ejecución de una configuración de flujo de trabajo, Dataform ejecuta el resultado de compilación en vivo de la configuración de lanzamiento seleccionada.

Antes de comenzar

  1. En la consola de Google Cloud, ve a la página Dataform.

    Ve a la página Dataform

  2. Selecciona o crea un repositorio.

  3. Opcional: Para anular el proyecto Google Cloud predeterminado en la configuración de lanzamiento, otorga acceso a tu cuenta de servicio de Dataform al proyecto Google Cloud que planeas usar.

Roles obligatorios

Para obtener los permisos que necesitas para crear una configuración de lanzamiento, pídele a tu administrador que te otorgue el rol de IAM de Editor de Dataform (roles/dataform.editor) en los repositorios. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

Crea una configuración de lanzamiento

Para crear una configuración de lanzamiento de Dataform, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. En la sección Configuraciones de lanzamiento, haz clic en Crear.

  3. En el panel Crear configuración de lanzamiento, configura la configuración de la versión.

    1. En el campo ID de versión, ingresa un ID único para la configuración de la versión.

      Los IDs solo pueden incluir números, letras, guiones y guiones bajos.

    2. En el campo Commitish de Git, ingresa la rama de Git o el SHA de confirmación de Git para la versión.

    En un repositorio de Dataform que no está conectado a un repositorio remoto, el valor siempre es main.

    1. Opcional: En el menú desplegable Frecuencia, selecciona la frecuencia con la que se crearán los resultados de la compilación.

      Si se establece, la frecuencia mínima es de 1 hora.

  4. Opcional: En la sección Anulaciones de compilación, configura la configuración de compilación.

    1. En el campo ID del proyecto de Google Cloud, ingresa el ID del proyecto Google Cloud en el que deseas almacenar el resultado de la compilación.
    2. En el campo Sufijo de esquema, ingresa un sufijo para agregar al esquema configurado en la configuración del flujo de trabajo.
    3. En el campo Prefijo de tabla, ingresa un prefijo para todos los nombres de las tablas.

  5. Opcional: En la sección Variables de compilación, establece las variables de compilación.

    1. Haz clic en Agregar variable.
    2. En el campo Clave, ingresa la variable de compilación.
    3. En el campo Valor, ingresa el valor de la variable de compilación.
    4. Para agregar otra variable de compilación, haz clic en Agregar variable.

  6. Haz clic en Crear.

Si anulas el proyecto Google Cloud predeterminado, asegúrate de que la cuenta de servicio de Dataform tenga acceso al proyecto Google Cloud establecido en la configuración de lanzamiento.



Por ejemplo, la siguiente configuración de lanzamiento crea un resultado de compilación production de la rama main cada hora, sin ninguna anulación de compilación:

  • ID de versión: production
  • Git commitish: main
  • Frecuencia: por hora
  • sin anulaciones de compilación

Consulta los detalles de una configuración de lanzamiento

Puedes ver los siguientes detalles de una configuración de lanzamiento:

  • Configuración de la versión
    • Commitish de Git
    • Marca de tiempo del resultado de compilación más reciente
    • Programa de cron
    • Anulaciones de compilación
    • Variables de compilación
  • Resultado de la compilación en vivo
    • Marca de tiempo de creación
    • Commitish de Git
    • SHA de confirmación
  • Resultados de compilaciones anteriores

Para ver los detalles de una configuración de lanzamiento, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. Selecciona una configuración de lanzamiento.
  3. En la página Release configuration details, inspecciona los detalles de la configuración de lanzamiento.

En la tabla Resultados de la compilación programada, se muestran los resultados de compilación anteriores que creó automáticamente la configuración de lanzamiento.

La tabla Resultados de compilación manual/con API muestra los resultados de compilación que se crearon de forma manual o a través de llamadas a la API de Dataform de los 1,000 resultados de compilación más recientes del repositorio.

Cómo activar la compilación de forma manual

Para crear un resultado de compilación de forma manual a partir de una configuración de lanzamiento seleccionada, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. Selecciona una configuración de lanzamiento.
  3. En la página Detalles de la configuración de lanzamiento, haz clic en Nueva compilación.

El resultado de la compilación recién creado se convierte en el resultado en vivo de esa configuración de lanzamiento.

Los resultados de la compilación manual se muestran en la tabla Resultados de compilación manual/con API en la página Detalles de la configuración de lanzamiento.

Activa la ejecución de una configuración de lanzamiento

Para activar la ejecución del resultado de la compilación en vivo en una configuración de lanzamiento seleccionada en BigQuery, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. En la sección Configuraciones de lanzamiento, haz clic en Iniciar ejecución.
  3. En el panel Ejecutar flujo de trabajo manual, en el menú desplegable Configuración de lanzamiento, selecciona una configuración de lanzamiento.
  4. Selecciona las acciones del flujo de trabajo de SQL que se ejecutarán:
    1. Para ejecutar todo el flujo de trabajo de SQL, haz clic en Todas las acciones.
    2. Para ejecutar acciones seleccionadas en el flujo de trabajo de SQL, haz clic en Selección de acciones y, luego, selecciona las acciones.
    3. Para ejecutar acciones con etiquetas seleccionadas, haz clic en Selección de etiquetas y, luego, selecciona las etiquetas.
  5. Opcional: Para ejecutar las acciones o etiquetas seleccionadas y sus dependencias, selecciona la opción Incluir dependencias.
  6. Opcional: Para ejecutar las acciones o etiquetas seleccionadas y sus dependencias, selecciona la opción Incluir dependencias.

  7. Opcional: Para volver a compilar todas las tablas desde cero, selecciona la opción Run with full refresh.

    Sin esta opción, Dataform actualiza las tablas incrementales sin volver a compilarlas desde cero.

  8. Haz clic en Iniciar ejecución.

Edita una configuración de lanzamiento

Para editar la configuración de una versión, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. En la configuración de lanzamiento que deseas editar, haz clic en el menú Más y, luego, en Editar.
  3. En el panel Editar configuración de lanzamiento, edita la configuración de la configuración de lanzamiento y, luego, haz clic en Guardar.

Borra una configuración de lanzamiento

Para borrar una configuración de lanzamiento, sigue estos pasos:

  1. En tu repositorio, ve a Lanzamientos y programación.
  2. En la configuración de lanzamiento que deseas borrar, haz clic en el menú Más y, luego, en Borrar.
  3. En el diálogo Borrar configuración de lanzamiento, haz clic en Borrar.

¿Qué sigue?