תיאור (לניתוחים)

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

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

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

Usage

explore: explore_name {
  description: "Description I Want"
}

היררכיה קובץ מודל explore description

ערך ברירת המחדל ללא אישור מחרוזת

הגדרה

‫description מאפשר להוסיף מידע על ניתוח נתונים לממשק המשתמש, כדי שהמשתמשים יוכלו לקבל מידע נוסף בזמן יצירת שאילתות בניתוח הנתונים. לדוגמה, הנה פרמטר description:

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

אם מוסיפים description ל-Explore, המשתמשים יכולים לראות את התיאור על ידי העברת העכבר מעל סמל המידע שליד שם ה-Explore בחלק העליון של בורר השדות.

משתמשים יכולים גם להציג תיאור על ידי העברת העכבר מעל אותו סמל מידע ברשימה הנפתחת של הניתוחים.

אם לא מוסיפים description באופן מפורש להמלצות, לא יוצג תיאור.

דוגמאות

הוספת תיאור לניתוח ב-Explore בשם User:

explore: user {
  description: "All customer users, staff users are excluded"
}