dashboards (レガシ) コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
databricks dashboards コマンドグループは、レガシーダッシュボード用です。AI/BI ダッシュボードの場合は、コマンドLakeview databricks を使用します。
Databricks CLI 内の dashboards コマンド グループを使用すると、レガシ ダッシュボード オブジェクトを管理できます。
databricks dashboards create
ダッシュボードオブジェクトを作成します。
databricks dashboards create [flags]
引数
なし
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、JSON ファイルを使用してダッシュボードを作成します。
databricks dashboards create --json @dashboard-config.json
databricks dashboards delete
ダッシュボードをゴミ箱に削除します。ごみ箱に入れられたダッシュボードは、リストビューや検索に表示されず、共有できません。
databricks dashboards delete DASHBOARD_ID [flags]
引数
DASHBOARD_ID
削除するダッシュボードの ID。
オプション
例
次の例では、ダッシュボードを削除します。
databricks dashboards delete 12345
databricks dashboards get
ダッシュボードオブジェクトの JSON 表現 (視覚化オブジェクトとクエリオブジェクトを含む) を取得します。
databricks dashboards get DASHBOARD_ID [flags]
引数
DASHBOARD_ID
取得するダッシュボードの ID。
オプション
例
次の例では、ダッシュボード定義を取得します。
databricks dashboards get 12345
databricks dashboards list
ダッシュボードオブジェクトのページ分割されたリストを取得します。
このコマンドを同時に 10 回以上実行すると、スロットリング、サービスの低下、または一時的な禁止が発生する可能性があります。
databricks dashboards list [flags]
引数
なし
オプション
--order ListOrder
順序付けするダッシュボード属性の名前。サポートされている値: created_at、 name。
--page int
取得するページ番号。
--page-size int
ページごとに返されるダッシュボードの数。
--q string
全文検索語。
例
次の例は、すべてのダッシュボードを一覧表示します。
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
ダッシュボードを復元します。
復元されたダッシュボードは、リストビューと検索に表示され、共有できます。
databricks dashboards restore DASHBOARD_ID [flags]
引数
DASHBOARD_ID
復元するダッシュボードの ID。
オプション
例
次の例では、ダッシュボードを復元します。
databricks dashboards restore 12345
Databricks ダッシュボードの更新
ダッシュボード定義を変更します。この操作は、ダッシュボード オブジェクトの属性にのみ影響します。ウィジェットの追加、変更、削除は行いません。
注 : この操作は元に戻すことはできません。
databricks dashboards update DASHBOARD_ID [flags]
引数
DASHBOARD_ID
更新するダッシュボードの ID。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--name string
リストビューとダッシュボードページの上部に表示されるこのダッシュボードのタイトル。
--run-as-role RunAsRole
オブジェクトの 「実行」 ロールを設定します。サポートされている値: owner、 viewer。
例
次の例では、ダッシュボードの名前を更新します。
databricks dashboards update 12345 --name "Updated Dashboard Name"
次の例では、ダッシュボードの実行ロールを更新します。
databricks dashboards update 12345 --run-as-role viewer
グローバルフラグ
--debug
デバッグログを有効にするかどうか。
-h または --help
Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。
--log-file string
出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format format
ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。
--log-level string
ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。
-o, --output タイプ
コマンド出力タイプ text または json。デフォルト値は textです。
-p, --profile string
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format format
進行状況ログを表示する形式: default、 append、 inplace、 json
-t, --target string
該当する場合は、使用するバンドル・ターゲット