Como gerenciar arquivos e pastas do LookML

Os arquivos do projeto 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 informações 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, é importante ter em mente as 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 seu projeto ao nomear as pastas. Por exemplo, se a convenção é usar letras minúsculas no projeto, nomeie a pasta com views em vez de Views. Isso faz diferença especialmente quando você precisa especificar o caminho de um arquivo, como ao incluir arquivos. Geralmente, é recomendável usar letras minúsculas 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 LookML com o ambiente de desenvolvimento integrado do Looker, o Looker adicionará 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 do arquivo flights_data_tests, o Looker o nomeá como flights_data_tests.lkml.
• Como mudar o nome exibido de um objeto LookML:se você quiser mudar o nome exibido de um modelo ou objeto LookML, use o parâmetro label ou o alias em vez de renomear o arquivo ou objeto. Os parâmetros label e alias alteram o nome exibido enquanto preservam o URL subjacente usado para e-mails ou outros sistemas. Em geral, você deve tomar precauções para fazer alterações no modelo o mais invasivas possível. Se for necessário renomear um modelo ou um objeto, use o Validador de conteúdo para atualizar todas as referências a um modelo ou objeto.

Criação de pastas

É possível criar pastas para diferentes tipos de arquivo, como ver arquivos ou modelos. Você pode até criar subpastas, o que é muito útil se quiser include um subconjunto de 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 as pastas. Isso é importante, principalmente quando você precisa especificar o caminho de um arquivo, como ao incluir arquivos. Geralmente, é recomendável usar letras minúsculas ao nomear objetos e pastas do LookML. Consulte as observações importantes para criar arquivos e pastas e veja as limitações e diretrizes para a nomeação de arquivos e pastas.

Para criar uma pasta:

1. Selecione a opção Criar pasta no menu apropriado:
   • Para criar uma nova pasta no nível superior da estrutura do diretório, use o menu Adicionar arquivo ou pasta, que pode ser acessado no ícone + (mais) na parte superior do painel Navegador de arquivos.
   • Para criar uma nova subpasta em uma pasta existente, use o menu de três pontos Opções de pasta da pasta existente.
2. Digite um nome para a nova pasta.
3. Selecione Criar.

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

Criação de arquivos

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

Observação: é recomendável usar o ambiente de desenvolvimento integrado do Looker para adicionar arquivos ao projeto do LookerML. Para fazer isso, crie os arquivos no ambiente de desenvolvimento integrado do Looker, conforme descrito abaixo, ou faça o upload deles no ambiente de desenvolvimento integrado do Looker. Se, em vez disso, você criar arquivos fora do IDE do Looker e usá-lo para extrair (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 os arquivos de exploração). Se um nome de arquivo incluir caracteres incompatíveis, o navegador de arquivos do Looker IDE mostrará o nome em vermelho, e você não poderá ver o conteúdo do arquivo até que renomeie o arquivo com caracteres compatíveis. Além disso, o ambiente de desenvolvimento integrado do Looker não exibirá o arquivo se ele não tiver a extensão .lkml.

