Como usar o ambiente de desenvolvimento integrado
O ambiente de desenvolvimento integrado (IDE, na sigla em inglês) do Looker tem vários recursos para ajudar na criação de 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 de um 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 sempre que puder ser mostrada. Para fechá-la, pressione a tecla Esc no teclado. Para vê-lo, pressione Ctrl+Espaço (Windows) ou Control-Space (Mac).
Verificação ad hoc de erros
O ambiente de desenvolvimento integrado detecta erros de sintaxe enquanto você digita. Um X vermelho no gutter indica um erro de sintaxe, que está sublinhado em vermelho. Ao passar o cursor sobre o "X" vermelho, uma breve descrição do problema será exibida.
O LookML Validator ainda é necessário para realizar uma validação completa do modelo. Alguns erros, como uma referência de campo inválida devido a uma mesclagem ausente, exigem uma visão holística do modelo e, portanto, são apresentados somente quando o validador LookML é executado.
Painel de Ajuda rápida
Clique no ícone de informação para abrir o painel Ajuda rápida, que mostra explicações e opções do local atual no código. Clique no nome de um parâmetro na barra lateral para abrir a página de documentação do Looker para ele.
Também é possível usar o painel de metadados para visualizar informações contextualmente relevantes sobre os objetos no painel de metadados do ambiente de desenvolvimento integrado do Looker. Consulte a página de documentação Metadados para objetos LookML para saber mais.
Formatação automática
No Modo de desenvolvimento, é possível usar o atalho de teclado do arquivo de formato para recuar automaticamente o arquivo 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. Clique nessa seta para dobrar ou desdobrar a seção do LookML para que você possa se concentrar apenas em seções específicas.
O menu de arquivo também oferece as opções Fold LookML e Unfold LookML para expandir ou recolher todas as seções LookML até o parâmetro de nível superior no arquivo atual:
Também é possível usar atalhos de teclado para dobrar e desdobrar o LookML.
Marcar adições, mudanças e exclusões
No ambiente de desenvolvimento integrado 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, alterado ou renomeado.
- Quando você abre um arquivo novo ou alterado, os números de linha dentro do arquivo são destacados em verde para mostrar linhas novas ou alteradas, e uma linha vermelha horizontal indica as linhas removidas.
Adicionar comentários
É possível adicionar 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
}
É possível comentar um bloco de código inteiro usando atalhos de teclado:
- Selecione as linhas que você quer comentar.
- Pressione ⌘ + / em um Mac ou ctrl + / em um computador Windows.
O ambiente de desenvolvimento integrado adicionará o caractere # a cada uma das linhas selecionadas.
Comentários sobre blocos de 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ários SQL.
Quando você usa o bloco de comentários SQL, as seções comentadas ainda são interpretadas como um código LookML. Portanto, você verá os comentários no SQL gerado pelo LookML, mas os comentários não afetarão os resultados da consulta.
Ir para o objeto ou arquivo
No ambiente de desenvolvimento integrado do Looker, é possível fazer uma pesquisa rápida para navegar diretamente até os objetos LookML e do projeto usando o recurso Jump to object or file. Clique no ícone Ir para o objeto ou arquivo no navegador de arquivos ou navegador de objetos ou use o atalho de teclado Command-J (Mac) ou Ctrl+J (Windows):
Consulte a página de documentação Acessar e editar informações do projeto para mais informações.
Como encontrar e substituir texto no projeto
O ambiente de desenvolvimento integrado do Looker tem uma função de localizar e substituir. Assim, é possível pesquisar todos os arquivos do projeto por texto e substituir todas as instâncias ou instâncias selecionadas em uma operação em massa.
A ferramenta Localizar e substituir do ambiente de desenvolvimento integrado do Looker é uma ótima ferramenta para localizar elementos LookML em grandes projetos LookML e para substituir textos em descrições e rótulos. Se você quiser pesquisar e substituir no projeto os nomes dos modelos, explorações e campos, use a função de busca e substituição de conteúdo do validador de conteúdo. Quando você altera os nomes dos modelos, os Explorars e os campos, as referências no seu modelo podem ser prejudicadas, e o validador de conteúdo pode validar as referências do LookML e corrigir erros no LookML após fazer esses tipos de alterações.
Para usar a função de localização do Looker:
- Navegue até o painel de pesquisa no ambiente de desenvolvimento integrado.
- Digite um termo no campo Localizar.
- Também é possível selecionar Diferenciar maiúsculas de minúsculas para pesquisar apenas instâncias que correspondam ao caso inserido no campo Localizar ou selecionar RegEX para fazer uma pesquisa de expressão regular.
- Clique em Localizar.
- Também é possível clicar no 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:
Insira um texto substituto no campo Substituir por. Também é possível deixar o campo Substituir por em branco se quiser excluir o texto no campo Localizar em vez de substituí-lo.
Clique em Selecionar & Replace para visualizar como o texto seria substituído no projeto.
Os resultados mostram todas as instâncias do projeto destacadas para substituição. É possível usar as seguintes opções 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 do projeto inteiro.
- Use a caixa de seleção ao lado de uma única instância para marcar ou desmarcar essa instância.
Clique no botão Substituir selecionados para aplicar a substituição às instâncias que você selecionou. O ambiente de desenvolvimento integrado mostrará as mudanças feitas:
Criar e testar novos campos
Como exemplo de edição do LookML, vamos adicionar vários campos e testá-los.
Como criar uma dimensão
Primeiro, vamos adicionar 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 ela retornará Sim se o usuário for da Califórnia ou de Nova York e Não se não for.
O LookML para nossa nova dimensão tem esta 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 Salvar alterações do arquivo.
Confira os operadores de substituição para saber mais sobre o ${TABLE}.state.
Como criar uma medida
Em seguida, vamos adicionar uma nova medida à visualização user que calcula a média da idade dos usuários. Essa medida será type: average e será agregada à coluna age.
O LookML para essa nova medida tem esta aparência:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
Adicione essa medida ao arquivo de visualização user e clique no botão Salvar alterações do arquivo.
Como testar os campos no Explorar
Consulte a nova dimensão e avalie-a consultando-a. Depois de salvar as mudanças, esses campos vão aparecer no seletor em "Explorar". Uma maneira fácil de acessar a guia "Explorar" para a visualização atual é usar o menu suspenso ao lado do nome do arquivo da visualização:
Em Explorar, os usuários podem 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 de usuários da Califórnia ou de Nova York e a idade média dos usuários que não são:
Você precisa estar no modo de desenvolvimento para acessar esses novos campos até confirmar e enviar as alterações para produção.
Como validar seu LookML
Quando terminar, salve as mudanças. O ambiente de desenvolvimento integrado alertará você sobre erros de sintaxe não resolvidos em um único arquivo.
Em seguida, use o LookML Validator para realizar uma validação de modelo completa. Alguns erros, como uma referência de campo inválida devido a uma mesclagem ausente, exigem uma visão holística do modelo e, portanto, são apresentados somente quando o validador LookML é executado. Valide as mudanças do LookML antes de publicá-las no ambiente de produção. Embora a validação não identifique todos os problemas, como os de permissão de banco de dados, isso evita a maioria dos erros.
O LookML Validator não pode ser confundido com o Validador de conteúdo, que, em vez disso, verifica se as alterações feitas interromperão as aparências salvas.
O LookML Validator verifica apenas os arquivos LookML que foram atualizados desde a última validação do LookML ou os arquivos afetados por atualizações:
- Se uma configuração no nível do modelo for alterada, tudo será validado novamente.
- Se uma visualização mudar, somente as explorações em que ela é usada serão validadas novamente.
- Quando uma exploração muda, somente ela é validada novamente.
Dica da equipe do Chat: se a validação do LookML levar muito tempo para ser concluída, você precisará verificar o parâmetro
includeno arquivo do seu modelo. Se você incluir todos os seus arquivos de visualização (include: "*.view"), o LookML Validator vai precisar verificar todos eles, o que pode afetar o desempenho. Se esse for o caso, atualize o parâmetroincludedo arquivo de modelo para que apenas os arquivos de visualização necessários sejam incluídos.
Validação em execução
Para executar o LookML Validator, selecione o botão Validate LookML no canto superior direito do ambiente de desenvolvimento integrado do Looker ou selecione o ícone Project Health na parte superior do ambiente de desenvolvimento integrado para abrir o painel Project Health e, em seguida, selecione o botão Validate LookML:
Depois de executar o LookML Validator, você pode ver uma lista de erros e outros avisos que precisam ser resolvidos. É possível selecionar qualquer seta para expandir as listas de erros ou avisos:
O botão validador no painel Integridade do projeto ficará disponível novamente se você fizer e salvar outra alteração.
Mensagens de validação
O Looker mostra mensagens de validação após a execução da validação no LookML.
Os painéis do LookML mostram mensagens informativas, em vez de avisos, na barra lateral quando a localização permissiva está ativada.
Nenhum erro de LookML encontrado
Quando não há problemas encontrados pelo validador, o Looker exibe uma marca de seleção verde junto com o texto No LookML errors found.
Erros do LookML
Os erros LookML são problemas que podem impedir a execução de consultas. O número entre parênteses é a quantidade de erros encontrados (nove no exemplo a seguir):
Na lista expandida de problemas, você verá o motivo para a validação não ser aprovada. Muitas vezes, clique no erro para acessar a linha de código do problema. Você verá um "X" vermelho ao lado da linha. Passe o cursor sobre ele para ver informações de erro mais detalhadas em alguns casos:
Dica da equipe do Chat: o erro de validação mais frequente é o de "campo desconhecido ou inacessível." Confira este artigo da Central de Ajuda para ver as causas e o que fazer.
Alertas do LookML
Os avisos do LookML podem não impedir a execução de uma consulta, mas ainda podem resultar em funcionalidades corrompidas ou não intencionais para seus usuários. Assim como nos erros, o número de parênteses é o número de avisos encontrados (três avisos no exemplo a seguir):
Assim como nos erros LookML, é possível expandir avisos e ir para o código do problema selecionando o aviso no painel Project Health e passando o cursor sobre o ícone vermelho X para ver mais informações:
Como implantar as alterações
Depois de validar se as alterações estão funcionando corretamente, use a integração Git do Looker para confirmar e implantar as alterações na produção.
Se você mudar os nomes dos campos que servem como filtros nas suas aparências ou painéis, verifique a seção Filtros dos seus painéis e aparências programados e atualize os filtros conforme necessário para refletir as mudanças. Se a entrega de conteúdo programada incluir filtros que não funcionam mais (por exemplo, se o campo referenciado tiver mudado), a exibição programada poderá expor dados não filtrados.