Um projeto do LookML é uma coleção de arquivos do LookML que informam ao Looker como se conectar ao banco de dados, como consultar os dados e como controlar o comportamento da interface do usuário. É possível acessar os arquivos de projeto do LookML na seção Desenvolver do Looker ou na UI, conforme descrito na página de documentação Acessar arquivos de projeto do Look3}
Os arquivos de projeto são organizados pelos desenvolvedores do Looker usando pastas no ambiente de desenvolvimento integrado.
Um projeto do LookML consiste em pelo menos um arquivo modelo e um arquivo de visualização, e possivelmente alguns dos outros tipos de arquivos descritos nesta página. Todos os arquivos de projeto têm extensões, embora elas fiquem ocultas na lista do ambiente de desenvolvimento integrado se o projeto não estiver ativado para pastas no ambiente de desenvolvimento integrado.
Selecione os links a seguir para mais informações sobre cada um dos tipos de arquivos que podem ser usados em um projeto do LookML:
- Arquivos modelo com extensão
.model.lkml - Arquivos de visualização com extensão
.view.lkml - Arquivos de painel com extensão
.dashboard.lookml - Arquivos de dados com extensão
.topojsonou.geojsonou.json - Arquivos de documento com extensão
.md - Arquivos de manifesto de projeto que sempre são nomeados
manifest.lkml - Arquivos de bloqueio de manifesto com extensão
.lkml - Arquivos de strings de localidade com extensão
.strings.json - Arquivos de análise com extensão
.explore.lkml - Arquivos de teste de dados com extensão
.lkml - Arquivos de refinamentos com extensão
.lkml - Outros arquivos com qualquer extensão de arquivo não listada anteriormente
Depois de criar um projeto do LookML, é possível acessar os arquivos do projeto e adicionar novos arquivos e pastas ao projeto usando o ambiente de desenvolvimento integrado do Looker.
Arquivos modelo
Um arquivo modelo especifica uma conexão de banco de dados e o conjunto de análises que usam essa conexão. Um arquivo modelo também define as análises e as relações delas com outras visualizações. Uma análise é um ponto de partida para consultar seus dados. Em termos de SQL, uma análise é a cláusula FROM de uma consulta. As análises definidas no modelo são mostradas aos usuários quando eles acessam o menu Análise do Looker.
Em outras palavras, o arquivo modelo é onde você define quais tabelas de dados devem ser usadas (como visualizações incluídas) e como elas devem ser unidas, se necessário.
Observações sobre arquivos modelo:
- As análises geralmente são definidas em um arquivo modelo. No entanto, às vezes, é necessário um arquivo do Explore separado para uma tabela derivada ou para estender um Explore ou para refinar um Explore em modelos.
- Um arquivo modelo precisa ter um nome exclusivo em todos os projetos na sua instância. Se a instância contiver dois arquivos
.model.lkmlcom o mesmo nome, é provável que você encontre erros, como erros de configuração de modelo na página Projetos do LookML e erros de renderização para painéis do LookML, já que os painéis do LookML usam o nome do modelo no formato do URL (<hostname>/dashboard/model_name::<dashboard_name>
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos modelo.
Estrutura e sintaxe geral
Dentro das chaves de uma análise, { }, você define parâmetros para a análise. É possível usar parâmetros join para unir outras visualizações a uma análise em um arquivo modelo.
No exemplo a seguir, o LookML em um arquivo modelo de amostra define uma análise chamada inventory_items, juntamente com as visualizações unidas:
connection: "thelook_events"
explore: inventory_items {
join: products {
type: left_outer
sql_on: ${inventory_items.product_id} = ${products.id} ;;
relationship: many_to_one
}
join: distribution_centers {
type: left_outer
sql_on: ${products.distribution_center_id} = ${distribution_center.id} ;;
relationship: many_to_one
}
}
Essa definição do LookML faz com que Itens de inventário apareçam na seção Análise da navegação do Looker e une dados das visualizações products e distribution_centers à visualização inventory_items.
Para informações mais específicas sobre as estruturas do LookML em um arquivo modelo, consulte a página de documentação Termos e conceitos do LookML.
Leia as páginas de documentação Parâmetros do modelo, Parâmetros de análise e Parâmetros de união para saber mais sobre os parâmetros do LookML no arquivo modelo.
Arquivos de visualização
Um arquivo de visualização geralmente define uma única "visualização" no Looker. Uma visualização corresponde a uma única tabela no banco de dados ou a uma única tabela derivada. O arquivo de visualização especifica uma tabela para consultar e os campos (dimensões e medições) a serem incluídos nessa tabela para que os usuários possam criar consultas com esses campos na interface do Looker.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de visualização.
Estrutura e sintaxe geral
Dentro das chaves de cada visualização, { }, há definições de campo, que geralmente correspondem a uma coluna na tabela subjacente ou a um cálculo no Looker. O Looker categoriza a maioria dessas definições como dimensões ou medidas.
No exemplo a seguir de um arquivo de visualização, o arquivo orders.view inclui definições para as dimensões id, status e user_id, o grupo de dimensões created e a medida count:
view: orders {
sql_table_name: demo_db.orders ;;
drill_fields: [id]
dimension: id {
primary_key: yes
type: number
sql: ${TABLE}.id ;;
}
dimension: status {
type: string
sql: ${TABLE}.status ;;
}
dimension: user_id {
type: number
# hidden: yes
sql: ${TABLE}.user_id ;;
}
dimension_group: created {
type: time
timeframes: [
raw,
time,
date,
week,
month,
quarter,
year
]
sql: ${TABLE}.created_at ;;
}
measure: count {
type: count
drill_fields: [id, users.id, users.first_name, users.last_name, order_items.count]
}
}
A definição desses campos na visualização orders expõe os campos Data de criação, ID, Status, ID do usuário e Contagem no seletor de campos da análise Pedidos.
Os usuários que têm acesso à análise Pedidos podem consultar a análise Pedidos selecionando e filtrando esses campos.
Além de dimensões e medidas, também é possível criar várias dimensões com base no tempo de uma só vez usando grupos de dimensões ou especificar um filtro para os usuários com campos de filtro. Acesse a página de documentação Parâmetros de visualização para saber mais sobre os parâmetros do LookML em arquivos de visualização e acesse a página de documentação Parâmetros de campo para informações sobre os parâmetros do LookML usados para definir dimensões, medidas, grupos de dimensões e campos de filtro no LookML.
Arquivos de painel
O Looker é compatível com dois tipos de painéis:
- Painéis definidos pelo usuário, que podem ser criados por usuários não desenvolvedores sem usar o LookML. Para mais detalhes, consulte a página de documentação Criar painéis definidos pelo usuário.
- Painéis do LookML, que são armazenados como arquivos com controle de versão associados ao projeto.
Se o projeto contiver painéis do LookML, eles serão definidos em arquivos de painel dedicados no ambiente de desenvolvimento integrado, com a extensão .dashboard.lookml.
Para mais informações sobre painéis do LookML, consulte a página de documentação Criar painéis do LookML.
Arquivos de documento
Os arquivos de documento do Looker permitem escrever documentação ou outras observações sobre o modelo de dados do Looker usando o Markdown com sabor do GitHub. Isso pode ser útil para que os usuários se familiarizem com a forma como a organização usa o Looker.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de documento.
Como visualizar o documento fora do ambiente de desenvolvimento integrado
Para visualizar um documento fora do ambiente de desenvolvimento integrado, o que é necessário para aproveitar os recursos de navegação descritos nesta página, escolha a opção Visualizar documento no menu Ver ações do arquivo do arquivo de documento:
É possível distribuir o URL da página resultante para outros usuários para que eles possam acessar o documento diretamente sem precisar navegar pelo menu Desenvolver do Looker.
Como adicionar uma estrutura de navegação ao documento
É possível adicionar uma barra lateral aos arquivos de documento para que os usuários possam conferir a estrutura das informações e navegar entre os documentos.
Para adicionar a navegação da barra lateral a um documento, crie uma seção de navegação começando na primeira linha do documento. Marque o início e o fim da seção de navegação com três traços (---).
É possível usar os seguintes parâmetros na seção de navegação:
navigation
É possível usar navigation: true em um arquivo de documento para adicionar a barra lateral de navegação a esse documento. Por exemplo, é possível adicionar o código a seguir à parte de cima de um arquivo Markdown:
---
navigation: true
---
Esse código adiciona ao documento uma barra lateral de navegação com links para todos os documentos do projeto. Se você incluir apenas navigation: true em um documento, a barra lateral desse documento vai listar todos os documentos do projeto em ordem alfabética por nome de arquivo.
Além disso, a organização por nome de arquivo alfabético pode não ser ideal, ou você pode ter alguns documentos que não quer que apareçam na navegação:
Neste exemplo, talvez você queira listar os documentos Documento um, Documento dois, Documento três e Documento quatro em ordem numérica em vez de alfabética, bem como ocultar o documento Não mostrar na barra lateral de navegação.
Para mudar a ordem dos documentos na barra lateral de navegação ou mostrar apenas um subconjunto dos documentos na barra lateral, use este formato:
---
navigation:
- document_one
- document_two
- document_three
- document_four
---
Agora a navegação vai mostrar apenas os arquivos de documento que você quer que sejam mostrados, e eles vão aparecer em uma ordem mais lógica:
title
Por padrão, a barra lateral mostra o cabeçalho do documento (se o documento começar com um cabeçalho) ou o nome do arquivo se não houver cabeçalho no arquivo. É possível adicionar um parâmetro title na parte de cima de um documento para mudar a forma como o documento é mostrado nas barras laterais de navegação:
---
title: New Title for Users
---
Esse título será usado como o texto do link nas barras laterais de navegação de todos os documentos, a menos que você especifique um label na seção de navegação de um documento.
label
Se você quiser mudar a forma como um documento é listado na barra lateral de navegação, use os parâmetros document e label desta forma:
---
navigation:
- document_one
- document: document_two
label: Customized Label for Document Two
- document_three
- document_four
---
O valor label define como um documento é mostrado na navegação da barra lateral do documento, mesmo que o documento a que ele se refere tenha o próprio title parâmetro.
O exemplo anterior aparece assim na barra lateral do documento:
section
Se você quiser dividir a barra lateral de navegação em seções, use o parâmetro section desta forma:
---
navigation:
- document_one
- document_two
- section: My Section Name
- document_three
- document_four
---
Neste exemplo, o parâmetro section adiciona uma quebra de seção e o cabeçalho de texto Nome da minha seção à barra lateral.
O cabeçalho de texto não é um link em si. Ele não se refere a nenhum dos arquivos de documento.
Arquivos de dados
Os arquivos de dados são JSON arquivos com extensão .json, .topojson, ou .geojson.
O parâmetro map_layer permite usar um arquivo JSON como um mapa personalizado que pode ser usado para plotar os dados no Looker.
Em seguida, use o parâmetro map_layer_name com uma dimensão para associar um valor de dados (como "Paris") a uma região geográfica no mapa personalizado.
É possível editar um arquivo JSON no ambiente de desenvolvimento integrado do LookML e selecionar Salvar.
Para depuração, é possível escolher Visualizar bruto selecionando o menu Ver ações do arquivo ao lado do nome do arquivo para visualizar o arquivo no formato bruto. Se você tiver a extensão adequada para visualizar JSON no navegador, também terá a opção de visualizar o arquivo em um formato analisado.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como fazer upload de um arquivo JSON para um projeto do LookML.
Arquivos de manifesto de projeto
O projeto pode conter um arquivo de manifesto de projeto, que é usado para as seguintes tarefas:
- Especificar outros projetos para importar para o projeto atual
- Especificar configurações de localização do modelo
- Definir constantes do LookML
- Adicionar uma extensão ao projeto
- Adicionar uma visualização personalizada ao projeto
Consulte a página de documentação Parâmetros de manifesto de projeto para conferir um exemplo de arquivo de manifesto e os possíveis parâmetros para arquivos de manifesto. Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de manifesto de projeto.
Observações sobre arquivos de manifesto de projeto:
- Cada projeto só pode ter um arquivo de manifesto, e ele precisa ser nomeado
manifest.lkmle estar localizado no nível raiz da estrutura de diretórios do projeto e no repositório Git. - O Looker não oferece suporte a um arquivo de manifesto de projeto vazio. Se o arquivo de manifesto estiver vazio, exclua o arquivo.
- Cada projeto pode ter apenas um arquivo de manifesto.
- O arquivo de manifesto de projeto precisa ser nomeado
manifest.lkmle estar localizado no nível raiz da estrutura de diretórios do projeto.
Arquivos de bloqueio de manifesto
Os arquivos de bloqueio de manifesto são criados automaticamente quando uma dependência remota é adicionada ao arquivo de manifesto do projeto. O Looker usa o arquivo de bloqueio de manifesto para rastrear a versão dos projetos remotos especificados no arquivo de manifesto. O arquivo de bloqueio de manifesto é listado no painel do navegador de arquivos do ambiente de desenvolvimento integrado do Looker e tem o nome de arquivo manifest_lock.lkml.
Os desenvolvedores do Looker não precisam criar ou editar um arquivo de bloqueio de manifesto, já que os arquivos de bloqueio são gerenciados automaticamente pelo Looker.
Para mais informações, consulte a página de documentação Importar arquivos de outros projetos.
Arquivos de strings de localidade
Se você estiver localizando o modelo de dados, será necessário criar arquivos de strings de localidade para cada localidade que você quiser localizar, incluindo a localidade padrão (por exemplo, geralmente inglês nos EUA).
Os arquivos de strings de localidade listam pares de chave-valor para cada rótulo e descrição que você está localizando no modelo. O arquivo de strings de cada localidade precisa fornecer a tradução dessa localidade para cada rótulo ou descrição. Mais informações sobre como criar arquivos de strings de localidade aparecem na página de documentação Localizar o modelo do LookML.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de strings de localidade.
Arquivos de análise
Uma análise é uma visualização que os usuários podem consultar. Uma análise é o ponto de partida para uma consulta ou, em termos de SQL, o FROM em uma instrução SQL. Consulte a página de documentação Visualizar e interagir com análises no Looker para informações sobre como os usuários interagem com as análises para consultar seus dados.
As análises geralmente são definidas em um arquivo modelo. No entanto, às vezes, é necessário um arquivo do Explore separado para uma tabela derivada ou para estender ou refinar uma Análise em modelos.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de análise.
Arquivos de teste de dados
O projeto pode ter arquivos de teste de dados usados para verificar a lógica do modelo do LookML. Os testes de dados podem estar contidos em arquivos modelo ou em arquivos de visualização, mas, se os desenvolvedores quiserem usar os mesmos testes de dados em vários modelos diferentes, pode ser útil manter os testes de dados em um arquivo dedicado.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de teste de dados.
Arquivos de refinamentos
O projeto pode ter arquivos usados para refinamentos do LookML. Com os refinamentos do LookML, é possível adaptar uma visualização ou análise sem editar o arquivo do LookML que a contém. Os refinamentos do LookML podem estar contidos em arquivos modelo, de visualização ou de análise, ou no próprio arquivo dedicado.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de refinamentos.
Outros arquivos
Muitos elementos do LookML podem ser armazenados em arquivos diferentes no projeto ou nos próprios arquivos dedicados. Por exemplo, os testes de dados podem ser armazenados em arquivos modelo, arquivos de visualização ou nos próprios arquivos .lkml dedicados.