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 una exploración, como se describe en la página de documentación del parámetro description (para exploraciones).

description también se puede usar como parte de un panel, como 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 y parámetro Acepta Una string.

Definición

Puedes agregar una descripción a cualquier campo. En el caso de las conexiones de BigQuery, si generas un proyecto de LookML a partir de tu base de datos, Looker completará automáticamente las descripciones de los campos con las descripciones de los metadatos de las columnas de BigQuery, si las hay.

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

Por ejemplo, para una dimensión definida 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 coloca el cursor sobre el nombre de la columna en una visualización de tabla o gráfico de tabla en una Exploración, un panel o una Vista.

Usa variables de Liquid en el parámetro description

Puedes usar variables de Liquid 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 según un atributo del usuario o según la función Explorar en la que se ejecuta una consulta.

Por ejemplo, si deseas que la descripción de un campo difiera según el Explorar en el que se ejecuta una consulta, puedes usar la variable de Liquid _explore._name dentro de una estructura {% else %} {% endif %} de {% if %} de 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 %}"
}

En este ejemplo, si se ejecuta una consulta en la exploración Artículos pedidos, la descripción de la dimensión ID de usuario será El ID de usuario para la exploración de artículos pedidos. En la exploración Inventory Items, la descripción será The user ID for the Inventory Items Explore. En cualquier otra exploración, se mostrará la descripción El ID de usuario.

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

En este ejemplo, la descripción que se muestra para la dimensión Margen bruto difiere según si un usuario forma parte del equipo de Marketing, Ventas o algún otro equipo.

Puedes usar variables de Liquid 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 de la referencia de variables de Liquid para obtener más información sobre el uso de parámetros de Liquid con LookML y ver qué variables de Liquid se pueden usar con el parámetro description.

Información importante

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

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