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 dans BigQuery.

À propos de la prévisualisation des requêtes 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 de la requête SQL compilée avant de l'exécuter dans BigQuery, vous pouvez la prévisualiser dans votre espace de travail Dataform.

Lorsque vous prévisualisez une requête, Dataform exécute une tâche dans BigQuery pour exécuter votre requête compilée dans une table de destination temporaire et afficher les résultats de la requête 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 au bout de 24 heures. Pour en savoir plus sur les tâches BigQuery, consultez Gérer les tâches.

L'exécution de la prévisualisation des requêtes dans Dataform entraîne une facturation dans BigQuery. Pour en savoir plus sur les tarifs de BigQuery, consultez la page Tarifs de BigQuery.

Lors de la prévisualisation des requêtes, Dataform utilise les identifiants de votre compte Google pour exécuter des tâches dans BigQuery. Lors de l'exécution du workflow, le mode "Agir en tant que" strict exige que Dataform utilise un compte de service personnalisé ou les identifiants d'utilisateur d'un compte Google pour créer ou mettre à jour des composants dans BigQuery.

Dataform affiche les résultats de toutes les requêtes prévisualisées lors de 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 lors de la session de navigateur actuelle :

  • Informations sur la tâche
    • ID de la tâche BigQuery
    • Utilisateur exécutant la prévisualisation
    • Emplacement d'exécution de la tâche, extrait du fichier de paramètres de votre workflow
    • 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 de la sortie 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 à BigQuery Studio pour afficher la tâche de prévisualisation.

Avant de commencer

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

    Accéder à 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, créez une table.

Rôles requis

Pour obtenir les autorisations nécessaires pour prévisualiser les requêtes, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

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

Prévisualiser une requête

Pour inspecter les résultats d'une requête dans Dataform avant son exécution, exécutez une prévisualisation de la requête dans votre espace de travail. Si le fichier que vous modifiez contient plusieurs requêtes, sélectionnez celle que vous souhaitez prévisualiser. Vous ne pouvez prévisualiser qu'une seule requête à la fois.

L'exécution d'une prévisualisation est légèrement différente pour les tables avec des assertions. Pour en savoir plus, consultez 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 celle que vous souhaitez prévisualiser dans le menu.

  4. Inspectez les résultats de la prévisualisation dans le panneau Résultats de la requête.

    1. Pour inspecter les détails de la tâche, sélectionnez l'onglet Informations sur la tâche.
    2. Pour inspecter les résultats de la requête, sélectionnez l'onglet Résultats.
    3. Pour afficher la sortie JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher la tâche de prévisualisation dans l'espace de travail SQL, cliquez sur le Plus menu > Afficher la tâche dans l'espace de travail SQL.

Prévisualiser une table avec des assertions

Dans un fichier de définition de table SQLX avec des 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 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, sélectionnez-la dans le menu à côté du bouton 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 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 avec des assertions.
  3. Exécutez une prévisualisation :
    • 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 de 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 la prévisualisation dans le panneau Résultats de la requête.
    1. Pour inspecter les détails de la tâche, sélectionnez l'onglet Informations sur la tâche.
    2. Pour inspecter les résultats de la requête, sélectionnez l'onglet Résultats.
    3. Pour afficher la sortie JSON de la requête, sélectionnez l'onglet JSON.
    4. Pour afficher la tâche de prévisualisation dans l'espace de travail SQL, cliquez sur le Plus menu > Afficher la tâche dans l'espace de travail SQL.

Étape suivante