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 fornece instruções para 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.

Antes de começar: convenções importantes de nomenclatura de arquivos e pastas

Ao criar arquivos e pastas, é melhor manter as seguintes convenções de nomenclatura em mente:

• 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 especialmente 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 Looker IDE, o Looker adiciona automaticamente a extensão .lkml ao final do nome do arquivo se você não a incluir 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 e preservam o URL usado para e-mails ou outros sistemas. Em geral, você deve tomar precauções para tornar as alterações no modelo o mais não invasivas possível. 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 das suas visualizações.

Observação: ao criar pastas, lembre-se de que o LookML diferencia maiúsculas de minúsculas. Siga as convenções do seu projeto ao nomear suas pastas. Isso é importante, principalmente quando é necessário 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. Consulte as observações importantes sobre a criação de arquivos e pastas para ver as limitações e diretrizes de nomenclatura.

Para criar uma pasta:

1. Selecione a opção Criar pasta no menu correspondente:
   • Para criar uma nova pasta no nível superior da sua estrutura de diretórios, use o menu Adicionar arquivo ou pasta, que pode ser acessado selecionando o ícone + (mais) na parte superior do painel Navegador 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

É possível gerar automaticamente um arquivo de modelo e visualizar arquivos com base no seu banco de dados ao criar um novo projeto. Para projetos existentes, é possível criar novos arquivos manualmente.

Observação: é recomendável usar o Looker IDE para adicionar arquivos ao seu projeto do LookML, criando-os no Looker IDE, conforme descrito mais adiante nesta seção, ou fazendo o upload deles no Looker IDE. Se, em vez disso, você criar arquivos fora do ambiente de desenvolvimento integrado do Looker e depois usar esse ambiente para extrair de (ramificação 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 de exploração). Se um nome de arquivo incluir caracteres não compatíveis, o navegador de arquivos do Looker IDE vai mostrar o nome do arquivo em vermelho, e você não vai poder acessar o conteúdo do arquivo até renomear o arquivo com caracteres compatíveis. Além disso, o Looker IDE não vai mostrar o arquivo se ele não tiver a extensão .lkml.

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 do diretório, use o menu Adicionar arquivo ou pasta, que pode ser acessado selecionando o ícone + (mais) na parte superior do painel Navegador de arquivos.
   • Para criar um novo arquivo em uma pasta existente, use o menu de três pontos Opções de pasta da pasta existente.

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

   • Arquivos de modelo com a extensão de arquivo .model.lkml
   • Acessar arquivos com a extensão .view.lkml*
   • Arquivos de manifesto do projeto que sempre são nomeados como manifest.lkml**
   • Arquivos de painel com a extensão .dashboard.lookml
   • Arquivos de documento com a extensão .md
   • Arquivos de strings de localidade com a extensão .strings.json***
   • Arquivos do LookML genéricos, que são usados para os seguintes tipos de arquivos:
     • Explorar arquivos com a extensão .explore.lkml****
     • Arquivos de teste de dados com a extensão .lkml
     • Arquivos de refinamentos com a extensão .lkml
     • Qualquer outro arquivo usado para armazenar elementos do LookML
   Observação:

   ^* Consulte a seção Considerações sobre a criação de arquivos de visualização nesta página para ver instruções sobre métodos alternativos para criar arquivos de visualização, incluindo instruções para adicionar arquivos de visualização com base em tabelas de banco de dados.

   ^** 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, que precisa estar localizado no nível raiz da estrutura de diretórios do projeto.

   ^*** A opção Criar arquivo de strings de localidade está disponível apenas no ícone Adicionar arquivo ou pasta + (mais) na parte de cima do navegador de arquivos no ambiente de desenvolvimento integrado do Looker, mas depois que um arquivo de strings de localidade é criado (ou enviado), você pode 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 UI nativa 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 "Explorar", o arquivo precisa ter a extensão .explore.lkml no final do nome. 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.

3. No pop-up Criar arquivo, digite um nome para o novo arquivo. Consulte as observações importantes para criar arquivos e pastas para ver as limitações e diretrizes de nomenclatura.

4. Selecione Criar. O novo arquivo será exibido onde você o criou. Se necessário, você pode mover para outra pasta.

Importante: depois de criar o 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.

Observação: se o administrador do Looker tiver ativado o recurso de laboratórios Improved LookML Generation, o menu Add file or folder + (mais) na parte de cima do painel File Browser vai mostrar uma opção para Generate LookML from Database, além das opções listadas aqui.

Considerações sobre a criação de 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, um desenvolvedor do Looker no modo de desenvolvimento pode adicionar arquivos de visualização a um projeto do LookML de muitas maneiras:

• Como criar arquivos de visualização com base em tabelas em um banco de dados:

  • Geração de arquivos de visualização de tabelas de banco de dados quando você se conecta ao banco de dados pela primeira vez, conforme descrito na página de documentação Como gerar um modelo
  • Gerar arquivos de visualização de tabelas de banco de dados para um projeto que já está conectado a um banco de dados, conforme descrito na seção Adicionar uma nova visualização de uma tabela de banco de dados existente desta página

