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 configuración de compilación, que puedes ejecutar según una programación. Puedes usar configuraciones de lanzamiento para configurar entornos de ejecución, por ejemplo, de etapa de pruebas y de producción.

Acerca de las configuraciones de lanzamiento de Dataform

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

Las configuraciones de la versión 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 versión

En una configuración de lanzamiento, puedes configurar anulaciones de compilación de dataform.json, variables de compilación y la frecuencia de creación de los 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
El ID de la versión, el git commitish para los resultados de la compilación y la frecuencia con la que se crean los resultados de la compilación.
Anulaciones de compilación
Anulaciones del proyecto de Google Cloud, el prefijo de tabla, el sufijo de 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 necesaria para crear una configuración de lanzamiento. Puedes activar manualmente la compilación en la página Detalles de configuración de la versión o activar la compilación con la API de Dataform releaseConfigs.

Durante la compilación, Dataform obtiene el código del compromiso 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 la versión es el resultado de compilación en vivo.

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

Antes de comenzar

  1. En Google Cloud Console, 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 que necesitas para crear una configuración de lanzamiento, solicita al administrador que te otorgue la función de IAM de editor de formulario de datos (roles/dataform.editor) en los repositorios. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso.

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 Configuración de la versión y, luego, haz clic en Configuración de la versión nueva.

  2. En el panel Crear configuración de la versión, establece la configuración de la versión.

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

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

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

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

    1. Opcional: En el menú desplegable Frecuencia, selecciona la frecuencia de creación de resultados de compilación.

  3. 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 deseas almacenar el resultado de la compilación.
    2. En el campo Sufijo del 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.

  4. Opcional: En la sección Variables de compilación, configura variables de compilación.

    1. Haga 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.

  5. 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 la versión.



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

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

Ver detalles de la configuración de una versión

Puedes ver los siguientes detalles de una configuración de la versión:

  • Configuración de la versión
    • Commitish de Git
    • Marca de tiempo del último resultado de la 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 la configuración de una versión, sigue estos pasos:

  1. En tu repositorio, ve a Configuración de la versión.
  2. Selecciona una configuración de lanzamiento.
  3. En la página Detalles de configuración de la versión, inspecciona los detalles de la configuración de la versión.

Cómo activar 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 tu repositorio, ve a Configuración de la versión.
  2. Selecciona una configuración de lanzamiento.
  3. En la página Detalles de configuración de la versión, haz clic en Compilación nueva.

El resultado de la compilación recién creado se convierte en el resultado en vivo de 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 para BigQuery, sigue estos pasos:

  1. En tu repositorio, ve a Configuración de la versión y, luego, haz clic en Iniciar ejecución.
  2. En el panel Ejecutar trabajo manual, en el menú desplegable Configuración de la versión, selecciona una configuración de lanzamiento.
  3. 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 acciones.
    3. Para ejecutar acciones con las etiquetas seleccionadas, haz clic en Selección de etiquetas y, luego, selecciona etiquetas.
  4. Opcional: Para ejecutar acciones o etiquetas seleccionadas y sus dependencias, selecciona la opción Incluir dependencias.
  5. Opcional: Para ejecutar acciones o etiquetas seleccionadas y sus dependientes, selecciona la opción Include depends.

  6. Opcional: Si quieres 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.

  7. Haz clic en Iniciar ejecución.

Editar la configuración de una versión

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

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

Borra una configuración de lanzamiento

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

  1. En tu repositorio, ve a Configuración de la versión.
  2. En la configuración de la versión que deseas borrar, haz clic en el menú Más y, luego, en Borrar.
  3. En la ventana emergente Borrar configuración de la versión, haz clic en Borrar.

¿Qué sigue?