Gérer des fichiers et des dossiers LookML

Les fichiers de projet LookML sont organisés dans des dossiers dans la section "Explorateur de fichiers" de l'IDE Looker. Cette page explique comment 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 d'attribution de noms importantes pour les fichiers et les dossiers

Lorsque vous créez des fichiers et des dossiers, tenez compte des conventions d'attribution de noms 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 des lettres minuscules dans votre projet, vous pouvez nommer votre dossier views au lieu de Views. Cela fait une différence, en particulier lorsque vous devez spécifier le chemin d'accès d'un fichier, par exemple lorsque vous incluez des fichiers. En règle générale, nous vous recommandons de toujours utiliser des lettres minuscules lorsque vous nommez les objets et les dossiers LookML.
• Espaces et caractères spéciaux:les noms de fichiers ne peuvent pas inclure d'espaces ni les caractères suivants: / ? * : | " < > %
• Extensions de fichier:lorsque vous créez des fichiers LookML avec l'IDE Looker, Looker ajoute automatiquement l'extension .lkml à la fin du nom de fichier si vous ne l'incluez pas 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 modifier le nom affiché d'un modèle ou d'un objet LookML, vous pouvez utiliser les paramètres 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 les autres systèmes. En général, vous devez prendre des précautions pour que les modifications du modèle soient aussi non intrusives que possible. Si vous devez renommer un modèle ou un objet, utilisez l'outil de validation de contenu pour mettre à jour toutes les références au modèle ou à l'objet.

Créer des dossiers

Vous pouvez créer des dossiers pour différents types de fichiers (afficher les fichiers ou les fichiers de modèle, par exemple). 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. C'est important, en particulier lorsque vous devez spécifier le chemin d'accès à un fichier, par exemple lorsque vous incluez des fichiers. En règle générale, nous vous recommandons de toujours utiliser des lettres minuscules lorsque vous nommez les objets et les dossiers LookML. Consultez les notes importantes concernant la création de fichiers et de dossiers pour connaître les limites et les consignes pour l'attribution de noms aux fichiers et dossiers.

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 la structure de votre répertoire, utilisez le menu Ajouter un fichier ou un dossier, accessible en sélectionnant l'icône + (en haut) du panneau Explorateur de fichiers.
   • Pour créer un sous-dossier dans un dossier existant, utilisez le menu à trois points Options du dossier associé au 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 les fichiers de 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 ci-dessous, 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 normes de nommage appropriées et incluez l'extension .lkml dans le nom de fichier (ou explore.lkml pour les fichiers Explorer). Si un nom de fichier contient des caractères non compatibles, l'explorateur de fichiers de l'IDE Looker affiche le nom du fichier en rouge. Vous ne pourrez pas afficher le contenu du fichier tant que vous ne l'aurez pas renommé avec des caractères acceptés. En outre, l'IDE Looker n'affiche pas le fichier s'il ne comporte 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 la structure de votre répertoire, utilisez le menu Ajouter un fichier ou un dossier, accessible en sélectionnant l'icône + (en haut) du panneau Explorateur de fichiers.
   • Pour créer un fichier dans un dossier existant, utilisez le menu à trois points Options du dossier associé au 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 avec l'extension .view.lkml*
   • Fichiers manifestes du projet toujours nommés manifest.lkml**
   • Fichiers du tableau de bord avec l'extension .dashboard.lookml
   • Fichiers de document avec l'extension .md
   • Localez les fichiers de chaînes avec l'extension .strings.json***
   • Fichiers LookML génériques, qui sont utilisés pour les types de fichiers suivants :
     • Explorer des fichiers avec l'extension .explore.lkml****
     • Fichiers de test des données avec l'extension .lkml
     • Affine les fichiers avec l'extension .lkml
     • Tous les autres fichiers que vous utilisez pour héberger des éléments LookML
   Remarque:

   ^* Consultez la section Points à prendre en compte pour créer des fichiers de vue de cette page afin d'obtenir des instructions sur les autres méthodes de création de fichiers de vue (y compris sur l'ajout de fichiers de vue en fonction 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 de l'explorateur de fichiers dans l'IDE Looker. Cela n'est possible que si le projet ne comporte pas déjà de fichier manifeste. En effet, un projet ne peut avoir qu'un seul fichier manifeste, lequel doit se trouver à la racine de sa structure de répertoire.

   ^*** L'option Create Locale Strings File est disponible uniquement via l'icône Add file or folder + (plus) située en haut de l'explorateur de fichiers dans l'IDE Looker, mais une fois qu'un fichier de chaînes locales a été créé (ou importé), vous pouvez le déplacer dans un dossier. Si vous créez des fichiers de chaînes de paramètres régionaux pour localiser votre modèle et que vous souhaitez bénéficier de la localisation native de Looker, vous devez nommer vos fichiers de chaînes à l'aide de codes de paramètres régionaux spécifiques, disponibles dans la section "Paramètres régionaux" de la page Utilisateurs.

   ^**** Lorsque vous créez un fichier Explorer, celui-ci 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 du fichier si l'extension n'est pas présente, mais vous devez tout de même ajouter manuellement la partie .explore du nom du 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 la fenêtre pop-up Créer un fichier, saisissez le nom du nouveau fichier. Consultez les notes importantes concernant la création de fichiers et de dossiers pour connaître les limites et les consignes relatives à l'attribution des noms de fichiers.

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

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

