Cómo obtener 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 espacio de trabajo de Dataform antes de ejecutar la consulta en BigQuery.

Acerca de la vista previa de 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 de SQL compilada antes de ejecutarla en BigQuery, puedes ejecutar una vista previa de la consulta en tu espacio 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 espacio 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 de vista previa se borra automáticamente en un plazo de 24 horas. Para obtener más información sobre los trabajos de BigQuery, consulta Administra trabajos.

La ejecución de la vista previa de la consulta 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 que se obtuvieron en la vista previa durante la sesión actual del navegador en el panel Resultados de la consulta de tu espacio de trabajo. En el panel Resultados de la consulta, puedes ver la siguiente información sobre cada consulta que se previsualizó durante la sesión actual del navegador:

  • Información del trabajo
    • ID del trabajo de BigQuery
    • Usuario que ejecuta la vista previa
    • Ubicación en la que se ejecuta el trabajo, que se toma de tu archivo de configuración del flujo de trabajo
    • Fechas y 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
    • Uso de SQL heredado en la consulta
    • Tabla de destino temporal de la consulta
  • Resultados de la búsqueda
  • 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 con vista previa y 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, crea una tabla.

Roles obligatorios

Para obtener los permisos que necesitas para 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

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.

Obtén una vista previa de una búsqueda

Para inspeccionar los resultados de la consulta en Dataform antes de la ejecución, ejecuta una vista previa de una consulta en tu espacio de trabajo. Si el archivo que se está editando contiene varias consultas, selecciona 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 para las tablas con aserciones. Para obtener más información, consulta Cómo obtener 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 espacio de trabajo de Dataform, sigue estos pasos:

  1. En el panel Archivos, expande definitions/.
  2. Selecciona un archivo SQLX o JavaScript.
  3. Haz clic en Ejecutar.
    1. Si el archivo contiene varias búsquedas, en el menú desplegable, selecciona la búsqueda 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 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 SQLX con aserciones, puedes obtener una vista previa de la consulta de creación de tablas y de las consultas de aserciones definidas.

Dataform trata la consulta de definición de la tabla como la consulta predeterminada. Para obtener una vista previa de la consulta de creación de la tabla, haz clic en Ejecutar en tu espacio de trabajo. Para obtener una vista previa de una consulta de aserción, debes seleccionarla en un menú desplegable junto al botón Ejecutar. 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 tabla con aserciones en un espacio de trabajo de Dataform, sigue estos pasos:

  1. En el panel Archivos, expande definitions/.
  2. Selecciona un archivo de definición de una tabla con aserciones.
  3. Ejecutar vista previa:
    • Para obtener una vista previa de la consulta de creación de la tabla, haz clic en Ejecutar.
    • Para obtener una vista previa de una consulta de aserción, haz clic en el ícono de menú desplegable junto a Ejecutar 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 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?