Gerenciar arquivos e pastas do LookML

Os arquivos de projeto do LookML são organizados em pastas na seção do navegador de arquivos do Looker IDE. Esta página traz instruções sobre como criar e gerenciar pastas e arquivos em um projeto do LookML.

Para saber mais sobre a estrutura e a finalidade de cada tipo de arquivo em um projeto do LookML, consulte a página de documentação Tipos de arquivos em um projeto do LookML.

Convenções de nomenclatura importantes para arquivos e pastas

Ao criar arquivos e pastas, lembre-se das seguintes convenções de nomenclatura:

  • Diferenciação entre maiúsculas e minúsculas:o LookML diferencia maiúsculas de minúsculas. Siga as convenções do projeto ao nomear as pastas. Por exemplo, se a convenção for usar todas as letras minúsculas no projeto, nomeie a pasta como views em vez de Views. Isso faz diferença principalmente quando você precisa especificar o caminho de um arquivo, como ao incluir arquivos. Em geral, é recomendável usar letras minúsculas de forma consistente ao nomear objetos e pastas do LookML.
  • Espaços e caracteres especiais:os nomes de arquivos não podem incluir espaços nem os seguintes caracteres: / ? * : | " < > %
  • Extensões de arquivo:ao criar arquivos do LookML com o IDE do Looker, o Looker vai adicionar automaticamente a extensão .lkml ao final do nome do arquivo se você não incluir a extensão manualmente. Por exemplo, se você digitar o nome de arquivo flights_data_tests, o Looker vai nomear o arquivo como flights_data_tests.lkml.
  • Como mudar o nome exibido de um objeto do LookML:se você quiser mudar o nome exibido de um modelo ou objeto do LookML, use o parâmetro label ou alias em vez de renomear o arquivo ou objeto. Os parâmetros label e alias mudam o nome exibido, preservando o URL usado para e-mails ou outros sistemas. Em geral, tome cuidado para fazer as mudanças no modelo de forma não invasiva. Se você precisar renomear um modelo ou objeto, use o Validador de conteúdo para atualizar todas as referências a ele.

Como criar pastas

É possível criar pastas para diferentes tipos de arquivo, como arquivos de visualização ou arquivos de modelo. Você pode até criar subpastas, o que é muito útil se quiser include um subconjunto de visualizações.

Para criar uma pasta:

  1. Selecione a opção Create Folder no menu apropriado:
    • Para criar uma nova pasta no nível superior da estrutura de diretórios, use o menu Adicionar arquivo ou pasta. Para acessar, selecione o ícone + (sinal de adição) na parte de cima do painel Pesquisador de arquivos.
    • Para criar uma nova subpasta em uma pasta existente, use o menu de Opções da pasta com três pontos.
  2. Digite um nome para a nova pasta.
  3. Selecione Criar.

A nova pasta é adicionada ao painel de navegação.

Criação de arquivos

O Looker cria automaticamente um arquivo de modelo e arquivos de visualização com base no seu banco de dados quando você gera um modelo. Para projetos existentes, é possível criar novos arquivos manualmente.

Para criar um novo arquivo no projeto do LookML:

  1. Selecione o menu apropriado:

    • Para criar um novo arquivo no nível superior da estrutura de diretórios, use o menu Adicionar arquivo ou pasta, que pode ser acessado selecionando o ícone + (sinal de adição) na parte de cima do painel Pesquisador de arquivos.
    • Para criar um novo arquivo em uma pasta, use o menu de Opções de pasta com três pontos.

  2. Selecione o tipo de arquivo LookML que você quer criar. Selecione os links na lista a seguir para conferir uma descrição mais detalhada de cada tipo de arquivo. É possível criar os seguintes tipos de arquivos:

  3. Na caixa de diálogo Create File, insira um nome para o novo arquivo. Consulte a seção Convenções de nomenclatura de arquivos e pastas importantes para ver limitações e diretrizes sobre como nomear arquivos.

  4. Selecione Criar. O novo arquivo será exibido onde foi criado. Você pode mover para outra pasta se necessário.

