Establecer parámetros de configuración adicionales de la tabla

En este documento, se muestra cómo establecer la configuración de tablas adicionales en un archivo de definición de tablas. Con Dataform Core, puedes definir pre_operations y post_operations para ejecutar una instrucción de SQL antes o después de la creación de la tabla. También puedes anular la configuración de la tabla, como database o schema, e inhabilitar la creación de tablas.

Antes de comenzar

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

    Ir a Dataform

  2. Selecciona o crea un repositorio.

  3. Selecciona o crea un lugar de trabajo de desarrollo.

  4. Crea una tabla.

Funciones obligatorias

Si quieres obtener los permisos que necesitas para establecer parámetros de configuración adicionales de la tabla, pídele a tu administrador que te otorgue el rol de IAM Editor de Dataform (roles/dataform.editor) en los lugares de trabajo. 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 a través de funciones personalizadas o, también, otras funciones predefinidas.

Anular la configuración de la tabla

Puedes anular el esquema, la base de datos y el nombre de una tabla seleccionada.

De forma predeterminada, una tabla sigue el esquema y la configuración de la base de datos que estableciste en dataform.json. El nombre de una tabla es el mismo que el nombre del archivo SQLX de definición de tablas.

Para anular el esquema y el nombre de una tabla seleccionada, sigue estos pasos:

  1. Ve a tu lugar de trabajo de desarrollo.

  2. En el panel Files, expande definitions/.

  3. Abre un archivo de definición de tablas de SQLX.

  4. En el bloque config, ingresa el siguiente fragmento de código:

     {
   schema: "OVERRIDDEN_SCHEMA",
   database: "OVERRIDDEN_DATABASE",
   name: "OVERRIDDEN_NAME"
 }

    Reemplaza lo siguiente:

    • OVERRIDDEN_SCHEMA: Es el conjunto de datos de BigQuery en el que deseas crear la tabla.

    • OVERRIDDEN_DATABASE: Es el ID del proyecto de BigQuery en el que deseas crear la tabla.

    • OVERRIDDEN_NAME: Es el nombre de la tabla, diferente del nombre de archivo de la definición de tabla de SQLX.

  5. Opcional: Haz clic en Formato.

Cómo hacer referencia a una tabla con un nombre de tabla anulado

  • Para hacer referencia a una tabla con un nombre de tabla anulado, en la función ref, ingresa el nombre de tabla anulada establecido en name: "".

En la siguiente muestra de código, se hace referencia a una tabla cuyo nombre se anuló como overridden_name:

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

Definir una instrucción de SQL que se ejecutará antes de crear la tabla

Puedes configurar Dataform para que ejecute una o más instrucciones de SQL antes de crear una tabla seleccionada en BigQuery. Para ejecutar una instrucción de SQL antes de que Dataform cree una tabla seleccionada, agrega tu instrucción al bloque pre_operations en el archivo SQLX de definición de la tabla.

Para crear una instrucción de SQL personalizada que se ejecute antes de que Dataform cree una tabla específica, sigue estos pasos:

  1. Ve a tu lugar de trabajo de desarrollo.

  2. En el panel Files, expande definitions/.

  3. Abre un archivo de definición de tablas de SQLX.

  4. Fuera del bloque config, ingresa pre_operations { ... }.

  5. Dentro de pre_operations { ... }, agrega tu instrucción de SQL.

  6. Opcional: Para agregar varias sentencias, sepáralas con ---.

  7. Opcional: Haz clic en Formato.

En la siguiente muestra de código, se observan sentencias pre_operations que crean una función temporal que se puede usar en la sentencia SELECT:

  pre_operations {
    CREATE TEMP FUNCTION AddFourAndDivide(x INT64, y INT64)
      RETURNS FLOAT64
      AS ((x + 4) / y);
  }

Definir una instrucción de SQL que se ejecutará después de crear la tabla

Puedes configurar Dataform para ejecutar una o más instrucciones de SQL después de crear una tabla seleccionada en BigQuery. Para ejecutar una instrucción de SQL después de que Dataform cree una tabla seleccionada, agrega tu instrucción al bloque post_operations del archivo SQLX de definición de tablas. Puedes agregar varias instrucciones de SQL al bloque post_operations.

Para crear una instrucción de SQL personalizada que se ejecute después de que Dataform cree una tabla específica, sigue estos pasos:

  1. Ve a tu lugar de trabajo de desarrollo.

  2. En el panel Files, expande definitions/.

  3. Abre un archivo de definición de tablas de SQLX.

  4. Fuera del bloque config, ingresa post_operations { ... }.

  5. Dentro de post_operations { ... }, agrega tu instrucción de SQL.

  6. Opcional: Haz clic en Formato.

En la siguiente muestra de código, se observan sentencias post_operations que otorgan a los grupos acceso a la tabla creada:

    post_operations {
      GRANT `roles/bigquery.dataViewer`
      ON
      TABLE ${self()}
      TO "group:allusers@example.com", "user:otheruser@example.com"
    }

Inhabilitar la creación de tablas

Para evitar que Dataform cree una tabla seleccionada en BigQuery, puedes inhabilitar la tabla en el archivo de definición de tablas de SQLX. Dataform mantiene una tabla inhabilitada en el gráfico de dependencia, pero no la compila ni la crea. Esto puede ser útil, por ejemplo, si una tabla falla y no quieres que todo el flujo de trabajo falle mientras solucionas el problema.

Para inhabilitar una tabla, sigue estos pasos:

  1. Ve a tu lugar de trabajo de desarrollo.

  2. En el panel Files, expande definitions/.

  3. Selecciona un archivo de definición de tablas de SQLX.

  4. En el bloque config del archivo, ingresa disabled: true.

  5. Opcional: Haz clic en Formato.

En la siguiente muestra de código, se puede ver una tabla inhabilitada:

  config {
    type: "table",
    disabled: true
  }

  select * from ${ref("source_data")}

¿Qué sigue?