Visão geral do Looker IDE

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

Como acessar o IDE do Looker

Para acessar um projeto do LookML, você precisa ter a permissão develop em pelo menos um modelo no projeto. Você pode acessar o Looker IDE no painel Desenvolver do 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 para o projeto do LookML que você selecionou.

Como alternativa, você pode abrir o ambiente de desenvolvimento integrado para objetos específicos do LookML em uma Análise ou no navegador de objetos. Consulte Como acessar arquivos do projeto para ver detalhes e outras opções.

Elementos do Looker IDE

O Looker IDE tem os seguintes elementos:

  1. Banner do Modo de Desenvolvimento: esse banner indica que você está no Modo de Desenvolvimento, em que é possível fazer alterações nos arquivos do LookML e visualizar como elas afetarão o conteúdo da instância. É possível clicar no link Sair do Modo de Desenvolvimento no banner para entrar no Modo de Produção.
  2. Barra de navegação do ambiente de desenvolvimento integrado: use a barra de navegação para acessar diferentes recursos do Looker. Alguns recursos só estão disponíveis quando você está 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 recolher o painel de recursos. A barra de navegação do ambiente de desenvolvimento integrado oferece acesso aos seguintes recursos:
  3. Painel de recursos: oferece navegação para arquivos e objetos do LookML para o navegador de arquivos e navegador de objetos, parâmetros de pesquisa para a função localizar e substituir, comandos Git disponíveis para o painel Git Actions e guias para acessar diferentes configurações do painel de configurações do projeto.
  4. Painel de edição do ambiente de desenvolvimento integrado: editor de arquivos do LookML. O editor é exibido quando as opções Navegador de arquivos ou Navegador de objetos estão selecionadas na barra de navegação do ambiente de desenvolvimento integrado. Consulte Recursos de edição do ambiente de desenvolvimento integrado 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 ambiente de desenvolvimento integrado:
    • 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 uma segunda vez no seletor do painel lateral para ocultá-lo.
  6. Painel lateral do ambiente de desenvolvimento integrado: exibe o recurso selecionado do painel lateral:
    • Integridade do projeto: permite verificar se há PDTs não criadas ou validar seu LookML. Se os desenvolvedores do LookML definiram testes de dados para verificar a lógica do LookML do projeto, você também pode executar testes de dados no painel Saúde do projeto.
    • Ajuda rápida: mostra as opções do LookML que se aplicam à localização do cursor em um arquivo do LookML e fornece um link para a documentação de referência do Looker para cada parâmetro do LookML.
    • Metadados: fornece informações contextualmente relevantes sobre o objeto do LookML no local do cursor.
  7. Botão do Git: dependendo do estado do projeto, o botão mostra a próxima ação necessária para colocar o projeto em produção, como Validate LookML, Push Branch to Remote ou Commit. Clique no botão para realizar a ação. Consulte a referência de comandos do Git (em inglês) para conferir os possíveis comandos que o botão pode mostrar e executar.

Configurar o Looker IDE

No Looker IDE, é possível personalizar o modo de editor de texto e o modo de quebra de linha, além de recolher os painéis laterais para maximizar a largura do editor na janela.

Modos de editor de texto

O Looker IDE oferece suporte a três modos de editor de texto:

  • Editor do Looker IDE (padrão)
  • Vim
  • Emacs (link em inglês)

Para alterar o modo de editor de texto, siga estas etapas:

  1. Selecione o ícone Configurações no painel de navegação à esquerda do Looker IDE.
  2. Selecione a guia Editor nas Configurações do ambiente de desenvolvimento integrado.
  3. Use o menu suspenso Text Editor Mode para selecionar sua opção.

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

Modo de quebra de linha

Por padrão, o Looker IDE tem quebra de linha.

Para ativar ou desativar a quebra de linha:

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

Quando você mudar a opção, a atualização vai ser aplicada ao ambiente de desenvolvimento integrado do Looker.

Recolher os painéis laterais do ambiente de desenvolvimento integrado

Se você quiser maximizar a largura do painel do editor do ambiente de desenvolvimento integrado, feche 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 do teclado Command-B (Mac) ou Ctrl+B (Windows) ou clique em um ícone na barra de navegação do ambiente de desenvolvimento integrado que já está selecionado.
  • Para mostrar ou ocultar o painel lateral do ambiente de desenvolvimento integrado, clique em um ícone no seletor de painel lateral que já está selecionado.

Recursos de edição do ambiente de desenvolvimento integrado do Looker

As seções a seguir descrevem alguns dos recursos de edição do IDE do Looker que podem ajudar você a desenvolver no 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 incluirão apenas opções válidas para esse parâmetro. Além disso, os campos nos parâmetros sql precisam ser marcados com ${...}. Portanto, o ambiente de desenvolvimento integrado adiciona essa sintaxe ao sugerir campos.

A sugestão automática aparece automaticamente onde quer que esteja. Para fechar, pressione a tecla Esc no teclado. Para visualizá-lo 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ê mantém 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 de uma medida por engano, o ambiente de desenvolvimento integrado vai mostrar o erro Invalid value for "type":avrage.

O validador do 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 mesclagem ausente, exigem uma visão holística do modelo e, portanto, só aparecem quando o LookML Validator é executado.

