共用方式為


workspace 命令群組

Note

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態

Databricks CLI 的使用受限於 Databricks 授權Databricks 隱私權聲明,包括任何使用數據條款。

workspace 內的命令群組可讓您列出、匯入、匯出和刪除工作區檔案和資料夾。 請參閱 什麼是工作區檔案?

databricks 工作區刪除

刪除工作區物件。

刪除物件或目錄(若需要,可遞歸刪除目錄中的所有物件)。 如果路徑不存在,此呼叫會傳回錯誤 RESOURCE_DOES_NOT_EXIST。 如果 path 是非空白目錄,且遞歸設定為 false,則此呼叫會傳回錯誤 DIRECTORY_NOT_EMPTY

物件刪除是不可逆的,且遞回刪除目錄的操作不是原子的。

databricks workspace delete PATH [flags]

Arguments

PATH

    筆記本或目錄的絕對路徑。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--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、、、DBCHTMLJUPYTERRAW、、 R_MARKDOWNSOURCE

全域旗標

databricks 工作區 export-dir

以遞歸方式將目錄從 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 格式搭配未設定的語言欄位。 若要將單一檔案匯入為 SOURCE,您必須設定語言欄位。 不支援目錄內的 Zip 檔案。

databricks workspace import TARGET_PATH [flags]

Arguments

PATH

    對象或目錄的絕對路徑。 匯入目錄只支援DBCSOURCE格式。

選項

--content string

    base64 編碼的內容。

--file string

    要匯入的本機檔案路徑

--format ImportFormat

    這會指定要匯入之檔案的格式。 支援的值:AUTO、、、DBCHTMLJUPYTERRAW、、 R_MARKDOWNSOURCE

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--language Language

    對象的語言。 支援的值:PYTHON、、RSCALASQL

--overwrite

    指定是否要覆寫已存在的物件的旗標。

全域旗標

databricks 工作區 import-dir

以遞歸方式將目錄從本機文件系統匯入至 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 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

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

    要取得或管理許可權的工作區物件。

選項

全域旗標

databricks 工作區設定許可權

設定工作區物件許可權。

設定物件的許可權,若已有許可權則予以取代。 如果未指定任何許可權,則刪除所有直接許可權。 物件可以從其父物件或根物件繼承許可權。

databricks workspace set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    要取得或管理許可權的工作區物件類型。

WORKSPACE_OBJECT_ID

    要取得或管理許可權的工作區物件。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks 工作區更新權限

更新工作區對象的許可權。 工作區物件可以從其父物件或根對象繼承許可權。

databricks workspace update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    要取得或管理許可權的工作區物件類型。

WORKSPACE_OBJECT_ID

    要取得或管理許可權的工作區物件。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

全域旗標

--debug

  是否要啟用偵錯記錄。

-h--help

    顯示 Databricks CLI、相關命令群組或相關命令的幫助說明。

--log-file 字串

    字串,表示要寫入輸出記錄檔的檔案。 若未指定此旗標,則預設值是將輸出記錄寫入 stderr。

--log-format 格式

    記錄格式類型,textjson。 預設值是 text

--log-level 字串

    表示日誌格式層級的字串。 若未指定,則日誌的格式層級功能將被停用。

-o, --output 類型

    指令輸出類型,textjson。 預設值是 text

-p, --profile 字串

    用於執行命令的~/.databrickscfg檔案中的配置檔名稱。 如果未指定此旗標,則如果存在,則會使用名為 DEFAULT 的配置檔。

--progress-format 格式

    顯示進度記錄的格式:default、、appendinplace、 或json

-t, --target 字串

    如果適用,要使用的套件組合目標