Para criar um novo arquivo no projeto 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 no í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 obter uma descrição mais detalhada de cada tipo de arquivo. Você pode criar os seguintes tipos de arquivos:

   • Arquivos de modelo com a extensão de arquivo .model.lkml
   • Veja os arquivos com a extensão .view.lkml*
   • Arquivos de manifesto do projeto que sempre têm o nome manifest.lkml**
   • Arquivos do painel com a extensão de arquivo .dashboard.lookml
   • Arquivos de documentos com a extensão de arquivo .md
   • Localizar arquivos de strings com a extensão de arquivo .strings.json***
   • Arquivos genéricos do LookML, que são usados para os seguintes tipos de arquivos:
     • Explore os arquivos com a extensão de arquivo .explore.lkml****
     • Arquivos de teste de dados com a extensão .lkml
     • Arquivos de refinamento com a extensão de arquivo .lkml
     • Qualquer outro arquivo que você esteja usando para armazenar elementos LookML
   Observação:

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

   ^** Arquivos de manifesto do projeto só podem ser criados selecionando o ícone + (mais) para abrir o menu Adicionar arquivo ou pasta na parte superior do navegador de arquivos do 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 Create Locale Strings File está disponível apenas no ícone Adicionar arquivo ou pasta + (mais) na parte superior do navegador de arquivos no ambiente de desenvolvimento integrado do Looker, mas quando um arquivo de strings de localidade é criado (ou enviado), é possível mover o arquivo para uma pasta. Se você estiver criando arquivos de strings de localidade para localizar seu modelo e também quiser usar a localização nativa da UI do Looker, precisará nomear seus arquivos usando strings específicas que podem ser encontradas na seção "Localidade" da página de documentação Usuários.

   ^**** Quando você cria um arquivo "Explorar", ele precisa ter a extensão .explore.lkml no fim do nome. Se você estiver fazendo o upload do arquivo, será necessário usar a extensão .explore.lkml completa. Se você estiver usando o ambiente de desenvolvimento integrado do Looker para criar o arquivo com a opção Arquivos genéricos LookML, o Looker adicionará .lkml ao final do nome do arquivo se a extensão não estiver presente, mas ainda será preciso adicionar manualmente a parte .explore da extensão ao nome do arquivo. Por exemplo, para criar um arquivo de exploração chamado flights usando o ambiente de desenvolvimento integrado do Looker, é possível inserir flights.explore ou flights.explore.lkml, e o nome do arquivo será 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 saber as limitações e diretrizes para a nomenclatura de arquivos.

4. Selecione Criar. O novo arquivo será exibido onde você o criou. Se necessário, você poderá movê-lo facilmente para outra pasta.

Importante: depois de criar o arquivo, use o parâmetro include se quiser fazer referência a elementos do arquivo em outros arquivos 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 Geração de LookML melhorada do Labs, o menu Adicionar arquivo ou pasta + (mais) na parte superior do painel Navegador de arquivos mostrará uma opção para Gerar LookML do banco de dados, além das opções listadas aqui.

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 para fazer o upload de arquivos, o desenvolvedor do Looker no modo de desenvolvimento pode adicionar arquivos de visualização a um projeto do LookML de várias maneiras:

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

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

• Como criar 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 depois definir manualmente a tabela derivada, conforme descrito na seção Como definir uma tabela derivada nativa no LookML da página de documentação Como criar tabelas derivadas nativas
  • Como o Looker cria a tabela derivada LookML de um explorar, conforme descrito na seção Como usar uma exploração para começar a definir suas tabelas derivadas nativas da página de documentação Como criar tabelas derivadas nativas.
  • Como fazer o Looker criar a tabela derivada LookML a partir de 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 mesclá-lo a uma exploração existente no arquivo de modelo.

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

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

1. Em um projeto, selecione o menu Adicionar arquivo ou pasta selecionando + (mais) na parte superior 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 dela.

2. Selecione Criar visualização da tabela.

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

4. Selecione as tabelas para criar visualizações. Para isso, marque 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 inferior da página e selecione Criar visualizações.

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

Fazer upload de arquivos

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

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

Para fazer upload de um arquivo para seu 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 computador para o ambiente de desenvolvimento integrado do Looker. O arquivo será exibido na raiz da estrutura do seu diretório.
3. Depois do 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 aos elementos do arquivo 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: a exclusão de uma pasta também exclui o conteúdo dela, portanto, tenha cuidado ao excluir essas pastas. Antes de excluir uma pasta, faça o seguinte:

• Confirme que deseja excluir os arquivos da pasta ou mova-os para um local diferente antes de excluir a pasta.
• Verifique se a pasta não contém nenhum arquivo mencionado nas instruções include do projeto. 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 mais informações sobre como usar o 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, o que inclui a pasta e os arquivos contidos nela.

Observação: se você excluir um arquivo de modelo, ele não será removido de nenhum conjunto de modelos a que ele pertence. 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 o modelo excluído. Isso pode resultar na concessão de 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.

