Guide de l’interface utilisateur de Query Editor

Query Editor est un outil interactif fourni par le Query Service d’Adobe Experience Platform. Il permet d’écrire, de valider et d’exécuter des requêtes pour les données d’expérience client dans l’interface utilisateur d’Experience Platform. Query Editor prend en charge le développement de requête pour l’analyse et l’exploration de données. Il vous permet également d’exécuter des requêtes interactives à des fins de développement, ainsi que des requêtes non interactives pour renseigner les jeux de données dans Experience Platform.

Pour plus d’informations sur les concepts et les fonctionnalités de Query Service, consultez la Présentation de Query Service. Pour en savoir plus sur la navigation dans l’interface utilisateur de Query Service sur Platform, consultez la Présentation de l’interface utilisateur de Query Service.

Prise en main

Query Editor offre une exécution flexible des requêtes en se connectant à Query Service, et ces requêtes seront uniquement exécutées tant que cette connexion sera active.

Connexion à Query Service

Query Editor ne prend que quelques secondes pour l’initialisation et, une fois ouvert, se connecte à Query Service. La console vous indique qu’il est connecté, comme illustré ci-dessous. Si vous tentez d’exécuter une requête avant que l’éditeur ne soit connecté, l’exécution est retardée jusqu’à ce que la connexion soit établie.

Sortie de console du Query Editor lors de la connexion initiale.

Exécution des requêtes depuis Query Editor

Dans Query Editor, les requêtes sont exécutées de manière interactive. Cela signifie que la requête sera annulée si vous fermez le navigateur ou quittez l’éditeur. Cela concerne également les requêtes visant à générer des jeux de données à partir de sorties de requête.

Création de requête à l’aide du Query Editor

Avec Query Editor, vous pouvez écrire, exécuter et enregistrer des requêtes de données d’expérience client. Toutes les requêtes enregistrées ou exécutées dans Query Editor sont accessibles à tous les utilisateurs de votre organisation bénéficiant d’un accès à Query Service.

Accéder à Query Editor

Pour ouvrir l’espace de travail Query Service, cliquez sur Requêtes dans le menu de navigation à gauche de l’interface utilisateur d’Experience Platform. Cliquez ensuite sur Créer une requête dans la partie supérieure droite de l’écran pour commencer à écrire des requêtes. Ce lien est disponible depuis n’importe quelle page de l’espace de travail Query Service.

Onglet Présentation de l’espace de travail Requêtes avec l’option Créer une requête mise en surbrillance.

Rédaction de requêtes

Query Editor est organisé de façon à rendre l’écriture de requête aussi facile que possible. ​ La copie d’écran ci-dessous présente l’affichage de l’éditeur dans l’interface utilisateur. Le champ d’entrée SQL et le bouton Lire sont mis en surbrillance.

Query Editor avec le champ d’entrée SQL et le bouton Lire en surbrillance.

Pour réduire le temps de développement, nous vous recommandons de développer vos requêtes en fixant des limites sur les lignes renvoyées. Par exemple : SELECT fields FROM table WHERE conditions LIMIT number_of_rows. Une fois que vous avez vérifié que votre requête produit la sortie attendue, supprimez les limites et exécutez la requête avec CREATE TABLE tablename AS SELECT, afin de générer un jeu de données avec la sortie.

Outils d’écriture dans le Query Editor

  • Mise en surbrillance automatique de la syntaxe : facilite la lecture et l’organisation SQL.

Instruction SQL dans le Query Editor présentant une mise en surbrillance des couleurs de syntaxe.

  • Saisie automatique de mots-clés SQL : commencez à saisir votre requête, puis utilisez les touches fléchées pour accéder au terme souhaité et appuyez sur Entrée.

Quelques caractères SQL avec le menu déroulant de saisie automatique qui fournit des options du Query Editor.

  • Saisie automatique de tableau et de champ : commencez à saisir le nom du tableau auquel vous souhaitez appliquer SELECT, puis utilisez les touches fléchées pour accéder au tableau recherché et appuyez sur Entrée. Une fois le tableau sélectionné, la saisie automatique reconnaît les champs de ce tableau.

Entrée du Query Editor affichant les suggestions de noms de tableau déroulant.

(Version limitée) Bascule de configuration de l’interface utilisateur à saisie automatique

IMPORTANT

Le bouton de configuration de l’interface utilisateur à saisie automatique est actuellement disponible dans une version limitée et n’est pas disponible pour tous les clients.

