description (for Fields)

This page refers to the description parameter that is part of a field.

description can also be used as part of an Explore, described on this documentation page.

description can also be used as part of a dashboard, described on this documentation page.

Usage

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

Hierarchy

View File

view

Field Type

description

Possible Field Types

Dimension, Dimension Group, Measure, Filter, Parameter

Accepts

A string

Definition

You can add a description to any field. The user can see this description in multiple places.

In the Field Picker, Looker displays this description if a user hovers over the help link, which is to the right of the field name. For example, this LookML:

dimension: name { description: "The first and last name of the user" sql: CONCAT(${TABLE}.first_name,' ', ${TABLE}.last_name) ;; }

will give this result in the Looker UI:

In addition, the description is displayed when the user hovers over the column name in a table or table chart visualization in an Explore, dashboard, or Look:

Things to Know

The Description Displays Once Per Dimension Group

For a dimension group, Looker displays the description only once for the entire group, and not for each timeframe dimension within the group.