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