Considerações sobre a criação de arquivos

Considere o seguinte ao criar arquivos:

  • Recomendamos que você use o IDE do Looker para adicionar arquivos ao seu projeto do LookML criando-os no IDE do Looker ou fazendo upload deles no IDE do Looker. Se você criar arquivos fora do ambiente de desenvolvimento integrado do Looker e usar o ambiente de desenvolvimento integrado do Looker para extrair do (ramo de produção), use as convenções de nomenclatura corretas e inclua a extensão .lkml no nome do arquivo (ou explore.lkml para arquivos do Explore). Se um nome de arquivo incluir caracteres não compatíveis, o navegador de arquivos do Looker IDE vai mostrar o nome em vermelho, e você não vai conseguir acessar o conteúdo do arquivo até renomear o arquivo com caracteres compatíveis. Além disso, o IDE do Looker não vai mostrar o arquivo se ele não tiver a extensão .lkml.
  • Depois de criar um arquivo, use o parâmetro include se quiser fazer referência a elementos dele em outros arquivos do LookML do seu projeto. Consulte a página de documentação do parâmetro include para mais informações.
  • Se você criar um arquivo aninhado em sete ou mais pastas, o File Explorer não vai exibir o arquivo.
  • Os arquivos de manifesto do projeto só podem ser criados selecionando o ícone + (sinal de adição) para abrir o menu Add file or folder na parte de cima do navegador de arquivos no ambiente de desenvolvimento integrado do Looker e somente se o projeto ainda não tiver um arquivo de manifesto. Isso ocorre porque um projeto pode ter apenas um arquivo de manifesto, e ele precisa estar localizado no nível raiz da estrutura de diretórios do projeto.
  • A opção Create Locale Strings File só está disponível no ícone + (sinal de adição) Adicionar arquivo ou pasta na parte de cima do navegador de arquivos no ambiente de desenvolvimento integrado do Looker. No entanto, depois que um arquivo de strings de localidade for criado (ou carregado), você poderá mover o arquivo para uma pasta. Se você estiver criando arquivos de strings de localidade para localizar seu modelo e também quiser aproveitar a localização da interface integrada do Looker, nomeie os arquivos de strings usando códigos de localidade específicos, que podem ser encontrados na seção Localidade da página de documentação Usuários.
  • Ao criar um arquivo do Google Analytics, ele precisa ter a extensão .explore.lkml no final do nome do arquivo. Se você estiver fazendo upload do arquivo, use a extensão .explore.lkml completa. Se você usar o IDE do Looker para criar o arquivo com a opção Arquivos genéricos do LookML, o Looker vai adicionar .lkml ao final do nome do arquivo se a extensão não estiver lá, mas você ainda precisa adicionar manualmente a parte .explore da extensão ao nome do arquivo. Por exemplo, para criar um arquivo de análise detalhada chamado flights usando o ambiente de desenvolvimento integrado do Looker, insira flights.explore ou flights.explore.lkml. O arquivo será nomeado flights.explore.lkml.

Considerações para criar arquivos de visualização

A maioria dos desenvolvedores do LookML começa com um ou mais arquivos de visualização que são criados automaticamente quando o projeto do LookML é gerado a partir de um conjunto de tabelas em um banco de dados. No entanto, além dos métodos descritos nesta página para criar arquivos de visualização em branco e fazer upload de arquivos, há muitas maneiras de um desenvolvedor do Looker no modo de desenvolvimento adicionar arquivos de visualização a um projeto do LookML:

Para usar uma nova visualização, adicione-a ao arquivo de modelo usando o parâmetro explore ou use o parâmetro join para unir a uma Análise existente no arquivo de modelo.

Como adicionar uma nova visualização a partir de uma tabela de banco de dados

