Prévisualiser les requêtes SQL

Ce document explique comment prévisualiser le résultat d'une requête SQL dans un l'espace de travail Dataform avant d'exécuter la requête sur BigQuery.

À propos de l'aperçu d'une 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 la sortie du code SQL compilé avant de l'exécuter dans BigQuery, vous pouvez prévisualiser dans votre espace de travail Dataform.

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

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

Pendant l'aperçu de la requête, Dataform utilise vos identifiants utilisateur pour exécuter des jobs 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 au cours de la dans le panneau Résultats de la requête de votre espace de travail. Dans le champ Query des résultats de recherche, vous pouvez afficher les informations suivantes sur chaque requête prévisualisé pendant la session actuelle du navigateur:

  • Informations sur le job <ph type="x-smartling-placeholder">
      </ph>
    • ID de la tâche BigQuery
    • Utilisateur exécutant l'aperçu
    • Emplacement d'exécution du job, issu de votre fichier de paramètres de workflow
    • Heures de création, de début et de fin du job BigQuery
    • Durée du job 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, puis accédez à BigQuery Studio pour afficher l'aperçu d'un projet.

Avant de commencer

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

    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 définissez une tableau.

Rôles requis

Pour obtenir les autorisations dont vous avez besoin pour prévisualiser les requêtes, demandez à votre administrateur de vous accorder le les rôles IAM suivants sur votre projet:

  • Éditeur Dataform (roles/dataform.editor) - Espaces de travail
  • Utilisateur de job BigQuery (roles/bigquery.jobUser) : projet

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'un dans votre espace de travail. Si le fichier actuellement modifié contient plusieurs requêtes, sélectionnez la requête que vous voulez prévisualiser. Vous ne pouvez prévisualiser qu'une seule requête à la fois.

L'exécution de l'aperçu est légèrement différente pour les tables avec des assertions. Pour plus d'informations, 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 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 que vous voulez 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 la sortie JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher l'aperçu du job dans l'espace de travail SQL, cliquez sur le bouton 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 contenant des assertions, vous pouvez prévisualiser la table de création 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. À prévisualisez la requête de création de table, puis cliquez sur Exécuter dans votre espace de travail. Pour prévisualiser un d'assertion, sélectionnez-la dans un menu déroulant à côté de Bouton Run (Exécuter) Vous ne pouvez prévisualiser qu'une seule requête à la fois.

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

  1. Dans le volet Fichiers, développez definitions/.
  2. Sélectionnez le fichier de définition d'une table avec des assertions.
  3. Exécuter l'aperçu: <ph type="x-smartling-placeholder">
      </ph>
    • 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 l'icône du menu déroulant à côté de Exécuter, puis sélectionnez la requête que vous souhaitez 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 la sortie JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher l'aperçu du job dans l'espace de travail SQL, cliquez sur le bouton Menu Plus > Afficher le job dans l'espace de travail SQL

Étape suivante