Note
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。
sync 内の コマンド グループを使用すると、ローカル開発マシン上のディレクトリ内のローカル コードとファイルの変更を、リモート Azure Databricks ワークスペース内のフォルダーに一方向に同期できます。
Note
databricks 同期
ローカル ディレクトリをワークスペース ディレクトリに同期させます。
databricks sync [flags] SRC DST
Arguments
SRC
ソース ディレクトリ のパス
DST
宛先ディレクトリ のパス
オプション
--dry-run
実際の変更を加えずに同期の実行をシミュレートする
--exclude strings
同期から除外するパターン (複数回指定できます)
--exclude-from string
同期から除外するパターンを含むファイル (1 行につき 1 パターン)
--full
完全同期の実行 (既定値は増分)
--include strings
同期に含めるパターン (複数回指定できます)
--include-from string
同期するパターンを含むファイル (1 行に 1 パターン)
--interval duration
ファイル システムのポーリング間隔 (--watch の場合) (既定値は 1)
--watch
ローカル ファイル システムで変更を監視する
Examples
次のセクションでは、 sync コマンドの使用方法について説明します。
ローカルファイルの変更をリモートディレクトリに増分的に同期します。
ローカル ディレクトリ内のファイル変更をリモートの Azure Databricks ワークスペース内のフォルダーに対して 1 つの増分的な一方向同期を実行するには、次のように 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
Note
バンドル内のファイルを同期する場合は、代わりに sync 構成マッピングを使用します。 「同期」を参照してください。
次の例では、特定のファイル パターンを同期から除外します。
databricks sync --exclude "*.pyc" --exclude "__pycache__" ./my-local-folder /Users/someone@example.com/my-workspace-folder
ローカル ファイルの変更をリモート ディレクトリに完全同期します
ローカル ディレクトリ内のファイル変更をリモート Azure Databricks ワークスペース内のフォルダーに対して 1 回の完全な一方向同期を実行するには、最後の 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 を押して端末からコマンドを停止するまで継続します。
考えられる同期イベントのポーリングは、既定では 1 秒に 1 回行われます。 この間隔を変更するには、--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、 append、 inplace、または json
-t, --target 文字列
該当する場合は、使用するバンドル ターゲット