descrição (para campos)

Esta página se refere ao parâmetro description que faz parte de um campo.

O description também pode ser usado como parte de uma exploração, descrita na página de documentação do parâmetro description (para explorações).

description também pode ser usado como parte de um painel, descrito na página de documentação Parâmetros do painel.

Uso

view: view_name {
dimension: field_name {
description: "string de descrição"
}
}

Hierarquia Ver arquivo view Tipo de campo description

Tipos de campo possíveis Dimensão, grupo de dimensões, medida, filtro, parâmetro Aceita Uma string

Definição

Você pode adicionar uma descrição a qualquer campo. Para conexões do BigQuery, se você gerar um projeto LookML a partir do seu banco de dados, o Looker preencherá automaticamente as descrições dos campos com as descrições dos metadados de coluna do BigQuery, se houver.

O usuário pode ver as descrições dos campos em vários lugares.

Por exemplo, para uma dimensão definida com este LookML:

dimension: id {
  primary_key: yes
  description: "Unique ID for the order"
  type: string
  sql: ${TABLE}.id ;;

O Looker exibe a descrição quando o usuário seleciona o ícone de informação à direita do nome do campo no seletor de campo:

Além disso, o Looker também exibe a descrição quando o usuário passa o cursor sobre o nome da coluna em uma visualização de tabela ou gráfico em uma opção "Explorar", um painel ou uma visualização:

Como usar variáveis líquidas no parâmetro description

É possível usar variáveis líquidas com o parâmetro description para um campo. Isso é útil, por exemplo, quando você quer que o Looker exiba uma descrição diferente para um campo de acordo com um atributo do usuário ou com base na área "Explorar" em que uma consulta é executada.

Por exemplo, se você quiser que a descrição de um campo seja diferente dependendo do recurso "Explorar" em que uma consulta é executada, use a variável Liquid _explore._name em uma estrutura Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %}:

dimension: user_id {
  description:
   "{% dynamic if _explore._name == 'order_items' %}
      The user ID for the Order Items Explore
    {% elsif _explore._name == 'inventory_items' %}
      The user ID for the Inventory Items Explore
    {% dynamic else %}
      The user ID
    {% dynamic endif %}"
}

Neste exemplo, se uma consulta for executada em Order Items Explore, a descrição da dimensão User ID será User user for the Order Items Explore. Em Explorar itens de inventário, a descrição será O ID do usuário para a seção Explorar itens de inventário. Em outros "Explorar", a descrição ID do usuário é exibida.

Como outro exemplo, imagine que você queira exibir descrições diferentes para usuários diferentes dependendo do departamento. Se você definiu um atributo do usuário chamado Departamento, pode usar a variável _user_attributes['name_of_attribute'] em uma estrutura {% dynamic if %} {% dynamic else %} Liquid para especificar uma descrição diferente, dependendo do valor do atributo de usuário Departamento:

dimension: gross_margin {
  description:
   "{% dynamic if _user_attributes['department'] == 'Marketing' %}
      The standard margin for a field
    {% elsif _user_attributes['department'] == 'Sales' %}
      The operating margin for a field
    {% dynamic else %} The gross margin for a field {% dynamic endif %}"
  type: number
  value_format_name: usd
  sql: ${sale_price} - ${inventory_items.cost} ;;
}

Neste exemplo, a descrição exibida para a dimensão Margem bruta varia caso o usuário faça parte da equipe de marketing, vendas ou outra equipe.

É possível usar variáveis líquidas, como _model._name, _view._name, _explore._name, _field._name e _user_attributes['name_of_attribute'], com o parâmetro description. Consulte a página de documentação Referência de variáveis líquidas para saber mais sobre o uso de parâmetros Liquid com LookML e para saber quais variáveis Liquid podem ser usadas com o parâmetro description.

Informações úteis

A descrição é exibida uma vez por grupo de dimensões

Para um grupo de dimensões, o Looker exibe a descrição apenas uma vez para todo o grupo, e não para cada dimensão de período no grupo.