Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
workspace 内の コマンド グループを使用すると、ワークスペースのファイルとフォルダーを一覧表示、インポート、エクスポート、および削除できます。 「ワークスペース ファイルとは」を参照してください。
Databricks ワークスペース削除
ワークスペース オブジェクトを削除します。
オブジェクトまたはディレクトリを削除します (必要に応じて、ディレクトリ内のすべてのオブジェクトを再帰的に削除します)。 パスが存在しない場合、この呼び出しはエラー RESOURCE_DOES_NOT_EXISTを返します。 パスが空でないディレクトリで、再帰が false に設定されている場合、この呼び出しはエラー DIRECTORY_NOT_EMPTYを返します。
オブジェクトの削除を元に戻すことはできず、ディレクトリを再帰的に削除することはアトミックではありません。
databricks workspace delete PATH [flags]
Arguments
PATH
ノートブックまたはディレクトリの絶対パス。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--recursive
オブジェクトを再帰的に削除するかどうかを指定するフラグ。
Databricks ワークスペースをエクスポートする
ワークスペース オブジェクトまたはディレクトリ全体の内容をエクスポートします。
パスが存在しない場合、この呼び出しはエラー RESOURCE_DOES_NOT_EXISTを返します。
エクスポートされたデータがサイズ制限を超える場合、この呼び出しは MAX_NOTEBOOK_SIZE_EXCEEDEDを返します。 現時点では、この API はライブラリのエクスポートをサポートしていません。
databricks workspace export SOURCE_PATH [flags]
Arguments
PATH
オブジェクトまたはディレクトリの絶対パス。 ディレクトリのエクスポートは、DBC、SOURCE、および AUTO 形式でのみサポートされます。
オプション
--file string
エクスポートされたファイルを保存するローカル ファイル システムのパス。
--format ExportFormat
これにより、エクスポートされたファイルの形式が指定されます。 サポートされる値: AUTO、 DBC、 HTML、 JUPYTER、 RAW、 R_MARKDOWN、 SOURCE
Databricks ワークスペースのエクスポートディレクトリ
Databricks ワークスペースからローカル ファイル システムにディレクトリを再帰的にエクスポートします。
databricks workspace export-dir SOURCE_PATH TARGET_PATH [flags]
Arguments
SOURCE_PATH
ワークスペース内のソース ディレクトリ パス
TARGET_PATH
ローカル ファイル システム上のターゲット ディレクトリ パス
オプション
--overwrite
既存のローカル ファイルを上書きする
databricks ワークスペースの状態を取得する get-status コマンド
オブジェクトまたはディレクトリの状態を取得します。 パスが存在しない場合、この呼び出しはエラー RESOURCE_DOES_NOT_EXISTを返します。
databricks workspace get-status PATH [flags]
Arguments
PATH
ノートブックまたはディレクトリの絶対パス。
オプション
databricks ワークスペースを取り込む
ワークスペース オブジェクト (ノートブックやファイルなど) またはディレクトリ全体の内容をインポートします。 パスが既に存在し、上書きが false に設定されている場合、この呼び出しはエラー RESOURCE_ALREADY_EXISTSを返します。 ディレクトリをインポートするには、言語フィールドが設定されていない DBC 形式または SOURCE 形式を使用できます。 1 つのファイルを SOURCEとしてインポートするには、言語フィールドを設定する必要があります。 ディレクトリ内の zip ファイルはサポートされていません。
databricks workspace import TARGET_PATH [flags]
Arguments
PATH
オブジェクトまたはディレクトリの絶対パス。 ディレクトリのインポートは、 DBC 形式と SOURCE 形式でのみサポートされます。
オプション
--content string
base64 でエンコードされたコンテンツ。
--file string
インポートするローカル ファイルのパス
--format ImportFormat
インポートするファイルの形式を指定します。 サポートされる値: AUTO、 DBC、 HTML、 JUPYTER、 RAW、 R_MARKDOWN、 SOURCE
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
--language Language
オブジェクトの言語。 サポートされている値: PYTHON、R、SCALA、SQL
--overwrite
既存のオブジェクトを上書きするかどうかを指定するフラグ。
Databricks ワークスペース ディレクトリをインポートする
ローカル ファイル システムから Databricks ワークスペースにディレクトリを再帰的にインポートします。
ノートブックの拡張機能は削除されます。
databricks workspace import-dir SOURCE_PATH TARGET_PATH [flags]
Arguments
SOURCE_PATH
ローカル ファイル システムのソース ディレクトリ パス
TARGET_PATH
ワークスペース内のターゲット ディレクトリ パス
オプション
--overwrite
既存のワークスペース ファイルを上書きする
databricks ワークスペースの一覧
ディレクトリの内容を一覧表示するか、ディレクトリでない場合はオブジェクトを一覧表示します。 入力パスが存在しない場合、この呼び出しはエラー RESOURCE_DOES_NOT_EXISTを返します。
databricks workspace list PATH [flags]
Arguments
PATH
ノートブックまたはディレクトリの絶対パス。
オプション
--notebooks-modified-after int
UTC タイムスタンプ (ミリ秒)。
databricks ワークスペース mkdirs
指定したディレクトリ (および必要な親ディレクトリが存在しない場合) を作成します。 入力パスのプレフィックスに (ディレクトリではない) オブジェクトがある場合、この呼び出しはエラー RESOURCE_ALREADY_EXISTSを返します。
この操作が失敗した場合、必要な親ディレクトリの一部の作成に成功した可能性があることに注意してください。
databricks workspace mkdirs PATH [flags]
Arguments
PATH
ディレクトリの絶対パス。 親ディレクトリが存在しない場合は、親ディレクトリも作成されます。 ディレクトリが既に存在する場合、このコマンドは何も実行せず、成功します。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks ワークスペースのアクセス権レベル取得機能
ワークスペース オブジェクトのアクセス許可レベルを取得します。
databricks workspace get-permission-levels WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]
Arguments
WORKSPACE_OBJECT_TYPE
アクセス許可を取得または管理するワークスペース オブジェクトの種類。
WORKSPACE_OBJECT_ID
アクセス許可を取得または管理するワークスペース オブジェクト。
オプション
databricks ワークスペースの権限取得
ワークスペース オブジェクトのアクセス許可を取得します。 ワークスペース オブジェクトは、親オブジェクトまたはルート オブジェクトから権限を継承できます。
databricks workspace get-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]
Arguments
WORKSPACE_OBJECT_TYPE
アクセス許可を取得または管理するワークスペース オブジェクトの種類。
WORKSPACE_OBJECT_ID
アクセス許可を取得または管理するワークスペース オブジェクト。
オプション
データブリックス ワークスペースの権限設定 (set-permissions)
ワークスペース オブジェクトのアクセス許可を設定します。
オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。 指定されていない場合は、すべての直接アクセス許可を削除します。 オブジェクトは、親オブジェクトまたはルート オブジェクトから権限を継承できます。
databricks workspace set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]
Arguments
WORKSPACE_OBJECT_TYPE
アクセス許可を取得または管理するワークスペース オブジェクトの種類。
WORKSPACE_OBJECT_ID
アクセス許可を取得または管理するワークスペース オブジェクト。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
databricks ワークスペースの権限更新
ワークスペース オブジェクトのアクセス許可を更新します。 ワークスペース オブジェクトは、親オブジェクトまたはルート オブジェクトから権限を継承できます。
databricks workspace update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]
Arguments
WORKSPACE_OBJECT_TYPE
アクセス許可を取得または管理するワークスペース オブジェクトの種類。
WORKSPACE_OBJECT_ID
アクセス許可を取得または管理するワークスペース オブジェクト。
オプション
--json JSON
要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。
グローバル フラグ
--debug
デバッグ ログを有効にするかどうかを指定します。
-h または --help
Databricks CLI、または関連コマンド グループ、または関連コマンドのヘルプの表示。
--log-file 文字列
出力ログを書き込むファイルを表す文字列。 このフラグが指定されていない場合、既定では stderr に出力ログが書き込まれます。
--log-format 形式
ログ形式の種類、 text 、または json。 既定値は text です。
--log-level 文字列
ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。
-o, --output 型
コマンド出力の種類( text または json)。 既定値は text です。
-p, --profile 文字列
コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。 このフラグが指定されていない場合は、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。
--progress-format 形式
進行状況ログを表示する形式: default、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット