É possível usar vários parâmetros do LookML para facilitar a experiência das Análises, mudando a forma como os campos aparecem na interface do usuário sem mudar o LookML. Nesta página, apresentamos uma visão geral dos parâmetros do LookML que modificam a aparência do menu da Análise do Looker e do seletor de campo.
No Looker, os usuários encontram as Análises listadas no menu Explorar. | Em uma Análise, os usuários podem usar o seletor de campo para escolher os campos (dimensões e medidas) que vão usar para consultar os dados. |
Esta página lista cada parâmetro usado com frequência com um link para sua página de referência completa, uma breve descrição de sua função e uma imagem do que ele faz.
Se quiser dicas e sugestões para criar uma Análise fácil de usar, consulte a página Práticas recomendadas: criar uma experiência positiva para os usuários do Looker.
Explorar nome e menu
Nesta seção, descrevemos o comportamento padrão do nome e da aparência de uma Análise no menu Explorar. Em seguida, descrevemos os parâmetros do LookML que permitem mudar esse comportamento:
Comportamento padrão do menu "Explorar"
Nomes de modelos
Por padrão, o menu Explorar é organizado por nomes de modelo, que são determinados pelo nome de cada arquivo de modelo. O menu Explorar mostra uma versão formatada do nome do modelo, com sublinhados alterados para espaços e cada palavra maiúscula. Abaixo de cada nome de modelo, há uma lista das Análises definidas nesse arquivo.
Conheça os nomes
O nome de cada Análise no menu é baseado no parâmetro explore
correspondente no arquivo de modelo. Assim como os nomes dos modelos, os nomes do Explore são formatados no menu para que os sublinhados sejam alterados para espaços e cada palavra seja maiúscula. O nome da Análise também aparece como o título da Análise acima do seletor de campo.
No exemplo a seguir, a Análise order_items
é definida no arquivo de modelo e_commerce_model.model
:
explore: order_items {
join: orders {
type: left_outer
sql_on: ${order_items.order_id} = ${orders.id} ;;
relationship: many_to_one
}
}
A Análise order_items
aparece como Itens do pedido no menu "Explorar" e no seletor de campo.
Menu "Explorar": | Seletor de campo: |
Para mais informações sobre os arquivos de modelo, consulte a página de documentação Noções básicas sobre arquivos de modelo e visualização. Para mais informações sobre como definir "Explores", consulte a página da documentação do parâmetro explore
.
label
(modelo)
O parâmetro label
de um modelo renomeia um modelo no menu Explorar sem mudar a forma como ele é referenciado no LookML. Os URLs de análise, o ambiente de desenvolvimento integrado do Looker e o SQL Runner ainda refletem o nome real do modelo. A forma como o modelo será referenciado nas configurações do LookML e do administrador não será alterada.
Por padrão, o modelo market_research.model
aparece como Pesquisa de mercado no menu "Explorar".
É possível usar o parâmetro label
para renomear o modelo no menu "Explorar". Por exemplo, você adiciona o código label: "Marketing R&D"
ao arquivo de modelo market_research.model
:
label: "Marketing R&D"
Neste exemplo, o Looker mostra o nome do modelo da seguinte maneira no menu "Explorar":
label
(Explorar)
O parâmetro label
de uma Análise renomeia uma Análise no menu Explorar e na página Explorar sem mudar como ela é referenciada no LookML.
Se o parâmetro label
não for usado, o nome da Análise vai ser mostrado de acordo com o comportamento padrão.
group_label
(Explorar)
O parâmetro group_label
de uma Análise muda a organização padrão do menu Explorar. Em vez de listar cada Explore abaixo do nome do modelo, group_label
permite definir um título personalizado para listar uma ou mais Análises.
Neste exemplo, Explore Clientes, Inventário, Itens de pedido e Dados do usuário, que estão listados no rótulo de grupo Consultas da loja on-line:
description
(Explorar)
O parâmetro description
da Análise permite adicionar uma descrição à UI para que os usuários possam consultar mais informações ao criar relatórios.
Para conferir a descrição, os usuários podem passar o cursor sobre o ícone de informações, ao lado do nome da Análise, na parte de cima do seletor de campo. O ícone de informações também aparece na lista suspensa da ferramenta "Explores". Se você não adicionar explicitamente uma descrição a um Explore, nenhuma descrição será exibida.
hidden
(Explorar)
O parâmetro hidden
de uma Análise oculta essa opção do menu Explorar. Por padrão, a opção hidden
fica desativada e a Análise é mostrada. hidden
não oculta o LookML nem impede o acesso a uma Análise pelo URL. hidden
não é um recurso de segurança, mas um recurso de apresentação.
Por exemplo, adicionar o código LookML hidden: yes
ao LookML da Análise inventory
no exemplo a seguir oculta a Análise de inventário no menu "Explorar":
explore: inventory {
hidden: yes
join: order_facts {
view_label: "Orders"
relationship: many_to_one
sql_on: ${order_facts.order_id} = ${order_items.order_id} ;;
}
}
Seletor de campo
Nesta seção, descrevemos o comportamento padrão do seletor de campo e os parâmetros do LookML que permitem alterar esse comportamento.
Mude como os nomes das visualizações aparecem no seletor de campo com:
Altere a forma como os nomes de campos individuais aparecem no seletor de campo com:
Altere a forma como os campos são organizados no seletor de campo com:
Comportamento padrão do seletor de campo
Por padrão, o seletor de campo é organizado por cabeçalhos que correspondem às visualizações especificadas pelo parâmetro view
do LookML. Os campos de cada visualização são agrupados no seletor de campos. O tipo de campo (dimensão, grupo de dimensões, medida, campo de filtro e campo de parâmetro) determina onde ele vai aparecer na visualização. A menos que o parâmetro label
seja usado para mudar o nome de exibição, o seletor de campo vai mostrar uma versão formatada da visualização ou do nome do campo do LookML, com sublinhados alterados para espaços e cada palavra maiúscula.
No exemplo a seguir, o Looker mostra a visualização accounts
como Accounts no seletor de campo, que é o comportamento padrão:
view: accounts {
sql_table_name: accounts ;;
}
O exemplo a seguir mostra como os nomes de uma dimensão, um grupo de dimensão e uma medida aparecem por padrão. A mesma formatação será aplicada aos nomes de todos os campos de filtro e de parâmetro.
dimension: account_number {
primary_key: yes
type: number
sql: ${TABLE}.account_number ;;
}
dimension: name {
type: string
sql: ${TABLE}.name ;;
}
dimension_group: created {
type: time
timeframes: [raw, time, date, week, month, quarter, year]
sql: ${TABLE}.created_date ;;
}
measure: average_annual_revenue {
type: average
sql: ${annual_revenue} ;;
value_format_name: custom_amount_value_format
}
Neste exemplo, o seletor de campo mostra os nomes de campo padrão Número da conta, Nome, Data de criação e Receita média anual para as dimensões account_number
e name
, o grupo de dimensões created
e a medida average_annual_revenue
, respectivamente.
Se você mudar o nome de um campo, o seletor vai se adaptar ao novo nome, mas você pode adicionar um parâmetro alias
com o nome antigo do campo. Esse parâmetro fornece nomes alternativos para um campo que pode aparecer no URL de uma consulta. Isso pode ser útil nos casos em que os nomes dos campos em um modelo mudam, mas algumas pessoas compartilharam links para dados e você quer manter os URLs atuais funcionando.
view_label
(Explorar)
O parâmetro view_label
de uma Análise muda a forma como o grupo de campos da visualização básica é marcado no seletor de campo sem mudar a forma como a Análise e os campos são referenciados no LookML.
Por exemplo, se você mesclar uma visualização order_facts
a uma Análise chamada order_items
, poderá usar o parâmetro view_label
para definir o rótulo que o Looker vai mostrar para a visualização order_facts
no seletor de campo da seguinte maneira:
explore: order_items {
label: "Order Items"
join: order_facts {
view_label: "Orders and more"
relationship: many_to_one
sql_on: ${order_facts.order_id} = ${order_items.order_id} ;;
}
}
Neste exemplo, a visualização order_facts
aparece como Pedidos e mais no seletor de campo da Análise Itens do pedido.
view_label
(participar)
Com o parâmetro view_label
de uma visualização, você pode agrupar campos de uma visualização sob o nome de outra no seletor de campos. Se você não adicionar explicitamente um view_label
a uma junção, o view_label
terá o nome padrão da junção.
Por exemplo, você mescla a visualização products
com a Análise product_facts
:
explore: product_facts {
join: products {
type: left_outer
sql_on: ${product_facts.product_id} = ${products.id} ;;
relationship: many_to_one
}
}
Neste exemplo, como um rótulo de visualização não é especificado, os campos da visualização products
são agrupados em Produtos no seletor de campos, separados da visualização Fatos do produto:
É possível usar o parâmetro view_label
para adicionar um rótulo de visualização à visualização products
unida, como no exemplo a seguir:
explore: product_facts {
join: products {
view_label: "Product Facts"
type: left_outer
sql_on: ${product_facts.product_id} = ${products.id} ;;
relationship: many_to_one
}
}
Isso agrupa os campos da visualização products
no rótulo de visualização Facts do produto no seletor de campos:
label
(visualização)
O parâmetro label
de uma visualização muda a forma como ela é rotulada no seletor de campo, sem mudar a forma como ela é referenciada no LookML. Se não for especificado, o rótulo vai ter como padrão o nome da visualização. Ao contrário de view_label
(Explorar) e view_label
(Participar), esse parâmetro afeta todas as Análises que usam a visualização.
Por exemplo, é possível usar o parâmetro label
para especificar um rótulo para a visualização inventory_items
da seguinte maneira:
view: inventory_items {
label: "Items in Inventory"
sql_table_name: inventory_items ;;
}
Neste exemplo, o seletor de campo exibe o rótulo Itens no inventário para a visualização inventory_items
, em vez do rótulo padrão Itens de inventário.
description
(campo)
Você pode adicionar uma description
a qualquer campo. Para conexões do BigQuery, se você gerar um projeto LookML do seu banco de dados, o Looker vai preencher automaticamente as descrições dos campos com as descrições dos metadados das colunas do BigQuery, se houver.
O usuário terá acesso a essa descrição em vários lugares. O Looker mostra a descrição quando o usuário seleciona o ícone de informações à direita do nome do campo no seletor de campo.
Além disso, o Looker também mostra a descrição quando o usuário passa o cursor sobre o nome da coluna em uma tabela ou visualização de gráfico de tabela em uma Análise, um painel ou um Look.
hidden
(campo)
Por padrão, os campos especificados em uma visualização são mostrados no seletor de campos. O parâmetro hidden
oculta um campo no seletor.
Os campos ocultos ainda podem ser acessados na UI se forem adicionados manualmente ao URL e vão aparecer em algumas janelas do Looker. Portanto, pense no hidden
como uma forma de manter o seletor de campo limpo, e não como um recurso de segurança.
Por exemplo, adicionar o código LookML hidden: yes
ao LookML da dimensão product_id
no exemplo a seguir oculta a dimensão Product ID do seletor de campo:
dimension: product_id {
hidden: yes
type: number
sql: ${TABLE}.product_id ;;
}
fields
(campo)
O parâmetro fields
permite especificar quais campos da visualização básica e das mesclagens de uma Análise são expostos no seletor de campos. Se você não usar o parâmetro fields
, o Looker exibirá todos os campos.
Para especificar os campos que você quer exibir no seletor de campos, use uma lista de campos ou conjuntos separados por vírgulas. Para especificar os campos que você quer ocultar do seletor de campos, use o conjunto ALL_FIELDS*
com uma lista separada por vírgulas dos campos ou conjuntos a serem excluídos, com um hífen (-) antes de cada um.
Por exemplo, é possível usar o seguinte código LookML para exibir apenas uma seleção de campos do Explore aircraft
no seletor de campo:
explore: aircraft {
fields: [
aircraft.aircraft_model_code,
aircraft.aircraft_engine_code,
aircraft.count,
aircraft.city,
aircraft.country,
aircraft.zip,
]
}
Neste exemplo, a Análise de aeronave mostra apenas as dimensões Código do modelo de aeronave, Código do mecanismo de aeronave, Cidade, País e CEP, além da medida Contagem no seletor de campo.
label
(campo)
O parâmetro label
de um campo permite mudar como o nome de um campo vai aparecer no seletor de campo sem mudar como ele é referenciado no LookML. Se nenhum rótulo for especificado, o rótulo padrão será o nome do campo.
Por exemplo, é possível usar o parâmetro label
para definir um rótulo para a dimensão cost
da seguinte maneira:
dimension: cost {
label: "price"
type: number
sql: ${TABLE}.cost ;;
}
Neste exemplo, a dimensão Custo tem o rótulo price no seletor de campo.
view_label
(campo)
O parâmetro view_label
de um campo permite mudar o nome da visualização em que o campo está listado no seletor de campo sem mudar a forma como ele é referenciado no LookML. Se nenhum rótulo for especificado, o campo será exibido abaixo do rótulo da visualização em que foi definido.
Por exemplo, é possível usar o parâmetro view_label
da seguinte maneira para especificar um rótulo de visualização para a dimensão cost
:
dimension: cost {
view_label: "Cost Information"
type: number
sql: ${TABLE}.cost ;;
}
Neste exemplo, o Looker mostra a dimensão Custo no rótulo da visualização Informações de custo no seletor de campo.
group_label
(campo)
O parâmetro group_label
permite combinar campos em uma lista suspensa comum em uma visualização no seletor de campos.
Neste exemplo, o grupo Informações de frete inclui os campos Cidade de envio, País de envio e Estado do envio:
group_item_label
(campo)
Quando os campos são mostrados sob um marcador de grupo, talvez não seja necessário mostrar os nomes completos ou os marcadores de campo no seletor de campo. No exemplo mostrado anteriormente para group_label
(campo), o rótulo do grupo já indica que os campos pertencem ao frete. Nesses casos, é possível adicionar o parâmetro group_item_label
a cada um desses campos agrupados para mudar a aparência deles no marcador do grupo.
Neste exemplo, o grupo Informações de frete inclui os campos Cidade, País e Estado: