说明（用于字段）

本页面引用了字段内的 description 参数。

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

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

用量

视图：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 会显示相应说明：

此外，当用户将鼠标悬停在“探索”、“信息中心”或“查看”部分的表格或表格图表的列名称上时，Looker 还会显示说明：

在 description 参数中使用 Liquid 变量

您可以将 Liquid 变量与字段的 description 参数一起使用。例如，如果您希望 Looker 根据用户属性或运行查询的“探索”针对字段显示不同的说明，这会非常有用。

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

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

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

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

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

在本例中，针对“毛利润”维度显示的说明会因用户属于营销、销售还是其他团队而异。

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

注意事项

每个维度组显示一次说明

对于维度组，Looker 只会为整个组显示一次说明，而不会为组内的每个时间范围维度显示一次说明。