Visão geral do IDE do Looker

O IDE (ambiente de desenvolvimento integrado) do Looker oferece acesso aos arquivos e às configurações do projeto do LookML.

Acessar o Looker IDE

Para ver um projeto do LookML, você precisa ter a permissão develop em pelo menos um modelo do projeto. Acesse o Looker IDE pelo painel Desenvolver no menu de navegação principal do Looker:

  1. Selecione Desenvolver no painel de navegação para abrir o painel Desenvolver.
  2. No painel Desenvolver, selecione o nome do projeto que você quer acessar.

O Looker abre o ambiente de desenvolvimento integrado no projeto do LookML selecionado.

Como alternativa, abra o IDE para objetos específicos do LookML em uma análise detalhada ou no navegador de objetos. Consulte Como acessar arquivos do projeto para mais detalhes e outras opções.

Elementos do Looker IDE

O IDE do Looker tem os seguintes elementos:

  1. Banner do modo de desenvolvimento: indica que você está no modo de desenvolvimento, em que é possível fazer mudanças nos arquivos do LookML e conferir como elas vão afetar o conteúdo na sua instância. Clique no link Sair do modo de desenvolvimento no banner para acessar o modo de produção.

  2. Barra de navegação do IDE: use a barra de navegação para acessar diferentes recursos do Looker IDE. Alguns recursos só estão disponíveis no Modo de Desenvolvimento. Depois de selecionar um recurso na barra de navegação do ambiente de desenvolvimento integrado, selecione o item da barra de navegação uma segunda vez para fechar o painel de recursos. A barra de navegação do IDE oferece acesso aos seguintes recursos:

    • Navegador de arquivos: abre o navegador de arquivos, que dá acesso aos arquivos e pastas no seu projeto do LookML.
    • Navegador de objetos: abre o navegador de objetos, que mostra os objetos LookML no seu projeto e as relações hierárquicas entre eles.
    • Localizar e substituir: mostra a página Localizar e substituir no projeto, que pode ser usada para pesquisar texto em todos os arquivos do projeto e substituir todas as instâncias ou as selecionadas em uma operação em massa.
    • Integração contínua: (visível apenas se a integração contínua estiver ativada) abre a página Integração contínua (CI), em que é possível criar pacotes de CI que executam testes no seu projeto LookML para detectar problemas com SQL, testes de dados, conteúdo e LookML antes que eles cheguem à produção.
    • Ações do Git: (visível apenas no modo de desenvolvimento) mostra as ramificações do Git no seu projeto e os comandos disponíveis para a ramificação do Git do projeto. Consulte a página de documentação Como usar o controle de versões e implantação para informações sobre como usar o Git com seu projeto do LookML.
    • Configurações: (visível apenas no modo de desenvolvimento) mostra as páginas de configurações do projeto em que é possível configurar opções de controle de versão do projeto, credenciais de autenticação para projetos importados, ramificações do Git usadas pelo projeto e configurações do IDE.
    • Implantar: (visível apenas no modo de desenvolvimento) para projetos configurados com o modo de implantação avançado, abre o Deployment Manager, em que os desenvolvedores com a permissão deploy podem implantar um commit ou uma tag no ambiente de produção do Looker.

  3. Painel de recursos: oferece navegação para arquivos e objetos LookML no navegador de arquivos e de objetos, parâmetros de pesquisa para a função de localizar e substituir, comandos Git disponíveis no painel Ações do Git e guias para acessar diferentes configurações no painel de configurações do projeto.

  4. Painel do editor do IDE: o editor de arquivos do LookML. O editor é exibido quando Navegador de arquivos ou Navegador de objetos é selecionado na barra de navegação do ambiente de desenvolvimento integrado. Consulte Recursos de edição do IDE do Looker para mais informações sobre o editor.

  5. Seletor do painel lateral: clique em uma opção para abrir os recursos do painel lateral do IDE:

    • Quero ajuda para codificar: (para instâncias do Looker (Google Cloud Core) com o Gemini ativado) abre o painel Quero ajuda para codificar.
    • Integridade do projeto: abre o painel Integridade do projeto.
    • Ajuda rápida: abre o painel Ajuda rápida, que inclui uma guia para acessar o painel Metadados. Clique na opção do seletor de painel lateral uma segunda vez para ocultar o painel lateral do IDE.

  6. Painel lateral do IDE: mostra o recurso selecionado do painel lateral:

  7. Botão do Git: dependendo do estado do projeto, o botão mostra a próxima ação que você precisa realizar para colocar o projeto em produção, como Validar LookML, Enviar ramificação para remoto ou Commit. Clique no botão para realizar a ação. Consulte a referência de comandos do Git para ver os comandos que o botão pode mostrar e executar.

