descrizione (per i campi)

Questa pagina si riferisce al parametro description che fa parte di un campo.

description può essere utilizzato anche nell'ambito di un'esplorazione, come descritto nella pagina della documentazione dedicata al parametro description (per le esplorazioni).

description può essere utilizzato anche nell'ambito di una dashboard, come descritto nella pagina della documentazione Parametri della dashboard.

Utilizzo

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

Gerarchia Visualizza file view Tipo di campo description

Tipi di campi possibili Dimensione, Gruppo di dimensioni, Misura, Filtro, Parametro Accetta Una stringa

Definizione

Puoi aggiungere una descrizione a qualsiasi campo. Per le connessioni BigQuery, se generi un progetto LookML a partire dal tuo database, Looker popola automaticamente le descrizioni dei campi con le descrizioni dei metadati delle colonne di BigQuery, se disponibili.

L'utente può visualizzare le descrizioni dei campi in più posizioni.

Ad esempio, per una dimensione definita con questo codice LookML:

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

Looker visualizza la descrizione quando l'utente seleziona l'icona delle informazioni a destra del nome del campo nel selettore dei campi.

Inoltre, Looker mostra la descrizione anche quando l'utente passa il mouse sopra il nome della colonna in una visualizzazione a tabella o grafico a tabella in un'esplorazione, una dashboard o un look.

Utilizzo delle variabili Liquid nel parametro description

Puoi utilizzare le variabili Liquid con il parametro description per un campo. Ciò è utile, ad esempio, quando vuoi che Looker mostri una descrizione diversa per un campo in base a un attributo utente o all'esplorazione in cui viene eseguita una query.

Ad esempio, se vuoi che la descrizione di un campo sia diversa a seconda dell'esplorazione in cui viene eseguita una query, puoi utilizzare la variabile Liquid _explore._name all'interno di una struttura 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 %}"
}

In questo esempio, se viene eseguita una query nell'esplorazione Elementi ordine, la descrizione della dimensione ID utente sarà L'ID utente per l'esplorazione Elementi ordine. Nell'esplorazione Articoli di inventario, la descrizione sarà L'ID utente per l'esplorazione Articoli di inventario. In qualsiasi altra esplorazione, verrà visualizzata la descrizione L'ID utente.

Come altro esempio, supponiamo che tu voglia mostrare descrizioni diverse a utenti diversi a seconda del reparto. Se hai definito un attributo utente denominato Department (reparto), puoi utilizzare la variabile Liquid _user_attributes['name_of_attribute'] all'interno di una struttura Liquid {% if %} {% else %} {% endif %} per specificare una descrizione diversa a seconda del valore dell'attributo utente Department (reparto):

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 questo esempio, la descrizione visualizzata per la dimensione Margine lordo varia a seconda che un utente faccia parte del team di marketing, vendite o di un altro team.

Puoi utilizzare le variabili Liquid come _model._name, _view._name, _explore._name, _field._name e _user_attributes['name_of_attribute'] con il parametro description. Per saperne di più sull'utilizzo dei parametri Liquid con LookML e per scoprire quali variabili Liquid possono essere utilizzate con il parametro description, consulta la pagina della documentazione Riferimento alle variabili Liquid.

Cose da sapere

La descrizione viene visualizzata una volta per gruppo di dimensioni

Per un gruppo di dimensioni, Looker mostra la descrizione una sola volta per l'intero gruppo e non per ogni dimensione del periodo di tempo all'interno del gruppo.