lakeview コマンド グループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI内のlakeviewコマンド グループには、Lakeview ダッシュボードの特定の管理操作のコマンドが含まれています。ダッシュボードを参照してください。

databricks lakeview create

下書きダッシュボードを作成します。

databricks lakeview create [flags]

オプション

--display-name string

ダッシュボードの表示名。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--serialized-dashboard string

シリアル化された文字列形式のダッシュボードの内容。

--warehouse-id string

ダッシュボードの実行に使用したウェアハウス ID。

グローバルフラグ

例

次の例では、表示名を持つ新しいダッシュボードを作成します。

Bash

databricks lakeview create --display-name "Sales Dashboard" --warehouse-id "abc123"

次の例では、JSON 設定でダッシュボードを作成します。

Bash

databricks lakeview create --json '{"display_name": "Revenue Report", "warehouse_id": "xyz789"}'

databricks lakeview create-schedule

ダッシュボードのスケジュールを作成します。

databricks lakeview create-schedule DASHBOARD_ID [flags]

引数

DASHBOARD_ID

スケジュールが属するダッシュボードを識別するUUID。

オプション

--display-name string

スケジュールの表示名。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--pause-status SchedulePauseStatus

ステータスは、このスケジュールが停止するかどうかを示します。 サポートされている値: PAUSED、 UNPAUSED

--warehouse-id string

スケジュールのダッシュボードを実行するウェアハウス ID。

グローバルフラグ

例

次の例では、ダッシュボードのスケジュールを作成します。

Bash

databricks lakeview create-schedule abc123 --display-name "Daily Sales Report" --warehouse-id "wh456"

次の例では、 停止する スケジュールを作成します。

Bash

databricks lakeview create-schedule abc123 --display-name "Weekly Report" --pause-status PAUSED --warehouse-id "wh456"

databricks lakeview create-subscription

ダッシュボード スケジュールのサブスクリプションを作成します。

databricks lakeview create-subscription DASHBOARD_ID SCHEDULE_ID [flags]

引数

DASHBOARD_ID

サブスクリプションが属するダッシュボードを識別するUUID。

SCHEDULE_ID

サブスクリプションが属するスケジュールを識別するUUID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

例

次の例では、スケジュールのサブスクリプションを作成します。

Bash

databricks lakeview create-subscription abc123 sch456 --json '{"email": "someone@example.com"}'

databricks lakeview delete-schedule

ダッシュボードのスケジュールを削除します。

databricks lakeview delete-schedule DASHBOARD_ID SCHEDULE_ID [flags]

引数

DASHBOARD_ID

スケジュールが属するダッシュボードを識別するUUID。

SCHEDULE_ID

スケジュールを識別するUUID。

オプション

--etag string

スケジュールの etag。

グローバルフラグ

例

次の例では、ダッシュボードのスケジュールを削除します。

Bash

databricks lakeview delete-schedule abc123 sch456

次の例では、etag を使用してスケジュールを削除します。

Bash

databricks lakeview delete-schedule abc123 sch456 --etag "v1.0"

databricks lakeview delete-subscription

ダッシュボード スケジュールのサブスクリプションを削除します。

databricks lakeview delete-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

引数

DASHBOARD_ID

サブスクリプションが属するダッシュボードを識別するUUID。

SCHEDULE_ID

サブスクリプションが属するスケジュールを識別するUUID。

SUBSCRIPTION_ID

サブスクリプションを識別する UUID。

オプション

--etag string

サブスクリプションの etag。

グローバルフラグ

例

次の例では、サブスクリプションを削除します。

Bash

databricks lakeview delete-subscription abc123 sch456 sub789

次の例では、etag を使用してサブスクリプションを削除します。

Bash

databricks lakeview delete-subscription abc123 sch456 sub789 --etag "v1.0"

databricks lakeview get

下書きダッシュボードを取得します。

databricks lakeview get DASHBOARD_ID [flags]

引数

DASHBOARD_ID

ダッシュボードを識別するUUID。

オプション

グローバルフラグ

例

次の例では、ダッシュボードを取得します。

Bash

databricks lakeview get abc123

databricks lakeview get-published

現在公開されているダッシュボードを取得します。

