Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
Note
databricks dashboards コマンド グループは、従来のダッシュボード用です。 AI/BI ダッシュボードの場合は、 databricks lakeview コマンドを使用します。
dashboards 内の コマンド グループを使用すると、レガシ ダッシュボード オブジェクトを管理できます。
databricks ダッシュボードを作成する
ダッシュボード オブジェクトを作成します。
databricks dashboards create [flags]
Arguments
None
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、JSON ファイルを使用してダッシュボードを作成します。
databricks dashboards create --json @dashboard-config.json
databricks のダッシュボードを削除
ダッシュボードをごみ箱に移動します。 ごみ箱に入ったダッシュボードはリスト ビューや検索に表示されず、共有できません。
databricks dashboards delete DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
削除するダッシュボードの ID。
オプション
Examples
次の例では、ダッシュボードを削除します。
databricks dashboards delete 12345
databricks ダッシュボードを取得する
視覚化オブジェクトやクエリ オブジェクトなど、ダッシュボード オブジェクトの JSON 表現を取得します。
databricks dashboards get DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
取得するダッシュボードの 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 dashboards restore DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
復元するダッシュボードの ID。
オプション
Examples
次の例では、ダッシュボードを復元します。
databricks dashboards restore 12345
データブリックス ダッシュボードの更新
ダッシュボード定義を変更します。 この操作は、ダッシュボード オブジェクトの属性にのみ影響します。 ウィジェットの追加、変更、削除は行われません。
注: この操作を元に戻すことはできません。
databricks dashboards update DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
更新するダッシュボードの ID。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--name string
リスト ビューとダッシュボード ページの上部に表示されるこのダッシュボードのタイトル。
--run-as-role RunAsRole
オブジェクトの 実行 ロールを設定します。 サポートされる値: 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 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット