Um projeto LookML é uma coleção de arquivos LookML que informam ao Looker como se conectar ao banco de dados, consultar os dados e controlar o comportamento da interface do usuário. É possível acessar os arquivos de projetos do LookML na seção Desenvolver do Looker ou na UI, conforme descrito na página de documentação Como acessar arquivos de projetos 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, um de visualização e possivelmente alguns dos outros tipos de arquivo descritos nesta página. Todos os arquivos do projeto têm extensões, mas elas ficam ocultas na lista de ambientes de desenvolvimento integrado se o projeto não estiver ativado para pastas nele.
Selecione os links abaixo para saber mais sobre cada um dos tipos de arquivos que podem ser usados em um projeto do LookML:
- Arquivos de modelo com extensão
.model.lkml - Ver arquivos com a extensão
.view.lkml - Arquivos do painel com extensão
.dashboard.lookml - Arquivos de dados com extensão
.topojson,.geojsonou.json - Arquivos de documentos com a extensão
.md - Arquivos de manifesto do projeto que sempre são nomeados como
manifest.lkml - Arquivos de bloqueio do manifesto com a extensão
.lkml - Arquivos de strings de localidade com extensão
.strings.json - Explore os arquivos com a extensão
.explore.lkml - Arquivos de teste de dados com extensão
.lkml - Arquivos de refinamento com a 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 dele e adicionar novos arquivos e pastas a ele usando o ambiente de desenvolvimento integrado do Looker.
Arquivos de modelo
Um arquivo de modelo especifica uma conexão de banco de dados e o conjunto de Explores que usam essa conexão. Um arquivo de modelo também define as próprias 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 definidas no modelo são vistas pelos usuários no menu Explorar do Looker.
Em outras palavras, é no arquivo de modelo que você define quais tabelas de dados devem ser usadas (como visualizações incluídas) e como elas devem ser combinadas, se necessário.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, inclusive arquivos de modelo.
Estrutura e sintaxe geral
Dentro das chaves de uma Análise, { }, você define parâmetros para ela. Você pode usar parâmetros join para mesclar outras visualizações a uma Análise em um arquivo de modelo.
No exemplo a seguir, o LookML em um arquivo de modelo de amostra define uma Análise chamada inventory_items e 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 os Itens de inventário apareçam na seção Explorar da navegação do Looker (links em inglês) e mescla os dados das visualizações products e distribution_centers com a visualização 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 de modelo, Parâmetros de exploração 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 para consultar 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 Como 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 ou a um cálculo no Looker. O Looker categoriza a maioria deles 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 Created Date, ID, Status, User ID e Count no seletor de campos da Análise Orders.
Os usuários com acesso à Análise Pedidos podem consultar a Análise Pedidos selecionando e filtrando esses campos.
Além de dimensões e medidas, você também pode criar várias dimensões com base no tempo de uma só vez usando grupos de dimensão ou especificar um filtro para seus usuários com os campos de filtro. Acesse a página de documentação Visualizar parâmetros para saber mais sobre os parâmetros do LookML em arquivos de visualização. Acesse a página de documentação Parâmetros de campo para saber mais sobre os parâmetros do LookML usados para definir dimensões, medidas, grupos de dimensões e campos de filtro no LookML.
Arquivos do dashboard
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 Como criar painéis definidos pelo usuário.
- Dashboards do LookML, que são armazenados como arquivos com controle de versões associados ao projeto.
Se o projeto tiver dashboards do LookML, eles serão definidos em arquivos 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 Como criar painéis do LookML.
Arquivos de documentos
Com os arquivos de documentos do Looker, é possível escrever documentação ou outras observações sobre seu modelo de dados do Looker usando o Markdown com sabores do GitHub. Assim, os usuários vão saber como a organização usa o Looker.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projetos do LookML, inclusive arquivos de documentos.
Visualizar o documento fora do ambiente de desenvolvimento integrado
Para ver um documento fora do ambiente de desenvolvimento integrado, o que você precisará fazer para aproveitar os recursos de navegação descritos nesta página, selecione a opção Visualizar documento no menu Ver ações do arquivo do arquivo do documento:
É possível distribuir o URL da página resultante a 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 seu documento
É possível adicionar uma barra lateral aos arquivos para que os usuários possam ver facilmente a estrutura das informações e navegar entre os documentos.
Para adicionar navegação na barra lateral, crie uma seção de navegação na primeira linha do documento. Marque o início e o fim da seção de navegação com três traços (---).
Você pode usar os seguintes parâmetros na seção de navegação:
navigation
Você pode usar navigation: true em um arquivo para adicionar a barra lateral de navegação. Por exemplo, você pode adicionar o seguinte código na parte superior 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 dele vai listar todos os documentos do projeto em ordem alfabética pelo nome de arquivo.
Além disso, você pode achar que organizar por nome de arquivo alfabético não é o ideal ou pode ter alguns documentos que não deseja que apareçam na navegação:
Neste exemplo, é possível listar os documentos Documento um, Documento Dois, Documento 3 e Documento 4 em ordem numérica em vez de em ordem alfabética, além de ocultar o documento Não exibir da barra lateral de navegação.
Para alterar a ordem dos documentos na barra lateral de navegação ou mostrar apenas um subconjunto de documentos na barra lateral, você pode usar 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 exibe o título do documento (se o documento começar com um título) ou o nome do arquivo do documento se não houver um título. Você pode adicionar um parâmetro title na parte de cima de um documento para mudar a forma como ele é 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 diferente na seção de navegação.
label
Para mudar a forma como um documento é listado na barra lateral de navegação, use os parâmetros document e label da seguinte maneira:
---
navigation:
- document_one
- document: document_two
label: Customized Label for Document Two
- document_three
- document_four
---
O valor label define como um documento é exibido na navegação da barra lateral, mesmo que ele tenha o próprio parâmetro title.
O exemplo anterior fica assim na barra lateral do documento:
section
Para 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
---
Nesse exemplo, o parâmetro section adiciona uma quebra de seção e o título de texto Nome da minha seção à barra lateral.
O título do texto não é um link em si e não se refere a nenhum dos seus arquivos de documentos.
Arquivos de dados
Arquivos de dados são arquivos JSON com extensão de arquivo .json, .topojson ou .geojson.
Com o parâmetro map_layer, é possível usar um arquivo JSON como um mapa personalizado que pode ser utilizado para plotar 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 seu mapa personalizado.
É possível editar um arquivo JSON no ambiente de desenvolvimento integrado do LookML e selecionar Salvar.
Para depuração, escolha View Raw ao selecionar o menu See file actions ao lado do nome do arquivo para visualizar o arquivo no formato bruto. Se você tiver a extensão adequada para visualizar o JSON no navegador, também terá a opção de exibir o arquivo em um formato Analisado.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como fazer upload de um arquivo JSON em um projeto do LookML.
Arquivos de manifesto do projeto
Seu projeto pode conter um arquivo de manifesto, que é usado para as seguintes tarefas:
- Especificar outros projetos a serem importados para o projeto atual
- Especificar as configurações de localização do modelo
- Como definir constantes do LookML
- Como adicionar uma extensão ao projeto
- Como adicionar uma visualização personalizada ao projeto
Cada projeto pode ter apenas um arquivo de manifesto, que precisa ser nomeado como manifest.lkml e localizado no nível raiz da estrutura de diretórios do seu projeto e no seu repositório Git.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para ver instruções de 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. 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 manifest_lock.lkml.
Os desenvolvedores do Looker não precisam criar ou editar um arquivo de bloqueio de manifesto, já que esses arquivos são gerenciados automaticamente pelo Looker.
Para mais informações, consulte a página de documentação Como 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 uma delas, incluindo sua 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 dela para cada rótulo ou descrição. Para mais informações sobre como criar arquivos de strings de localidade, acesse a página de documentação Como localizar seu modelo do LookML.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, inclusive arquivos de strings de localidade.
Conheça os 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 SQL, o FROM em uma instrução SQL. Consulte a página de documentação Como visualizar e interagir com Análises no Looker para informações sobre como os usuários interagem com as Análises para consultar dados.
As Análises geralmente são definidas em um arquivo de modelo. No entanto, às vezes você precisa de um arquivo "Explore" separado para uma tabela derivada ou para estender ou refinar a Análise entre modelos.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos do Explore.
Arquivos de teste de dados
Seu projeto pode ter arquivos de teste de dados usados para verificar a lógica do modelo LookML. Os testes de dados podem estar em arquivos de modelo ou de visualização. No entanto, 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 próprio e dedicado.
Consulte a página de documentação Como 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
Seu projeto pode ter arquivos usados para refinamentos do LookML. Com os refinamentos do LookML, é possível adaptar uma visualização ou Análise atual sem editar o arquivo do LookML que a contém. Os refinamentos do LookML podem ser contidos em arquivos modelo, visualização ou Explore, ou em um arquivo próprio dedicado.
Consulte a página de documentação Como gerenciar arquivos e pastas do LookML para instruções sobre como criar arquivos de projeto do LookML, incluindo arquivos de refinamento.
Outros arquivos
Muitos elementos do LookML podem ser hospedados em diferentes arquivos do projeto ou em arquivos dedicados próprios. Por exemplo, testes de dados podem ser hospedados em arquivos de modelo, arquivos de visualização ou nos próprios arquivos .lkml dedicados.