说明（针对字段）

本页面中提及的 description 参数是字段的一部分。

description 也可以用作探索的一部分，如 description（适用于探索）参数文档页面中所述。

description 还可以用作信息中心的一部分，如信息中心参数文档页面中所述。

用法

view: view_name {
  dimension: field_name {
    description: "description string"
  }
}
层次结构
view
字段类型
description
可能的字段类型
维度、维度组、度量、过滤条件、参数

接受
一个字符串

定义

您可以为任何字段添加说明。对于 BigQuery 连接，如果您从数据库生成 LookML 项目，Looker 会自动使用 BigQuery 列元数据中的说明（如果有）预填充字段说明。

用户可以在多个位置查看字段说明。

例如，对于使用以下 LookML 定义的维度：

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

当用户在字段选择器中选择字段名称右侧的信息图标时，Looker 会显示说明。

此外，当用户将光标悬停在“探索”“信息中心”或“Look”中的表格或表格图表可视化图表中的列名称上时，Looker 也会显示说明。

在 description 参数中使用 Liquid 变量

您可以将 Liquid 变量与字段的 description 参数搭配使用。例如，如果您希望 Looker 根据用户属性或运行查询的探索来显示不同的字段说明，此功能会非常有用。

例如，如果您希望字段的说明因运行查询的探索而异，可以在 Liquid {% if %} {% else %} {% endif %} 结构中使用 Liquid 变量 _explore._name：


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 %}"
}

在此示例中，如果在订单项探索中运行查询，用户 ID 维度的说明将为订单项探索的用户 ID。在商品目录项探索中，说明将为商品目录项探索的用户 ID。在任何其他探索中，系统都会显示“用户 ID”说明。

再举一个例子，假设您想根据用户的部门向其显示不同的说明。如果您定义了一个名为 Department 的用户属性，则可以在 Liquid {% if %} {% else %} {% endif %} 结构中使用 Liquid 变量 _user_attributes['name_of_attribute']，以根据 Department 用户属性的值指定不同的说明：


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} ;;
}

在此示例中，针对毛利率维度显示的说明因用户所属的团队（营销、销售或其他团队）而异。

您可以将 _model._name、_view._name、_explore._name、_field._name 和 _user_attributes['name_of_attribute'] 等 Liquid 变量与 description 参数搭配使用。如需详细了解如何将 Liquid 参数与 LookML 搭配使用，以及哪些 Liquid 变量可与 description 参数搭配使用，请参阅 Liquid 变量参考文档页面。

注意事项

说明会针对每个维度组显示一次

对于维度组，Looker 仅针对整个组显示一次说明，而不会针对组内的每个时间段维度显示说明。