Um projeto do LookML é uma coleção de arquivos LookML que informam ao Looker como se conectar ao banco de dados, como consultar dados e como 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 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 arquivo de visualização e possivelmente alguns dos outros tipos de arquivos descritos nesta página. Todos os arquivos do projeto têm extensões, mas elas ficam 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 obter mais informações 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 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 extensão
.md - Arquivos de manifesto do projeto que sempre são nomeados como
manifest.lkml - Arquivos de bloqueio de manifesto com a extensão
.lkml - Arquivos de strings de localidade com a extensão
.strings.json - Explore arquivos com a extensão
.explore.lkml - Arquivos de teste de dados com a 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 e adicionar novos arquivos e pastas ao projeto 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 Análises que usa essa conexão. Um arquivo de modelo também define as Análises em si 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 aparecem para os usuários no menu Análise do Looker.
Em outras palavras, o arquivo do 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.
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 modelo.
Estrutura e sintaxe geral
Dentro das chaves de uma Análise, { }, você define parâmetros para ela. É possível 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, 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 os Itens de inventário apareçam na seção Explorar da navegação do Looker 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 do modelo, Explorar parâmetros e Parâmetros de junção 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 dessa 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 delas como dimensões ou medidas.
No exemplo a seguir de um arquivo de visualização, o orders.view inclui definições para as dimensões id, status e user_id, o grupo de dimensões created e a medição 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 para a análise Orders.
Os usuários com acesso à Análise de Pedidos podem consultar a Análise Pedidos selecionando e filtrando esses campos.
Além das dimensões e medições, 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 Ver parâmetros para saber mais sobre os parâmetros do LookML nos arquivos de visualização. Consulte também a página Parâmetros de campo para informações sobre os parâmetros do LookML usados para definir dimensões, medições, grupos de dimensões 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 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.
- Painéis 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 de dashboard dedicados no ambiente de desenvolvimento integrado, com a extensão .dashboard.lookml.
Para mais informações sobre os dashboards do LookML, consulte a página de documentação Como criar dashboards do LookML.
Arquivos de documentos
Com os arquivos de documentos do Looker, é possível escrever documentações ou outras observações sobre seu modelo de dados do Looker usando o Markdown com estilo do GitHub (link em inglês). 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 projeto do LookML, incluindo arquivos de documentos.
Como visualizar o documento fora do ambiente de desenvolvimento integrado
Para acessar um documento fora do ambiente de desenvolvimento integrado, o que é necessário para usar os recursos de navegação descritos nesta página, escolha a opção Ver documento no menu Ver ações do arquivo do documento:
Você pode distribuir o URL da página resultante para outros usuários. Assim, eles não precisam navegar pela seção do desenvolvedor do Looker para acessá-la.
Como adicionar uma estrutura de navegação a um documento
Você pode adicionar uma barra lateral aos arquivos dos documentos para que os usuários possam ver 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 (---).
Você pode usar os seguintes parâmetros na seção de navegação:
navigation
Você pode usar navigation: true em um arquivo do documento para adicionar a barra lateral de navegação a ele. Por exemplo, é possível adicionar o seguinte código à 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 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 você 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 ordem alfabética, bem como ocultar o documento Não exibir na barra lateral de navegação.
Para alterar 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 documentos que você quer mostrar, em uma ordem mais lógica:
title
Por padrão, a barra lateral exibe o título do documento (se começar com um cabeçalho) ou o nome do arquivo do documento se não houver um título nele. É possível adicionar um parâmetro title na parte de cima de um documento para mudar como ele aparece 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 uma label diferente na seção de navegação do documento.
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 aparece 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 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 da seguinte maneira:
---
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 título de texto Nome da seção à barra lateral.
O título do texto não é um link em si; ele não se refere a nenhum dos seus 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 utilizado para plotar seus dados no Looker.
Em seguida, você usa 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 IDE do LookML e selecionar Salvar.
Para depuração, escolha View Raw. Para ver o arquivo no formato bruto, selecione o menu See file actions ao lado do nome do arquivo. Se você tiver a extensão adequada para ver JSON no navegador, também terá a opção de ver 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 para um projeto do LookML.
Arquivos de manifesto do projeto
Seu projeto pode conter um arquivo de manifesto de projeto, que é usado para as seguintes tarefas:
- Especificar outros projetos a serem importados para o projeto atual
- Como especificar configurações de localização de modelos
- Como definir constantes do LookML
- Como adicionar uma extensão ao projeto
- Adicionar uma visualização personalizada ao projeto
Cada projeto pode ter apenas um arquivo de manifesto. Ele precisa ser nomeado como manifest.lkml e localizado no nível raiz da estrutura de diretórios do projeto e no seu repositório Git.
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 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 de manifesto aparece 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 eles são gerenciados automaticamente pelo Looker.
Para obter 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, será necessário criar arquivos de strings de localidade para cada localidade que você quer localizar, incluindo a padrão (por exemplo, geralmente em 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. Saiba mais sobre a criação de arquivos de strings de localidade na 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, 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 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 estender ou refinar uma Análise em vários 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 do LookML. Os testes de dados podem estar em arquivos de modelo ou de visualização. No entanto, se seus desenvolvedores quiserem usar os mesmos testes de dados em vários modelos diferentes, talvez seja ú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 refinamento do LookML. Com os refinamentos do LookML, é possível adaptar uma visualização ou Análise existentes sem editar o arquivo do LookML que a contém. Os refinamentos do LookML podem estar contidos em arquivos de modelo, visualização ou Análise, 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 arquivos diferentes no projeto ou em arquivos próprios dedicados. Por exemplo, os testes de dados podem ser armazenados em arquivos de modelo, arquivos de visualização ou seus próprios arquivos .lkml dedicados.