Formatação automática

No Modo de Desenvolvimento, é possível usar o atalho de teclado para formatar arquivo para recuar automaticamente o arquivo do LookML. O recuo indica a hierarquia de parâmetros e subparâmetros, facilitando a leitura e compreensão do LookML.

Dobrável

Uma pequena seta aparece no gutter, ao lado do início de cada parâmetro LookML de nível superior no arquivo. Selecionar essa seta dobra ou desdobra a seção do LookML para que você possa se concentrar apenas em seções específicas.

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

Você também pode usar atalhos de teclado para dobrar e abrir o LookML.

Comentários

Adicione comentários ao LookML para torná-lo mais legível. Para adicionar um único comentário, use o caractere #:

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

Para comentar um bloco de código inteiro usando atalhos do teclado, 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.

Como fazer comentários em blocos SQL

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

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

Como visualizar adições, alterações e exclusões

No IDE do LookML, vários indicadores são sempre exibidos quando você está no Modo de Desenvolvimento e tem alterações não confirmadas.

  • O nome do arquivo é exibido com um ponto azul no lado esquerdo da janela para indicar que o arquivo é 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 linhas novas ou alteradas, e uma linha vermelha horizontal indica linhas removidas.

Persistência do estado do ambiente de desenvolvimento integrado

Em atualizações e logins, o Looker IDE mantém o estado do ambiente de desenvolvimento integrado de um usuário, incluindo 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)
  • Abrir o arquivo do LookML no navegador de arquivos
  • Estado expandido ou recolhido de itens no navegador de arquivos e de objetos
  • O item selecionado na barra lateral direita do ambiente de desenvolvimento integrado (como os painéis "Ajuda rápida", "Metadados" e "Integridade do projeto")
  • O modo de quebra de linha do editor.

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

Acessar o objeto ou arquivo

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

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

Painel de ajuda rápida

Selecione o ícone Ajuda rápida para abrir o painel Ajuda rápida, que fornece explicações e opções para o local atual no código. Selecione um nome de parâmetro na barra lateral para abrir a página da documentação do Looker sobre ele.

Menus de opções para arquivos e pastas

No navegador de arquivos, cada arquivo ou pasta no painel esquerdo tem um menu que exibe as ações disponíveis para aquele item. Mantenha 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 nome longo ou aninhado em várias pastas, você pode acessar o menu rolando para os lados no painel do navegador de arquivos.

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, você precisa confirmar suas alterações e implantá-las na produção antes que outros desenvolvedores do Looker possam acessá-las. Isso é como qualquer alteração que você fizer no projeto do LookML.

Como encontrar 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 de projeto e substituir todas as instâncias ou instâncias selecionadas em uma operação em massa.

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

  1. Navegue até o painel de pesquisa no ambiente de desenvolvimento integrado.
  2. Digite um termo no campo Localizar.
  3. Também é possível selecionar Diferenciar maiúsculas de minúsculas para pesquisar apenas instâncias que correspondam ao caso digitado no campo Localizar. Também é possível selecionar RegEX para pesquisar por expressões regulares.
  4. Selecione Localizar.
  5. Opcionalmente, é possível selecionar o nome de um arquivo para abri-lo no ambiente de desenvolvimento integrado.

Se você estiver no Modo de Desenvolvimento, também 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. Você também pode deixar o campo Substituir por em branco se quiser excluir o texto do campo Localizar em vez de substituí-lo.

  2. Escolha Selecionar e Substitua para conferir como o texto seria substituído no projeto.

  3. Os resultados mostram todas as instâncias do projeto destacadas para substituição. É possível usar as opções a seguir para personalizar quais instâncias serão substituídas:

    • Use a caixa de seleção ao lado do resumo dos resultados para marcar ou desmarcar todas as instâncias em todo o projeto.
    • Use a caixa de seleção ao lado de uma instância para selecioná-la ou desmarcá-la.
  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.

Criar e testar novos campos

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

Como criar uma dimensão

Primeiro, adicionaremos uma nova dimensão à 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 retornará Yes se o usuário for da Califórnia ou de Nova York, e No se não for.

O LookML da nossa nova dimensão tem a seguinte aparência:

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 Save Changes.

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

Como criar uma medição

Em seguida, adicionaremos uma nova medição à visualização user para calcular a média da idade dos usuários. Essa medida será type: average e agregada na coluna age.

O LookML dessa nova medição tem a seguinte aparência:

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

Adicione essa medição ao arquivo de visualização user e clique no botão Save Changes no arquivo.

Como testar os campos em "Explorar"

Para testar a nova dimensão e a métrica, faça uma consulta. Depois de salvar as mudanças, esses campos vão aparecer no seletor em "Explorar". Use o menu suspenso Conferir ações do arquivo ao lado do nome do arquivo para acessar a seção "Explorar" da visualização atual. O menu suspenso See file actions lista todas as Análises que são baseadas na visualização, incluindo as Análises a que ela está associada. Por exemplo, para acessar uma visualização chamada users, selecione a opção Explore Users no menu suspenso See file actions.

Na seção Usuários, você pode selecionar os novos campos para adicioná-los a uma consulta. Por exemplo, é possível criar uma consulta com os dois novos campos que mostram 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 localidades:

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