description (für Felder)

Diese Seite bezieht sich auf den Parameter description, der Teil eines Felds ist.

description kann auch als Teil eines explorativen Analysetools verwendet werden, wie auf der Seite mit der Parameterdokumentation für description beschrieben.

description kann auch als Teil eines Dashboards verwendet werden, wie auf der Dokumentationsseite zu den Dashboard-Parametern beschrieben.

Nutzung

view: view_name {
Dimension: Feldname {
Beschreibung: „Beschreibungsstring“
}
}

Hierarchie Datei ansehen view Feldtyp description

Mögliche Feldtypen Dimension, Dimensionsgruppe, Messen, 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, füllt Looker automatisch Feldbeschreibungen mit den Beschreibungen aus Ihren BigQuery-Spaltenmetadaten aus, 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 Benutzer das Informationssymbol rechts neben dem Feldnamen im Field Picker auswählt.

Darüber hinaus zeigt Looker die Beschreibung auch an, wenn der Benutzer 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. Dies ist beispielsweise nützlich, wenn von Looker eine andere Beschreibung für ein Feld basierend auf einem Nutzerattribut oder basierend auf dem Feld „Erkunden“ angezeigt werden soll, in dem eine Abfrage ausgeführt wird.

Wenn Sie beispielsweise möchten, dass sich die Beschreibung eines Felds abhängig von der Methode, in der eine Abfrage ausgeführt wird, unterscheidet, können Sie die Liquid-Variable _explore._name in einer Liquid-{% dynamic if %}-{% dynamic else %}-{% dynamic endif %}-Struktur verwenden:

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

Wenn in diesem Beispiel eine Abfrage auf dem Tab Bestellelemente ausgeführt wird, lautet die Beschreibung für die Dimension User ID User ID for the Order Items Explore. Unter Inventarelemente finden Sie als Beschreibung User-ID für die Inventarelemente. In allen anderen Bereichen wird die Beschreibung Die User-ID angezeigt.

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

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

In diesem Beispiel weicht die Beschreibung für die Dimension Bruttospanne davon ab, ob ein Nutzer zum Marketing-, Vertriebs- oder 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 in der Dokumentation zu Liquid-Variablen.

Wichtige Informationen

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.