Gestion des fichiers et dossiers LookML

Les fichiers de projet LookML sont organisés en dossiers dans la section de l'explorateur de fichiers de l'IDE Looker. Cette page fournit des instructions pour créer et gérer des dossiers et des fichiers dans un projet LookML.

Pour en savoir plus sur la structure et l'objectif de chaque type de fichier dans un projet LookML, consultez la page de documentation Types de fichiers dans un projet LookML.

Avant de commencer: conventions importantes pour l'attribution de noms aux fichiers et aux dossiers

Lorsque vous créez des fichiers et des dossiers, il est préférable de garder à l’esprit les conventions de nommage suivantes:

• Sensibilité à la casse : LookML est sensible à la casse. Veillez à respecter les conventions de votre projet lorsque vous nommez vos dossiers. Par exemple, si votre convention consiste à utiliser toutes les lettres minuscules dans votre projet, nommez votre dossier views au lieu de Views. Cela est particulièrement utile lorsque vous devez spécifier le chemin d'accès à un fichier, par exemple lorsque vous ajoutez des fichiers. Nous recommandons généralement d'utiliser systématiquement des minuscules pour nommer des objets et des dossiers LookML.
• Espaces et caractères spéciaux:les noms de fichiers ne doivent pas inclure d'espaces ni aucun des caractères suivants: / ? * : | " < > %
• Extensions de fichier:lors de la création de fichiers LookML avec l'IDE Looker, Looker ajoute automatiquement l'extension .lkml à la fin du nom de fichier si vous n'incluez pas l'extension manuellement. Par exemple, si vous saisissez le nom de fichier flights_data_tests, Looker nommera le fichier flights_data_tests.lkml.
• Modifier le nom affiché d'un objet LookML:si vous souhaitez changer le nom affiché d'un modèle ou d'un objet LookML, utilisez le paramètre label ou alias au lieu de renommer le fichier ou l'objet. Les paramètres label et alias modifient le nom affiché tout en conservant l'URL sous-jacente utilisée pour les e-mails ou d'autres systèmes. En général, vous devez prendre des précautions pour que les modifications apportées au modèle soient aussi peu invasives que possible. Si vous avez besoin de renommer un modèle ou un objet, utilisez l'outil de validation de contenu pour mettre à jour toutes les références à ce modèle ou à cet objet.

Créer des dossiers

Vous pouvez créer des dossiers pour différents types de fichiers (par exemple, des fichiers de vue ou des fichiers de modèle). Vous pouvez même créer des sous-dossiers, ce qui est très utile si vous souhaitez include un sous-ensemble de vos vues.

Remarque :Lorsque vous créez des dossiers, n'oubliez pas que LookML est sensible à la casse. Veillez à respecter les conventions de votre projet lorsque vous nommez vos dossiers. Cette étape est importante, en particulier lorsque vous devez spécifier le chemin d'accès à un fichier, par exemple lors de l'inclusion de fichiers. En règle générale, il est conseillé d'utiliser systématiquement des lettres minuscules pour nommer les objets et dossiers LookML. Consultez les conseils importants pour créer des fichiers et des dossiers pour connaître les limites et les consignes de dénomination.

Pour créer un dossier, procédez comme suit :

1. Sélectionnez l'option Créer un dossier dans le menu approprié:
   • Pour créer un dossier au premier niveau de votre structure de répertoires, utilisez le menu Ajouter un fichier ou un dossier, accessible en sélectionnant l'icône + (plus) en haut du panneau Explorateur de fichiers.
   • Pour créer un sous-dossier dans un dossier existant, utilisez le menu à trois points Options de dossier du dossier existant.
2. Saisissez un nom pour le nouveau dossier.
3. Sélectionnez Créer.

Le nouveau dossier est ajouté au volet de navigation.

Création de fichiers

Vous pouvez générer automatiquement un fichier de modèle et afficher des fichiers basés sur votre base de données lorsque vous créez un projet. Pour les projets existants, vous pouvez créer des fichiers manuellement.

