descrizione (per i campi)

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

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

description può essere utilizzato anche come parte di una dashboard, descritto nella pagina della documentazione relativa ai parametri della dashboard.

Utilizzo

view: view_name {
dimension: field_name {
description: "stringa di descrizione"
}
}

Gerarchia Visualizza file view Tipo di campo description

Tipi di campi possibili Dimensione, gruppo di dimensioni, misurazione, 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ù punti.

Ad esempio, per una dimensione definita con questo 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 campi:

Inoltre, Looker visualizza anche la descrizione quando l'utente passa il mouse sul nome della colonna nella visualizzazione di una tabella o un grafico a tabella in un Explore, una dashboard o un Look:

Utilizzo delle variabili Liquid nel parametro description

Puoi utilizzare le variabili Liquid con il parametro description per un campo. Questo è utile, ad esempio, quando vuoi che Looker mostri una descrizione diversa in un campo basato su un attributo utente o sulla base di Explore (Esplora) 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 in una struttura Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %}:

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

In questo esempio, se una query viene eseguita nell'esplorazione degli articoli dell'ordine, la descrizione della dimensione User-ID sarà L'ID utente per l'esplorazione degli articoli dell'ordine. In Elementi di inventario, la descrizione sarà Lo User-ID per l'esplorazione degli elementi dell'inventario. In qualsiasi altra sezione Esplora, verrà visualizzata la descrizione ID utente.

Per fare un altro esempio, supponiamo che tu voglia mostrare descrizioni diverse a utenti diversi a seconda dei reparti. Se hai definito un attributo utente chiamato Reparto, puoi utilizzare la variabile Liquid _user_attributes['name_of_attribute'] in una struttura Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %} per specificare una descrizione diversa in base al valore dell'attributo utente Reparto:

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 questo esempio, la descrizione visualizzata per la dimensione Margine lordo varia a seconda che un utente faccia parte 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. Consulta la pagina Riferimento variabile Liquid per ulteriori informazioni sull'utilizzo dei parametri Liquid con LookML e per sapere quali variabili Liquid possono essere utilizzate con il parametro description.

Aspetti da tenere presenti

La descrizione viene visualizzata una volta per gruppo di dimensioni

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