Modifier et valider LookML

Utiliser l'IDE

L'environnement de développement intégré (IDE) de Looker inclut plusieurs fonctionnalités pour vous aider à écrire LookML.

Suggestions automatiques

Au fur et à mesure de votre saisie, l'IDE suggère des paramètres et des valeurs sensibles au contexte de votre saisie. Par exemple, les suggestions associées au paramètre type d'une dimension ne contiennent que des options valides pour ce paramètre. De plus, les champs des paramètres sql doivent être marqués avec ${...}. L'IDE ajoute donc cette syntaxe lorsqu'il suggère des champs.

La suggestion automatique s'affiche automatiquement partout où elle peut s'afficher. Pour la fermer, appuyez sur la touche Échap de votre clavier. Pour l'afficher à tout moment, appuyez sur Ctrl+Espace (Windows) ou sur Ctrl+Espace (Mac).

Vérification des erreurs ponctuelles

L'IDE détecte les erreurs de syntaxe à mesure que vous saisissez du texte. Un "X" rouge dans la marge indique une erreur de syntaxe, soulignée en rouge. Lorsque vous pointez sur le X rouge, une brève description du problème apparaît. Par exemple, si vous saisissez par erreur avrage au lieu de average comme valeur du paramètre type pour une mesure, l'IDE affiche l'erreur Invalid value for "type":avrage.

L'outil de validation LookML est toujours nécessaire pour effectuer une validation complète du modèle. Certaines erreurs, comme une référence de champ non valide en raison d'une jointure manquante, nécessitent un examen global du modèle. Elles ne s'affichent donc que lorsque l'outil de validation LookML est en cours d'exécution.

Panneau d'aide rapide

Sélectionnez l'icône Aide rapide pour ouvrir le panneau Aide rapide, qui fournit des explications et des options pour l'emplacement actuel dans le code. Sélectionnez un nom de paramètre dans la barre latérale pour ouvrir la page de documentation Looker correspondante.

Remarque :Vous pouvez également utiliser le panneau des métadonnées pour afficher des informations contextuelles pertinentes sur les objets dans le panneau des métadonnées de l'IDE Looker. Pour en savoir plus, consultez la page Métadonnées des objets LookML.

Format automatique

Lorsque vous êtes en mode développement, vous pouvez utiliser le raccourci clavier de format de fichier pour mettre automatiquement en retrait votre fichier LookML. Les retraits indiquent la hiérarchie des paramètres et des sous-paramètres, ce qui facilite la lecture et la compréhension de votre LookML.

Pliable

Une petite flèche apparaît dans la marge, à côté du début de chaque paramètre LookML de premier niveau dans le fichier. Sélectionner cette flèche pour plier ou déplier cette section de LookML afin de vous concentrer sur des sections spécifiques

Le menu See file actions (Afficher les actions sur les fichiers) du fichier LookML fournit également les options Fold LookML et Unfold LookML pour développer ou réduire toutes les sections LookML jusqu'au paramètre de premier niveau du fichier actuel.

Vous pouvez également utiliser des raccourcis clavier pour plier et déplier LookML.

Marquer des ajouts, modifications et suppressions

Dans l'IDE LookML, plusieurs indicateurs sont toujours affichés lorsque vous êtes en mode développement et que vous avez des modifications non validées.

• Le nom du fichier s'affiche avec un point bleu sur le côté gauche de la fenêtre pour indiquer que le fichier est nouveau, modifié ou renommé.
• Lorsque vous ouvrez un fichier nouveau ou modifié, les lignes de ligne qu'il contient sont mises en surbrillance en vert pour afficher les nouvelles lignes ou les lignes modifiées. Une ligne horizontale rouge indique les lignes supprimées.

Ajouter des commentaires

Vous pouvez ajouter des commentaires à votre LookML pour le rendre plus lisible. Pour ajouter un seul commentaire, utilisez le caractère #:

dimension: name {
  sql: ${TABLE}.name ;; # This is the customer's full name
}

Vous pouvez mettre en commentaire un bloc de code entier avec des raccourcis clavier:

1. Sélectionnez les lignes que vous souhaitez commenter.
2. Appuyez sur ⌘+ / sur un Mac, ou sur Ctrl+ / sur un ordinateur Windows.

L'IDE ajoute le caractère # à chacune des lignes sélectionnées.

Commenter des blocs SQL

Si vous commentez des lignes qui se trouvent entièrement dans un bloc de code SQL, ajoutez manuellement la notation de commentaire SQL.

Lorsque vous utilisez le bloc de commentaires SQL, les sections commentées sont tout de même interprétées comme du code LookML. Vos commentaires s'afficheront alors dans le langage SQL généré par LookML, mais ils n'auront aucune incidence sur les résultats de la requête.

Accéder à un objet ou à un fichier

Dans l'IDE Looker, vous pouvez effectuer une recherche rapide pour accéder directement aux objets LookML et aux fichiers de projet à l'aide de la fonctionnalité Accéder à un objet ou à un fichier. Cliquez sur l'icône Accéder à l'objet ou au fichier dans l'explorateur de fichiers ou dans le navigateur d'objets, ou utilisez le raccourci clavier Commande-J (Mac) ou Ctrl+J (Windows):

