Crea una configuración de lanzamiento

En este documento, se muestra cómo crear una configuración de lanzamiento en Dataform para establecer plantillas de ajustes de compilación, que puedes ejecutar de forma programada. Puedes usar configuraciones de lanzamiento para configurar entornos de ejecución, por ejemplo, de 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 código de flujo de trabajo de SQL en un resultado de compilación. Este proceso ocurre 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.

Parámetros de configuración de lanzamiento

En una configuración de lanzamiento, puedes configurar anulaciones de compilación de los ajustes de dataform.json, 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 la compilación y frecuencia con la que se crean los resultados. La frecuencia es una configuración opcional. Si se establece, la frecuencia mínima es de 1 hora.
Anulaciones de compilación
Anulaciones del proyecto de Google Cloud, el prefijo de la tabla, el sufijo del esquema y las variables de compilación definidas en dataform.json.

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 una configuración opcional y no es necesario crear una configuración de lanzamiento. Si se establece, la frecuencia mínima es de 1 hora. Puedes activar manualmente la compilación en la página Detalles de configuración de la versión o con la API de Dataform releaseConfigs.

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

Puedes programar ejecuciones de resultados de compilación de configuraciones de lanzamientos en configuraciones del flujo de trabajo. También puedes ejecutar una configuración de lanzamiento seleccionada fuera de cualquier programa. Durante la ejecución de la configuración del flujo de trabajo, Dataform ejecuta el resultado de la 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.

    Ir a la página Dataform

  2. Selecciona o crea un repositorio.

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

Roles obligatorios

Si quieres obtener los permisos necesarios 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.

Es posible que también puedas obtener los permisos necesarios mediante funciones personalizadas, o bien otras funciones predefinidas.

Crea una configuración de lanzamiento

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

  1. En el repositorio, ve a Lanzamientos y programación.
  2. En la sección Configuración de la versión, haz clic en Crear.

  3. En el panel Crear configuración de lanzamiento, establece los parámetros de configuración de la versión.

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

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

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

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

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

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

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

    1. En el campo ID del proyecto de Google Cloud, ingresa el ID del proyecto de Google Cloud en el que desees almacenar el resultado de la compilación.
    2. En el campo Sufijo de esquema, ingresa un sufijo para adjuntar al esquema configurado en dataform.json.
    3. En el campo Prefijo de la tabla, ingresa un prefijo para todos los nombres de tabla.

  5. Opcional: En la sección Variables de compilación, configura 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 Value, ingresa el valor de la variable de compilación.
    4. Para agregar otra variable de compilación, haz clic en Add variable.

  6. Haz clic en Crear.

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



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

  • ID de versión: production
  • Commitish de Git: 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 la última compilación
    • 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
    • Confirmar SHA
  • Resultados de compilaciones anteriores

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

  1. En el repositorio, ve a Lanzamientos y programación.
  2. Selecciona una configuración de lanzamiento.
  3. En la página Detalles de configuración de lanzamiento, consulta los detalles de la configuración de lanzamiento.

Activa la compilación de forma manual

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

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

El resultado de la compilación recién creado se convierte en el resultado publicado para esa 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 el repositorio, ve a Lanzamientos y programación.
  2. En la sección Configuración de la versión, haz clic en Iniciar ejecución.
  3. En el panel Ejecutar flujo de trabajo manual del 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 las acciones seleccionadas en el flujo de trabajo de SQL, haz clic en Selección de acciones y, luego, selecciónala.
    3. Para ejecutar acciones con las 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 IncludeDependencies.
  6. Opcional: Para ejecutar las acciones o etiquetas seleccionadas y sus dependientes, selecciona la opción Include dependents.

  7. Opcional: Para volver a compilar todas las tablas desde cero, selecciona la opción Ejecutar con actualización completa.

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

  8. Haz clic en Iniciar ejecución.

Cómo editar una configuración de lanzamiento

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

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

Cómo borrar una configuración de lanzamiento

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

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

¿Qué sigue?