É possível criar um arquivo de visualização a partir de uma tabela de banco de dados no Modo de desenvolvimento.

  1. Em um projeto, selecione o menu Add file or folder clicando no + (sinal de adição) na parte de cima da lista de arquivos do projeto no IDE do Looker ou selecione o menu de uma pasta para criar o arquivo dentro dela.

  2. Selecione Criar visualização da tabela.

  3. O Looker mostra uma lista de tabelas associadas a uma das suas conexões. Para mudar a conexão, use o menu suspenso Conexão no canto superior esquerdo.

  4. Selecione as tabelas que você quer usar para criar visualizações marcando a caixa à esquerda do nome da tabela. É possível fechar e abrir bancos de dados ou esquemas nessa lista para acessar todas as tabelas disponíveis.

  5. Vá até a parte de baixo da página e selecione Criar visualizações.

  6. O Looker gera visualizações com o LookML para todas as colunas da tabela.

Fazer upload de arquivos

Também é possível fazer upload de arquivos para o projeto do seu computador. Isso é útil se você criou arquivos de dados JSON ou LookML localmente no computador.

Para fazer upload de um arquivo para o projeto, use a função de arrastar e soltar no ambiente de desenvolvimento integrado do Looker para seguir estas etapas:

  1. Navegue até os arquivos do projeto.
  2. Arraste o arquivo do seu computador para o ambiente de desenvolvimento integrado do Looker. O arquivo vai aparecer na raiz da estrutura de diretórios.
  3. Depois que o arquivo for enviado, mova o item para outra pasta.

Como excluir arquivos e pastas

Ao excluir uma pasta, o conteúdo dela também é removido. Portanto, tenha cuidado ao excluir pastas. Antes de excluir uma pasta, siga estas etapas:

Para excluir uma pasta ou um arquivo, selecione Excluir no menu de três pontos Opções de arquivo do item no painel esquerdo do ambiente de desenvolvimento integrado.

Quando você exclui uma pasta, o ambiente de desenvolvimento integrado mostra uma caixa de diálogo de confirmação. A caixa de diálogo especifica quantos itens são incluídos na exclusão, incluindo a pasta e todos os arquivos dentro dela.

Se você excluir um arquivo de modelo, ele não será removido dos conjuntos de modelos aos quais pertencia. Se um novo arquivo de modelo for criado com o mesmo nome de um modelo excluído, o novo modelo será incluído em todos os conjuntos de modelos que incluíam o modelo excluído. Isso pode resultar em acesso indesejado ao novo arquivo de modelo. Os administradores do Looker podem editar conjuntos de modelos e remover um modelo excluído para evitar esse problema.

Excluir arquivos e pastas em massa

Ao excluir uma pasta, o conteúdo dela também é removido. Portanto, tenha cuidado ao excluir pastas. Antes de excluir uma pasta, siga estas etapas:

Para excluir pastas e arquivos em massa, siga estas etapas:

  1. Selecione o ícone Editar em massa na parte de cima do painel Navegador de arquivos.

  2. Selecione os itens que você quer excluir. O número de arquivos selecionados é exibido ao lado do cabeçalho Selecionar arquivos.

    • Para selecionar ou desmarcar arquivos individuais, abra as pastas e marque a caixa de seleção ao lado dos nomes dos arquivos.
    • Para selecionar ou desmarcar pastas inteiras e o conteúdo delas, marque a caixa de seleção ao lado do nome da pasta.
    • Para selecionar uma seção inteira da lista de diretórios, use Shift + clique. Marque a caixa de seleção do item de cima do intervalo e mantenha a tecla Shift pressionada. Depois, marque a caixa de seleção do último item da lista. Os dois itens e todos os itens entre eles serão selecionados. Você também pode pressionar Shift e clicar em um item para selecionar esse item e todos os itens anteriores na lista de diretórios.

  3. Selecione o ícone da lixeira Delete Items. O ambiente de desenvolvimento integrado vai mostrar uma caixa de diálogo com os itens selecionados.

  4. Confirme os itens a serem excluídos selecionando Sim, excluir ou retorne à seleção de itens selecionando Cancelar.

  5. Selecione o X no cabeçalho Selecionar arquivos para sair do modo de edição em massa.