Pour en savoir plus, consultez la page Accéder aux fichiers du projet LookML.

Rechercher et remplacer du texte dans votre projet

L'IDE Looker possède une fonction de recherche et de remplacement qui vous permet de rechercher du texte dans tous les fichiers de votre projet, et de remplacer toutes les instances ou les instances sélectionnées dans une opération groupée.

Conseil :La fonction de recherche et de remplacement de l'IDE Looker est un excellent outil pour localiser les éléments LookML dans les projets LookML volumineux et pour remplacer le texte dans les descriptions et les libellés. Si vous souhaitez rechercher et remplacer dans votre projet les noms des modèles, des explorations et des champs, utilisez plutôt la fonction de recherche et de remplacement de l'outil de validation de contenu. La modification des noms des modèles, des explorations et des champs peut briser les références dans votre modèle. L'outil de validation de contenu peut valider vos références LookML et corriger les erreurs dans ces modèles.

Pour utiliser la fonction de recherche de l'IDE Looker:

1. Accédez au panneau de recherche de l'IDE.
2. Saisissez un terme dans le champ Find (Rechercher).
3. Vous pouvez également sélectionner Sensible à la casse pour rechercher uniquement les instances correspondant à la casse que vous avez saisie dans le champ Rechercher. Vous pouvez aussi sélectionner Expression régulière pour effectuer une recherche d'expression régulière.
4. Sélectionnez Rechercher.
5. Vous pouvez éventuellement sélectionner le nom d'un fichier pour l'ouvrir dans l'IDE.

Si vous êtes en mode Développement, le champ Remplacer par s'affiche également. Pour remplacer du texte dans votre projet:

1. Saisissez le texte de remplacement dans le champ Remplacer par. Vous pouvez éventuellement laisser le champ Remplacer par vide si vous souhaitez supprimer le texte du champ Rechercher au lieu de le remplacer.

2. Sélectionnez Sélectionner et remplacer pour prévisualiser le remplacement de votre texte dans votre projet.

3. Les résultats présentent toutes les instances de votre projet qui sont mises en surbrillance pour le remplacement. Vous pouvez utiliser les options suivantes pour personnaliser les instances à remplacer:

   • Cochez ou décochez tous les résultats pour sélectionner ou désélectionner toutes les instances de votre projet.
   • Cochez ou décochez une instance pour la sélectionner ou la désélectionner.

4. Sélectionnez le bouton Remplacer la sélection afin d'appliquer le remplacement aux instances que vous avez sélectionnées. L'IDE affiche les modifications apportées.

Créer et tester des champs

Pour modifier un exemple de LookML, nous allons ajouter plusieurs champs, puis les tester.

Créer une dimension

Nous allons commencer par ajouter une nouvelle dimension à la vue users, qui détermine si un utilisateur provient de Californie ou de New York. La dimension est type: yesno, ce qui signifie qu'elle renvoie Yes (Oui) si l'utilisateur provient de Californie ou New York, et No (Non) dans le cas contraire.

Voici ce à quoi ressemble le LookML de notre nouvelle dimension:

dimension: from_ca_or_ny {
  type: yesno
  sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}

Ajoutez cette dimension au fichier de vue user, puis cliquez sur le bouton Enregistrer les modifications dans le fichier.

Consultez les opérateurs de substitution pour en savoir plus sur ${TABLE}.state.

Créer une mesure

Nous allons ensuite ajouter à la vue user une nouvelle mesure permettant de connaître l'âge moyen de nos utilisateurs. Cette mesure sera type: average et agrégée sur la colonne age.

Voici ce à quoi ressemble le LookML pour cette nouvelle mesure:

measure: average_age {
  type: average
  sql: ${TABLE}.age ;;
}

Ajoutez cette mesure au fichier de vue user, puis cliquez sur le bouton Save Changes (Enregistrer les modifications) dans le fichier.

Tester les champs de l'onglet "Explorer"

Vous pouvez tester vos nouvelles dimensions et les mesurer en les interrogeant. Une fois les modifications enregistrées, ces champs apparaissent dans l'outil de sélection des champs de l'onglet "Explorer". Utilisez le menu déroulant Afficher les actions sur les fichiers à côté du nom du fichier d'affichage afin d'accéder facilement à l'exploration pour la vue actuelle. Le menu déroulant Afficher les actions sur les fichiers liste les explorations basées sur la vue, y compris celles auxquelles la vue est associée. Par exemple, pour accéder à l'exploration pour une vue appelée users, vous pouvez sélectionner l'option Explorer les utilisateurs dans le menu déroulant Voir les actions sur les fichiers.

Dans la section Utilisateurs, vous pouvez sélectionner les nouveaux champs pour les ajouter à une requête. Par exemple, vous pouvez créer une requête avec les deux nouveaux champs qui montrent l'âge moyen des utilisateurs qui proviennent de Californie et de New York et l'âge moyen des utilisateurs qui ne sont pas:

