DatabricksCLI コマンド

注

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

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

この記事では、利用可能な 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 コマンドは、 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

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

アイデンティティとアクセス管理コマンド

グループ

説明とコマンド

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によって認識され、電子メール アドレスで表されるユーザー ID のコマンド:

create、 delete、 get、 list、 patch、 update

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

モデルのバージョンを管理するためのコマンド。 でDatabricks のホストMLflow Model RegistryUnity 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

登録されたモデルを管理するためのコマンド。 でDatabricks のホストMLflow Model RegistryUnity 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シェアリングコマンド

グループ

説明とコマンド

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

追加コマンド

グループ

説明とコマンド

原薬

Databricks REST API にリクエストを行うコマンド:

delete、 get、 head、 patch、 post、 put

完了

指定されたシェルの自動補完スクリプトを生成するコマンド:

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