Databricks CLI コマンド

注記

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

Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。

この記事では、使用可能な Databricks CLI コマンドに関する情報を提供します。 この情報は、コマンドラインのヘルプを補足するものです。 のインストールと使用の詳細については、「DatabricksCLI のインストールまたは更新DatabricksCLI 」および「DatabricksCLIとは」を参照してください。

Databricks CLI には、次の表に示すコマンド グループが含まれています。 コマンド グループには、関連するコマンドのセットが含まれており、サブコマンドを含めることもできます。 コマンド・グループ、個々のコマンド、またはサブコマンドの使用法と構文情報を出力するには、次のようにします。

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

多くの CLI コマンドは、 Databricks REST API リファレンスに記載されている操作にマップされます。

ワークスペース コマンド

グループ	説明とコマンド
FSの	ファイルおよびファイル・システムを管理するためのコマンド: cat、cp、ls、mkdir、 rm
git-credentials	Databricks がユーザーに代わって操作を行うための個人用アクセス トークンを登録するためのコマンド: create、delete、get、list、 update
repos	ユーザーが自分の git リポジトリを管理できるようにするためのコマンド: create、delete、get、list、 update get-permission-levels、get-permissions、set-permissions、 update-permissions
secrets	シークレット、シークレットスコープ、およびアクセス権限を管理するためのコマンド: create-scope、delete-acl、delete-scope、delete-secret、get-acl、get-secret、list-acls、list-scopes、list-secrets、put-acl、 put-secret
workspace	ワークスペース内のノートブックとフォルダーを一覧表示、インポート、エクスポート、および削除するコマンド: delete、export、export-dir、get-status、import、import-dir、list、 mkdirs get-permission-levels、get-permissions、set-permissions、 update-permissions

コンピュート コマンド

グループ	説明とコマンド
cluster-policies	一連のルールに基づいてクラスターを構成するユーザーの機能を制御するコマンド: create、delete、edit、get、 list get-permission-levels、get-permissions、set-permissions、 update-permissions
clusters	クラスターを作成、開始、編集、一覧表示、終了、および削除できるコマンド: change-owner、create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpin get-permission-levels、get-permissions、set-permissions、 update-permissions
global-init-scripts	ワークスペース管理者がワークスペースのグローバル初期化スクリプトを構成できるようにするコマンド: create、delete、get、list、 update
instance-pools	すぐに使用できるクラウドインスタンスを使用してインスタンスプールを作成、編集、削除、一覧表示するコマンドにより、クラスターの開始時間と自動スケーリング時間が短縮されます。 create、delete、edit、get、 list get-permission-levels、get-permissions、set-permissions、 update-permissions
instance-profiles	管理者が、ユーザーがクラスターを起動できるインスタンスプロファイルを追加、一覧表示、削除できるようにするコマンド: add、edit、list、 remove
libraries	クラスター上のライブラリをインストール、アンインストール、およびステータスを取得するコマンド: all-cluster-statuses、cluster-status、install、 uninstall
policy-families	使用可能なポリシーファミリを表示するコマンド: get, list

ジョブ・コマンド

グループ	説明とコマンド
jobs	ジョブを管理するためのコマンド: cancel-all-runs, cancel-run, create, delete, delete-run, export-run, get, get-run, get-run-output, list, list-runs, repair-run, reset, run-now, submit, update get-permission-levels、get-permissions、set-permissions、 update-permissions

DLT コマンド

グループ	説明とコマンド
pipelines	パイプラインを作成、編集、削除、開始、および詳細を表示するコマンド: create、delete、get、get-update、list-pipeline-events、list-pipelines、list-updates、start-update、stop、 update get-permission-levels、get-permissions、set-permissions、 update-permissions

機械学習コマンド

