description (pour les champs)

Cette page fait référence au paramètre description qui fait partie d'un champ.

description peut également être utilisé dans une exploration, comme décrit sur la page de documentation du paramètre description (pour les explorations).

description peut également être utilisé dans un tableau de bord, comme décrit sur la page de documentation Paramètres du tableau de bord.

Utilisation

view: view_name {
  dimension: field_name {
    description: "description string"
  }
}
Hiérarchie
view
Type de champ
description
Types de champs possibles
Dimension, groupe de dimensions, mesure, filtre, paramètre

Acceptation
Chaîne

Définition

Vous pouvez ajouter une description à un champ. Pour les connexions BigQuery, si vous générez un projet LookML à partir de votre base de données, Looker préremplit automatiquement les descriptions des champs avec les descriptions des métadonnées de vos colonnes BigQuery, le cas échéant.

L'utilisateur peut consulter les descriptions des champs à plusieurs endroits.

Par exemple, pour une dimension définie avec ce code LookML :

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

Looker affiche la description lorsque l'utilisateur sélectionne l'icône d'informations à droite du nom de champ dans le sélecteur de champs.

Par ailleurs, Looker affiche la description lorsque l'utilisateur pointe sur le nom de la colonne d'une table ou d'une visualisation sous forme de tableau affichée dans une exploration, un tableau de bord ou une présentation.

Utiliser des variables Liquid dans le paramètre description

Vous pouvez utiliser des variables Liquid avec le paramètre description pour un champ. Cela peut être utile, par exemple, lorsque vous souhaitez que Looker affiche une description différente pour un champ en fonction d'un attribut utilisateur ou de l'exploration dans laquelle une requête est exécutée.

Par exemple, si vous souhaitez que la description d'un champ diffère selon l'onglet Explorer dans lequel une requête est exécutée, vous pouvez utiliser la variable Liquid _explore._name dans une structure Liquid {% if %} {% else %} {% endif %} :


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

Dans cet exemple, si une requête est exécutée dans l'exploration Order Items, la description de la dimension User ID sera The user ID for the Order Items Explore (ID utilisateur pour l'exploration "Order Items"). Dans l'exploration Éléments d'inventaire, la description sera ID utilisateur pour l'exploration Éléments d'inventaire. Dans toute autre exploration, la description The user ID (ID utilisateur) s'affiche.

Par exemple, supposons que vous souhaitiez afficher des descriptions différentes pour différents utilisateurs en fonction de leur service. Si vous avez défini un attribut utilisateur appelé Department (Service), vous pouvez utiliser la variable Liquid _user_attributes['name_of_attribute'] dans une structure Liquid {% if %} {% else %} {% endif %} pour spécifier une description différente en fonction de la valeur de l'attribut utilisateur Department :


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

Dans cet exemple, la description affichée pour la dimension Marge brute diffère selon que l'utilisateur fait partie de l'équipe marketing, de l'équipe commerciale ou d'une autre équipe.

Vous pouvez utiliser des variables Liquid telles que _model._name, _view._name, _explore._name, _field._name et _user_attributes['name_of_attribute'] avec le paramètre description. Pour en savoir plus sur l'utilisation des paramètres Liquid avec LookML et sur les variables Liquid pouvant être utilisées avec le paramètre description, consultez la page de documentation Documentation de référence sur les variables Liquid.

Bon à savoir

La description s'affiche une fois par groupe de dimensions.

Pour un groupe de dimensions, Looker n'affiche la description qu'une seule fois pour l'ensemble du groupe, et non pour chacune des dimensions de période qui le composent.