Prévisualiser les requêtes SQL

Ce document explique comment prévisualiser la sortie d'une requête SQL dans un espace de travail Dataform avant d'exécuter la requête à BigQuery.

À propos de l'aperçu de la requête dans Dataform

Lorsque vous développez une requête dans un fichier SQLX ou JavaScript avec Dataform Core, Dataform compile la requête en SQL en temps réel. Pour tester le résultat de la requête SQL compilée avant de l'exécuter dans BigQuery, vous pouvez exécuter un aperçu de la requête dans votre espace de travail Dataform.

Lorsque vous affichez l'aperçu d'une requête, Dataform exécute une tâche dans BigQuery pour exécuter la requête compilée dans une table de destination temporaire et afficher les résultats dans votre espace de travail. Vous pouvez inspecter le résultat de la requête avant de déclencher l'exécution pour publier votre table dans BigQuery. La table temporaire contenant la requête prévisualisée est automatiquement supprimée dans un délai de 24 heures. Pour en savoir plus sur les tâches BigQuery, consultez la page Présentation des tâches BigQuery.

L'exécution de l'aperçu de la requête dans Dataform entraîne la facturation dans BigQuery. Pour en savoir plus sur les tarifs de BigQuery, consultez la page Tarifs de BigQuery.

Lors de l'aperçu de la requête, Dataform utilise vos identifiants utilisateur pour exécuter des tâches dans BigQuery. Toutefois, lors de l'exécution du workflow, Dataform utilise les identifiants de votre compte de service pour créer ou mettre à jour des éléments dans BigQuery.

Dataform affiche les résultats de toutes les requêtes prévisualisées pendant la session de navigateur actuelle dans le panneau Résultats de la requête de votre espace de travail. Dans le panneau Résultats de la requête, vous pouvez afficher les informations suivantes sur chaque requête prévisualisée au cours de la session de navigateur actuelle:

  • Informations sur la tâche
    • ID de la tâche BigQuery
    • Utilisateur exécutant l'aperçu
    • Emplacement d'exécution de la tâche, extrait de votre fichier dataform.json
    • Heures de création, de début et de fin de la tâche BigQuery
    • Durée de la tâche BigQuery
    • Octets traités
    • Octets facturés dans BigQuery
    • Priorité de la tâche
    • Utilisation de l'ancien SQL dans la requête
    • Table de destination temporaire de la requête
  • Résultats de la requête
  • Représentation JSON du résultat de la requête

De plus, dans le panneau Résultats de la requête, vous pouvez accéder au fichier source de chaque requête prévisualisée et accéder à l'espace de travail SQL BigQuery pour afficher la tâche d'aperçu.

Avant de commencer

  1. Dans la console Google Cloud, accédez à la page Dataform.

    Accéder à la page Dataform

  2. Sélectionnez ou créez un dépôt.

  3. Sélectionnez ou créez un espace de travail de développement.

  4. Créez une requête SQL, par exemple pour définir une table.

Rôles requis

Pour obtenir les autorisations nécessaires pour prévisualiser les requêtes dans un espace de travail Dataform, demandez à votre administrateur de vous attribuer les rôles IAM suivants:

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Prévisualiser une requête

Pour inspecter les résultats de la requête dans Dataform avant son exécution, exécutez l'aperçu d'une requête dans votre espace de travail. Si le fichier en cours de modification contient plusieurs requêtes, sélectionnez celle que vous souhaitez prévisualiser. Vous pouvez prévisualiser une requête à la fois.

L'exécution de l'aperçu est légèrement différente pour les tables comportant des assertions. Pour en savoir plus, consultez la section Prévisualiser une table avec des assertions.

Pour prévisualiser une requête SQL et afficher les résultats de la requête dans un espace de travail Dataform, procédez comme suit:

  1. Dans le volet Fichiers, développez definitions/.
  2. Sélectionnez un fichier SQLX ou JavaScript.
  3. Cliquez sur Exécuter.
    1. Si le fichier contient plusieurs requêtes, sélectionnez-la dans la liste déroulante.
  4. Inspectez les résultats de l'aperçu dans le panneau Résultats de la requête.
    1. Pour inspecter les détails du job, sélectionnez l'onglet Informations sur le job.
    2. Pour inspecter les résultats de la requête, sélectionnez l'onglet Results (Résultats).
    3. Pour afficher le résultat JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher la tâche d'aperçu dans l'espace de travail SQL, cliquez sur le menu Plus > Afficher le job dans l'espace de travail SQL.

Prévisualiser une table avec des assertions

Dans un fichier de définition de table SQLX avec assertions, vous pouvez prévisualiser la requête de création de table et les requêtes d'assertion définies.

Dataform traite la requête de définition de table comme la requête par défaut. Pour prévisualiser la requête de création de table, cliquez sur Exécuter dans votre espace de travail. Pour prévisualiser une requête d'assertion, vous devez la sélectionner dans une liste déroulante à côté du bouton Exécuter. Vous pouvez prévisualiser une requête à la fois.

Pour prévisualiser une requête dans un fichier de définition de table avec des assertions dans un espace de travail Dataform, procédez comme suit:

  1. Dans le volet Fichiers, développez definitions/.
  2. Sélectionnez un fichier de définition d'une table comportant des assertions.
  3. Exécutez l'aperçu :
    • Pour prévisualiser la requête de création de table, cliquez sur Exécuter.
    • Pour prévisualiser une requête d'assertion, cliquez sur la liste déroulante à côté de l'option Exécuter, puis sélectionnez la requête à prévisualiser.
  4. Inspectez les résultats de l'aperçu dans le panneau Résultats de la requête.
    1. Pour inspecter les détails du job, sélectionnez l'onglet Informations sur le job.
    2. Pour inspecter les résultats de la requête, sélectionnez l'onglet Results (Résultats).
    3. Pour afficher le résultat JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher la tâche d'aperçu dans l'espace de travail SQL, cliquez sur le menu Plus > Afficher le job dans l'espace de travail SQL.

Étapes suivantes