Remarque : Nous vous recommandons d'utiliser l'IDE Looker pour ajouter des fichiers à votre projet LookML, soit en les créant dans l'IDE Looker comme décrit plus loin dans cette section, soit en les important dans l'IDE Looker. Si vous créez des fichiers en dehors de l'IDE Looker, puis utilisez l'IDE Looker pour Extraire de (branche de production), veillez à utiliser les conventions d'attribution de noms correctes et à inclure l'extension .lkml dans le nom de fichier (ou explore.lkml pour les fichiers d'exploration). Si un nom de fichier inclut des caractères non acceptés, le navigateur de fichiers de l'IDE Looker le met en rouge. Vous ne pourrez pas voir le contenu du fichier tant que vous ne l'aurez pas renommé avec des caractères acceptés. De plus, l'IDE Looker n'affiche pas du tout le fichier s'il n'a pas l'extension .lkml.

Pour créer un fichier dans votre projet LookML :

1. Sélectionnez le menu approprié :

   • Pour créer un fichier au premier niveau de votre structure de répertoires, utilisez le menu Ajouter un fichier ou un dossier, accessible en sélectionnant l'icône + (plus) en haut du panneau Explorateur de fichiers.
   • Pour créer un fichier dans un dossier existant, utilisez le menu à trois points Options de dossier du dossier existant.

2. Sélectionnez le type de fichier LookML que vous souhaitez créer. Sélectionnez les liens de la liste suivante pour obtenir une description plus détaillée de chaque type de fichier. Vous pouvez créer les types de fichiers suivants :

   • Fichiers de modèle avec l'extension .model.lkml
   • Afficher les fichiers portant l'extension .view.lkml*
   • Fichiers manifestes de projet qui sont toujours nommés manifest.lkml**
   • Fichiers de tableau de bord avec l'extension de fichier .dashboard.lookml
   • Fichiers de document avec l'extension de fichier .md
   • Fichiers de chaînes de paramètres régionaux avec l'extension de fichier .strings.json***
   • Fichiers LookML génériques, utilisés pour les types de fichiers suivants :
     • Explorer les fichiers portant l'extension .explore.lkml****
     • Fichiers de test de données avec l'extension de fichier .lkml
     • Fichiers de précisions avec l'extension de fichier .lkml
     • Tous les autres fichiers que vous utilisez pour héberger des éléments LookML
   Remarque :

   ^* Consultez la section Considérations à prendre en compte lors de la création de fichiers de vue de cette page pour découvrir d'autres méthodes de création de fichiers de vue, y compris pour ajouter des fichiers de vue basés sur des tables de base de données.

   ^** : vous ne pouvez créer des fichiers manifestes de projet qu'en sélectionnant l'icône + (plus) pour ouvrir le menu Ajouter un fichier ou un dossier en haut du navigateur de fichiers de l'IDE Looker, et uniquement si le projet ne dispose pas déjà d'un fichier manifeste. En effet, un projet ne peut avoir qu'un seul fichier manifeste, qui doit se trouver au niveau racine de la structure de répertoires du projet.

   ^*** L'option Create Locale Strings File (Créer un fichier de chaînes de paramètres régionaux) n'est disponible que depuis l'icône Add file or folder + (Ajouter un fichier ou un dossier) en haut du navigateur de fichiers de l'IDE Looker. Toutefois, une fois qu'un fichier de chaînes de paramètres régionaux a été créé (ou importé), vous pouvez le déplacer vers un dossier. Si vous créez des fichiers de chaînes de paramètres régionaux pour localiser votre modèle et si vous souhaitez également bénéficier de la localisation native de l'UI de Looker, vous devez nommer vos fichiers de chaînes en utilisant des codes de paramètres régionaux spécifiques, disponibles dans la section "Paramètres régionaux" de la page de documentation Utilisateurs.

   ^**** Lorsque vous créez un fichier d'exploration, il doit comporter l'extension .explore.lkml à la fin de son nom. Si vous importez le fichier, vous devez utiliser l'extension .explore.lkml complète. Si vous utilisez l'IDE Looker pour créer le fichier avec l'option Fichiers LookML génériques, Looker ajoute .lkml à la fin du nom de fichier si l'extension n'est pas présente. Vous devez toutefois ajouter manuellement la partie .explore de l'extension au nom de fichier. Par exemple, pour créer un fichier d'exploration appelé flights à l'aide de l'IDE Looker, vous pouvez saisir flights.explore ou flights.explore.lkml. Le fichier sera nommé flights.explore.lkml.

3. Dans le pop-up Créer un fichier, saisissez un nom pour le nouveau fichier. Consultez les conseils importants pour créer des fichiers et des dossiers pour connaître les limites et les consignes de dénomination de vos fichiers.

4. Sélectionnez Créer. Le nouveau fichier s'affiche à l'endroit où vous l'avez créé. Si nécessaire, vous pouvez facilement le déplacer vers un autre dossier.

Important :Une fois le fichier créé, veillez à utiliser le paramètre include si vous souhaitez faire référence à des éléments du fichier dans d'autres fichiers LookML de votre projet. Pour en savoir plus, consultez la page de documentation sur le paramètre include.

Remarque :Si votre administrateur Looker a activé la fonctionnalité de laboratoire Amélioration de la génération LookML, le menu Ajouter un fichier ou un dossier + (plus) en haut du panneau Explorateur de fichiers affichera une option Générer LookML à partir d'une base de données en plus des options listées ici.

Éléments à prendre en compte pour créer des fichiers de vue

La plupart des développeurs LookML commencent avec un ou plusieurs fichiers de vue qui sont créés automatiquement lorsque le projet LookML est généré à partir d'un ensemble de tables d'une base de données. Toutefois, en plus des méthodes décrites sur cette page pour créer des fichiers de vue vides et importer des fichiers, un développeur Looker en mode Développement peut ajouter des fichiers de vue à un projet LookML de plusieurs manières:

• Créer des fichiers de vue basés sur des tables d'une base de données :

  • Générer des fichiers de vue à partir de tables de base de données lorsque vous vous connectez pour la première fois à votre base de données, comme décrit sur la page de documentation Générer un modèle
  • Générer des fichiers de vue à partir de tables de base de données pour un projet déjà connecté à une base de données, comme décrit dans la section Ajouter une vue à partir d'une table de base de données existante de cette page

• Créer un fichier de vue pour une table dérivée:

  • Commencer avec un fichier de vue vierge en utilisant l'une des options décrites sur cette page, puis définir manuellement votre table dérivée, comme décrit dans la section Définir une table dérivée native dans LookML de la page de documentation Créer des tables dérivées natives
  • Laisser Looker créer le code LookML de la table dérivée à partir d'une exploration, comme décrit dans la section Définition de vos tables dérivées natives à partir d'une exploration de la page de documentation Créer des tables dérivées natives
  • Faire en sorte que Looker crée la table dérivée LookML à partir d'une requête SQL Runner, comme décrit sur la page de documentation Utiliser SQL Runner pour créer des tables dérivées

Pour utiliser une nouvelle vue, ajoutez-la à votre fichier de modèle à l'aide du paramètre explore ou utilisez le paramètre join pour la joindre à une exploration existante dans votre fichier de modèle.

Ajouter une vue à partir d'une table de base de données existante

Vous pouvez créer un fichier de vue à partir d'une table de base de données existante en mode Développement.

1. Dans un projet, sélectionnez le menu Ajouter un fichier ou un dossier en cliquant sur le signe + (plus) en haut de la liste des fichiers du projet dans l'IDE Looker. Vous pouvez également sélectionner le menu d'un dossier pour créer le fichier dans le dossier.

2. Sélectionnez Créer une vue à partir d'une table.

3. Looker affiche la liste des tables associées à l'une de vos connexions. Pour modifier la connexion, utilisez la liste déroulante Connexion en haut à gauche.

4. Cochez les cases à gauche des tables à partir desquelles vous souhaitez créer des vues. Vous pouvez réduire et développer les bases de données ou les schémas de cette liste pour accéder à toutes les tables disponibles.

5. Faites défiler la page jusqu'en bas, puis sélectionnez Créer des vues.

6. Looker génère des vues contenant du code LookML pour toutes les colonnes de la table.

Importer des fichiers

Vous pouvez également importer des fichiers dans votre projet depuis votre ordinateur. Cela est utile si vous avez créé des fichiers de données JSON ou des fichiers LookML localement sur votre ordinateur.

Remarque : Consultez les conseils importants pour créer des fichiers et des dossiers pour connaître les limites et les consignes de nommage des fichiers.

Pour importer un fichier dans votre projet, utilisez la fonction glisser-déposer dans l'IDE Looker:

1. Accédez aux fichiers de votre projet.
2. Faites glisser le fichier depuis votre ordinateur vers l'IDE Looker. Le fichier sera affiché à la racine de votre structure de répertoires.
3. Une fois le fichier importé, déplacez l'élément vers un autre dossier.

Important : Une fois le fichier importé, veillez à utiliser le paramètre include si vous souhaitez référencer le fichier ou des éléments du fichier dans d'autres fichiers LookML de votre projet. Pour en savoir plus, consultez la page de documentation du paramètre include.

Supprimer des fichiers et des dossiers

Pour supprimer un dossier ou un fichier, sélectionnez Delete (Supprimer) dans le menu à trois points File Options (Options de fichier) de l'élément dans le panneau de gauche de l'IDE.

Remarque : La suppression d'un dossier entraîne également la suppression de son contenu. Soyez donc prudent lorsque vous supprimez des dossiers. Avant de supprimer un dossier, procédez comme suit :

• Vérifiez que vous souhaitez supprimer les fichiers du dossier ou les déplacer vers un autre emplacement avant de supprimer le dossier.
• Vérifiez que le dossier ne contient aucun fichier référencé dans les instructions include de votre projet. Pour savoir comment utiliser include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation du paramètre include.

Lorsque vous supprimez un dossier, l'IDE affiche un pop-up de confirmation. Le pop-up indique le nombre d'éléments inclus dans la suppression, y compris le dossier et les fichiers qu'il contient.

Remarque : Si vous supprimez un fichier de modèle, le modèle n'est pas supprimé des ensembles de modèles auxquels il appartenait. Si un fichier de modèle est créé avec le même nom qu'un modèle supprimé, le nouveau modèle est inclus dans tous les ensembles de modèles qui incluaient le modèle supprimé. Cela peut donner lieu à un accès indésirable au nouveau fichier de modèle. Pour éviter ce problème, les administrateurs Looker peuvent modifier les ensembles de modèles et supprimer un modèle supprimé.

Supprimer des fichiers et des dossiers de manière groupée

Pour supprimer plusieurs dossiers et fichiers simultanément :

Remarque :La suppression d'un dossier entraîne celle de tout son contenu. Avant de supprimer un dossier, vérifiez que vous souhaitez supprimer les fichiers qu'il contient. Si vous souhaitez les conserver, déplacez-les vers un autre emplacement avant de supprimer le dossier.

1. Sélectionnez l'icône Modification groupée en haut du panneau Explorateur de fichiers.

   

2. Sélectionnez les éléments à supprimer. Le nombre de fichiers sélectionnés s'affiche à côté de l'en-tête Sélectionner des fichiers.

   

   • Pour sélectionner ou désélectionner des fichiers individuels, développez leurs dossiers, puis cochez la case à côté de leur nom de fichier.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté du nom du dossier.
   • Pour sélectionner une section entière de la liste des répertoires, maintenez la touche Maj enfoncée tout en cliquant. Cochez la case correspondant à l'élément situé en haut de la plage, puis maintenez la touche Maj enfoncée et cochez la case correspondant au dernier élément de la liste. Les éléments sélectionnés, ainsi que tous ceux qui se trouvent entre les deux, sont sélectionnés. Vous pouvez également cliquer sur un élément en appuyant sur la touche Maj pour le sélectionner, ainsi que tout ce qui se trouve au-dessus de lui dans la liste du répertoire.

3. Sélectionnez l'icône Corbeille Supprimer des éléments. L'IDE affiche alors un menu pop-up listant les éléments sélectionnés.

   

4. Confirmez les éléments à supprimer en sélectionnant Oui, supprimer, ou revenez à la sélection d'éléments en sélectionnant Annuler.

5. Sélectionnez le X dans l'en-tête Sélectionner des fichiers pour quitter le mode de modification groupée.

Déplacer des éléments dans un projet organisé en dossiers

Pour déplacer des fichiers, glissez-déposez un fichier ou un dossier dans un autre dossier.

Il n'est pas nécessaire de développer le dossier de destination pour recevoir d'autres dossiers ou fichiers. Un dossier se développe automatiquement lorsque vous le survolez avec la souris.

Remarque : Lorsque vous modifiez le chemin d'accès d'un fichier, veillez à mettre à jour toutes les instructions include de votre projet pour qu'elles correspondent au nouveau chemin d'accès. Consultez la section Utiliser include avec des dossiers IDE de la page de documentation du paramètre include pour en savoir plus sur l'utilisation de include avec des dossiers IDE.

Sachez également que lorsque vous modifiez le chemin d'accès à un fichier, Git le supprime et crée un nouveau fichier avec le nouveau chemin d'accès. Cela signifie que l'historique Git du fichier sera vide, car Git le considère comme un nouveau fichier. Pour afficher l'historique Git du fichier avant son déplacement, utilisez votre interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique à un fichier renommé, puisque Git supprime effectivement le fichier et crée un nouveau fichier avec un nom différent.)