Remarque :Si votre administrateur Looker a activé la fonctionnalité expérimentale Génération LookML, le menu Ajouter un fichier ou un dossier + (plus) en haut du panneau Navigateur de fichiers proposera une option permettant de générer des LookML à partir de la base de données.

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

La plupart des développeurs LookML commencent par un ou plusieurs fichiers de vue créés automatiquement lorsque le projet LookML est généré à partir d'un ensemble de tables dans une base de données. Toutefois, en plus des méthodes décrites sur cette page pour créer des fichiers de vue vierges et pour importer des fichiers, il existe de nombreuses façons pour un développeur Looker en mode Développement d'ajouter des fichiers de vue à un projet LookML:

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

  • Générer des fichiers de vue à partir des 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 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 sur cette page

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

  • Commencez par utiliser un fichier de vue vide en utilisant l'une des options décrites sur cette page, puis définissez 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 Créer des tables dérivées natives.
  • Demandez à Looker de créer le LookML de table dérivée à partir d'un Explore, comme décrit dans la section Utiliser un exploration pour commencer à définir vos tables dérivées natives de la page de documentation Créer des tables dérivées natives.
  • Demander à Looker de créer le LookML de table dérivée à partir d'une requête Runner SQL, comme décrit dans la page de documentation Utiliser l'exécuteur SQL 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 sélectionnant le signe + (plus) en haut de la liste des fichiers du projet dans l'IDE Looker. Vous pouvez aussi sélectionner le menu d'un dossier pour créer le fichier à l'intérieur du dossier.

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

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

4. Pour sélectionner les tables à partir desquelles vous souhaitez créer des vues, cochez la case située à gauche de leur nom. 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 LookML pour toutes les colonnes de la table.

Importer des fichiers

Vous pouvez également importer des fichiers dans votre projet depuis votre ordinateur. Cela peut être utile si vous avez créé des fichiers de données JSON ou des fichiers LookML en local sur votre ordinateur.

Remarque :Consultez les Remarques importantes sur la création des fichiers et des dossiers pour connaître les limites et les consignes relatives à l'attribution des noms de 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 de 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 sur le paramètre include.

Supprimer des fichiers et des dossiers

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

Remarque:La suppression d'un dossier entraîne également celle de son contenu. Par conséquent, soyez prudent lorsque vous supprimez des dossiers. Avant de supprimer un dossier, procédez comme suit :

