Previsualizar consultas de SQL

En este documento se explica cómo obtener una vista previa de la salida de una consulta de 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 SQL compilada antes de ejecutarla en BigQuery, puedes obtener una vista previa de la consulta en tu espacio de trabajo de Dataform.

Cuando ejecutas una vista previa de una consulta, Dataform ejecuta un trabajo en BigQuery para ejecutar la 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 la tabla en BigQuery. La tabla temporal con la consulta vista previamente se elimina automáticamente en un plazo de 24 horas. Para obtener más información sobre las tareas de BigQuery, consulta Gestionar tareas.

Ejecutar una vista previa de una consulta en Dataform conlleva facturación en BigQuery. Para obtener más información sobre los precios de BigQuery, consulta la página 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 ha obtenido una 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, puede ver la siguiente información sobre cada consulta que se haya previsualizado durante la sesión actual del navegador:

  • Información del trabajo
    • ID de tarea de BigQuery
    • Usuario que ejecuta la vista previa
    • Ubicación en la que se ejecuta el trabajo, tomada del archivo de configuración del flujo de trabajo
    • Horas de creación, inicio y finalización de la tarea de BigQuery
    • Duración de la tarea de BigQuery
    • Bytes procesados
    • Bytes facturados en BigQuery
    • Prioridad de tareas
    • Uso de SQL antiguo 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 ir al archivo de origen de cada consulta previsualizada y a BigQuery Studio para ver el trabajo de previsualización.

Antes de empezar

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

    Ir a la página de Dataform

  2. Seleccione o cree un repositorio.

  3. Seleccione o cree un espacio de trabajo de desarrollo.

  4. Crea una consulta de SQL, por ejemplo, crear una tabla.

Roles obligatorios

Para obtener los permisos que necesitas para previsualizar consultas, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

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

Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

Previsualizar una consulta

Para inspeccionar los resultados de una consulta en Dataform antes de ejecutarla, obtén una vista previa de la consulta en tu espacio de trabajo. Si el archivo que se está editando contiene varias consultas, seleccione la que quiera previsualizar. Solo puedes previsualizar una consulta a la vez.

La vista previa de las tablas con aserciones funciona de forma ligeramente diferente. Para obtener más información, consulta Vista previa de una tabla con aserciones.

Para previsualizar una consulta de SQL y ver los resultados de la consulta en un espacio de trabajo de Dataform, sigue estos pasos:

  1. En el panel Archivos, despliega definitions/.
  2. Selecciona un archivo SQLX o JavaScript.
  3. Haz clic en Ejecutar.
    1. Si el archivo contiene varias consultas, en el desplegable, selecciona la consulta que quieras previsualizar.
  4. Consulta los resultados de la vista previa en el panel Resultados de la consulta.
    1. Para consultar los detalles de un 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 la salida JSON de la consulta, selecciona la pestaña JSON.
    4. Para ver la tarea de vista previa en el espacio de trabajo SQL, haz clic en el menú Más > Ver tarea en el espacio de trabajo SQL.

Vista previa de una tabla con aserciones

En un archivo de definición de tabla SQLX con aserciones, puedes previsualizar la consulta de creación de la tabla y las consultas de aserciones 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 la tabla, haz clic en Ejecutar en tu espacio de trabajo. Para previsualizar una consulta de aserción, debes seleccionarla en un menú desplegable situado junto al botón Ejecutar. Solo puedes previsualizar 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, despliega definitions/.
  2. Selecciona un archivo de definición de una tabla con aserciones.
  3. Ejecutar vista previa:
    • Para previsualizar la consulta de creación de tabla, haz clic en Ejecutar.
    • Para previsualizar una consulta de aserción, haga clic en el icono de menú desplegable situado junto a Ejecutar y, a continuación, seleccione la consulta que quiera previsualizar.
  4. Consulta los resultados de la vista previa en el panel Resultados de la consulta.
    1. Para consultar los detalles de un 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 la salida JSON de la consulta, selecciona la pestaña JSON.
    4. Para ver la tarea de vista previa en el espacio de trabajo SQL, haz clic en el menú Más > Ver tarea en el espacio de trabajo SQL.

Siguientes pasos