Déplacer des fichiers et des dossiers de manière groupée

Pour déplacer des dossiers et des fichiers de manière groupée :

1. Sélectionnez l'icône Modification groupée en haut du panneau Explorateur de fichiers.

   

2. Sélectionnez les éléments à déplacer. Le nombre de fichiers sélectionnés s'affiche à côté de l'en-tête Sélectionner des fichiers.

   

   • Pour sélectionner ou désélectionner des fichiers individuels, développez leurs dossiers, puis cochez la case à côté de leur nom de fichier.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté du nom du dossier.
   • Pour sélectionner une section complète de la liste de répertoires, appuyez sur Maj+clic. Cochez la case de l'élément le plus haut de la plage, puis appuyez sur la touche Maj et cochez la case de l'élément le plus bas de la liste. Les deux éléments et tous les éléments intermédiaires seront sélectionnés. Vous pouvez également cliquer sur un élément tout en maintenant la touche Maj enfoncée pour le sélectionner, ainsi que tout ce qui se trouve au-dessus dans la liste des répertoires.

3. Sélectionnez l'icône de dossier Déplacer les éléments pour sélectionner l'option. L'IDE affiche alors un menu pop-up de sélection de dossier.

   

4. Dans le menu contextuel Déplacer vers, choisissez un dossier pour les éléments sélectionnés ou sélectionnez Nouveau dossier pour créer un dossier. Le nom du projet affiche le chemin d'accès du dossier que vous avez sélectionné en haut de la page de menu suivante. Pour déplacer des éléments vers le répertoire racine de votre projet, sélectionnez Déplacer sans sélectionner de dossier.

5. Confirmez la destination sélectionnée en sélectionnant Déplacer, créez un dossier dans le dossier sélectionné en sélectionnant Nouveau dossier ou revenez au menu d'options principal du dossier en sélectionnant le lien du nom du projet dans le chemin d'accès au fichier.

6. Sélectionnez le X dans l'en-tête Sélectionner des fichiers pour quitter le mode de modification groupée.

Remarque :Après avoir modifié le chemin d'accès à un fichier, veillez à mettre à jour les instructions include de votre projet afin qu'elles correspondent au nouveau chemin d'accès au fichier. Consultez la section Utiliser include avec des dossiers IDE de la page de documentation du paramètre include pour en savoir plus sur l'utilisation de include avec des dossiers IDE.

Sachez également que lorsque vous modifiez le chemin d'accès à un fichier, Git le supprime et crée un nouveau fichier avec le nouveau chemin d'accès. Cela signifie que l'historique Git du fichier sera vide, car Git le considère comme un nouveau fichier. Pour afficher l'historique Git du fichier avant son déplacement, utilisez votre interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git à partir de là. (La même logique s'applique à un fichier renommé, puisque Git supprime effectivement le fichier et crée un nouveau fichier avec un nom différent.)