Obtén una vista previa de las consultas en SQL

En este documento, se muestra cómo obtener una vista previa del resultado de una consulta en SQL en un lugar de trabajo de Dataform antes de ejecutar la consulta en BigQuery.

Acerca de la vista previa de las consultas en Dataform

Cuando desarrollas una consulta en un archivo SQLX o JavaScript con Dataform core, Dataform compila la consulta en SQL en tiempo real. Para probar el resultado de la consulta en SQL compilada antes de ejecutarla en BigQuery, puedes ejecutar una vista previa de la consulta en tu lugar de trabajo de Dataform.

Cuando ejecutas la vista previa de una consulta, Dataform ejecuta un trabajo en BigQuery para ejecutar tu consulta compilada en una tabla de destino temporal y mostrar los resultados de la consulta en tu lugar de trabajo. Puedes inspeccionar el resultado de la consulta antes de activar la ejecución para publicar tu tabla en BigQuery. La tabla temporal con la consulta previsualizada se borra de forma automática en un máximo de 24 horas. Para obtener más información sobre los trabajos de BigQuery, consulta Introducción a los trabajos de BigQuery.

Ejecutar la vista previa de consultas en Dataform genera facturación en BigQuery. Para obtener más información sobre los precios de BigQuery, consulta Precios de BigQuery.

Durante la vista previa de la consulta, Dataform usa tus credenciales de usuario para ejecutar trabajos en BigQuery. Sin embargo, durante la ejecución del flujo de trabajo, Dataform usa las credenciales de tu cuenta de servicio para crear o actualizar recursos en BigQuery.

Dataform muestra los resultados de todas las consultas de las que se tiene una vista previa durante la sesión actual del navegador en el panel Resultados de la consulta en tu lugar de trabajo. En el panel Resultados de la consulta, puedes ver la siguiente información sobre cada consulta de la que se obtuvo una vista previa durante la sesión actual del navegador:

  • Información del trabajo
    • ID de trabajo de BigQuery
    • Usuario que ejecuta la vista previa
    • Ubicación en la que se ejecuta el trabajo, tomada de tu archivo de configuración del flujo de trabajo
    • Horas de creación, inicio y finalización del trabajo de BigQuery
    • Duración del trabajo de BigQuery
    • Bytes procesados
    • Bytes facturados en BigQuery
    • Prioridad del trabajo
    • El uso de SQL heredado en la consulta
    • Tabla de destino temporal de la consulta
  • Resultados de la consulta
  • Representación JSON del resultado de la consulta

Además, en el panel Resultados de la consulta, puedes navegar al archivo fuente de cada consulta previsualizada y navegar a BigQuery Studio para ver el trabajo de vista previa.

Antes de comenzar

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

    Ir a la página de Dataform

  2. Selecciona o crea un repositorio.

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

  4. Crea una consulta en SQL, por ejemplo, define una tabla.

Funciones obligatorias

Para obtener los permisos que necesitas a fin de obtener una vista previa de las consultas, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

  • Editor de Dataform (roles/dataform.editor): lugares de trabajo
  • Usuario de trabajo de BigQuery (roles/bigquery.jobUser): el proyecto

Si quieres obtener más información para 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.

Obtén una vista previa de una consulta

Para inspeccionar los resultados de la consulta en Dataform antes de la ejecución, ejecuta la vista previa de una consulta en tu lugar de trabajo. Si el archivo editado contiene varias consultas, selecciona la de la que deseas obtener una vista previa. Puedes obtener una vista previa de una consulta a la vez.

La ejecución de la vista previa es un poco diferente en las tablas con aserciones. Para obtener más información, consulta Obtén una vista previa de una tabla con aserciones.

Para obtener una vista previa de una consulta en SQL y ver los resultados de la consulta en un lugar de trabajo de Dataform, sigue estos pasos:

  1. En el panel Files, expande definitions/.
  2. Selecciona un archivo SQLX o JavaScript.
  3. Haz clic en Ejecutar.
    1. Si el archivo contiene varias consultas, en el menú desplegable, selecciona la consulta de la que deseas obtener una vista previa.
  4. Inspecciona los resultados de la vista previa en el panel Resultados de la consulta.
    1. Para inspeccionar los detalles del trabajo, selecciona la pestaña Información del trabajo.
    2. Para inspeccionar los resultados de la consulta, selecciona la pestaña Resultados.
    3. Para ver el resultado de JSON de la consulta, selecciona la pestaña JSON.
    4. Para ver el trabajo de vista previa en el lugar de trabajo de SQL, haz clic en el menú Más > Ver trabajo en el lugar de trabajo de SQL.

Obtén una vista previa de una tabla con aserciones

En un archivo de definición de tablas de SQLX con aserciones, puedes obtener una vista previa de la consulta de creación de tablas y las consultas de aserción definidas.

Dataform trata la consulta de definición de tabla como la consulta predeterminada. Para obtener una vista previa de la consulta de creación de tablas, haz clic en Ejecutar en tu lugar de trabajo. Para obtener una vista previa de una consulta de aserción, debes seleccionarla en un menú desplegable junto al botón Run. Puedes obtener una vista previa de una consulta a la vez.

Para obtener una vista previa de una consulta en un archivo de definición de tablas con aserciones en un lugar de trabajo de Dataform, sigue estos pasos:

  1. En el panel Files, expande definitions/.
  2. Selecciona un archivo de definición de una tabla con aserciones.
  3. Ejecuta la vista previa:
    • Para obtener una vista previa de la consulta de creación de tablas, haz clic en Ejecutar.
    • Para obtener una vista previa de una consulta de aserción, haz clic en el ícono desplegable junto a Run y, luego, selecciona la consulta de la que deseas obtener una vista previa.
  4. Inspecciona los resultados de la vista previa en el panel Resultados de la consulta.
    1. Para inspeccionar los detalles del trabajo, selecciona la pestaña Información del trabajo.
    2. Para inspeccionar los resultados de la consulta, selecciona la pestaña Resultados.
    3. Para ver el resultado de JSON de la consulta, selecciona la pestaña JSON.
    4. Para ver el trabajo de vista previa en el lugar de trabajo de SQL, haz clic en el menú Más > Ver trabajo en el lugar de trabajo de SQL.

¿Qué sigue?