• Confirmez que vous souhaitez supprimer les fichiers du dossier ou déplacez-les vers un autre emplacement avant de supprimer le dossier.
• Vérifiez que le dossier ne contient aucun fichier mentionné dans les instructions include de votre projet. Pour en savoir plus sur l'utilisation de include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation sur les paramètres include.

Lorsque vous supprimez un dossier, l'IDE affiche un pop-up de confirmation. Le pop-up spécifie le nombre d'éléments à supprimer, y compris le dossier et les fichiers qu'il contient.

Remarque :Si vous supprimez un fichier de modèle, il n'est supprimé d'aucun ensemble de modèles auquel il appartient. Si vous créez un fichier de modèle portant le même nom qu'un modèle supprimé, le nouveau modèle est inclus dans tous les ensembles de modèles qui incluent le modèle supprimé. Cela peut entraîner un accès indésirable au nouveau fichier de modèle. Les administrateurs Looker peuvent modifier des ensembles de modèles et retirer un modèle supprimé pour éviter ce problème.

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

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

Remarque :La suppression d'un dossier entraîne la suppression 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, placez-les à 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 et cochez la case à côté des noms de fichiers.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté de leur nom.
   • Pour sélectionner une section entière de la liste de répertoires, utilisez Maj + clic. Cochez le premier élément de la plage, puis maintenez la touche Maj enfoncée et cochez le dernier élément de la liste. Les é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 pour le sélectionner et tous les éléments situés au-dessus dans la liste des répertoires.

3. Sélectionnez l'icône Supprimer des éléments de la corbeille. L'IDE affiche ensuite un menu contextuel répertoriant 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 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 doté d'un dossier

Vous pouvez glisser-déposer un seul fichier ou un dossier entier avec son contenu dans de nouveaux emplacements:

Glissez-déposez un fichier ou un dossier dans un autre. Il n'est pas nécessaire d'étendre le dossier de destination pour recevoir d'autres dossiers ou fichiers. Un dossier se développe automatiquement lorsque vous pointez dessus.

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

Sachez également que lorsque vous modifiez le chemin d'accès d'un fichier, Git le supprime efficacement et en crée un autre 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 transfert, utilisez l'interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git. (La même logique s'applique pour un fichier renommé, car Git supprime le fichier et crée un autre 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 et cochez la case à côté des noms de fichiers.
   • Pour sélectionner ou désélectionner des dossiers entiers et leur contenu, cochez la case à côté de leur nom.
   • Pour sélectionner une section entière de la liste de répertoires, utilisez Maj + clic. Cochez le premier élément de la plage, puis maintenez la touche Maj enfoncée et cochez le dernier élément de la liste. Les é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 pour le sélectionner et tous les éléments situés au-dessus dans la liste des répertoires.

3. Sélectionnez l'icône Déplacer des éléments pour sélectionner une option. L'IDE affiche ensuite un menu pop-up de sélection des dossiers.

   

4. Dans le menu contextuel Déplacer vers, choisissez un dossier pour les éléments sélectionnés, ou cliquez sur Nouveau dossier pour créer un dossier. Le nom du projet affiche le chemin d'accès au 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 du dossier principal en sélectionnant le lien du nom du projet dans le chemin du fichier.

6. Sélectionnez 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 toutes les instructions include de votre projet pour qu'elles correspondent au nouveau chemin d'accès. Pour en savoir plus sur l'utilisation de include avec des dossiers IDE, consultez la section Utiliser include avec des dossiers IDE de la page de documentation sur les paramètres include.

Sachez également que lorsque vous modifiez le chemin d'accès d'un fichier, Git le supprime efficacement et en crée un autre 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 transfert, utilisez l'interface Git pour accéder au fichier à son emplacement d'origine et afficher l'historique Git. (La même logique s'applique pour un fichier renommé, car Git supprime le fichier et crée un autre fichier avec un nom différent.)