Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
lakeview 内の コマンド グループには、Lakeview ダッシュボードの特定の管理操作用のコマンドが含まれています。 「ダッシュボード」を参照してください。
Databricks Lakeview 作成
下書きダッシュボードを作成します。
databricks lakeview create [flags]
オプション
--display-name string
ダッシュボードの表示名。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--serialized-dashboard string
シリアル化された文字列形式のダッシュボードの内容。
--warehouse-id string
ダッシュボードの実行に使用されるウェアハウス ID。
Examples
次の例では、表示名を持つ新しいダッシュボードを作成します。
databricks lakeview create --display-name "Sales Dashboard" --warehouse-id "abc123"
次の例では、JSON 構成を使用してダッシュボードを作成します。
databricks lakeview create --json '{"display_name": "Revenue Report", "warehouse_id": "xyz789"}'
databricks lakeview create-schedule（スケジュール作成）
ダッシュボードのスケジュールを作成します。
databricks lakeview create-schedule DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
スケジュールが属するダッシュボードを識別する UUID。
オプション
--display-name string
スケジュールの表示名。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--pause-status SchedulePauseStatus
状態は、このスケジュールが一時停止されているかどうかを示します。 サポートされる値: PAUSED、UNPAUSED
--warehouse-id string
スケジュールに対してダッシュボードを実行するウェアハウス ID。
Examples
次の例では、ダッシュボード スケジュールを作成します。
databricks lakeview create-schedule abc123 --display-name "Daily Sales Report" --warehouse-id "wh456"
次の例では、一時停止中のスケジュールを作成します。
databricks lakeview create-schedule abc123 --display-name "Weekly Report" --pause-status PAUSED --warehouse-id "wh456"
databricks lakeview サブスクリプションを作成
ダッシュボード スケジュールのサブスクリプションを作成します。
databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
サブスクリプションが属するダッシュボードを識別する UUID。
SCHEDULE_ID
サブスクリプションが属するスケジュールを識別する UUID。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、スケジュールのサブスクリプションを作成します。
databricks lakeview create-subscription abc123 sch456 --json '{"email": "someone@example.com"}'
databricks lakeview スケジュール削除
ダッシュボードのスケジュールを削除します。
databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
スケジュールが属するダッシュボードを識別する UUID。
SCHEDULE_ID
スケジュールを識別する UUID。
オプション
--etag string
スケジュールの ETag。
Examples
次の例では、ダッシュボード スケジュールを削除します。
databricks lakeview delete-schedule abc123 sch456
次の例では、etag を使用してスケジュールを削除します。
databricks lakeview delete-schedule abc123 sch456 --etag "v1.0"
databricks lakeview サブスクリプション削除
ダッシュボード スケジュールのサブスクリプションを削除します。
databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]
Arguments
DASHBOARD_ID
サブスクリプションが属するダッシュボードを識別する UUID。
SCHEDULE_ID
サブスクリプションが属するスケジュールを識別する UUID。
SUBSCRIPTION_ID
サブスクリプションを識別する UUID。
オプション
--etag string
サブスクリプションのEタグ。
Examples
次の例では、サブスクリプションを削除します。
databricks lakeview delete-subscription abc123 sch456 sub789
次の例では、etag を使用してサブスクリプションを削除します。
databricks lakeview delete-subscription abc123 sch456 sub789 --etag "v1.0"
databricks lakeview を取得
下書きダッシュボードを取得します。
databricks lakeview get DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
ダッシュボードを識別する UUID。
オプション
Examples
次の例では、ダッシュボードを取得します。
databricks lakeview get abc123
Databricks Lakeview 発行する
現在発行されているダッシュボードを取得します。
databricks lakeview get-published DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
発行されたダッシュボードを識別する UUID。
オプション
Examples
次の例では、公開されたダッシュボードを取得する方法を示します。
databricks lakeview get-published abc123
データブリックス・レイクビューのスケジュール取得
ダッシュボードのスケジュールを取得します。
databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
スケジュールが属するダッシュボードを識別する UUID。
SCHEDULE_ID
スケジュールを識別する UUID。
オプション
Examples
次の例では、ダッシュボードのスケジュールを取得します。
databricks lakeview get-schedule abc123 sch456
databricks lakeview get-subscription (サブスクリプションの取得)
ダッシュボード スケジュールのサブスクリプションを取得します。
databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]
Arguments
DASHBOARD_ID
サブスクリプションが属するダッシュボードを識別する UUID。
SCHEDULE_ID
サブスクリプションが属するスケジュールを識別する UUID。
SUBSCRIPTION_ID
サブスクリプションを識別する UUID。
オプション
Examples
次の例では、サブスクリプションを取得します。
databricks lakeview get-subscription abc123 sch456 sub789
databricks lakeview リスト
すべてのダッシュボードを一覧表示します。
databricks lakeview list [flags]
オプション
--page-size int
ページごとに返されるダッシュボードの数。
--page-token string
以前の ListDashboards 呼び出しから受信したページ トークン。
--show-trashed
ごみ箱にあるダッシュボードを含めるフラグ。
--view DashboardView
DASHBOARD_VIEW_BASIC には、ダッシュボードからの概要メタデータのみが含まれます。 サポートされる値: DASHBOARD_VIEW_BASIC
Examples
次の例では、すべてのダッシュボードを一覧表示します。
databricks lakeview list
次の例では、特定のページ サイズのダッシュボードを一覧表示します。
databricks lakeview list --page-size 10
次の例では、ごみ箱に入ったものも含めてダッシュボードを一覧表示します。
databricks lakeview list --show-trashed
次の例では、基本的なビューを含むダッシュボードを一覧表示します。
databricks lakeview list --view DASHBOARD_VIEW_BASIC
databricks lakeview スケジュール一覧
ダッシュボードのすべてのスケジュールを一覧表示します。
databricks lakeview list-schedules DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
スケジュールが属するダッシュボードを識別する UUID。
オプション
--page-size int
ページごとに返されるスケジュールの数。
--page-token string
前の ListSchedules 呼び出しから受信したページ トークン。
Examples
次の例では、ダッシュボードのスケジュールを一覧表示します。
databricks lakeview list-schedules abc123
「databricks lakeview リスト購読」
ダッシュボード スケジュールのすべてのサブスクリプションを一覧表示します。
databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
サブスクリプションが属するダッシュボードを識別する UUID。
SCHEDULE_ID
サブスクリプションが属するスケジュールを識別する UUID。
オプション
--page-size int
ページごとに返されるサブスクリプションの数。
--page-token string
前の ListSubscriptions 呼び出しから受信したページ トークン。
Examples
次の例では、スケジュールのサブスクリプションを一覧表示します。
databricks lakeview list-subscriptions abc123 sch456
Databricks Lakeview 移行
クラシック SQL ダッシュボードを Lakeview に移行します。
databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]
Arguments
SOURCE_DASHBOARD_ID
移行するダッシュボードの UUID。
オプション
--display-name string
新しい Lakeview ダッシュボードの表示名。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--parent-path string
移行された Lakeview ダッシュボードを格納するフォルダーのワークスペース パス。
--update-parameter-syntax
ダッシュボードでデータセットを変換するときに、口ひげパラメーター構文 ({{ param }}) を名前付き構文 (:param) に自動更新する必要があるかどうかを示すフラグ。
Examples
次の例では、クラシック SQL ダッシュボードを Lakeview に移行します。
databricks lakeview migrate old123 --display-name "Migrated Sales Dashboard"
次の例では、ダッシュボードを特定のフォルダーに移行します。
databricks lakeview migrate old123 --display-name "Migrated Report" --parent-path "/Workspace/Reports"
次の例では、パラメーター構文の更新を使用してダッシュボードを移行します。
databricks lakeview migrate old123 --display-name "Migrated Dashboard" --update-parameter-syntax
Databricks レイクビュー公開
現在の下書きダッシュボードを発行します。
databricks lakeview publish DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
発行するダッシュボードを識別する UUID。
オプション
--embed-credentials
公開されたダッシュボードに発行元の資格情報を埋め込む必要があるかどうかを示すフラグ。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--warehouse-id string
下書きで設定されたウェアハウスをオーバーライドするために使用できるウェアハウスの ID。
Examples
次の例では、ダッシュボードを発行します。
databricks lakeview publish abc123
次の例では、共有データアクセス許可を持つダッシュボードを発行します。
databricks lakeview publish abc123 --embed-credentials
次の例では、特定のウェアハウスを含むダッシュボードを発行します。
databricks lakeview publish abc123 --warehouse-id "wh456"
databricks lakeview 削除済みアイテム
ダッシュボードをごみ箱に入れます。
databricks lakeview trash DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
ダッシュボードを識別する UUID。
オプション
Examples
次の例では、ダッシュボードが削除されます。
databricks lakeview trash abc123
Databricks Lakeview 非公開
ダッシュボードの発行を解除します。
databricks lakeview unpublish DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
発行されたダッシュボードを識別する UUID。
オプション
Examples
次の例では、ダッシュボードの発行を解除します。
databricks lakeview unpublish abc123
Databricks Lakeviewのアップデート
下書きダッシュボードを更新します。
databricks lakeview update DASHBOARD_ID [flags]
Arguments
DASHBOARD_ID
ダッシュボードを識別する UUID。
オプション
--display-name string
ダッシュボードの表示名。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--serialized-dashboard string
シリアル化された文字列形式のダッシュボードの内容。
--warehouse-id string
ダッシュボードの実行に使用されるウェアハウス ID。
Examples
次の例では、ダッシュボードの表示名を更新します。
databricks lakeview update abc123 --display-name "Updated Sales Dashboard"
次の例では、ダッシュボードの倉庫を更新します。
databricks lakeview update abc123 --warehouse-id "wh456"
databricks lakeview アップデートスケジュール
ダッシュボードのスケジュールを更新します。
databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]
Arguments
DASHBOARD_ID
スケジュールが属するダッシュボードを識別する UUID。
SCHEDULE_ID
スケジュールを識別する UUID。
オプション
--display-name string
スケジュールの表示名。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--pause-status SchedulePauseStatus
状態は、このスケジュールが一時停止されているかどうかを示します。 サポートされる値: PAUSED、UNPAUSED
--warehouse-id string
スケジュールに対してダッシュボードを実行するウェアハウス ID。
Examples
次の例では、スケジュールの表示名を更新します。
databricks lakeview update-schedule abc123 sch456 --display-name "Updated Daily Report"
次の例では、スケジュールを一時停止します。
databricks lakeview update-schedule abc123 sch456 --pause-status PAUSED
次の例では、別のウェアハウスでスケジュールを更新します。
databricks lakeview update-schedule abc123 sch456 --warehouse-id "wh789"
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット