תיאור (לשדות)

בדף הזה מוסבר על הפרמטר description שהוא חלק משדה.

אפשר להשתמש ב-description גם כחלק מניתוח, כמו שמתואר בדף התיעוד של הפרמטר description (לניתוחים).

אפשר להשתמש ב-description גם כחלק מלוח בקרה, כמו שמתואר בדף התיעוד פרמטרים של לוח בקרה.

Usage

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

היררכיה הצגת הקובץ view סוג השדה description

סוגי שדות אפשריים מאפיין, קבוצת מאפיינים, מדד, מסנן, פרמטר מקבל מחרוזת

הגדרה

אפשר להוסיף תיאור לכל שדה. בחיבורים ל-BigQuery, אם יוצרים פרויקט LookML ממסד הנתונים, מערכת Looker תמלא אוטומטית את תיאורי השדות בתיאורים ממטא-נתונים של עמודות ב-BigQuery, אם יש כאלה.

המשתמש יכול לראות תיאורי שדות בכמה מקומות.

לדוגמה, למאפיין שמוגדר באמצעות LookML הזה:

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

התיאור מוצג ב-Looker כשהמשתמש לוחץ על סמל המידע משמאל לשם השדה בכלי לבחירת שדות.

בנוסף, Looker מציג את התיאור גם כשמשתמש מעביר את הסמן מעל שם העמודה בטבלה או בתרשים טבלה בתרשים להמחשה ב-Explore, בלוח בקרה או בטבלת Look.

שימוש במשתני Liquid בפרמטר description

אפשר להשתמש במשתני Liquid עם הפרמטר description של שדה. לדוגמה, זה שימושי כשרוצים ש-Looker יציג תיאור שונה לשדה על סמך מאפיין משתמש, או על סמך הניתוח שבו מופעלת שאילתה.

לדוגמה, אם רוצים שהתיאור של שדה יהיה שונה בהתאם לניתוח שבו מופעלת שאילתה, אפשר להשתמש במשתנה Liquid‏ _explore._name בתוך מבנה 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 %}"
}

בדוגמה הזו, אם מריצים שאילתה ב-Explore Order Items, התיאור של המאפיין User ID יהיה The user ID for the Order Items Explore. בכרטיסייה פריטים במלאי ב-Explore, התיאור יהיה מזהה המשתמש ב-Explore של פריטים במלאי. בכל ניתוח אחר, יוצג התיאור מזהה המשתמש.

דוגמה נוספת: נניח שאתם רוצים להציג תיאורים שונים למשתמשים שונים בהתאם למחלקה שלהם. אם הגדרתם מאפיין משתמש בשם Department, תוכלו להשתמש במשתנה Liquid‏ _user_attributes['name_of_attribute'] בתוך מבנה Liquid‏ {% if %} {% else %} {% endif %} כדי לציין תיאור שונה בהתאם לערך של מאפיין המשתמש 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} ;;
}

בדוגמה הזו, התיאור שמוצג למאפיין Gross Margin שונה בהתאם לכך שהמשתמש הוא חלק מצוות השיווק, צוות המכירות או צוות אחר.

אפשר להשתמש במשתני Liquid כמו _model._name,‏ _view._name,‏ _explore._name,‏ _field._name ו-_user_attributes['name_of_attribute'] עם הפרמטר description. מידע נוסף על שימוש בפרמטרים של Liquid עם LookML ועל משתני Liquid שאפשר להשתמש בהם עם הפרמטר description זמין בדף העזרה בנושא משתני Liquid.

חשוב לדעת

התיאור מוצג פעם אחת לכל קבוצת מאפיינים

בקבוצת מאפיינים, Looker מציג את התיאור רק פעם אחת לכל הקבוצה, ולא לכל מאפיין של מסגרת זמן בתוך הקבוצה.