Configurar o Looker IDE

É possível personalizar o IDE do Looker das seguintes maneiras:

Modos do editor de texto

O ambiente de desenvolvimento integrado do Looker é compatível com três modos de editor de texto:

  • Editor da IDE do Looker (padrão)
  • Vim
  • Emacs

Para mudar o modo do editor de texto, siga estas etapas:

  1. Selecione o ícone Configurações no painel de navegação à esquerda do IDE do Looker.
  2. Selecione a guia Editor em Configurações do IDE.
  3. Use o menu suspenso Modo do editor de texto para selecionar sua opção.

Depois de selecionar uma opção no menu suspenso, o IDE do Looker é atualizado imediatamente para usar o modo de editor de texto selecionado.

Modo de quebra de linha

Por padrão, o Looker IDE está ativado para quebra de linha.

Para ativar ou desativar a quebra de linha:

  1. Selecione o ícone Configurações no painel de navegação à esquerda do IDE do Looker.
  2. Selecione a guia Editor em Configurações do IDE.
  3. Use a opção Modo de quebra de linha para ativar ou desativar a quebra de linha no ambiente de desenvolvimento integrado.

Depois que você mudar a chave, a atualização será aplicada ao Looker IDE.

Redimensionar os painéis laterais do ambiente de desenvolvimento integrado

É possível mudar a largura dos painéis no ambiente de desenvolvimento integrado, tanto o painel de recursos (que contém os painéis Navegador de arquivos, Navegador de objetos e Ações do Git) quanto o painel lateral (que contém os painéis Integridade do projeto, Ajuda rápida e Metadados).

Para redimensionar os painéis do ambiente de desenvolvimento integrado, passe o cursor sobre a borda do painel e arraste para redimensionar:

Se você estiver no modo de desenvolvimento, o ambiente de desenvolvimento integrado vai manter o tamanho dos painéis laterais em logins e atualizações.

Como fechar os painéis laterais do ambiente de desenvolvimento integrado

Se quiser maximizar a largura do painel do editor do ambiente de desenvolvimento integrado, recolha os painéis laterais do ambiente de desenvolvimento integrado:

  • Para mostrar ou ocultar o painel de recursos do ambiente de desenvolvimento integrado, use o atalho de teclado Command-B (Mac) ou Ctrl+B (Windows) ou clique em um ícone já selecionado na barra de navegação do ambiente de desenvolvimento integrado.
  • Para mostrar ou ocultar o painel lateral da IDE, clique em um ícone já selecionado no seletor.

Recursos de edição do IDE do Looker

As seções a seguir descrevem alguns dos recursos de edição do Looker IDE que podem ajudar você a desenvolver em LookML:

Sugestão automática

Conforme você digita, o ambiente de desenvolvimento integrado sugere possíveis parâmetros e valores sensíveis ao contexto do que você está digitando. Por exemplo, as sugestões para o parâmetro type de uma dimensão só incluem opções válidas para ele. Além disso, os campos nos parâmetros sql precisam ser marcados com ${...} para que o ambiente de desenvolvimento integrado adicione essa sintaxe ao sugerir campos.

A sugestão automática aparece automaticamente sempre que pode ser mostrada. Para fechar, pressione a tecla Esc no teclado. Para ver a lista a qualquer momento, pressione Ctrl+Espaço (Windows) ou Control-Espaço (Mac).

Verificação de erros ad hoc

O ambiente de desenvolvimento integrado detecta erros de sintaxe enquanto você digita. Um X vermelho na margem indica um erro de sintaxe, que é sublinhado em vermelho. Quando você passa o cursor sobre o X vermelho, uma breve descrição do problema aparece. Por exemplo, se você digitar avrage em vez de average como o valor do parâmetro type para uma métrica, a IDE vai mostrar o erro Invalid value for "type":avrage.

O validador de LookML ainda é necessário para realizar uma validação completa do modelo. Alguns erros, como uma referência de campo inválida causada por uma junção ausente, exigem uma análise completa do modelo e, portanto, só aparecem quando o validador do LookML é executado.

Formatação automática

No modo de desenvolvimento, use o atalho de teclado para formatar arquivo e identar automaticamente seu arquivo LookML. O recuo indica a hierarquia de parâmetros e subparâmetros, facilitando a leitura e a compreensão da LookML.

Dobrável

Uma pequena seta aparece na margem ao lado do início de cada parâmetro do LookML de nível superior no arquivo. Ao selecionar essa seta, você recolhe ou abre essa seção da LookML para se concentrar apenas em partes específicas.