databricks lakeview get-published DASHBOARD_ID [flags]

引数

DASHBOARD_ID

公開されたダッシュボードを識別するUUID。

オプション

グローバルフラグ

例

次の例では、公開されたダッシュボードを取得します。

Bash

databricks lakeview get-published abc123

databricks lakeview get-schedule

ダッシュボードのスケジュールを取得します。

databricks lakeview get-schedule DASHBOARD_ID SCHEDULE_ID [flags]

引数

DASHBOARD_ID

スケジュールが属するダッシュボードを識別するUUID。

SCHEDULE_ID

スケジュールを識別するUUID。

オプション

グローバルフラグ

例

次の例では、ダッシュボードのスケジュールを取得します。

Bash

databricks lakeview get-schedule abc123 sch456

databricks lakeview get-subscription

ダッシュボードのスケジュールのサブスクリプションを取得します。

databricks lakeview get-subscription DASHBOARD_ID SCHEDULE_ID SUBSCRIPTION_ID [flags]

引数

DASHBOARD_ID

サブスクリプションが属するダッシュボードを識別するUUID。

SCHEDULE_ID

サブスクリプションが属するスケジュールを識別するUUID。

SUBSCRIPTION_ID

サブスクリプションを識別する UUID。

オプション

グローバルフラグ

例

次の例では、サブスクリプションを取得します。

Bash

databricks lakeview get-subscription abc123 sch456 sub789

databricks lakeview list

すべてのダッシュボードを一覧表示します。

databricks lakeview list [flags]

オプション

--page-size int

ページごとに返されるダッシュボードの数。

--page-token string

以前の ListDashboards 呼び出しから受信したページ トークン。

--show-trashed

ゴミ箱にあるダッシュボードを含めるフラグ。

--view DashboardView

DASHBOARD_VIEW_BASIC ダッシュボードのサマリーメタデータのみが含まれます。サポートされている値: DASHBOARD_VIEW_BASIC

グローバルフラグ

例

次の例は、すべてのダッシュボードを一覧表示します。

Bash

databricks lakeview list

次の例は、特定のページサイズのダッシュボードを一覧表示します。

Bash

databricks lakeview list --page-size 10

次の例は、ごみ箱に入れられたダッシュボードを含むダッシュボードを一覧表示します。

Bash

databricks lakeview list --show-trashed

次の例は、基本ビューを持つダッシュボードを一覧表示します。

Bash

databricks lakeview list --view DASHBOARD_VIEW_BASIC

databricks lakeview list-schedules

ダッシュボードのすべてのスケジュールを一覧表示します。

databricks lakeview list-schedules DASHBOARD_ID [flags]

引数

DASHBOARD_ID

スケジュールが属するダッシュボードを識別するUUID。

オプション

--page-size int

ページごとに返すスケジュールの数。

--page-token string

前の ListSchedules 呼び出しから受信したページ トークン。

グローバルフラグ

例

次の例は、ダッシュボードのスケジュールをリストします。

Bash

databricks lakeview list-schedules abc123

databricks lakeview list-subscriptions

ダッシュボード スケジュールのすべてのサブスクリプションを一覧表示します。

databricks lakeview list-subscriptions DASHBOARD_ID SCHEDULE_ID [flags]

引数

DASHBOARD_ID

サブスクリプションが属するダッシュボードを識別するUUID。

SCHEDULE_ID

サブスクリプションが属するスケジュールを識別するUUID。

オプション

--page-size int

ページごとに返されるサブスクリプションの数。

--page-token string

以前の ListSubscriptions 呼び出しから受信したページ トークン。

グローバルフラグ

例

次の例は、スケジュールのサブスクリプションを一覧表示します。

Bash

databricks lakeview list-subscriptions abc123 sch456

databricks lakeview migrate

クラシック SQL ダッシュボードを Lakeview に移行します。

databricks lakeview migrate SOURCE_DASHBOARD_ID [flags]

引数

SOURCE_DASHBOARD_ID

移行するダッシュボードの UUID。

オプション

--display-name string

新しい Lakeview ダッシュボードの表示名。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--parent-path string

移行された Lakeview ダッシュボードを含むフォルダーのワークスペース パス。

--update-parameter-syntax

