Beschreibung (für Felder)

Auf dieser Seite wird auf den Parameter description verwiesen, der Teil eines Felds ist.

description kann auch als Teil eines Explores verwendet werden. Dies wird auf der Dokumentationsseite zum Parameter description (für Explores) beschrieben.

description kann auch als Teil eines Dashboards verwendet werden. Weitere Informationen finden Sie auf der Dokumentationsseite Dashboard-Parameter.

Nutzung

view: view_name {
  dimension: field_name {
    description: "description string"
  }
}
Hierarchie
view
Feldtyp
description
Mögliche Feldtypen
Dimension, Dimensionsgruppe, Messwert, Filter, Parameter

Akzeptiert
Ein String

Definition

Sie können jedem Feld eine Beschreibung hinzufügen. Wenn Sie für BigQuery-Verbindungen ein LookML-Projekt aus Ihrer Datenbank generieren, werden Feld-Beschreibungen in Looker automatisch mit den Beschreibungen aus den BigQuery-Spaltenmetadaten gefüllt, sofern vorhanden.

Der Nutzer kann Feldbeschreibungen an mehreren Stellen sehen.

Beispiel: Für eine Dimension, die mit diesem LookML definiert ist:

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

Looker zeigt die Beschreibung an, wenn der Nutzer das Informationssymbol rechts neben dem Feldnamen im Field Picker auswählt.

Darüber hinaus zeigt Looker die Beschreibung auch an, wenn der Nutzer mit der Maus auf den Spaltennamen in einer Tabelle oder Tabellendiagramm-Visualisierung auf einer Explore-Seite, in einem Dashboard oder einem Look zeigt.

Liquid-Variablen im Parameter description verwenden

Sie können Liquid-Variablen mit dem Parameter description für ein Feld verwenden. Das ist beispielsweise nützlich, wenn Sie möchten, dass in Looker für ein Feld je nach Nutzerattribut oder je nach dem Explore, in dem eine Abfrage ausgeführt wird, eine andere Beschreibung angezeigt wird.

Wenn Sie beispielsweise möchten, dass sich die Beschreibung eines Felds je nach dem Explore unterscheidet, in dem eine Abfrage ausgeführt wird, können Sie die Liquid-Variable _explore._name in einer Liquid-Struktur {% if %} {% else %} {% endif %} verwenden:


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

Wenn in diesem Beispiel eine Abfrage im Bestellartikel-Explore ausgeführt wird, lautet die Beschreibung für die Dimension Nutzer-ID Die Nutzer-ID für den Bestellartikel-Explore. Im Inventarartikel-Explore lautet die Beschreibung Die Nutzer-ID für das Inventarartikel-Explore. In allen anderen Explores wird die Beschreibung Die Nutzer-ID angezeigt.

Ein weiteres Beispiel: Sie möchten verschiedenen Nutzern je nach Abteilung unterschiedliche Beschreibungen anzeigen. Wenn Sie ein Nutzerattribut mit dem Namen Abteilung definiert haben, können Sie die Liquid-Variable _user_attributes['name_of_attribute'] in einer Liquid-{% if %}-{% else %}-{% endif %}-Struktur verwenden, um je nach Wert des Nutzerattributs Abteilung eine andere Beschreibung anzugeben:


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

In diesem Beispiel unterscheidet sich die für die Dimension Bruttogewinnspanne angezeigte Beschreibung je nachdem, ob ein Nutzer zum Marketing-, Vertriebs- oder einem anderen Team gehört.

Sie können Liquid-Variablen wie _model._name, _view._name, _explore._name, _field._name und _user_attributes['name_of_attribute'] mit dem Parameter description verwenden. Weitere Informationen zur Verwendung von Liquid-Parametern mit LookML und dazu, welche Liquid-Variablen mit dem Parameter description verwendet werden können, finden Sie auf der Dokumentationsseite Referenz für Liquid-Variablen.

Wichtige Punkte

Die Beschreibung wird einmal pro Dimensionsgruppe angezeigt.

Bei einer Dimensionsgruppe zeigt Looker die Beschreibung nur einmal für die gesamte Gruppe an, nicht für jede Zeitrahmen-Dimension innerhalb der Gruppe.