Le Query Editor suggère automatiquement des mots-clés SQL potentiels ainsi que des détails de tableau ou de colonne pour la requête au fur et à mesure que vous l’écrivez. La fonction de saisie automatique est activée par défaut et peut être désactivée ou activée à tout moment en cliquant sur le bouton (bascule) Saisie automatique de la syntaxe dans la partie supérieure droite du Query Editor.

Le paramètre de configuration de saisie automatique est défini par utilisateur et mémorisé pour les connexions consécutives de l’utilisateur.

Query Editor avec le bouton (bascule) de saisie automatique de la syntaxe mis en surbrillance.

La désactivation de cette fonction arrête le traitement de plusieurs commandes de métadonnées et la suggestion de recommandations qui accélère généralement la vitesse de l’auteur lors de la modification des requêtes.

Lorsque vous cliquez sur le bouton (bascule) pour activer la fonction de saisie automatique, les suggestions recommandées pour les noms de tableau et de colonne ainsi que les mots-clés SQL deviennent disponibles après une courte pause. Un message de réussite dans la console sous le Query Editor indique que la fonctionnalité est activée.

Si vous désactivez la fonction de saisie automatique, une actualisation de page est nécessaire pour que cette action soit appliquée. Une boîte de dialogue de confirmation s’affiche avec trois options lorsque vous désactivez le bouton de la Saisie automatique de la syntaxe :

  • Annuler
  • Enregistrer les modifications et actualiser
  • Actualiser sans enregistrer les modifications
IMPORTANT

Si vous écrivez ou modifiez une requête lors de la désactivation de cette fonction, vous devez enregistrer les modifications apportées à votre requête avant d’actualiser la page, sinon toute progression sera perdue.

Boîte de dialogue de confirmation permettant de désactiver la fonction de saisie automatique.

Sélectionnez l’option appropriée pour désactiver la fonction de saisie automatique.

Détection des erreurs

Query Editor valide automatiquement la requête au fur et à mesure que vous l’écrivez grâce à une validation SQL générique et une validation d’exécution spécifique. Si un trait de soulignement rouge apparaît sous la requête (comme illustré dans l’image ci-dessous), il indique une erreur dans la requête.

Entrée de Query Editor affichant le style SQL souligné en rouge pour indiquer une erreur.

Lorsque des erreurs sont détectées, vous pouvez afficher les messages d’erreur spécifiques en survolant le code SQL avec la souris.

Boîte de dialogue contenant un message d’erreur.

Détails de la requête

Sélectionnez un modèle enregistré dans l’onglet Modèles pour l’afficher dans Query Editor. Le panneau des détails de la requête fournit plus d’informations et d’outils pour gérer la requête sélectionnée.

Query Editor avec le panneau des détails de la requête mis en surbrillance.

Ce panneau vous permet de générer un jeu de données de sortie directement à partir de l’interface utilisateur, de supprimer ou de nommer la requête affichée, et d’ajouter un planning à la requête.

Ce panneau présente également des métadonnées utiles, telles que la dernière fois où la requête a été modifiée et qui l’a modifiée, le cas échéant. Pour générer un jeu de données, sélectionnez Jeu de données de sortie. La boîte de dialogue Jeu de données de sortie s’affiche. Saisissez un nom et une description, puis sélectionnez Exécuter la requête. Le nouveau jeu de données s’affiche dans l’onglet Jeux de données de l’interface utilisateur Query Service dans Platform.

Requêtes planifiées

Les requêtes qui ont été enregistrées en tant que modèle peuvent être planifiées à partir de l’éditeur de requêtes. Vous pouvez ainsi automatiser les exécutions de requête exécutées sur une cadence personnalisée. Vous pouvez planifier des requêtes en fonction de la fréquence, de la date et de l’heure, et choisir également un jeu de données de sortie pour vos résultats, si nécessaire. Les plannings de requête peuvent également être désactivés ou supprimés via l’interface utilisateur.

Les plannings sont définis à partir du Query Editor. Vous trouverez ci-dessous une liste des limitations des requêtes planifiées lorsque vous utilisez l’éditeur de requêtes. Elles ne s’appliquent pas au Query Service API :

  • Vous pouvez uniquement ajouter un planning à une requête qui a déjà été créée, enregistrée et exécutée.
  • Vous ne pouvez pas ajouter un planning à une requête paramétrée.
  • Les requêtes planifiées ne peuvent pas contenir un bloc anonyme.

