Cómo declarar dependencias

En este documento, se muestra cómo definir la relación entre los objetos en el flujo de trabajo de SQL en Dataform mediante la declaración de dependencias.

Puedes definir una relación de dependencia entre objetos de un flujo de trabajo de SQL. En una relación de dependencia, la ejecución del objeto dependiente depende de la ejecución del objeto de dependencia. Esto significa que Dataform ejecuta el dependiente después de la dependencia. Para definir la relación, declara las dependencias dentro del archivo de definición de SQLX del objeto dependiente.

Las declaraciones de dependencias conforman un árbol de dependencias de tu flujo de trabajo de SQL que determina el orden en el que Dataform ejecuta tus objetos de flujo de trabajo de SQL.

Puedes definir la relación de dependencia entre los siguientes objetos del flujo de trabajo de SQL:

Declaraciones de fuentes de datos
Declaraciones de fuentes de datos de BigQuery que te permiten hacer referencia a estas fuentes de datos en definiciones de tablas de Dataform y operaciones de SQL. Puedes establecer una declaración de fuente de datos como una dependencia, pero no como dependiente.
Tablas
Tablas que creas en Dataform a partir de las fuentes de datos declaradas o de otras tablas en tu flujo de trabajo de SQL. Dataform admite los siguientes tipos de tablas: tabla, tabla incremental, vista y vista materializada. Puedes establecer una tabla como dependencia y dependiente.
Operaciones de SQL personalizadas
Instrucciones de SQL que Dataform ejecuta en BigQuery como están, sin modificaciones Puedes establecer una operación de SQL personalizada definida en un archivo type: operations como dependencia y como dependiente. Para declarar una operación de SQL personalizada como una dependencia en la función ref, debes establecer la propiedad hasOutput en true en el archivo de definición SQLX de la operación de SQL personalizada.
Aserciones
Consultas de las pruebas de calidad de los datos que puedes usar para validar los datos de las tablas. Dataform ejecuta aserciones cada vez que actualiza tu flujo de trabajo de SQL y te alerta si falla alguna. Puedes establecer una aserción definida en un archivo type: assertion como dependencia y como dependiente definiendo dependencias en el bloque config.

Puedes definir la relación de dependencia de las siguientes maneras:

Antes de comenzar

  1. Crea e inicializa un lugar de trabajo de desarrollo en tu repositorio.
  2. Opcional: Declara una fuente de datos.
  3. Crea al menos dos objetos de flujo de trabajo de SQL: tablas, aserciones, declaraciones de fuentes de datos u operaciones.

Roles obligatorios

Si deseas obtener los permisos que necesitas para declarar dependencias de tablas, aserciones, declaraciones de fuentes de datos y operaciones de SQL personalizadas, pídele al administrador que te otorgue la función de IAM de editor de formulario de datos (roles/dataform.editor) en los lugares de trabajo. 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.

Cómo declarar una dependencia como un argumento de la función ref

Para hacer referencia y declarar automáticamente una dependencia en una sentencia SELECT, agrega la dependencia como un argumento de la función ref.

La función ref es una función integrada de núcleo de Dataform que te permite hacer referencia y depender automáticamente de cualquier tabla, declaración de fuente de datos o, también, operación de SQL personalizada con la propiedad hasOutput establecida en true en tu flujo de trabajo de SQL.

Para obtener más información sobre la función ref, consulta la referencia de los métodos principales del contexto de Dataform.

Para obtener más información sobre el uso de la función ref en una definición de tabla, consulta Acerca de las definiciones de tablas.

En la siguiente muestra de código, se muestra la declaración de la fuente de datos source_data agregada como argumento de la función ref en el archivo de definición SQLX incremental_table.sqlx de una tabla incremental:

// filename is incremental_table.sqlx

config { type: "incremental" }

SELECT * FROM ${ref("source_data")}

En la muestra de código anterior, source_data se declara automáticamente como una dependencia de incremental_table.

En la siguiente muestra de código, se muestra el archivo SQLX de definición de tablas some_table como argumento de la función ref en el archivo de definición SQLX custom_assertion.sqlx de una aserción:

// filename is custom_assertion.sqlx

config { type: "assertion" }

SELECT
  *
FROM
  ${ref("some_table")}
WHERE
  a is null
  or b is null
  or c is null

En la muestra de código anterior, some_table se declara automáticamente como una dependencia de custom_assertion. Durante la ejecución, Dataform ejecuta some_table primero y, luego, ejecuta custom_assertion una vez que se crea some_table.

Cómo declarar dependencias en el bloque config

Para declarar dependencias a las que no se hace referencia en la definición de instrucción de SQL del dependiente, pero que deben ejecutarse antes de la operación de tabla, aserción o SQL personalizado, sigue estos pasos:

  1. En el lugar de trabajo de desarrollo, en el panel Archivos, expande el directorio definitions/.
  2. Selecciona la tabla, la aserción o el archivo SQLX de operación de SQL personalizado que deseas editar.
  3. En el bloque config del archivo, ingresa el siguiente fragmento de código:
dependencies: [ "DEPENDENCY", ]

Reemplaza DEPENDENCY por el nombre de archivo de la tabla, la aserción, la declaración de fuente de datos o la operación de SQL personalizada que deseas agregar como dependencia. Puedes ingresar varios nombres de archivo.

En la siguiente muestra de código, se muestra la tabla some_table y la aserción some_assertion agregadas como dependencias al bloque config de un archivo de definición de tablas:

config { dependencies: [ "some_table", "some_assertion" ] }

¿Qué sigue?