Como excluir arquivos e pastas em massa

Para excluir pastas e arquivos em massa:

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

1. Selecione o ícone Bulk Edit na parte superior do painel File Browser.

   

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

   

   • Para marcar ou desmarcar arquivos individuais, expanda as pastas e marque a caixa de seleção ao lado dos nomes dos arquivos.
   • Para marcar ou desmarcar pastas inteiras e seu conteúdo, marque a caixa de seleção ao lado do nome da pasta.
   • Para selecionar uma seção inteira da lista de diretórios, clique na tecla Shift e clique nela. Marque a caixa de seleção do item superior no intervalo, mantenha pressionada a tecla Shift e 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 clicar na tecla Shift e clicar em um item para selecioná-lo e tudo que estiver acima dele na lista de diretórios.

3. Selecione o ícone de lixeira Excluir itens. O IDE exibirá um menu pop-up listando os itens selecionados.

   

4. Confirme os itens que serão excluídos selecionando Sim, Excluir ou selecione Cancelar para retornar à seleção do item.

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

Você pode arrastar e soltar um único arquivo ou uma pasta inteira com todo o seu conteúdo para novos locais:

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 alterar o caminho de um arquivo, atualize as instruções include do projeto para corresponder ao novo caminho de arquivo. 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 mais informações sobre como usar o include com pastas do ambiente de desenvolvimento integrado.

Além disso, esteja ciente de que quando você altera o caminho de um arquivo, o Git o exclui e cria um novo com o novo caminho. Isso significa que o histórico do Git para o arquivo estará vazio, porque ele o considera um novo arquivo. Para ver o histórico do Git do arquivo antes de movê-lo, use a interface do Git para navegar até o arquivo no local original e ver o histórico do Git. A mesma lógica se aplica a um arquivo renomeado, já que o Git o exclui e cria um novo com outro nome.

Como mover arquivos e pastas em massa

Para mover pastas e arquivos em massa:

1. Selecione o ícone Bulk Edit na parte superior do painel File Browser.

   

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

   

   • Para marcar ou desmarcar arquivos individuais, expanda as pastas e marque a caixa de seleção ao lado dos nomes dos arquivos.
   • Para marcar ou desmarcar pastas inteiras e seu conteúdo, marque a caixa de seleção ao lado do nome da pasta.
   • Para selecionar uma seção inteira da lista de diretórios, clique na tecla Shift e clique nela. Marque a caixa de seleção do item superior no intervalo, mantenha pressionada a tecla Shift e 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 clicar na tecla Shift e clicar em um item para selecioná-lo e tudo que estiver acima dele na lista de diretórios.

3. Clique no ícone de pasta Mover itens para selecionar a opção. O ambiente de desenvolvimento integrado exibirá um menu pop-up de seleção de pastas.

   

4. No menu pop-up Mover para, escolha uma pasta para os itens selecionados ou Nova pasta para criar uma nova pasta. O nome do projeto exibirá o caminho do arquivo da pasta selecionada na parte superior da página do próximo menu. Para mover itens para o diretório raiz do projeto, selecione Mover sem selecionar uma pasta.

5. Confirme o destino selecionado em Mover, crie uma nova pasta dentro da pasta selecionada selecionando Nova pasta ou volte ao menu de opções da pasta principal 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 alterar o caminho de um arquivo, atualize as instruções include no projeto para corresponder ao novo caminho de arquivo. 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 mais informações sobre como usar o include com pastas do ambiente de desenvolvimento integrado.

Além disso, esteja ciente de que quando você altera o caminho de um arquivo, o Git o exclui e cria um novo com o novo caminho. Isso significa que o histórico do Git para o arquivo estará vazio, porque ele o considera um novo arquivo. Para ver o histórico do Git do arquivo antes de movê-lo, use a interface do Git para navegar até o arquivo no local original e ver o histórico do Git. A mesma lógica se aplica a um arquivo renomeado, já que o Git o exclui e cria um novo com outro nome.