descripción (para campos)

En esta página, se hace referencia al parámetro description que forma parte de un campo.

description también se puede usar como parte de Explorar, descrito en la página de documentación del parámetro description (para Explorar).

description también se puede usar como parte de un panel, que se describe en la página de documentación Parámetros del panel.

Uso

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

Jerarquía Ver archivo view Tipo de campo description

Tipos de campos posibles Dimensión, Grupo de dimensiones, Medición, Filtro, Parámetro Acepta Una string

Definición

Puedes agregar una descripción a cualquier campo. Para las conexiones de BigQuery, si genera un proyecto de LookML a partir de su base de datos, Looker propagará automáticamente las descripciones de campo con las descripciones de sus metadatos de columna de BigQuery, si las hubiera.

El usuario puede ver las descripciones de los campos en varios lugares.

Por ejemplo, para una dimensión que se define con este LookML:

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

Looker muestra la descripción cuando el usuario selecciona el ícono de información a la derecha del nombre del campo en el selector de campos:

Además, Looker también muestra la descripción cuando el usuario se desplaza sobre el nombre de la columna en una tabla o visualización de un gráfico en una tabla de Explorar, un panel o una vista:

Usa variables líquidas en el parámetro description

Puedes usar Variables líquidas con el parámetro description para un campo. Esto es útil, por ejemplo, cuando quieres que Looker muestre una descripción diferente para un campo basado en un atributo de usuario o en la exploración en la que se ejecuta una consulta.

Por ejemplo, si quieres que la descripción de un campo varíe en función de la sección Explorar en la que se ejecuta una consulta, puedes usar la variable Liquida _explore._name dentro de una estructura 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 %}"
}

En este ejemplo, si se ejecuta una consulta en la opción de Explorar artículos de pedido, la descripción para la dimensión ID de usuario será El ID de usuario de Explorar artículos de pedido. En Explorar elementos de inventario, la descripción será El ID de usuario para la exploración de elementos de inventario. En cualquier otra exploración, se mostrará la descripción User user.

Como otro ejemplo, supongamos que quieres mostrar diferentes descripciones a diferentes usuarios según sus departamentos. Si definiste un atributo de usuario llamado Departamento, puedes usar la variable Líquida _user_attributes['name_of_attribute'] dentro de una estructura {% dynamic if %} {% dynamic else %} {% dynamic endif %} líquida para especificar una descripción diferente según el valor del atributo de usuario de 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} ;;
}

En este ejemplo, la descripción que se muestra para la dimensión Margen bruto varía en función de si el usuario forma parte del equipo de marketing, de ventas o de otro equipo.

Puedes usar variables líquidas, como _model._name, _view._name, _explore._name, _field._name y _user_attributes['name_of_attribute'], con el parámetro description. Consulta la página de documentación Referencia de variables líquidas para obtener más información sobre cómo usar parámetros de Liquid con LookML y ver qué variables líquidas se pueden usar con el parámetro description.

Qué debes saber

La descripción se muestra una vez por grupo de dimensiones.

En el caso de los grupos de dimensiones, Looker muestra la descripción solo una vez para todo el grupo y no para cada dimensión del período del grupo.