Como mover itens em um projeto com pastas

Para mover arquivos, arraste um arquivo ou uma pasta para outra pasta.

A pasta de destino não precisa ser expandida para receber outras pastas ou arquivos. Uma pasta é expandida automaticamente quando você passa o cursor sobre ela.

Quando você muda o caminho de um arquivo, atualize todas as instruções include no projeto para corresponder ao novo caminho. Consulte a seção Usar include com pastas do ambiente de desenvolvimento integrado da página de documentação do parâmetro include para informações sobre como usar include com pastas do ambiente de desenvolvimento integrado.

Além disso, quando você muda o caminho de um arquivo, o Git exclui o arquivo e cria um novo com o novo caminho. Isso significa que o histórico do Git para o arquivo estará vazio, porque o Git o considera um novo arquivo. Para conferir o histórico do Git do arquivo antes da mudança, use a interface do Git para navegar até o arquivo no local original e acessar o histórico do Git. A mesma lógica se aplica a um arquivo renomeado, já que o Git exclui o arquivo e cria um novo com um nome diferente.

Mover arquivos e pastas em massa

Para mover pastas e arquivos em massa:

  1. Selecione o ícone Editar em massa na parte de cima do painel Navegador de arquivos.

  2. Selecione os itens a serem movidos. O número de arquivos selecionados é exibido ao lado do cabeçalho Selecionar arquivos.

    • Para selecionar ou desmarcar arquivos individuais, abra as pastas e marque a caixa de seleção ao lado dos nomes dos arquivos.
    • Para selecionar ou desmarcar pastas inteiras e o conteúdo delas, marque a caixa de seleção ao lado do nome da pasta.
    • Para selecionar uma seção inteira da lista de diretórios, use Shift + clique. Marque a caixa de seleção do item de cima do intervalo e mantenha a tecla Shift pressionada. Depois, marque a caixa de seleção do último item da lista. Os dois itens e todos os itens entre eles serão selecionados. Você também pode pressionar Shift e clicar em um item para selecionar o item e todos os arquivos anteriores na lista de diretórios.

  3. Selecione o ícone da pasta Mover itens para selecionar a opção. O ambiente de desenvolvimento integrado vai mostrar uma caixa de diálogo de seleção de pastas.

  4. Na caixa de diálogo Mover para, escolha uma pasta para os itens selecionados ou selecione Nova pasta para criar uma. O nome do projeto vai mostrar o caminho da pasta selecionada na parte de cima da próxima página do menu. Para mover itens para o diretório raiz do projeto, selecione Mover sem uma pasta selecionada.

  5. Confirme o destino selecionado selecionando Mover, crie uma nova pasta na pasta selecionada selecionando Nova pasta ou volte ao menu principal de opções de pastas selecionando o link do nome do projeto no caminho.

  6. Selecione o X no cabeçalho Selecionar arquivos para sair do modo de edição em massa.

Depois de mudar o caminho de um arquivo, atualize todas as instruções include no projeto para corresponder ao novo caminho. Consulte a seção Usar include com pastas do ambiente de desenvolvimento integrado da página de documentação do parâmetro include para informações sobre como usar include com pastas do ambiente de desenvolvimento integrado.

Além disso, quando você muda o caminho de um arquivo, o Git exclui o arquivo e cria um novo com o novo caminho. Isso significa que o histórico do Git para o arquivo estará vazio, porque o Git o considera um novo arquivo. Para conferir o histórico do Git do arquivo antes da mudança, use a interface do Git para navegar até o arquivo no local original e acessar o histórico do Git. A mesma lógica se aplica a um arquivo renomeado, já que o Git exclui o arquivo e cria um novo com um nome diferente.