apps コマンド グループ
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI 内の apps コマンド グループを使用すると、アプリを管理できます。アプリは、顧客の Databricks インスタンスで直接実行され、データと統合し、Databricks サービスを使用および拡張し、ユーザーがシングル サインオンを通じて対話できるようにします。「 Databricks アプリ」を参照してください。
databricks apps create
新しいアプリを作成します。
databricks apps create NAME [flags]
引数
NAME
アプリの名前。名前には、小文字の英数字とハイフンのみを含める必要があります。ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--compute-size ComputeSize
アプリのコンピュートサイズ。 サポートされている値: LARGE 、 MEDIUM 。
--description string
アプリの説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-compute
true の場合、アプリは作成後に起動されません。
--no-wait
ACTIVE 状態になるのを待たないでください。
--space string
このアプリが属するスペースの名前。
--timeout duration
ACTIVE状態に達するまでの最大時間(デフォルトは20m0s)。
--usage-policy-id string
アプリの使用ポリシー ID。
例
次の例では、基本的なアプリを作成します。
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 アプリの作成と更新
アプリの更新を作成し、更新プロセスを開始します。更新プロセスは非同期であり、更新のステータスは GetAppUpdate メソッドで確認できます。
databricks apps create-update APP_NAME UPDATE_MASK [flags]
引数
APP_NAME
アプリの名前。
UPDATE_MASK
フィールド マスクは単一の文字列で、複数のフィールドはコンマ (スペースなし) で区切る必要があります。フィールド パスはリソース オブジェクトに対する相対パスであり、ドット (.) を使用してサブフィールド (例: author.given_name) を移動します。コレクション フィールド全体のみを指定できるため、シーケンス フィールドまたはマップ フィールド内の要素の指定は許可されません。フィールド名はリソース フィールド名と完全に一致する必要があります。
フィールド マスク * は完全置換を示します。将来 API が変更された場合に意図しない結果が生じる可能性があるため、更新されるフィールドを常に明示的にリストし、* ワイルドカードの使用を避けることをお勧めします。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--no-wait
SUCCEEDED状態になるまで待たないでください。
--timeout duration
SUCCEEDED 状態に達するまでの最大時間 (デフォルト 20m0s)。
例
次の例では、特定のフィールド マスクを使用してアプリの更新を作成します。
databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'
次の例では、完了を待たずにアプリの更新を作成します。
databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait
次の例では、カスタム タイムアウトを使用してアプリの更新を作成します。
databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m
databricks apps delete
アプリを削除します。
Databricks Apps プロジェクト ディレクトリ ( databricks.ymlを含む) からNAME引数なしでこのコマンドを実行すると、プロジェクトによってデプロイされたすべてのリソースが削除されます。NAME引数が指定されている場合、またはプロジェクトディレクトリにない場合は、APIを使用して指定されたアプリを直接削除します。
databricks apps delete [NAME] [flags]
引数
NAME
アプリの名前。プロジェクトディレクトリ内にない場合は必須です。プロジェクトディレクトリに指定されている場合、プロジェクトの破棄ではなく、API の削除機能を使用します。
オプション
--auto-approve
リソースやファイルの削除に関する対話型承認をスキップする。
--force-lock
デプロイメントロックの取得を強制します。
例
次の例では、アプリを削除します。
databricks apps delete my-analytics-app
次の例は、プロジェクトディレクトリからすべてのプロジェクトリソースを削除します。
databricks apps delete
以下の例は、自動承認でプロジェクトリソースを削除する例です。
databricks apps delete --auto-approve
databricks apps delete-app-thumbnail
アプリのサムネイルを削除します。
databricks apps delete-app-thumbnail NAME [flags]
引数
NAME
アプリの名前。
オプション
例
以下の例では、アプリのサムネイルを削除します：
databricks apps delete-app-thumbnail my-app
databricks apps deploy
アプリケーションのデプロイメントを作成します。
APP_NAME引数を指定せずにDatabricks Appsプロジェクト ディレクトリ ( databricks.ymlを含む) から実行すると、このコマンドはプロジェクトを検証し、ワークスペースにデプロイし、アプリを実行する拡張デプロイメント パイプラインを実行します。 APP_NAME引数が指定されている場合、またはプロジェクトディレクトリにない場合は、APIを直接使用してアプリのデプロイメントを作成します。
databricks apps deploy [APP_NAME] [flags]
引数
APP_NAME
アプリの名前。プロジェクトディレクトリ内にない場合は必須です。プロジェクトディレクトリに指定されている場合、プロジェクトデプロイではなくAPIデプロイを使用します。
オプション
--deployment-id string
デプロイの一意の ID。
--force
Gitブランチ検証を強制的に上書きする。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--mode AppDeploymentMode
デプロイメントがソース・コードを管理するモード。サポートされている値: AUTO_SYNC、 SNAPSHOT。
--no-wait
SUCCEEDED状態になるまで待たないでください。
--skip-tests
検証中にテストを実行しない（デフォルトはtrue）。
--skip-validation
プロジェクトの検証（ビルド、型チェック、リンティング）をスキップします。
--source-code-path string
アプリのデプロイの作成に使用されるソースコードのワークスペースファイルシステムパス。
--timeout duration
SUCCEEDED 状態に達するまでの最大時間 (デフォルト 20m0s)。
例
次の例では、自動同期モードでデプロイを作成します。
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 apps dev-remote
リモートサーバーへの WebSocket ブリッジを使用して、AppKit アプリをローカルでラン。ローカルの Vite 開発サーバーを起動し、ホットモジュール置換を使用した開発のために、リモートの Databricks アプリへの WebSocket ブリッジを確立します。
databricks apps dev-remote [flags]
引数
なし
オプション
--auto-approve
すべての閲覧者の接続を自動的に承認します。共有可能なdev URLを持つユーザーはセッション期間中信頼されます。信頼できる環境でのみ使用してください。
--client-path string
Vite クライアント ディレクトリへのパス（default ./client）。
--name string
接続先のアプリ名（指定がない場合はプロンプトが表示されます）。
--port int
Vite サーバーをランするポート（default は 5173）。
例
次の例では、特定のアプリの開発サーバーを起動します。
databricks apps dev-remote --name my-app
以下の例では、カスタムクライアントパスとポートを使用します：
databricks apps dev-remote --name my-app --client-path ./frontend --port 3000
databricks apps get
指定された名前でアプリの情報を取得します。
databricks apps get NAME [flags]
引数
NAME
アプリの名前。
オプション
例
次の例では、アプリ情報を取得します。
databricks apps get my-analytics-app
次の例では、アプリ情報を JSON 形式で取得します。
databricks apps get my-data-app --output json
次の例では、特定のプロファイルを使用してアプリ情報を取得します。
databricks apps get my-ml-app --profile production
databricks apps get-deployment
指定された名前とデプロイ ID を使用して、アプリのデプロイに関する情報を取得します。
databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]
引数
APP_NAME
アプリの名前。
DEPLOYMENT_ID
デプロイの一意の ID。
オプション
例
次の例では、デプロイ情報を取得します。
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 アプリの get-update
アプリの更新のステータスを取得します。
databricks apps get-update APP_NAME [flags]
引数
APP_NAME
アプリの名前。
オプション
例
次の例では、アプリの更新のステータスを取得します。
databricks apps get-update my-analytics-app
次の例では、JSON 形式で更新ステータスを取得します。
databricks apps get-update my-data-app --output json
次の例では、特定のプロファイルを使用して更新ステータスを取得します。
databricks apps get-update my-ml-app --profile production
Databricksアプリのインポート
（実験的機能）既存のDatabricksアプリをバンドルとしてインポートします。
既存のDatabricksアプリをインポートし、バンドル構成に変換します。このコマンドは、アプリ構成を含む新しいバンドルディレクトリを作成し、アプリのソースコードをダウンロードし、バンドルを既存のアプリにバインドし、直接デプロイモードを使用してデプロイします。
databricks apps import [flags]
引数
なし
オプション
--cleanup
以前のアプリフォルダとその中のすべてのコンテンツをクリーンアップしてください。
--force-import
既にインポート済みのアプリを強制的に再インポートします（所有しているアプリのみ有効です）。
--name string
インポートするアプリの名前。指定がない場合、対話的に選択できるすべてのアプリを一覧表示します。
--output-dir string
バンドルを出力するディレクトリ。デフォルトではアプリ名が使用されます。
-q, --quiet
情報メッセージの表示を抑制します（エラーとプロンプトのみを表示します）。
例
次の例では、アプリをインポートし、アプリ名と同じ名前のディレクトリを作成します。
databricks apps import --name my-streamlit-app
次の例では、カスタム出力ディレクトリを持つアプリをインポートします。
databricks apps import --name my-app --output-dir ~/my-apps/analytics
次の例では、アプリをインポートし、古いアプリフォルダをクリーンアップします。
databricks apps import --name my-app --cleanup
databricks apps init
Templateから新しいAppKitアプリケーションを初期化します。引数なしでランすると、defaultのAppKit Templateが使用され、対話型プロンプトがセットアップをガイドします。--nameを指定してランすると、非対話モードでランされます（必要なフラグをすべて指定する必要があります）。defaultでは、このコマンドはAppKitの最新リリースバージョンを使用します。異なるバージョンを指定するには、--version を使用します。
databricks apps init [flags]
引数
なし
オプション
--auto-approve
オプションのリソースに対する確認プロンプトをスキップします。オプションのリソースは、その値が --set を介して提供された場合にのみ構成されます。
--branch string
GitのBranchまたはタグ（GitHub Template用、--versionとは排他的）。
--deploy
作成後にアプリをデプロイします。
--description string
アプリの説明。
--features strings
有効にする機能/プラグイン（カンマ区切り、Templateマニフェストで定義されているもの）。
--name string
プロジェクト名（指定されていない場合はプロンプトが表示されます）。
--output-dir string
プロジェクトの書き込み先ディレクトリ。
--run string
作成後にアプリをランします（none、dev、dev-remote）。
--set stringArray
リソース値を設定します（形式：plugin.resourceKey.field=value、は複数指定できます）。
--skip-install
プロジェクトの依存関係のインストールをスキップします (例:npm install / uv sync)。--run と組み合わせることはできません。
--template string
Templateパス（ローカルディレクトリまたはGitHub URL）。
--version string
使用する AppKit バージョン (default：自動検出、メイン Branch には latest を使用)。
例
以下の例では、対話型プロンプトを使用して新しいアプリを初期化しています。
databricks apps init
次の例では、特定のバージョンで新しいアプリを初期化します。
databricks apps init --version v0.2.0
次の例では、新しいアプリを非対話形式で初期化します。
databricks apps init --name my-app
次の例では、アナリティクス機能を使用してアプリを初期化する方法を示します。
databricks apps init --name my-app --features=analytics --set analytics.sql-warehouse.id=abc123
次の例では、アプリを初期化し、デプロイし、dev-remoteを実行します：
databricks apps init --name my-app --deploy --run=dev-remote
databricks apps list
ワークスペース内のすべてのアプリを一覧表示します。
databricks apps list [flags]
引数
なし
オプション
--page-size int
返されるアイテムの上限。
--page-token string
アプリの次のページに移動するページネーショントークン。
--space string
アプリスペース名でアプリをフィルタリングします。
例
次の例は、すべてのアプリを一覧表示します。
databricks apps list
次の例は、特定のページ サイズのアプリを一覧表示します。
databricks apps list --page-size 10
次の例は、ページネーションを含むアプリを一覧表示します。
databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
databricks apps list-deployments
指定された名前でアプリのすべてのアプリ展開を一覧表示します。
databricks apps list-deployments APP_NAME [flags]
引数
APP_NAME
アプリの名前。
オプション
--page-size int
返されるアイテムの上限。
--page-token string
アプリの次のページに移動するページネーショントークン。
例
次の例は、アプリのすべてのデプロイを一覧表示します。
databricks apps list-deployments my-analytics-app
次の例は、特定のページサイズのデプロイメントをリストします。
databricks apps list-deployments my-data-app --page-size 10
databricks apps マニフェスト
Template（default AppKit リポジトリまたは --template URL）を解決し、appkit.plugins.json を特定して、その生のコンテンツを stdout に出力します。ワークスペース認証は不要です。databricks apps init と同じ --template、--branch、および --version フラグを使用して、特定の Template をターゲットにします。--template がない場合は、default AppKit Template を使用します。
databricks apps manifest [flags]
引数
なし
オプション
--branch string
GitのBranchまたはタグ（GitHub Template用、--versionとは排他的）。
--template string
Templateパス（ローカルディレクトリまたはGitHub URL）。
--version string
default TemplateのAppKitバージョン (default: main、main Branchには latest を使用)。
例
次の例では、default Templateのマニフェストを表示します：
databricks apps manifest
次の例では、特定のバージョンのマニフェストを表示します。
databricks apps manifest --version v0.2.0
次の例は、GitHub リポジトリのマニフェストを表示します。
databricks apps manifest --template https://github.com/user/repo --branch main
データブリックスアプリのログ
ログ ストリームを使用して、 Databricksアプリの stdout/stderr ログをストリームします。 デフォルトでは、このコマンドは--tail-linesまでの最新のログを取得して終了します。サーバー側フィルタリングは--searchを使用して利用でき、クライアント側フィルタリングは--source APP|SYSTEMを使用して利用できます。
databricks apps logs [NAME] [flags]
引数
NAME
アプリの名前。
オプション
-f, --follow
キャンセルされるか、指定されたタイムアウトに達するまで、ログのストリーミングを続行します。
--tail-lines int
ストリーミング前に表示する最近のログ行の数。すべてを表示するには0に設定します。デフォルト： 200
--timeout duration
--followが設定されている場合のストリームまでの最大時間。 タイムアウトを無効にするには、 0に設定します。
--search string
ストリーミングする前に、検索用語をログ サービスに送信します。
--source strings
ログをAPPまたはSYSTEMソースに制限します。
--output-file string
stdout に加えてログを書き込むためのオプションのファイル パス。
例
次の例では、アプリの最新のログを取得します。
databricks apps logs my-analytics-app
次の例では、中断されるまでログを継続的にストリームします。
databricks apps logs my-analytics-app --follow
次の例では、ログの最後の 500 行を取得します。
databricks apps logs my-data-app --tail-lines 500
次の例では、10 分のタイムアウトでログをストリーミングします。
databricks apps logs my-ml-app --follow --timeout 10m
次の例では、検索語句でログをフィルタリングします。
databricks apps logs my-analytics-app --search "error"
次の例では、ログをアプリレベルの出力のみに制限します。
databricks apps logs my-data-app --source APP
次の例では、ログを stdout とファイルの両方に書き込みます。
databricks apps logs my-ml-app --output-file /tmp/app-logs.txt
databricks apps run-local
アプリをローカルで起動します。
databricks apps run-local [flags]
引数
なし
オプション
--app-port int
アプリを実行するポート (デフォルト 8000)。
--debug
デバッグモードを有効にします。
--debug-port string
デバッガーを実行するポート。
--entry-point string
アプリの構成 (.yml ファイル) を使用してカスタム エントリ ポイントを指定します。デフォルトは app.ymlです。
--env strings
環境変数を設定します。
--port int
アプリ プロキシを実行するポート (デフォルト 8001)。
--prepare-environment
アプリを実行するための環境を準備します。uv をインストールする必要があります。
例
次の例は、 アプリをローカルに実行します デフォルト設定:
databricks apps run-local
次の例では、特定のポートでアプリをローカルに実行します。
databricks apps run-local --app-port 9000 --port 9001
databricks apps start
ワークスペースでアプリの最後のアクティブなデプロイを開始します。
databricks apps start [NAME] [flags]
引数
NAME
アプリの名前。
オプション
--no-wait
ACTIVE 状態になるのを待たないでください。
--timeout duration
ACTIVE状態に達するまでの最大時間(デフォルトは20m0s)。
例
次の例では、アプリを起動します。
databricks apps start my-analytics-app
次の例では、待機せずにアプリを起動します。
databricks apps start my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを起動します。
databricks apps start my-ml-app --timeout 30m
databricks apps stop
ワークスペースでのアプリのアクティブなデプロイを停止します。
databricks apps stop [NAME] [flags]
引数
NAME
アプリの名前。
オプション
--no-wait
STOPPED 状態に達するのを待たないでください。
--timeout duration
STOPPED 状態に達するまでの最大時間 (デフォルトは 20 分 0 秒)。
例
次の例では、アプリを停止します。
databricks apps stop my-analytics-app
次の例では、待機せずにアプリを停止します。
databricks apps stop my-data-app --no-wait
次の例では、カスタム タイムアウトでアプリを停止します。
databricks apps stop my-ml-app --timeout 30m
databricks apps update
指定した名前でアプリを更新します。
databricks apps update NAME [flags]
引数
NAME
アプリの名前。名前には、小文字の英数字とハイフンのみを含める必要があります。ワークスペース内で一意である必要があります。
オプション
--budget-policy-id string
アプリの予算ポリシー ID。
--compute-size ComputeSize
アプリのコンピュートサイズ。 サポートされている値: LARGE 、 MEDIUM 。
--description string
アプリの説明。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--space string
このアプリが属するスペースの名前。
--usage-policy-id string
アプリの使用ポリシー ID。
例
次の例では、アプリの説明を更新します。
databricks apps update my-analytics-app --description "Updated analytics dashboard"
databricks apps update-app-thumbnail
アプリのサムネイルを更新します。
databricks apps update-app-thumbnail NAME [flags]
引数
NAME
アプリの名前。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、アプリのサムネイルを更新します。
databricks apps update-app-thumbnail my-app --json '{"image": "base64_encoded_image_data"}'
databricks apps validate
ビルド、型チェック、およびリントチェックを実行して、Databricks Appプロジェクトを検証します。このコマンドはプロジェクトタイプを検出し、適切な検証を実行します。Node.jsプロジェクト（package.json）の場合、npm install、ビルド、型チェック、リント、およびテストをランします。
databricks apps validate [flags]
引数
なし
オプション
--path string
プロジェクトディレクトリへのパス (default は現在のディレクトリ)。
--skip-tests
検証を高速化するためにテストの実行をスキップします。
例
以下の例では、現在のディレクトリを検証します。
databricks apps validate
以下の例では、特定のディレクトリを検証しています。
databricks apps validate --path ./my-app
次の例では、テストなしで検証を実行します：
databricks apps validate --skip-tests
Databricks アプリ get-permission-levels
アプリの権限レベルを取得します。
databricks apps get-permission-levels APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
例
次の例では、アプリのアクセス許可レベルを取得します。
databricks apps get-permission-levels my-analytics-app
databricks apps get-permissions
アプリのアクセス許可を取得します。アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps get-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
例
次の例では、アプリのアクセス許可を取得します。
databricks apps get-permissions my-analytics-app
次の例では、特定のプロファイルを使用してアクセス許可を取得します。
databricks apps get-permissions my-ml-app --profile production
databricks apps set-permissions
アプリの権限を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps set-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、JSON 設定を使用してアクセス許可を設定します。
databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'
databricks apps update-permissions
アプリのアクセス許可を更新します。アプリは、ルート オブジェクトからアクセス許可を継承できます。
databricks apps update-permissions APP_NAME [flags]
引数
APP_NAME
アクセス許可を取得または管理するアプリ。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、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 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
該当する場合は、使用するバンドル・ターゲット