• Crie um arquivo de visualização para uma tabela derivada:

  • Começar com um arquivo de visualização em branco usando uma das opções descritas nesta página e, em seguida, definir manualmente a tabela derivada, conforme descrito na seção Definir uma tabela derivada nativa no LookML da página de documentação Criar tabelas derivadas nativas
  • O Looker cria o LookML da tabela derivada a partir de uma Análise detalhada, conforme descrito na seção Usar uma análise detalhada para começar a definir suas tabelas derivadas nativas da página de documentação Criar tabelas derivadas nativas.
  • Fazer com que o Looker crie a tabela derivada LookML usando uma consulta do SQL Runner, conforme descrito na página de documentação Como usar o SQL Runner para criar tabelas derivadas.

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 Adicionar arquivo ou pasta selecionando + (sinal de mais) na parte de cima da lista de arquivos do projeto no ambiente de desenvolvimento integrado do Looker ou selecione o menu de uma pasta para criar o arquivo dentro da pasta.

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 recolher e expandir bancos de dados ou esquemas nessa lista para acessar todas as tabelas disponíveis.

5. Role 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 usando seu computador. Isso é útil se você criou arquivos de dados JSON ou arquivos LookML localmente no seu computador.

Observação: consulte as observações importantes para a criação de arquivos e pastas para conhecer as limitações e as diretrizes para nomear seus arquivos.

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

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. Após o upload do arquivo, mova o item para outra pasta.

Importante :depois de fazer upload do arquivo, use o parâmetro include se quiser fazer referência ao arquivo ou a elementos dele em outros arquivos LookML do seu projeto. Consulte a página de documentação do parâmetro include para mais informações.

Como excluir arquivos e pastas

Exclua uma pasta ou um arquivo selecionando Delete no menu de três pontos File Options do item no painel esquerdo do ambiente de desenvolvimento integrado.

Observação: quando uma pasta é excluída, o conteúdo dela também é excluído, portanto, tenha cuidado ao excluir as pastas. Antes de excluir uma pasta, faça o seguinte:

• Confirme que você quer excluir os arquivos da pasta ou mova-os para outro local antes de excluir a pasta.
• Verifique se a pasta não contém arquivos mencionados em instruções include no projeto. 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.

Quando você exclui uma pasta, o ambiente de desenvolvimento integrado mostra um pop-up de confirmação. O pop-up especifica quantos itens serão incluídos na exclusão, incluindo a pasta e todos os arquivos dentro dela.

Observação: 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íram aquele 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

Para excluir pastas e arquivos em massa:

Observação: a exclusão de uma pasta remove todo o conteúdo dela. Antes de excluir uma pasta, verifique se você quer excluir os arquivos contidos nela. Se você quiser mantê-los, mova os arquivos para outro local antes de excluir a pasta.

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 marcar ou desmarcar pastas inteiras e seus conteúdos, marque a caixa de seleção ao lado do nome da pasta.
   • Para selecionar uma seção inteira da lista de diretórios, pressione Shift e 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 itens e todos os itens intermediários serão selecionados. Você também pode pressionar Shift e clicar em um item para selecionar o item e tudo acima dele na lista de diretórios.

3. Selecione o ícone da lixeira Excluir itens. O ambiente de desenvolvimento integrado vai mostrar um menu pop-up 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 em uma pasta

Para mover arquivos, arraste e solte um arquivo ou uma pasta em outra.

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

Observação :ao mudar o caminho de um arquivo, não se esqueça de atualizar as instruções include no projeto para corresponder ao novo caminho. Consulte a seção Como usar include com pastas do ambiente de desenvolvimento integrado da página de documentação do parâmetro include para saber mais 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 do arquivo estará vazio, porque o Git o considera um novo arquivo. Para ver o histórico do Git do arquivo antes de ele ser movido, use sua interface do Git para navegar até o local original e ver o histórico do Git. (A mesma lógica se aplica a um arquivo renomeado, já que o Git exclui efetivamente 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 Edição em massa na parte superior 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 marcar ou desmarcar pastas inteiras e seus conteúdos, 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 itens e todos os itens intermediários serão selecionados. Você também pode simplesmente clicar com a tecla Shift pressionada para selecionar um item e tudo o que estiver acima dele 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 um menu pop-up de seleção de pastas.

   

4. No menu pop-up Mover para, escolha uma pasta para os itens selecionados ou selecione Nova pasta para criar uma nova. O nome do projeto vai mostrar o caminho do arquivo 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 selecionar uma pasta.

5. Selecione Mover para confirmar o destino selecionado, selecione Nova pasta para criar uma pasta ou retorne ao menu principal de opções da pasta selecionando o link do nome do projeto no caminho do arquivo.

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

Observação: depois de mudar o caminho de um arquivo, não se esqueça de atualizar as instruções include no projeto para corresponder ao novo caminho. Consulte a seção Como usar include com pastas do ambiente de desenvolvimento integrado da página de documentação do parâmetro include para saber mais sobre como usar include com pastas do ambiente de desenvolvimento integrado.

Além disso, quando você altera o caminho de um arquivo, o Git exclui o arquivo e cria um novo com o caminho novo. Isso significa que o histórico do Git do 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.