グループ	説明とコマンド
experiments	MLflowの組織の主要な単位であるエクスペリメントと対話するためのコマンド ;すべてのMLflow実行はエクスペリメントに属します。 create-experiment、 create-run、 delete-experiment、 delete-run、 delete-runs、 delete-tag、 get-by-name、 get-experiment、 get-history、 get-runGet、 list-artifacts、 list-experiments、 log-batch、 log-inputs、 log-metric、 log-model、 log-param、 restore-experiment、 restore-run、 restore-runs、 search-experiments、 search-runs、 set-experiment-tag、 set-tag、 update-experiment、 update-run get-permission-levels、get-permissions、set-permissions、 update-permissions
model-registry	Workspace Model Registryのコマンド : approve-transition-request、 create-comment、 create-model、 create-model-version、 create-transition-request、 create-webhook、 delete-comment、 delete-model、 delete-model-tag、 delete-model-version、 delete-model-version-tag、 delete-transition-request、 delete-webhook、 get-latest-versions、 get-model、 get-model-version、get-model-version-download-uri、 list-models、 list-transition-requests、 list-webhooks、 reject-transition-request, rename-model, search-model-versions, search-models, set-model-tag, set-model-version-tag, test-registry-webhook, transition-stage, update-comment, update-model, update-model-version, update-webhook get-permission-levels、get-permissions、set-permissions、 update-permissions

リアルタイムサービングコマンド

グループ	説明とコマンド
serving-endpoints	モデルサービングエンドポイントを作成、更新、削除するコマンド: build-logs、create、delete、export-metrics、get、list、logs、patch、put、query、 update-config get-permission-levels、get-permissions、set-permissions、 update-permissions

ID およびアクセス管理コマンド

グループ	説明とコマンド
account	Databricks アカウントを管理するためのコマンド: IDとアクセス: access-control、 groups、 service-principals、 users、 workspace-assignment Unity Catalog:metastore-assignments、metastores、 storage-credentials 設定:ip-access-lists, network-connectivity, settings プロビジョニング: credentials、 encryption-keys、 networks、 private-access、 storage、 vpc-endpoints、 workspaces 請求: billable-usage, log-delivery OAuth: custom-app-integration、 o-auth-published-apps、 published-app-integration、 service-principal-secrets
認証	認証用のコマンド: describe、env、login、profiles、 token
current-user	現在認証されているユーザーまたはサービスプリンシパルに関する情報を取得するコマンド: me
groups	ID 管理を簡素化し、Databricks ワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスを簡単に割り当てるグループ用のコマンド: create、delete、get、list、patch、 update
permissions	さまざまなオブジェクトやエンドポイントで、さまざまなユーザーのアクセスを読み取り、書き込み、編集、更新、管理するためのコマンド: get、set、 update get-permission-levels
service-principals	ジョブ、自動化ツール、およびシステム (スクリプト、アプリ、CI/CD プラットフォームなど) で使用する ID のコマンド: create、delete、get、list、patch、 update
users	Databricksによって認識され、Eメール アドレスで表されるユーザー ID のコマンド: create、delete、get、list、patch、 update get-permission-levels、get-permissions、set-permissions、 update-permissions

SQL 関連のコマンド

