Um projeto do LookML é uma coleção de arquivos 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. Você pode acessar os arquivos de projeto do LookML na seção Desenvolver no Looker ou na UI, conforme descrito na página de documentação Como acessar arquivos de projeto do LookML.
Os arquivos do 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 de modelo e um de visualização, além de alguns dos outros tipos de arquivos descritos nesta página. Todos os arquivos de projeto têm extensões, embora elas estejam 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 saber mais sobre cada um dos tipos de arquivos que podem ser usados em um projeto do LookML:
- Arquivos de modelo com a extensão
.model.lkml - Acessar arquivos com a extensão
.view.lkml - Arquivos de painel com a extensão
.dashboard.lookml - Arquivos de dados com a extensão
.topojson,.geojsonou.json - Arquivos de documento com a extensão
.md - Arquivos de manifesto do projeto, que sempre têm o nome
manifest.lkml. - Arquivos de bloqueio de manifesto com a extensão
.lkml - Arquivos de strings de localidade com a extensão
.strings.json - Conhecer os arquivos com a extensão
.explore.lkml - Arquivos de teste de dados com a extensão
.lkml - Arquivos de refinamentos com a extensão
.lkml - Outros arquivos com qualquer extensão não listada anteriormente
Depois de criar um projeto do LookML, você pode acessar os arquivos do projeto e adicionar novos arquivos e pastas ao projeto usando o Looker IDE.
Arquivos de modelo
Um arquivo de modelo especifica uma conexão de banco de dados e o conjunto de Análises detalhadas que usam essa conexão. Um arquivo de modelo também define as análises e as relações delas com outras visualizações. Uma Análise é o ponto de partida para consultar seus dados. Em termos de SQL, uma Análise é a cláusula FROM de uma consulta. As Análises que você define no modelo são mostradas aos usuários quando eles acessam o menu Análise do Looker.
Em outras palavras, o arquivo de modelo é onde você define quais tabelas de dados devem ser usadas (como visualizações incluídas) e como elas devem ser agrupadas, se necessário.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de modelo.
Estrutura e sintaxe geral
Dentro dos colchetes de uma Análise, { }, você define os parâmetros para a Análise. É possível usar parâmetros join para unir outras visualizações a uma Análise em um arquivo de modelo.
No exemplo a seguir, o LookML em um arquivo de modelo de exemplo define uma análise detalhada chamada inventory_items, com as visualizações mescladas:
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 Explorar da navegação do Looker e une os dados das visualizações products e distribution_centers à inventory_items.
Para informações mais específicas sobre as estruturas do LookML em um arquivo de 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 detalhada e Parâmetros de mesclagem para saber mais sobre os parâmetros do LookML no arquivo de modelo.
Mostrar arquivos
Um arquivo de visualização geralmente define uma única "visualização" no Looker. Uma visualização corresponde a uma única tabela no seu banco de dados ou a uma única tabela derivada. O arquivo de visualização especifica uma tabela a ser consultada e os campos (dimensões e medidas) 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 ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de visualização.
Estrutura e sintaxe geral
Dentro dos colchetes de cada visualização, { }, estão as 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 delas como dimensões ou medições.
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ão 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 para a Análise Pedidos.
Os usuários que têm acesso à Análise detalhada Pedidos podem consultar esse recurso selecionando e filtrando esses campos.
Além das dimensões e métricas, você também pode criar várias dimensões baseadas em tempo de uma só vez usando grupos de dimensões ou especificar um filtro para seus 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 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ão e campos de filtro no LookML.
Arquivos do painel
O Looker oferece suporte a dois tipos de painéis:
- Painéis definidos pelo usuário, que podem ser criados por usuários que não sã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 controlados por versão associados ao projeto.
Se o projeto tiver 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 os painéis do LookML, consulte a página de documentação Criar painéis do LookML.
Arquivos de documentos
Os arquivos de documento do Looker permitem que você escreva documentação ou outras anotações sobre seu modelo de dados do Looker usando Markdown com estilo GitHub. Isso pode ajudar os usuários a se familiarizarem com a forma como sua organização usa o Looker.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de documento.
Como acessar o documento fora do ambiente de desenvolvimento integrado
Para conferir um documento fora do ambiente de desenvolvimento integrado, o que você precisa fazer para aproveitar os recursos de navegação descritos nesta página, escolha a opção View Document no menu See file actions para o arquivo do documento:
Você pode distribuir o URL da página resultante para outros usuários, para que eles não precisem navegar pela seção de desenvolvedores do Looker para acessá-la.
Adicionar uma estrutura de navegação ao documento
É possível adicionar uma barra lateral aos arquivos de documentos para que os usuários possam conferir facilmente 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 ele. Por exemplo, você pode adicionar o seguinte código ao início 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 pelo nome do arquivo.
Além disso, talvez você ache que organizar por nome de arquivo em ordem alfabética não é ideal ou talvez tenha alguns documentos que não quer que apareçam na navegação:
Neste exemplo, você pode listar os documentos Document One, Document Two, Document Three e Document Four em ordem numérica, em vez de ordem alfabética, e ocultar o documento Do Not Display na barra lateral de navegação.
Para mudar a ordem dos documentos na barra lateral de navegação ou mostrar apenas um subconjunto deles, 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 mostrar, e eles vão aparecer em uma ordem mais lógica:
title
Por padrão, a barra lateral mostra o título do documento (se ele começar com um título) ou o nome do arquivo se não houver título. É possível adicionar um parâmetro title na parte de cima de um documento para mudar a forma como ele é exibido 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 diferente 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, mesmo que o documento a que ele se refere tenha o próprio parâmetro title.
O exemplo anterior tem esta aparência 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 um ponto de corte e o título de texto My Section Name à barra lateral.
O título 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 arquivos JSON com a 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 representar seus 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.
Você pode editar um arquivo JSON no ambiente de desenvolvimento integrado do LookML e selecionar Salvar.
Para depurar, escolha Ver em formato bruto selecionando o menu Conferir ações do arquivo ao lado do nome do arquivo para visualizar o arquivo em 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 ver instruções sobre como fazer upload de um arquivo JSON para um projeto do LookML.
Arquivos de manifesto do projeto
Seu projeto pode conter um arquivo de manifesto do projeto, que é usado para as seguintes tarefas:
- Como especificar outros projetos para importar para o projeto atual
- Como especificar as configurações de localização do modelo
- Como definir constantes do LookML
- Como adicionar uma extensão ao seu projeto
- Como adicionar uma visualização personalizada ao seu projeto
Cada projeto só pode ter um arquivo de manifesto, que precisa ser chamado de manifest.lkml e estar localizado no nível raiz da estrutura de diretórios do projeto e no repositório do Git.
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 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 do manifesto está 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, porque 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 seu modelo de dados, vai precisar criar arquivos de strings de localidade para cada localidade que quiser, incluindo a localidade padrão (por exemplo, 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 dela para cada rótulo ou descrição. Mais informações sobre a criação de arquivos de strings de localidade estão disponíveis na página de documentação Como localizar seu 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.
Acessar arquivos
Uma análise é uma visualização que os usuários podem consultar. Uma Análise é o ponto de partida de uma consulta ou, em termos de SQL, o FROM em uma instrução SQL. Consulte a página de documentação Como visualizar e interagir com as Análises no Looker para saber como os usuários interagem com as Análises para consultar seus dados.
As análises geralmente são definidas em um arquivo de modelo. No entanto, às vezes, você precisa de um arquivo de Análise separado para uma tabela derivada ou para ampliar ou refinar uma Análise em vários modelos.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de análise detalhada.
Arquivos de teste de dados
Seu projeto pode ter arquivos de teste de dados usados para verificar a lógica do modelo do LookML. Os testes de dados podem ser contidos em arquivos de modelo ou de visualização, mas, se os desenvolvedores quiserem usar os mesmos testes de dados em vários modelos diferentes, talvez seja útil manter os testes de dados em um arquivo dedicado.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de teste de dados.
Arquivos de refinamento
Seu projeto pode ter arquivos usados para aprimoramentos do LookML. Com os refinamentos do LookML, você pode adaptar uma visualização ou Explorar sem editar o arquivo do LookML que a contém. Os refinamentos do LookML podem ser contidos em arquivos de modelo, visualização ou do Explore ou em um arquivo dedicado.
Consulte a página de documentação Gerenciar arquivos e pastas do LookML para ver instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de refinamento.
Outros arquivos
Muitos elementos do LookML podem ser armazenados em arquivos diferentes no seu projeto ou em arquivos dedicados. Por exemplo, os testes de dados podem ser armazenados em arquivos de modelo, arquivos de visualização ou arquivos .lkml dedicados.