Configura los parámetros adicionales de la tabla

En este documento, se muestra cómo configurar parámetros adicionales de la tabla en un archivo de definición de tablas. Con el núcleo de Dataform, 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, y, además, 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.

Roles obligatorios

Para obtener los permisos que necesitas para configurar parámetros de configuración adicionales de la tabla, pídele a tu administrador que te otorgue el rol de IAM de editor de formularios de datos (roles/dataform.editor) en los espacios de trabajo. 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.

Anula 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 la configuración del esquema y la base de datos que estableciste en workflow_settings.yaml. El nombre de una tabla es el mismo que el nombre del archivo SQLX de definición de la tabla.

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 Archivos, expande definitions/.

  3. Abre un archivo de definición de tablas 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: El ID del proyecto de BigQuery en el que deseas crear la tabla

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

  5. Opcional: Haz clic en Formato.

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

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

En la siguiente muestra de código, se hace referencia a una tabla con el nombre anulado a overridden_name:

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

Define una sentencia SQL que se ejecutará antes de la creación de la tabla

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

Para crear una sentencia 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 Archivos, expande definitions/.

  3. Abre un archivo de definición de tablas 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 instrucciones, sepáralas con ---.

  7. Opcional: Haz clic en Formato.

En la siguiente muestra de código, se muestra una sentencia pre_operations que crea 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);
  }

Define una instrucción SQL que se ejecutará después de la creación de la tabla

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

Para crear una sentencia 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 Archivos, expande definitions/.

  3. Abre un archivo de definición de tablas 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 muestran 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"
    }

Inhabilita la creación de tablas

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

Para inhabilitar una tabla, sigue estos pasos:

  1. Ve a tu lugar de trabajo de desarrollo.

  2. En el panel Archivos, expande definitions/.

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

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

  5. Opcional: Haz clic en Formato.

En el siguiente ejemplo de código, se muestra una tabla inhabilitada:

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

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

¿Qué sigue?