グループ	説明とコマンド
alerts	アラートに対して操作を実行するコマンド: create、delete、get、list、 update
data-sources	新しいクエリオブジェクトを作成するためのコマンド: list
queries	クエリ定義に対して操作を実行するコマンド: create、delete、get、list、restore、 update
query-history	ウェアハウスを通じてクエリの履歴にアクセスするためのコマンド SQL: list
warehouses	SQLウェアハウスを管理するためのコマンド (これは、 内のデータ オブジェクトに対して コマンドを実行できるコンピュート リソースです。SQLDatabricks SQL create, delete, edit, get, get-workspace-warehouse-config, list, set-workspace-warehouse-config, start, stop get-permission-levels、get-permissions、set-permissions、 update-permissions

Unity Catalog コマンド

グループ	説明とコマンド
artifact-allowlists	アーティファクトの許可リストを管理するコマンド。 Databricks Runtime 13.3以降では、ライブラリとinitスクリプトをUCの許可リストに追加して、ユーザーが標準アクセスモードで設定されたコンピュートでこれらのアーティファクトを活用できるようにすることができます。 get, update
catalogs	カタログ (Unity Catalog の 3 レベル名前空間の最初のレイヤー) を管理するコマンド: create、delete、get、list、 update
connections	外部データソースへの接続を作成するコマンド: create、delete、get、list、 update
external-locations	クラウドストレージパスと、クラウドストレージパスへのアクセスを許可するストレージ認証情報を組み合わせた外部ロケーションを管理するためのコマンド: create、delete、get、list、 update
functions	Unity Catalogでユーザー定義関数 (UDF) を管理するコマンド: create、delete、get、list、 update
grants	Unity Catalog 内のデータへのアクセスを許可するコマンド: get、get-effective、 update
metastores	メタストア (Unity Catalog 内のオブジェクトの最上位コンテナー) を管理するためのコマンド: assign、create、current、delete、get、list、summary、unassign、update、 update-assignment
model-versions	モデルのバージョンを管理するためのコマンド。 DatabricksMLflow Model Registryは、 でホストされたバージョンのUnity Catalog を提供します。 delete、get、get-by-alias、list、 update
online-tables	オンライン テーブルを管理するコマンド (Delta テーブルのデータへの待機時間を短縮し、QPS アクセスを高速化する): create、delete、 get
quality-monitors	モニターを管理するコマンドは、時間の経過と共にテーブルのデータまたはモデル品質メトリクスを監視するモニターです。 create、delete、get、get-refresh、list-refreshes、run-refresh、 update
registered-models	登録されたモデルを管理するためのコマンド。 DatabricksMLflow Model Registryは、 でホストされたバージョンのUnity Catalog を提供します。 create、delete、delete-alias、get、list、set-alias、 update
schemas	Unity Catalog の 3 レベル名前空間の 2 番目のレイヤーであるスキーマを管理するためのコマンド。 create、delete、get、list、 update
storage-credentials	ストレージ資格情報を管理するコマンド (クラウド テナントに格納されているデータにアクセスするための認証および承認メカニズム): create、delete、get、list、update、 validate
system-schemas	システム・スキーマ (システム・カタログ内に存在するスキーマ) を管理するコマンド: disable、enable、 list
table-constraints	テーブル内のフィールド間の関係をエンコードする主キー制約と外部キー制約を管理するコマンド: create, delete
tables	コマンドは、 Unity Catalogの 3 レベル名前空間の 3 番目のレイヤーに存在するマネージドテーブルに対して行われます。 delete、exists、get、list、 list-summaries
volumes	ボリュームを管理するためのコマンド (ファイルへのアクセス、保存、管理、整理、処理のための Unity Catalog (UC) 機能) です。 create、delete、list、read、 update
workspace-bindings	セキュリティ保護可能なワークスペース バインドを管理するためのコマンド。 Databricks のセキュリティ保護可能なリソースは、 OPEN または ISOLATEDとして構成できます。 get、get-bindings、update、 update-bindings

Delta sharing コマンド

グループ	説明とコマンド
providers	データを共有する組織を表すデータ プロバイダーを管理するためのコマンド: create、delete、get、list、list-shares、 update
recipient-activation	受信者のアクティブ化を管理するためのコマンド (これは、受信者オブジェクトがトークン認証タイプを持つオープン共有モデルにのみ適用されます)。 get-activation-url-info, retrieve-token
recipients	受信者を管理するコマンド (共有へのアクセスを許可する組織を表すために :method:recipients/create を使用して作成します)。 create、delete、get、list、rotate-token、 update share-permissions
shares	共有を管理するコマンド ( :method:shares/createでインスタンス化されたコンテナ): create、delete、get、list、 update share-permissions, update-permissions

設定コマンド

グループ	説明とコマンド
ip-access-lists	管理者がIPアクセスリストを設定できるようにするコマンド: create、delete、get、list、replace、 update
settings	ユーザーがワークスペース レベルで設定を管理できるようにするコマンド: automatic-cluster-update、csp-enablement、default-namespace、esm-enablement、 restrict-workspace-admins
token-management	管理者が他のユーザーのすべてのトークンを取得し、トークンを削除できるようにするコマンド: create-obo-token、delete、get、 list get-permission-levels、get-permissions、set-permissions、 update-permissions
tokens	認証とアクセスに使用できるトークンを作成、一覧表示、および取り消すコマンド Databricks REST APIs: create、delete、 list
workspace-conf	ワークスペース設定を更新するコマンド: get-status, set-status

開発者ツールのコマンド

グループ	説明とコマンド
バンドル	Databricks アセット バンドルを管理するコマンド (Databricks プロジェクトをコードとして表現できます)。 deploy、deployment、destroy、generate、init、open、run、schema、summary、sync、 validate
同期	ローカルディレクトリをワークスペースディレクトリに同期します。

ベクトル検索コマンド

グループ	説明とコマンド
vector-search-endpoints	ベクトル検索インデックスをホストするコンピュート リソースを表すベクトル検索エンドポイントを管理するコマンド: create-endpoint、delete-endpoint、get-endpoint、 list-endpoints
vector-search-indexes	ベクトル検索インデックスを管理するコマンド。これは、埋め込みベクトルの効率的な表現であり、リアルタイムで効率的な近似最近傍 (ANN) 検索クエリをサポートします。 create-index、delete-data-vector-index、delete-index、get-index、list-indexes、query-index、sync-index、 upsert-data-vector-index

ダッシュボードのコマンド

グループ	説明とコマンド
dashboards	ダッシュボードを変更するためのコマンド: create、delete、get、list、restore、 update
lakeview	AI/BI ダッシュボードの特定の管理操作を提供するコマンド: create、get、get-published、migrate、publish、trash、unpublish、 update

追加のコマンド

グループ	説明とコマンド
API	Databricks REST API に要求を行うコマンド: delete、get、head、patch、post、 put
Completion	指定したシェルのオートコンプリートスクリプトを生成するコマンド: bash、fish、powershell、 zsh
構成	Databricks CLI を構成します。
help	任意のコマンドの使用情報を出力します。
ラボ	Databricks Labs のインストールを管理するためのコマンド: clear-cache、install、installed、list、show、uninstall、 upgrade
version	現在使用されているCLIのバージョンを取得します。

グローバルフラグ

次のフラグは、すべての Databricks CLI コマンドで使用できます。 一部のフラグは、一部のコマンドには適用されないことに注意してください。 特定のコマンドとそのフラグの詳細については、コマンド ラインのヘルプを参照してください。

旗	説明
-h または --help	Databricks CLI、関連コマンドグループ、または関連コマンドのヘルプを表示します。
-e または --environment string	関連するコマンドに該当する場合に使用するバンドル環境を表す文字列。
--log-file	出力ログの書き込み先を表す文字列。 このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。
--log-format	text 出力ログをテキストに書き込むか、 json 出力ログを JSON に書き込むかします。 このフラグが指定されていない場合、出力ログはテキストとして書き込まれます。
--log-level	ログ形式のレベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o または --output	text 出力をテキストとして書き込むか、 json JSON として出力を書き込むことができます。 このフラグが指定されていない場合、出力はテキストとして書き込まれます。
-p または --profile	.databrickscfg ファイル内で使用する名前付き構成プロファイルを表す文字列。このフラグが指定されていない場合、プロファイルという名前の DEFAULT (存在する場合) が使用されます。 --profile または -p の後に Tab を押すと、構成プロファイル名を手動で入力する代わりに、既存の使用可能な構成プロファイルのリストが表示され、選択することができます。
--progress-format	進行状況ログを表示する形式 (default (デフォルト)、 append 、 inplace 、または json)。