sync 命令

sync Databricks CLI 中的指令群組能單向同步本地開發機器目錄中的程式碼與檔案變更，並同步至遠端 Azure Databricks 工作區的資料夾。

Databricks 同步

將本機目錄同步至工作區目錄。

databricks sync [flags] SRC DST

Arguments

SRC

    來源目錄路徑

DST

    目的地目錄路徑

選項

--dry-run

    模擬同步執行而不進行實際變更

--exclude strings

    要從同步中排除的模式 （可以指定多次）

--exclude-from string

    包含要從同步中排除的模式的檔案（每行一個模式）

--full

    執行完整同步處理 （預設值為累加式）

--include strings

    要包含在同步中的模式（可以指定多次）

--include-from string

    包含要同步的模式的檔案（每行一個模式）

--interval duration

    檔案系統的輪詢間隔（適用於 --watch，預設為 1秒）

--watch

    監看本機文件系統是否有變更

全域旗標

Examples

下列各節說明如何使用 sync 命令。

增量同步本地檔案變更到遠端目錄

若要執行單一累加式單向同步處理本機目錄中檔案變更至遠端 Azure Databricks 工作區中的資料夾，請執行 sync 命令，如下所示：

databricks sync <local-directory-path> <remote-directory-path>

例如，若要將本機目前工作目錄中名為 my-local-folder 的資料夾的所有檔案變更，進行一次性的單向累加同步到遠端工作空間中的資料夾 my-workspace-folder，請執行下列命令：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder

在這裡範例中，只會將命令上次執行 sync 後的檔案變更同步處理至 /Users/someone@example.com/my-workspace-folder。 根據預設，呼叫者的 DEFAULT 設定檔內工作區的 URL 用來識別要同步到的遠端工作區。

僅同步處理特定檔案

若要包含或排除要根據指定模式同步的特定檔案，請使用 --include、 --include-from、 --exclude或 --exclude-from 選項。

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --exclude-from .gitignore

下列範例會排除同步處理中的特定檔案模式：

databricks sync --exclude "*.pyc" --exclude "__pycache__" ./my-local-folder /Users/someone@example.com/my-workspace-folder

將本機檔案變更完全同步至遠端目錄

若要在遠端 Azure Databricks 工作區中執行單一、完整、單向的檔案變更同步處理至遠端 Azure Databricks 工作區中的資料夾，不論上次執行命令 sync 的時間為何，請使用 --full 選項，例如：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --full

持續同步本機檔案變更至遠端目錄

若要開啟本機目錄中檔案變更的連續單向同步處理，到遠端 Azure Databricks 工作區中的資料夾，請使用 --watch 選項，例如：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --watch

單向同步處理會繼續進行，直到命令從終端機停止為止，通常是按 Ctrl + c 或 Ctrl + z。

預設情況下，對可能的同步事件進行輪詢的頻率是每秒一次。 若要變更此間隔，請使用 --interval 選項以及輪詢的秒數，後面接著字元 s，例如 5 秒：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --watch --interval 5s

變更同步進度輸出格式

同步處理進度資訊預設會以文字格式輸出至終端機。 若要指定同步進度輸出的格式，請使用 --output 選項，然後指定 text（默認設定，若未另指定 --output），或 json，例如：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --output json

預覽同步的檔案操作

若要預覽同步但不實際執行檔案同步作業，請使用 --dry-run 選項，例如：

databricks sync ./my-local-folder /Users/someone@example.com/my-workspace-folder --dry-run

Warn: Running in dry-run mode. No actual changes will be made.
Action: PUT: test.txt
Uploaded test.txt
Initial Sync Complete

全域旗標

--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、、appendinplace、 或json

-t, --target 字串

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