Consultez la documentation sur les plannings de requête pour savoir comment création de plannings de requête dans l’interface utilisateur. Pour savoir comment ajouter des plannings à l’aide de l’API, vous pouvez également lire le guide de point de terminaison des requêtes planifiées.

Toutes les requêtes planifiées sont ajoutées à la liste dans la variable Requêtes planifiées . Depuis cet espace de travail, vous pouvez surveiller l’état de toutes les tâches de requête planifiées via l’interface utilisateur. Sur le Requêtes planifiées vous pouvez trouver des informations importantes sur les exécutions de requête et vous abonner aux alertes. Les informations disponibles incluent l’état, les détails de planification et les codes/messages d’erreur en cas d’échec de l’exécution. Voir Surveiller le document des requêtes planifiées pour plus d’informations.

Enregistrement des requêtes

Le Query Editor offre une fonction de sauvegarde qui vous permet d’enregistrer une requête et d’y revenir ultérieurement. Pour enregistrer une requête, sélectionnez Enregistrer dans le coin supérieur droit du Query Editor. Avant de pouvoir enregistrer une requête, vous devez lui donner un nom à l’aide du panneau Détails sur la requête.

REMARQUE

Les requêtes nommées et enregistrées dans à l’aide du Query Editor sont disponibles sous forme de modèles dans l’onglet Modèles du tableau de bord Requête. Pour plus d’informations, consultez la documentation sur les modèles.

Accès aux requêtes précédentes

Toutes les requêtes exécutées à partir du Query Editor sont capturées dans le tableau Journal. Vous pouvez utiliser la fonctionnalité de recherche dans l’onglet Journal pour rechercher des exécutions de requête. Les requêtes enregistrées sont répertoriées dans l’onglet Modèles.

Si une requête a été planifiée, alors l’onglet Requêtes planifiées offre une meilleure visibilité à travers l’interface utilisateur pour ces tâches de requête. Pour plus d’informations, consultez la documentation sur la surveillance des requêtes.

REMARQUE

Les requêtes non exécutées ne sont pas enregistrées dans le journal. Pour que la requête soit disponible dans Query Service, elle doit être exécutée ou enregistrée dans Query Editor.

Exécution de requête à l’aide de Query Editor

Pour exécuter une requête dans Query Editor, vous pouvez saisir le langage SQL dans l’éditeur ou charger une requête précédente depuis l’onglet Journal ou Modèles, et sélectionner Lire. L’état de l’exécution de la requête s’affiche dans l’onglet Console ci-dessous et les données de sortie s’affichent dans l’onglet Résultats.

Console

La console fournit des informations sur le statut et le fonctionnement de Query Service. La console affiche le statut de la connexion à Query Service, les opérations des requêtes en cours d’exécution et tout message d’erreur résultant de ces requêtes.

L’onglet Console de la console du Query Editor.

REMARQUE

La console affiche uniquement les erreurs résultant de l’exécution d’une requête. Elle n’affiche pas les erreurs de validation de requête avant l’exécution de la requête.

Résultats de requête

Une fois une requête terminée, les résultats sont affichés dans l’onglet Résultats, en regard de l’onglet Console. Cet affichage indique la sortie tabulaire de votre requête (jusqu’à 100 lignes). Il vous permet de vérifier que votre requête produit la sortie attendue. Pour générer un jeu de données avec votre requête, supprimez les limites sur les lignes renvoyées, puis exécutez la requête avec CREATE TABLE tablename AS SELECT pour générer un jeu de données avec la sortie. Consultez le tutoriel sur la génération de jeux de données pour apprendre à générer un jeu de données à partir des résultats de requête dans Query Editor.

L’onglet Résultats de la console du Query Editor affiche les résultats de l’exécution d’une requête.

Exécuter des requêtes avec le tutoriel vidéo sur Query Service

La vidéo suivante montre comment exécuter des requêtes dans l’interface Adobe Experience Platform et dans un client PSQL. En outre, l’utilisation de propriétés individuelles dans un objet XDM, l’utilisation de fonctions définies par Adobe et l’utilisation de CREATE TABLE AS SELECT (CTAS) sont illustrées.

Étapes suivantes

Maintenant que vous connaissez les fonctionnalités disponibles dans le Query Editor et que vous savez naviguer dans l’application, vous pouvez commencer à créer vos requêtes directement sur Platform. Pour plus d’informations sur l’exécution de requêtes SQL par rapport aux jeux de données dans Data Lake, consultez le guide sur ’exécution de requêtes.

Sur cette page