O menu Ver ações do arquivo do arquivo LookML também oferece as opções Dobrar LookML e Desdobrar LookML para expandir ou recolher todas as seções da LookML até o parâmetro de nível superior no arquivo atual.

Também é possível usar atalhos de teclado para recolher e abrir o LookML.

Comentários

Você pode adicionar comentários à sua LookML para facilitar a leitura. Para adicionar um único comentário, use o caractere #:

dimension: name {
  sql: ${TABLE}.name ;; # This is the customer's full name
}

É possível comentar um bloco inteiro de código usando atalhos de teclado. Para isso, siga estas etapas:

  1. Selecione as linhas que você quer comentar.
  2. Pressione Command + / (Mac) ou Ctrl + / (Windows).

O ambiente de desenvolvimento integrado vai adicionar o caractere # a cada uma das linhas selecionadas.

Comentar blocos SQL

Se você estiver comentando linhas que estão totalmente dentro de um bloco de código SQL, adicione manualmente a notação de comentário SQL.

Quando você usa o bloco de comentários SQL, as seções comentadas ainda são interpretadas como código LookML. Portanto, você vai ver seus comentários no SQL gerado pela LookML, mas eles não vão afetar os resultados da consulta.

Como ver adições, mudanças e exclusões

No ambiente de desenvolvimento integrado do LookML, vários indicadores são sempre mostrados quando você está no modo de desenvolvimento e tem mudanças não confirmadas.

  • O nome do arquivo aparece com um ponto azul no lado esquerdo da janela para indicar que ele é novo, foi alterado ou renomeado.
  • Quando você abre um arquivo novo ou alterado, os números das linhas dentro dele são destacados em verde para mostrar as linhas novas ou alteradas, e uma linha vermelha horizontal indica as linhas removidas.

Persistência do estado do ambiente de desenvolvimento integrado

No modo de desenvolvimento, o IDE do Looker mantém o estado do IDE em atualizações e logins. O estado do ambiente de desenvolvimento integrado inclui o seguinte:

  • O item selecionado na barra de navegação do ambiente de desenvolvimento integrado (como o navegador de arquivos, ações do Git, navegador de objetos ou configurações do projeto)
  • Abra o arquivo LookML exibido no navegador de arquivos.
  • Estado aberto ou fechado dos itens no navegador de arquivos e no navegador de objetos
  • A largura dos painéis laterais do ambiente de desenvolvimento integrado
  • O item selecionado na barra lateral direita da IDE, como o painel de Ajuda rápida, o painel de metadados e o painel de integridade do projeto.
  • O modo de quebra de linha do editor

Para redefinir o IDE para os padrões, selecione o ícone Configurações no painel de navegação à esquerda do IDE do Looker, selecione a guia Editor na seção Configurações do IDE e clique no botão Redefinir layout do IDE. O ambiente de desenvolvimento integrado vai manter seu estado novamente enquanto você abre arquivos e faz seleções.

Acessar o objeto ou arquivo

No Looker IDE, você pode fazer uma pesquisa rápida para navegar diretamente até objetos da LookML e arquivos de projeto usando o recurso Ir para objeto ou arquivo. Clique no ícone Ir para objeto ou arquivo no navegador de arquivos ou no navegador de objetos. Também é possível usar o atalho de teclado Command-J (Mac) ou Ctrl+J (Windows).

Consulte a página de documentação Como acessar arquivos de projetos do LookML para mais informações.

Painel de Ajuda rápida

Para abrir o painel Ajuda rápida, selecione o ícone Ajuda rápida no navegador de arquivos ou no navegador de objetos:

O painel Ajuda rápida oferece explicações e opções para o local atual no código:

  • No painel do editor do IDE, clique nos campos e parâmetros dos arquivos LookML. O painel Ajuda rápida vai mostrar as opções e os subparâmetros compatíveis com esse elemento da LookML.
  • No painel Ajuda rápida, clique no nome de um parâmetro para abrir a página de documentação do Looker relacionada.

Painel "Preciso de ajuda com o código"

Se você tiver uma instância do Looker (Google Cloud Core) com o Gemini ativado, poderá usar o Gemini no Looker para ajudar a escrever LookML:

IDE do Looker com o ícone "Quero ajuda para codificar" em destaque.

Consulte a documentação Escrever LookML com o Gemini na assistência do Looker para mais detalhes.

Menus de opções para arquivos e pastas

