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 le cadre d'une exploration, décrite 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 des paramètres du tableau de bord.

Utilisation

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

Hiérarchie Afficher le fichier view Type de champ description

Types de champs possibles Dimension, Groupe de dimensions, Mesurer, Filtrer, Paramètre Acceptation Chaîne

Définition

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

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

Par exemple, pour une dimension définie avec ce 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 passe le curseur 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 s'avère utile, par exemple, lorsque vous souhaitez que Looker affiche une description différente pour un champ en fonction d'un attribut utilisateur ou de la fonction Explorer dans laquelle une requête est exécutée.

Par exemple, si vous souhaitez que la description d'un champ varie en fonction de la fonction Explorer dans laquelle une requête est exécutée, vous pouvez utiliser la variable Liquid _explore._name dans une structure {% dynamic endif %} {% dynamic if %} {% dynamic else %}:

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

Dans cet exemple, si une requête est exécutée dans le champ Explorer les éléments de la campagne, la description de la dimension User-ID sera L'ID utilisateur de la campagne "Explorer les éléments". Dans la section Explorer les éléments d'inventaire, la description sera l'ID utilisateur pour l'exploration des éléments d'inventaire. Dans tous les autres produits Explorer, la description User-ID s'affiche.

Prenons un autre exemple. Supposons que vous souhaitiez présenter des descriptions différentes selon les utilisateurs en fonction de leur service. Si vous avez défini un attribut utilisateur appelé Département, vous pouvez utiliser la variable Liquid _user_attributes['name_of_attribute'] dans une structure Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %} pour spécifier une description différente en fonction de la valeur de l'attribut utilisateur Department:

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

Dans cet exemple, la description affichée pour la dimension Marge brute varie selon que l'utilisateur fait partie du service marketing, des ventes 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. Consultez la documentation de référence sur les variables Liquid pour en savoir plus sur l'utilisation des paramètres Liquid avec LookML et pour savoir quelles variables Liquid peuvent être utilisées avec le paramètre description.

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.