DatabricksCLI コマンド
注
この情報は、 パブリック プレビュー段階の 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 コマンドは、 Databricks REST API リファレンスに記載されている操作にマップされます。
ワークスペースコマンド
グループ |
説明とコマンド |
---|---|
ファイルとファイルシステムを管理するためのコマンド:
|
|
|
Databricksユーザーに代わって操作を実行するための個人アクセストークンを登録するためのコマンド:
|
|
ユーザーが Git リポジトリを管理できるようにするためのコマンド:
|
|
シークレット、シークレットスコープ、およびアクセス権限を管理するためのコマンド:
|
|
ワークスペース内のノートブックとフォルダーを一覧表示、インポート、エクスポート、削除するためのコマンド:
|
コンピュートコマンド
グループ |
説明とコマンド |
---|---|
|
一連のルールに基づいてクラスターを構成するユーザーの機能を制御するコマンド:
|
|
クラスターを作成、開始、編集、一覧表示、終了、および削除できるコマンド:
|
|
ワークスペース管理者がワークスペースのグローバル初期化スクリプトを構成できるようにするコマンド:
|
|
すぐに使用できるクラウド インスタンスを使用してインスタンス プールを作成、編集、削除、および一覧表示するコマンド。これにより、クラスターの起動と自動スケーリングの時間が短縮されます。
|
|
ユーザーがクラスターを起動できるインスタンスプロファイルを管理者が追加、一覧表示、削除できるようにするコマンド:
|
|
クラスター上のライブラリをインストール、アンインストール、およびステータスを取得するためのコマンド:
|
|
利用可能なポリシー ファミリを表示するコマンド:
|
ジョブコマンド
グループ |
説明とコマンド |
---|---|
|
ジョブを管理するためのコマンド:
|
Delta Live Tables コマンド
グループ |
説明とコマンド |
---|---|
|
パイプラインの詳細を作成、編集、削除、開始、表示するためのコマンド:
|
機械学習コマンド
グループ |
説明とコマンド |
---|---|
|
MLflow内の主要な組織単位であるエクスペリメントと対話するためのコマンド。すべてのMLflow実行はエクスペリメントに属します:
|
|
Workspace Model Registryのコマンド:
|
リアルタイムのサービングコマンド
グループ |
説明とコマンド |
---|---|
|
モデルサービングエンドポイントを作成、更新、削除するコマンド:
|
アイデンティティとアクセス管理コマンド
グループ |
説明とコマンド |
---|---|
|
Databricks アカウントを管理するためのコマンド:
|
認証用のコマンド:
|
|
|
現在認証されているユーザーまたはサービスプリンシパルに関する情報を取得するコマンド:
|
|
ID 管理を簡素化し、Databricks ワークスペース、データ、その他のセキュリティ保護可能なオブジェクトへのアクセスの割り当てを容易にするグループ用のコマンド:
|
|
さまざまなオブジェクトおよびエンドポイント上のさまざまなユーザーの読み取り、書き込み、編集、更新、および管理アクセスを作成するコマンド:
|
|
ジョブ、自動化ツール、スクリプト、アプリ、CI/CD プラットフォームなどのシステムで使用する ID のコマンド:
|
|
Databricksによって認識され、電子メール アドレスで表されるユーザー ID のコマンド:
|
Unity Catalogコマンド
グループ |
説明とコマンド |
---|---|
|
アーティファクト許可リストを管理するためのコマンド。 Databricks Runtime 13.3 以降では、ライブラリと init スクリプトを UC の許可リストに追加して、ユーザーが共有アクセス モードで構成されたコンピュート上でこれらの成果物を活用できるようにすることができます。
|
|
Unity Catalog の 3 レベルの名前空間の最初のレイヤーであるカタログを管理するためのコマンド:
|
|
外部データソースへの接続を作成するコマンド:
|
|
クラウド ストレージ パスと、クラウド ストレージ パスへのアクセスを許可するストレージ資格情報を組み合わせた外部ロケーションを管理するためのコマンド:
|
|
Unity Catalog内のユーザー定義関数 (UDF) を管理するためのコマンド:
|
|
Unity Catalog内のデータへのアクセスを許可するコマンド:
|
|
Unity Catalog 内のオブジェクトの最上位コンテナーであるメタストアを管理するためのコマンド:
|
|
モデルのバージョンを管理するためのコマンド。 でDatabricks のホストMLflow Model RegistryUnity Catalog バージョンを提供します。
|
|
Delta テーブルのデータへの低レイテンシと高 QPS アクセスを提供するオンライン テーブルを管理するためのコマンド:
|
|
時間の経過に伴ってテーブルのデータやモデルの品質メトリックをコンピュートおよび監視するモニターを管理するコマンド:
|
|
登録されたモデルを管理するためのコマンド。 でDatabricks のホストMLflow Model RegistryUnity Catalog バージョンを提供します。
|
|
Unity Catalog の 3 レベルの名前空間の 2 番目のレイヤーであるスキーマを管理するためのコマンド:
|
|
クラウド テナントに保存されているデータにアクセスするための認証および承認メカニズムであるストレージ資格情報を管理するためのコマンド:
|
|
システム カタログ内に存在するスキーマであるシステム スキーマを管理するためのコマンド:
|
|
テーブル内のフィールド間の関係をエンコードする主キーと外部キーの制約を管理するためのコマンド:
|
|
Unity Catalog の 3 レベルの名前空間の 3 番目のレイヤーにあるテーブルを管理するためのコマンド:
|
|
ファイルにアクセスし、保存、管理、整理、処理するためのUnity Catalog (UC) 機能であるボリュームを管理するためのコマンド:
|
|
セキュリティ保護可能なワークスペース バインディングを管理するためのコマンド。 Databricks のセキュリティ保護可能なものは、
|
Deltaシェアリングコマンド
グループ |
説明とコマンド |
---|---|
|
データを共有する組織を表すデータ プロバイダーを管理するためのコマンド:
|
|
受信者のアクティベーションを管理するコマンド。これは、受信者オブジェクトがトークン認証タイプを持つオープン共有モデルでのみ適用されます。
|
|
共有へのアクセスを許可する組織を表すために
|
|
|
設定コマンド
グループ |
説明とコマンド |
---|---|
|
管理者が IP アクセス リストを設定できるようにするコマンド:
|
|
ユーザーがワークスペース レベルで設定を管理できるようにするコマンド:
|
|
管理者がすべてのトークンを取得し、他のユーザーのトークンを削除できるようにするコマンド:
|
|
Databricks REST APIsの認証とアクセスに使用できるトークンを作成、一覧表示、取り消すコマンド:
|
|
ワークスペース設定を更新するコマンド:
|
開発者ツールのコマンド
グループ |
説明とコマンド |
---|---|
Databricks アセット バンドルを管理するためのコマンド。これにより、Databricks プロジェクトをコードとして表現できます。
|
|
ローカル ディレクトリをワークスペース ディレクトリに同期します。 |
ベクトル検索コマンド
グループ |
説明とコマンド |
---|---|
|
ベクトル検索インデックスをホストするコンピュートリソースを表すベクトル検索エンドポイントを管理するためのコマンド:
|
|
リアルタイムで効率的な近似最近傍 (ANN) 検索クエリをサポートする埋め込みベクトルの効率的な表現であるベクトル検索インデックスを管理するためのコマンド:
|
ダッシュボードコマンド
グループ |
説明とコマンド |
---|---|
|
ダッシュボードを変更するためのコマンド:
|
|
AI/BI ダッシュボードの特定の管理操作を提供するコマンド:
|
追加コマンド
グループ |
説明とコマンド |
---|---|
Databricks REST API にリクエストを行うコマンド:
|
|
指定されたシェルの自動補完スクリプトを生成するコマンド:
|
|
Databricks CLI を構成します。 |
|
|
任意のコマンドの使用情報を出力します。 |
Databricks Labs インストールを管理するためのコマンド:
|
|
|
現在使用されている CLI のバージョンを取得します。 |
グローバル フラグ
次のフラグは、すべての Databricks CLI コマンドで使用できます。 一部のフラグは一部のコマンドには適用されないことに注意してください。 特定のコマンドとそのフラグに関する詳細な情報については、コマンド ラインのヘルプを参照してください。
旗 |
説明 |
---|---|
|
Databricks CLI または関連するコマンド グループまたは関連するコマンドのヘルプを表示します。 |
|
関連コマンドに適用可能な場合に使用するバンドル環境を表す文字列。 |
|
出力ログを書き込む先を表す文字列。 このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。 |
|
|
|
ログ形式のレベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。 |
|
|
|
|
|
表示する進行状況ログの形式 ( |