No navegador de arquivos, cada arquivo ou pasta no painel à esquerda tem um menu que mostra as ações disponíveis para esse item. Passe o cursor sobre um arquivo e uma pasta e selecione o menu de três pontos Opções de pasta (para pastas) ou Opções de arquivo (para arquivos) para abrir o menu. Para um item com um nome longo ou aninhado em várias pastas, role para o lado no painel do navegador de arquivos para acessar o menu.

Nos menus de opções, é possível criar pastas e arquivos, fazer upload de arquivos e excluir e mover arquivos e pastas usando o navegador de arquivos. Para mais informações, consulte a página de documentação Gerenciar arquivos e pastas do LookML.

Ao organizar seus arquivos do LookML com pastas, é necessário confirmar as mudanças e implantá-las na produção antes que outros desenvolvedores do Looker possam vê-las. Isso é igual a qualquer mudança feita no projeto do LookML.

Localizar e substituir texto no projeto

O IDE do Looker tem uma função de localizar e substituir que pode ser usada para pesquisar texto em todos os arquivos do projeto e substituir todas as instâncias ou as selecionadas em uma operação em massa.

Para usar a função de pesquisa do IDE do Looker, siga estas etapas:

  1. Navegue até o painel de pesquisa na IDE.
  2. Digite um termo no campo Localizar.
  3. Se quiser, selecione Diferencia maiúsculas de minúsculas para pesquisar apenas instâncias que correspondam ao caso inserido no campo Localizar ou selecione RegEX para realizar uma pesquisa de expressão regular.
  4. Selecione Encontrar.
  5. Se quiser, selecione o nome de um arquivo para abri-lo no ambiente de desenvolvimento integrado.

Se você estiver no modo de desenvolvimento, também vai ver o campo Substituir por. Para substituir texto no seu projeto, siga estas etapas:

  1. Insira o texto de substituição no campo Substituir por. Se quiser excluir o texto no campo Localizar em vez de substituir, deixe o campo Substituir por em branco.

  2. Selecione Selecionar e substituir para ver como o texto seria substituído no projeto.

  3. Os resultados mostram todas as instâncias no seu projeto destacadas para substituição. Você pode usar as seguintes opções para personalizar quais instâncias são substituídas:

    • Use a caixa de seleção ao lado do resumo dos resultados para selecionar ou desmarcar todas as instâncias em todo o projeto.
    • Use a caixa de seleção ao lado de uma única instância para selecionar ou desmarcar essa instância.

  4. Selecione o botão Substituir selecionado para aplicar a substituição às instâncias selecionadas. O ambiente de desenvolvimento integrado vai mostrar as mudanças feitas.

Como criar e testar novos campos

Como exemplo de edição de LookML, vamos adicionar vários campos e testá-los.

Como criar uma dimensão

Primeiro, vamos adicionar uma dimensão à nossa visualização users que determina se um usuário é da Califórnia ou de Nova York. A dimensão será type: yesno, o que significa que ela vai retornar Sim se o usuário for da Califórnia ou de Nova York e Não se não for.

A LookML da nossa nova dimensão é assim:

dimension: from_ca_or_ny {
  type: yesno
  sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}

Adicione essa dimensão ao arquivo de visualização user e clique no botão Salvar alterações no arquivo.

Confira os operadores de substituição para saber mais sobre ${TABLE}.state.

Como criar uma medição

Em seguida, vamos adicionar uma nova métrica à nossa visualização user que calcula a média da idade dos nossos usuários. Essa medida será type: average e vai agregar na coluna age.

A LookML para essa nova medida é assim:

measure: average_age {
  type: average
  sql: ${TABLE}.age ;;
}

Adicione essa métrica ao arquivo de visualização user e clique no botão Salvar alterações no arquivo.

Testar os campos na análise detalhada

Para testar sua nova dimensão e métrica, faça uma consulta. Depois que você salvar as mudanças, esses campos vão aparecer no seletor de campos da Análise detalhada. Use o menu suspenso Ver ações do arquivo ao lado do nome do arquivo da visualização para acessar a análise detalhada da visualização atual. O menu suspenso Ver ações de arquivo lista todas as análises detalhadas com base na visualização, incluindo aquelas a que ela está associada. Por exemplo, para acessar a análise detalhada de uma visualização chamada users, selecione a opção Analisar detalhadamente os usuários no menu suspenso Ver ações do arquivo.

Na análise detalhada Usuários, você pode selecionar os novos campos para adicioná-los a uma consulta. Por exemplo, você pode criar uma consulta com os dois novos campos que mostre a idade média dos usuários da Califórnia ou de Nova York e a idade média dos usuários que não são dessas regiões:

Tabela de dados de uma análise detalhada de usuários de amostra com os campos "Usuários da CA ou NY (Sim/Não)" e "Idade média dos usuários" selecionados.