Remarque :Vous devez être en mode développement pour accéder à ces nouveaux champs jusqu'à ce que vous ayez validé et appliqué vos modifications en production.

Valider votre LookML

Une fois que vous êtes satisfait de vos modifications, vous pouvez les enregistrer. L'IDE vous alerte en cas d'erreurs de syntaxe non résolues dans un seul fichier.

Ensuite, utilisez l'outil de validation LookML pour valider le modèle complet. Certaines erreurs, comme une référence de champ non valide en raison d'une jointure manquante, nécessitent un examen global du modèle. Elles ne s'affichent donc que lorsque l'outil de validation LookML est en cours d'exécution. Veillez à valider vos modifications LookML avant de les publier dans l'environnement de production. La validation n'identifie pas tous les problèmes, tels que ceux liés aux autorisations de base de données, mais elle permet d'éviter la plupart des erreurs.

Remarque :l'outil de validation LookML ne doit pas être confondu avec l'outil de validation de contenu, qui vérifie plutôt si les modifications que vous avez apportées entraînent des dysfonctionnements dans les styles enregistrés.

L'outil de validation LookML analyse uniquement les fichiers LookML mis à jour depuis la dernière validation LookML, ou les fichiers concernés par les mises à jour:

• Si un paramètre au niveau du modèle change, tout est à nouveau validé.
• Si une vue change, seules les explorations où elle est utilisée sont à nouveau validées.
• Si une exploration change, seule cette exploration est à nouveau validée.

Conseil :Si vous constatez que la validation LookML prend beaucoup de temps, vous devez d'abord vérifier le paramètre include dans le fichier de modèle. Si vous incluez tous vos fichiers de vues (include: "*.view"), l'outil de validation LookML devra tous les vérifier, ce qui peut affecter les performances. Dans ce cas, mettez à jour le paramètre include du fichier de modèle afin d'inclure uniquement les fichiers de vue nécessaires.

Validation en cours

Pour exécuter l'outil de validation LookML, cliquez sur le bouton Valider LookML en haut à droite de l'IDE Looker, ou sélectionnez l'icône État du projet en haut de l'IDE pour ouvrir le panneau État du projet, puis cliquez sur le bouton Valider le LookML.

Après avoir exécuté l'outil de validation LookML, une liste d'erreurs et d'autres avertissements peut s'afficher. Vous pouvez sélectionner n'importe quelle flèche pour développer la liste des erreurs ou des avertissements.

Le bouton de validation du panneau État du projet redeviendra disponible si vous effectuez et enregistrez une autre modification.

Messages de validation

Looker affiche des messages de validation après l'exécution de la validation sur votre LookML.

Remarque :Les tableaux de bord LookML affichent des messages d'information plutôt que des avertissements dans la barre latérale lorsque la localisation autorisée est activée.

Aucune erreur LookML détectée

Lorsqu'aucun problème n'est détecté par le programme de validation, Looker affiche une coche verte avec le texte Aucune erreur LookML détectée.

Erreurs LookML

Les erreurs LookML sont des problèmes susceptibles d'empêcher l'exécution de requêtes. Le nombre entre parenthèses correspond au nombre d'erreurs détectées (neuf dans l'exemple suivant):

La liste étendue de problèmes indique le motif de l'échec de la validation. Souvent, si vous cliquez sur l'erreur, vous accéderez directement à la ligne de code problématique. Un "X " rouge s'affiche à côté de la ligne. Pointez dessus pour obtenir des informations plus détaillées sur l'erreur dans certains cas:

Conseil de l'équipe du chat: l'erreur de validation qui nous intéresse le plus est "Champ inconnu ou inaccessible". Consultez la page sur les bonnes pratiques concernant les erreurs: champ inconnu ou inaccessible pour en connaître les causes et les solutions.

Avertissements LookML

Si les avertissements LookML n'empêchent pas l'exécution d'une requête, ils peuvent toujours entraîner un dysfonctionnement ou une fonctionnalité inattendue pour vos utilisateurs. Comme pour les erreurs, le nombre entre parenthèses correspond au nombre d'avertissements détectés (trois dans l'exemple suivant):

Comme pour les erreurs LookML, vous pouvez développer les avertissements et accéder au code du problème en le sélectionnant dans le panneau Project Health (État du projet), puis en pointant sur l'icône rouge X pour afficher plus d'informations:

Déployer vos modifications

Après avoir vérifié que vos modifications fonctionneront correctement, vous pourrez intégrer et déployer vos modifications en production à l'aide de l'intégration Git de Looker.

Remarque :Si vous modifiez les noms de champs qui servent de filtres dans vos styles ou tableaux de bord, veillez à consulter la section Filtres dans les styles et tableaux de bord planifiés, et mettez à jour les filtres si nécessaire. Si une diffusion de contenu programmée comprend des filtres qui ne fonctionnent plus (par exemple, si le champ référencé a changé), la diffusion planifiée risque d'exposer des données non filtrées.