descrição (para campos)

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

description também pode ser usado como parte de uma análise detalhada, conforme descrito na página de documentação do parâmetro description (para análises detalhadas).

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

Uso

view: view_name {
  dimension: field_name {
    description: "description string"
  }
}

Hierarquia Ver arquivo view Tipo de campo description

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

Definição

É possível adicionar uma descrição 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 da 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 mostra a descrição quando o usuário seleciona o ícone de informações à direita do nome do campo no seletor de campos.

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.

Como usar variáveis do Liquid no parâmetro description

É possível usar variáveis Liquid com o parâmetro description para um campo. Isso é útil, por exemplo, quando você quer que o Looker mostre uma descrição diferente para um campo com base em um atributo do usuário ou na Análise detalhada em que uma consulta é executada.

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

dimension: user_id {
  description:
   "{% 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
    {% else %}
      The user ID
    {% endif %}"
}

Neste exemplo, se uma consulta for executada na análise Itens do pedido, a descrição da dimensão ID do usuário será O ID do usuário para a análise "Itens do pedido". Na análise Itens de inventário, a descrição será O ID do usuário para a análise "Itens de inventário". Em qualquer outra análise detalhada, a descrição O ID do usuário vai aparecer.

Como outro exemplo, suponha que você queira mostrar descrições diferentes para usuários diferentes, dependendo dos departamentos deles. Se você definiu um atributo do usuário chamado Departamento, use a variável Liquid _user_attributes['name_of_attribute'] em uma estrutura {% if %} {% else %} {% endif %} do Liquid para especificar uma descrição diferente dependendo do valor do atributo do usuário Departamento:

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

Neste exemplo, a descrição mostrada para a dimensão Margem bruta varia de acordo com a equipe do usuário (marketing, vendas ou outra).

Você pode usar variáveis do Liquid, 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 do Liquid para mais informações sobre como usar parâmetros do Liquid com o LookML e quais variáveis do Liquid podem ser usadas com o parâmetro description.

Informações importantes

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

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