ダッシュボードでデータセットを変換するときに、mustache パラメーター構文 ({{ param }}) を名前付き構文 (:param) に自動更新する必要があるかどうかを示すフラグ。

グローバルフラグ

例

次の例では、クラシック SQL ダッシュボードを Lakeview に移行します。

Bash

databricks lakeview migrate old123 --display-name "Migrated Sales Dashboard"

次の例では、ダッシュボードを特定のフォルダーに移行します。

Bash

databricks lakeview migrate old123 --display-name "Migrated Report" --parent-path "/Workspace/Reports"

次の例では、パラメーター構文更新を使用してダッシュボードを移行します。

Bash

databricks lakeview migrate old123 --display-name "Migrated Dashboard" --update-parameter-syntax

databricks lakeview publish

現在のドラフトダッシュボードを公開します。

databricks lakeview publish DASHBOARD_ID [flags]

引数

DASHBOARD_ID

発行するダッシュボードを識別する UUID。

オプション

--embed-credentials

発行元の資格情報を公開ダッシュボードに埋め込む必要があるかどうかを示すフラグ。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--warehouse-id string

ドラフトで設定されたウェアハウスを上書きするために使用できるウェアハウスの ID。

グローバルフラグ

例

次の例では、ダッシュボードを公開します。

Bash

databricks lakeview publish abc123

次の例では、資格情報が埋め込まれたダッシュボードを公開します。

Bash

databricks lakeview publish abc123 --embed-credentials

次の例では、特定のウェアハウスを含むダッシュボードを公開します。

Bash

databricks lakeview publish abc123 --warehouse-id "wh456"

databricks lakeview trash

ダッシュボードをゴミ箱に捨てます。

databricks lakeview trash DASHBOARD_ID [flags]

引数

DASHBOARD_ID

ダッシュボードを識別するUUID。

オプション

グローバルフラグ

例

次の例では、ダッシュボードをごみ箱にします。

Bash

databricks lakeview trash abc123

databricks lakeview unpublish

ダッシュボードを非公開にします。

databricks lakeview unpublish DASHBOARD_ID [flags]

引数

DASHBOARD_ID

公開されたダッシュボードを識別するUUID。

オプション

グローバルフラグ

例

次の例では、ダッシュボードの公開を解除します。

Bash

databricks lakeview unpublish abc123

databricks lakeview update

下書きダッシュボードを更新します。

databricks lakeview update DASHBOARD_ID [flags]

引数

DASHBOARD_ID

ダッシュボードを識別するUUID。

オプション

--display-name string

ダッシュボードの表示名。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--serialized-dashboard string

シリアル化された文字列形式のダッシュボードの内容。

--warehouse-id string

ダッシュボードの実行に使用したウェアハウス ID。

グローバルフラグ

例

次の例では、ダッシュボードの表示名を更新します。

Bash

databricks lakeview update abc123 --display-name "Updated Sales Dashboard"

次の例では、ダッシュボードのウェアハウスを更新します。

Bash

databricks lakeview update abc123 --warehouse-id "wh456"

databricks lakeview update-schedule

ダッシュボードのスケジュールを更新します。

databricks lakeview update-schedule DASHBOARD_ID SCHEDULE_ID [flags]

引数

DASHBOARD_ID

スケジュールが属するダッシュボードを識別するUUID。

SCHEDULE_ID

スケジュールを識別するUUID。

オプション

--display-name string

スケジュールの表示名。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--pause-status SchedulePauseStatus

ステータスは、このスケジュールが停止するかどうかを示します。 サポートされている値: PAUSED、 UNPAUSED

--warehouse-id string

スケジュールのダッシュボードを実行するウェアハウス ID。

グローバルフラグ

例

次の例では、スケジュールの表示名を更新します。

Bash

databricks lakeview update-schedule abc123 sch456 --display-name "Updated Daily Report"

次の例では、スケジュールを停止する:

Bash

databricks lakeview update-schedule abc123 sch456 --pause-status PAUSED

次の例では、スケジュールを別のウェアハウスで更新します。

Bash

databricks lakeview update-schedule abc123 sch456 --warehouse-id "wh789"

グローバルフラグ

--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

該当する場合は、使用するバンドル・ターゲット