Como usar o ambiente de desenvolvimento integrado
Nesta página, descrevemos alguns dos recursos do ambiente de desenvolvimento integrado do Looker que podem ajudar você a criar no LookML.
É possível acessar o ambiente de desenvolvimento integrado do Looker (ambiente de desenvolvimento integrado) pelo menu Desenvolver do Looker. Consulte Como acessar arquivos de projeto para mais detalhes e outras opções.
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ó 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 sempre que pode ser mostrada. Para fechá-lo, pressione a tecla Esc no teclado. Para vê-lo em qualquer ponto, 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 no gutter indica um erro de sintaxe, 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 por engano em vez de average como o valor do parâmetro type de uma medida, o ambiente de desenvolvimento integrado vai mostrar o erro Invalid value for "type":avrage.
O validador do LookML ainda é necessário para executar uma validação de modelo completa. Alguns erros, como uma referência de campo inválida devido à ausência de uma junção, exigem uma visão holística do modelo e, portanto, só aparecem quando o LookML Validator é 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 referente a ele.
Formatação automática
No Modo de Desenvolvimento, é possível usar o atalho de teclado do arquivo de formatação 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 do LookML de nível superior 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 do LookML até o parâmetro de nível superior dentro do arquivo atual.
Também é possível usar atalhos de teclado para dobrar e desdobrar o LookML.
Marcar adições, alterações e exclusões
No LookML IDE, 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 ele é 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.
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 em um bloco inteiro de código usando atalhos de teclado seguindo estas etapas:
- Selecione as linhas que você quer comentar.
- Pressione Command + / (Mac) ou Ctrl + / (Windows).
O ambiente de desenvolvimento integrado vai adicionar o caractere # a cada uma das linhas selecionadas.
Comentar os blocos SQL
Se você estiver comentando linhas que estão 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ário SQL, as seções comentadas ainda serão interpretadas como código LookML. Portanto, você vai ver seus comentários no SQL gerado pelo LookML, mas eles não vão afetar os resultados da consulta.
Acessar o objeto ou arquivo
No ambiente de desenvolvimento integrado do Looker, é possível fazer uma pesquisa rápida para acessar diretamente objetos e arquivos de projetos do LookML usando o recurso Jump to object or file. Clique no ícone Ir para objeto ou arquivo no navegador de arquivos ou no navegador de objetos, ou use o atalho de teclado Command-J (Mac) ou Ctrl+J (Windows).
Para mais informações, consulte a página de documentação Como acessar arquivos do projeto LookML.
Encontrar e substituir texto no projeto
O ambiente de desenvolvimento integrado do Looker tem uma função de localizar e substituir, que pode ser usada para procurar 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, siga estas etapas:
- Acesse 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 pesquisar por 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 vai encontrar o campo Substituir por. Para substituir texto no seu projeto, siga estas etapas:
Insira o texto substituto no campo Substituir por. Você pode deixar o campo Substituir por em branco se quiser excluir o texto do campo Localizar em vez de substituí-lo.
Selecione Selecionar e substituir para visualizar como o texto seria substituído no projeto.
Os resultados mostram todas as instâncias no seu projeto destacadas para substituição. É possível 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 marcar ou desmarcar todas as instâncias em todo o projeto.
- Use a caixa de seleção ao lado de uma única instância para marcá-la ou desmarcá-la.
Selecione o botão Substituir selecionado para aplicar a substituição às instâncias selecionadas. O ambiente de desenvolvimento integrado vai mostrar as alterações feitas.
Criação e teste de 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á Yes se o usuário for da Califórnia ou de Nova York, e No se não for.
O LookML da nova dimensão vai ficar 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 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 dessa nova medida vai ficar assim:
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 em Explore
Você pode consultar e medir sua nova dimensão para testá-la. Depois de salvar as mudanças, esses campos vão aparecer no seletor de campos em "Explorar". Use o menu suspenso Ver ações do arquivo ao lado do nome do arquivo da visualização para acessar facilmente a opção "Explorar" da visualização atual. O menu suspenso Ver ações do arquivo lista todas as Análises baseadas na visualização, incluindo aquelas a que a visualização está integrada. Por exemplo, para acessar a opção "Explorar" de uma visualização chamada users, selecione a opção Explorar usuários no menu suspenso Ver ações do arquivo.
Em Explorar, selecione 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 que são 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 suas atualizações, você poderá salvá-las. 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 completa do modelo. Alguns erros, como uma referência de campo inválida devido à ausência de uma junção, exigem uma visão holística do modelo e, portanto, só aparecem quando o LookML Validator é 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 problemas de permissão de banco de dados, ela evita a maioria dos erros.
O Validador do LookML verifica somente arquivos do LookML que foram atualizados desde a última validação ou que foram afetados por atualizações:
- Se uma configuração no nível do modelo mudar, tudo será validado novamente.
- Se uma visualização mudar, somente as Análises em que ela é usada serão validadas novamente.
- Se um Explore mudar, somente ele será validado novamente.
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. Outra opção é selecionar o ícone Project Health na parte superior do ambiente de desenvolvimento integrado para abrir o painel Project Health e clicar no ícone Validate LookML.
Depois de executar o LookML Validator, é possível 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 mudança.
Mensagens de validação
O Looker mostra mensagens depois de executar a validação no LookML.
Nenhum erro do LookML encontrado
Quando o validador não encontrar problemas, o Looker vai mostrar uma marca de seleção verde ao lado do texto No LookML errors found.
Erros do LookML
Os erros do 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 da falha na validação. Muitas vezes, se você clicar no erro, ele o levará diretamente para a linha de código problemática. Você verá um "X" vermelho ao lado da linha. Passe o cursor sobre ele para ver informações mais detalhadas sobre o erro em alguns casos:
Dica para a equipe do Chat: o erro de validação que mais recebemos é "Campo desconhecido ou inacessível". Acesse a página de práticas recomendadas Erro: campo desconhecido ou inacessível para conferir as causas e saber o que fazer.
Avisos do LookML
Mesmo que os avisos do LookML não impeçam a execução de uma consulta, eles ainda poderão resultar em funcionalidades corrompidas ou indesejadas para os usuários. Assim como nos erros, o número entre parênteses é o número de avisos encontrados (três avisos no exemplo a seguir):
Assim como nos erros do LookML, é possível expandir os avisos e ir para o código do problema selecionando o aviso no painel Integridade do projeto e passando o cursor sobre o ícone vermelho X para ver mais informações:
Como implantar as alterações
Depois de confirmar que suas alterações funcionarão corretamente, use a integração Git do Looker para confirmar e implantar suas alterações na produção.