Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
apps 内の コマンド グループを使用すると、アプリを管理できます。 アプリは、顧客の Databricks インスタンス上で直接実行され、データと統合され、Databricks サービスを使用および拡張し、ユーザーがシングル サインオンを介して対話できるようにします。
Databricks アプリを参照してください。
databricks アプリケーションを作成
新しいアプリを作成する。
databricks apps create NAME [flags]
Arguments
NAME
アプリの名前。 名前には、小文字の英数字とハイフンのみを含める必要があります。 ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--description string
アプリの説明。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--no-compute
true の場合、アプリは作成後に開始されません。
--no-wait
ACTIVE 状態になるまで待つ必要はありません。
--timeout duration
ACTIVE 状態に達するまでの最大時間 (既定は 20m0 秒)。
Examples
次の例では、基本的なアプリを作成します。
databricks apps create my-analytics-app --description "Analytics dashboard app"
次の例では、アプリを起動せずに作成します。
databricks apps create my-data-app --description "Data processing app" --no-compute
次の例では、カスタム タイムアウトでアプリを作成します。
databricks apps create my-ml-app --description "Machine learning app" --timeout 30m
databricks アプリの削除
アプリを削除します。
databricks apps delete NAME [flags]
Arguments
NAME
アプリの名前。
オプション
Examples
次の例では、アプリを削除します。
databricks apps delete my-analytics-app
databricks アプリのデプロイ
提供された名前のアプリのデプロイを作成します。
databricks apps deploy APP_NAME [flags]
Arguments
APP_NAME
アプリの名前。
オプション
--deployment-id string
デプロイメントの一意の ID。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--mode AppDeploymentMode
デプロイがソース コードを管理するモード。 サポートされる値: AUTO_SYNC、SNAPSHOT。
--no-wait
SUCCEEDED 状態になるまで待ちません。
--source-code-path string
アプリのデプロイの作成に使用されるソース コードのワークスペース ファイル システム パス。
--timeout duration
SUCCEEDED 状態に達するまでの最大時間 (既定は 20m0 秒)。
Examples
次の例では、自動同期モードでデプロイを作成します。
databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC
次の例では、スナップショット モードでデプロイを作成します。
databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT
次の例では、カスタム デプロイ ID を使用してデプロイを作成します。
databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app
databricks アプリが取得する
指定された名前のアプリの情報を取得します。
databricks apps get NAME [flags]
Arguments
NAME
アプリの名前。
オプション
Examples
次の例では、アプリ情報を取得します。
databricks apps get my-analytics-app
次の例では、JSON 形式でアプリ情報を取得します。
databricks apps get my-data-app --output json
次の例では、特定のプロファイルを使用してアプリ情報を取得します。
databricks apps get my-ml-app --profile production
databricks アプリの get-deployment コマンド
指定された名前とデプロイ ID を使用して、アプリのデプロイに関する情報を取得します。
databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]
Arguments
APP_NAME
アプリの名前。
DEPLOYMENT_ID
デプロイメントの一意の ID。
オプション
Examples
次の例では、デプロイ情報を取得します。
databricks apps get-deployment my-analytics-app v1.0.0
次の例では、JSON 形式でデプロイ情報を取得します。
databricks apps get-deployment my-data-app v2.1.0 --output json
次の例では、特定のプロファイルを使用してデプロイ情報を取得します。
databricks apps get-deployment my-ml-app latest --profile production
databricks アプリの一覧
ワークスペース内のすべてのアプリを一覧表示します。
databricks apps list [flags]
Arguments
None
オプション
--page-size int
返される項目の上限。
--page-token string
アプリの次のページに移動するための改ページ トークン。
Examples
次の例では、すべてのアプリを一覧表示します。
databricks apps list
次の例では、特定のページ サイズのアプリを一覧表示します。
databricks apps list --page-size 10
次の例では、ページネーションが適用されたアプリをリストします。
databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
databricks アプリ リストデプロイメント
指定された名前を使用して、アプリのすべてのアプリのデプロイを一覧表示します。
databricks apps list-deployments APP_NAME [flags]
Arguments
APP_NAME
アプリの名前。
オプション
--page-size int
返される項目の上限。
--page-token string
アプリの次のページに移動するための改ページ トークン。
Examples
次の例では、アプリのすべてのデプロイの一覧を示します。
databricks apps list-deployments my-analytics-app
次の例では、特定のページ サイズを持つデプロイの一覧を示します。
databricks apps list-deployments my-data-app --page-size 10
databricks アプリをローカルで実行する
アプリをローカルで起動します。
databricks apps run-local [flags]
Arguments
None
オプション
--app-port int
アプリを実行するポート (既定値は 8000)。
--debug
デバッグモードを有効にします。
--debug-port string
デバッガーを実行するポート。
--entry-point string
アプリの構成 (.yml ファイル) でカスタム エントリ ポイントを指定します。 既定値は app.yml です。
--env strings
環境変数を設定します。
--port int
アプリ プロキシを実行するポート (既定値は 8001)。
--prepare-environment
アプリを実行するための環境を準備します。 uv をインストールする必要があります。
Examples
次の例では、既定の設定でアプリをローカルで実行します。
databricks apps run-local
次の例では、特定のポートでアプリをローカルで実行します。
databricks apps run-local --app-port 9000 --port 9001
databricks アプリの起動
ワークスペース内のアプリの最後のアクティブなデプロイを開始します。
databricks apps start NAME [flags]
Arguments
NAME
アプリの名前。
オプション
--no-wait
ACTIVE 状態になるまで待つ必要はありません。
--timeout duration
ACTIVE 状態に達するまでの最大時間 (既定は 20m0 秒)。
Examples
次の例では、アプリを起動します。
databricks apps start my-analytics-app
次の例では、待機せずにアプリを起動します。
databricks apps start my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを起動します。
databricks apps start my-ml-app --timeout 30m
databricks アプリが停止する
ワークスペース内のアプリのアクティブなデプロイを停止します。
databricks apps stop NAME [flags]
Arguments
NAME
アプリの名前。
オプション
--no-wait
STOPPED 状態になるまで待つ必要はありません。
--timeout duration
STOPPED 状態に達するまでの最大時間 (既定値は 20分0秒に設定されています)。
Examples
次の例では、アプリを停止します。
databricks apps stop my-analytics-app
次の例では、待機せずにアプリを停止します。
databricks apps stop my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを停止します。
databricks apps stop my-ml-app --timeout 30m
databricks アプリの更新
指定した名前でアプリを更新します。
databricks apps update NAME [flags]
Arguments
NAME
アプリの名前。 名前には、小文字の英数字とハイフンのみを含める必要があります。 ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--description string
アプリの説明。
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、アプリの説明を更新します。
databricks apps update my-analytics-app --description "Updated analytics dashboard"
databricks アプリの「get-permission-levels」エンティティ
アプリのアクセス許可レベルを取得します。
databricks apps get-permission-levels APP_NAME [flags]
Arguments
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
Examples
次の例では、アプリのアクセス許可レベルを取得します。
databricks apps get-permission-levels my-analytics-app
databricks アプリの権限取得
アプリのアクセス許可を取得します。 アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps get-permissions APP_NAME [flags]
Arguments
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
Examples
次の例では、アプリのアクセス許可を取得します。
databricks apps get-permissions my-analytics-app
次の例では、特定のプロファイルを使用してアクセス許可を取得します。
databricks apps get-permissions my-ml-app --profile production
databricks アプリに権限を設定する
アプリのアクセス許可を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps set-permissions APP_NAME [flags]
Arguments
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、JSON 構成を使用してアクセス許可を設定します。
databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
databricks アプリの権限を更新
アプリのアクセス許可を更新します。 アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps update-permissions APP_NAME [flags]
Arguments
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
Examples
次の例では、JSON 構成を使用してアクセス許可を更新します。
databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'
グローバル フラグ
--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 文字列
該当する場合は、使用するバンドル ターゲット