Note
此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明,包括任何使用數據條款。
Note
指令群組 databricks dashboards 適用於傳統儀表板。 針對 AI/BI 儀錶板,請使用 Databricks Lakeview 指令。
dashboards
Databricks CLI 中的指令群組允許你管理舊有儀表板物件。
建立 databricks 儀錶板
建立儀表板物件。
databricks dashboards create [flags]
Arguments
None
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
下列範例會使用 JSON 檔案建立儀錶板:
databricks dashboards create --json @dashboard-config.json
databricks 儀錶板刪除
將儀錶板移除至垃圾桶。 已刪除的儀表板不會出現在列表視圖或搜尋結果中,而且無法共用。
databricks dashboards delete DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
要刪除之儀錶板的標識碼。
選項
Examples
下列範例會刪除儀錶板:
databricks dashboards delete 12345
databricks 儀錶板取得
擷取儀錶板物件的 JSON 表示法,包括其視覺效果和查詢物件。
databricks dashboards get DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
要擷取之儀錶板的標識碼。
選項
Examples
下列範例會擷取儀錶板定義:
databricks dashboards get 12345
databricks 儀錶板清單
擷取儀錶板物件的分頁清單。
Important
同時執行此命令 10 次或多次,可能會導致節流、服務降低或暫時禁止。
databricks dashboards list [flags]
Arguments
None
選項
--order ListOrder
要排序依據的儀錶板屬性名稱。 支援的值:created_at、name。
--page int
要檢索的頁碼。
--page-size int
每個頁面要傳回的儀錶板數目。
--q string
全文搜索字詞。
Examples
下列範例會列出所有儀錶板:
databricks dashboards list
下列範例列出具有分頁的儀錶板:
databricks dashboards list --page 2 --page-size 10
下列範例列出依建立日期排序的儀錶板:
databricks dashboards list --order created_at
下列範例會依名稱搜尋儀表板:
databricks dashboards list --q "Sales Dashboard"
databricks 儀錶板還原
還原儀錶板。
已還原的儀錶板會出現在清單檢視和搜尋中,而且可以共用。
databricks dashboards restore DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
要還原之儀錶板的識別碼。
選項
Examples
下列範例會還原儀錶板:
databricks dashboards restore 12345
databricks 儀錶板更新
變更儀錶板定義。 此作業只會影響儀錶板物件的屬性。 它不會新增、修改或移除小工具。
注意:你無法撤銷這個操作。
databricks dashboards update DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
要更新之儀錶板的ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--name string
此儀錶板的標題會出現在清單檢視和儀錶板頁面頂端。
--run-as-role RunAsRole
將 Run 設定為 物件的角色。 支援的值:owner、viewer。
Examples
下列範例會更新儀錶板的名稱:
databricks dashboards update 12345 --name "Updated Dashboard Name"
下列範例會更新儀錶板的執行身分角色:
databricks dashboards update 12345 --run-as-role viewer
全域旗標
--debug
是否要啟用偵錯記錄。
-h 或 --help
顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。
--log-file 字串
字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。
--log-format 格式
記錄格式類型或 textjson。 預設值是 text。
--log-level 字串
表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。
-o, --output 類型
指令輸出類型或 textjson。 預設值是 text。
-p, --profile 字串
要用來執行命令之檔案中的 ~/.databrickscfg 配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。
--progress-format 格式
顯示進度記錄的格式:default、、appendinplace、 或json
-t, --target 字串
如果適用,要使用的套件組合目標