Databricks CLI コマンド

Note

この情報は、パブリック プレビュー段階である Databricks CLI バージョン 0.205 以降に当てはまる内容です。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

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

Databricks CLI には、次の表に示すコマンド グループが含まれています。 コマンド グループには一連の関連コマンドが含まれ、コマンドにはサブコマンドを含めることもできます。 コマンド グループ、個別のコマンド、またはサブコマンドの使用法と構文情報を出力するには、以下を使用します。

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

CLI コマンドの多くが、Azure 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

Delta Live Tables コマンド

グループ	説明とコマンド
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	ワークスペース モデル レジストリ用のコマンド。 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
auth	認証用のコマンド。 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	Azure Databricks で認識され、メール アドレスで表されるユーザー 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 ウェアハウスを管理するコマンド。SQL ウェアハウスは、Databricks SQL 内のデータ オブジェクトに対して 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 以降では、ライブラリと初期化スクリプトを 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	モデル バージョンを管理するコマンド。 Databricks は、Unity Catalog 内でホステッド バージョンの MLflow モデル レジストリを提供しています。 delete、get、get-by-alias、list、update
online-tables	オンライン テーブルを管理するコマンド。これにより待機時間が短くなり、差分テーブルからデータへの高い QPS アクセスを提供します。 create、delete、get
quality-monitors	モニターを管理するコマンド。テーブルのデータまたはモデルの品質メトリックを時系列で計算および監視します。 create､delete、get、get-refresh、list-refreshes、run-refresh、update
registered-models	登録済みモデルを管理するコマンド。 Databricks は、Unity Catalog 内でホステッド バージョンの MLflow モデル レジストリを提供しています。 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	受信者のアクティブ化を管理するコマンド。受信者のアクティブ化は、受信者オブジェクトに TOKEN 認証の種類があるオープン共有モデルでのみ適用可能です。 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 API の認証とアクセスに使用できるトークンの作成、一覧表示、取り消しを行うコマンド。 create、delete、list
workspace-conf	ワークスペース設定を更新するコマンド。 get-status、set-status

開発者用ツール コマンド

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

ベクトル検索コマンド

グループ	説明とコマンド
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	Lakeview ダッシュボードの特定の管理操作を提供するコマンド。 create, get, get-published, migrate, publish, trash, unpublish, update

追加のコマンド

グループ	説明とコマンド
api	Databricks REST API に対して要求を行うコマンド。 delete、get、head、patch、post、put
completion	指定したシェル用のオートコンプリート スクリプトを生成するコマンド。 bash、fish、powershell, zsh
configure	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)。