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 você a criar o LookML.
Sugestão automática
Conforme você digita, o IDE sugere possíveis parâmetros e valores que são sensíveis ao contexto do que você está digitando. Por exemplo, as sugestões para o parâmetro type de uma dimensão só incluirão 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 ela seja exibida. Para fechá-lo, pressione a tecla Esc no teclado. Para visualizá-lo a qualquer momento, 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 na calha indica um erro de sintaxe, sublinhado em vermelho. Quando você passa o mouse sobre o X vermelho, uma breve descrição do problema é exibida. Por exemplo, se você digitar avrage em vez de average como o valor do parâmetro type de uma medida, o ambiente de desenvolvimento integrado exibirá o erro Invalid value for "type":avrage.
O Validador de LookML ainda é necessário 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. Portanto, eles só são exibidos quando o Validador de LookML é executado.
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 a localização atual no código. Selecione um nome de parâmetro na barra lateral para abrir a página de documentação do Looker para esse parâmetro.
Formatação automática
Quando você está no modo de desenvolvimento, pode 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 de nível superior do LookML no arquivo. Selecionar essa seta dobra ou desdobra essa 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 LookML 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.
Como marcar 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, 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 linhas removidas.
Como adicionar comentários
É possível adicionar comentários ao 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
}
Você pode 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.
Como comentar 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ário SQL.
Quando você usar o bloco de comentários SQL, as seções comentadas ainda serão interpretadas como um código LookML. Portanto, você verá seus comentários no SQL gerado pelo LookML, mas eles não afetarão os resultados da consulta.
Acessar o objeto ou arquivo
No IDE do Looker, é possível fazer uma pesquisa rápida para navegar diretamente para objetos 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 navegador de objetos ou use 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 saber mais.
Como encontrar e substituir texto no projeto
O ambiente de desenvolvimento integrado do Looker tem uma função de localizar e substituir para que você possa pesquisar texto em todos os arquivos do projeto e substituir todas as instâncias ou instâncias selecionadas em uma operação em massa.
Para usar a função de localização do ambiente de desenvolvimento integrado 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 e minúsculas para pesquisar apenas instâncias que correspondem ao caso inserido no campo Localizar. Se preferir, selecione RegEX para fazer uma pesquisa de expressão regular.
- Selecione Localizar.
- Também é 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 o texto no seu projeto:
Insira o texto de substituição no campo Substituir por. Opcionalmente, deixe o campo Substituir por em branco se quiser excluir o texto no campo Localizar em vez de substituí-lo.
Selecione Selecionar e substituir para visualizar como o texto será substituído no projeto.
Os resultados mostram todas as instâncias do projeto destacadas para substituição. Você pode 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 de todo o projeto.
- Use a caixa de seleção ao lado de uma única instância para marcar ou desmarcar essa instância.
Selecione o botão Substituir selecionado para aplicar a substituição às instâncias selecionadas. O ambiente de desenvolvimento integrado mostrará as alterações que foram feitas.
Como 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, 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 ela retornará Yes se o usuário for da Califórnia ou de Nova York e No, 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 Save Changes no arquivo.
Confira os operadores de substituição para saber mais sobre ${TABLE}.state.
Como criar uma medida
Em seguida, adicionaremos uma nova medida à visualização user, que calcula a média da idade dos usuários. Essa medida será type: average e agregada na coluna age.
O LookML para essa nova medida tem a seguinte aparência:
measure: average_age {
type: average
sql: ${TABLE}.age ;;
}
Adicione essa medida ao arquivo de visualização user e clique no botão Save Changes no arquivo.
Como testar os campos na guia "Explorar"
Você pode testar sua nova dimensão e avaliar fazendo consultas. Depois de salvar as alterações, esses campos aparecerão no seletor de campo em "Explorar". Use o menu suspenso Ver ações do arquivo ao lado do nome do arquivo de visualização para acessar a ferramenta. O menu suspenso Ver ações do arquivo lista todos os Explorars baseados na visualização, incluindo aqueles aos quais a visualização está associada. Por exemplo, para acessar a guia Explorar de uma visualização chamada users, selecione a opção Explorar usuários no menu suspenso Ver ações do arquivo.
Em "Explorar" 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 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:
Como validar o LookML
Quando estiver satisfeito com as atualizações, você poderá salvar as alterações. 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 fazer 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. Portanto, eles só são exibidos quando o Validador de LookML é executado. Valide as alterações do LookML antes de publicá-las no ambiente de produção. Embora a validação não detecte todos os problemas, como os de permissão de banco de dados, ela evitará a maioria dos erros.
O Validador de LookML 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.
- Se uma exploração mudar, somente ela será validada novamente.
Validação em execução
Para executar o Validador de LookML, selecione o botão Validar LookML no canto superior direito do IDE do Looker ou selecione o ícone Integridade do projeto na parte superior do IDE para abrir o painel Integridade do projeto e selecione o botão Validar LookML.
Depois de executar o LookML Validator, talvez você veja uma lista de erros e outros avisos que precisam ser resolvidos. Você pode 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 exibe mensagens de validação depois de executar a validação no seu LookML.
Nenhum erro do LookML encontrado
Quando não forem encontrados problemas pelo validador, o Looker exibirá uma marca de seleção verde 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 representa o número de erros encontrados (nove no exemplo a seguir):
Na lista expandida de problemas, você verá o motivo pelo qual a validação não foi aprovada. Muitas vezes, se você clicar no erro, ele será levado diretamente para a linha do código com problema. Você verá um "X" vermelho ao lado da linha. Passe o cursor sobre ela para ver informações de erro mais detalhadas em alguns casos:
Dica da equipe do Chat: o erro de validação mais frequente é "Campo desconhecido ou inacessível". Acesse a página de práticas recomendadas Erro: campo desconhecido ou inacessível para saber as causas e o que fazer.
Avisos do LookML
Os avisos LookML podem não impedir que uma consulta seja executada, mas ainda podem resultar em funcionalidades corrompidas ou não intencionais para seus usuários. Como ocorre com erros, o número entre parênteses é a quantidade de avisos encontrados (três avisos no exemplo a seguir):
Assim como acontece com os erros do LookML, você pode expandir os avisos e ir para o código do problema selecionando o aviso no painel Project Health e, em seguida, passando o cursor sobre o ícone vermelho X para ver mais informações:
Como implantar as alterações
Depois de validar que suas alterações funcionarão corretamente, use a integração Git do Looker para confirmar e implantar as mudanças na produção.