`sync` コマンドグループ

Note

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は Public Preview です。

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

Databricks CLI 内の sync コマンドグループを使用すると、ローカルファイルシステムディレクトリ内のファイル変更を、リモート Azure Databricks ワークスペース内のディレクトリに一方向で同期できます。

Note

sync コマンドは、リモート Azure Databricks ワークスペース内のディレクトリからローカルファイルシステム内のディレクトリにファイルの変更を同期することはできません。
sync コマンドを使用すると、ローカル開発マシンからのファイル変更を Azure Databricks ワークスペース内のワークスペースユーザー (/Users) ファイルにのみ同期できます。 DBFS (dbfs:/) ファイルと同期することはできません。ファイルの変更をローカル開発マシンから Azure Databricks ワークスペースの DBFS (dbfs:/) に同期するには、dbx 同期ユーティリティを使用します。

sync コマンドは、databricks sync に追加して実行します。 sync コマンドのヘルプを表示するには、databricks sync -h を実行してください。

ローカルファイルの変更をリモートディレクトリに増分同期します

ローカルファイルシステムディレクトリ内のファイル変更をリモート Azure Databricks ワークスペース内のディレクトリに単一の増分一方向同期を実行するには、次のように sync コマンドを実行します。

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

たとえば、ローカルの現在の作業ディレクトリ内の my-folder という名前のフォルダー内のすべてのファイルの変更を、リモートワークスペース内の特定のパスに 1 回限りの一方向の増分同期を実行するには、次のコマンドを実行します。

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

この例では、sync コマンドの最後の実行以降のファイル変更のみが /Users/someone@example.com/ に同期されます。デフォルトでは、呼び出し元の DEFAULT プロファイル内のワークスペース URL を使用して、同期先のリモートワークスペースが決定されます。

ローカルファイルシステムディレクトリ内のファイル変更をリモート Azure Databricks ワークスペース内のディレクトリに単一の完全な一方向同期を実行するには、最後の sync コマンドがいつ実行されたかに関係なく、次のように --full オプションを使用します。

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

ローカルファイルシステムディレクトリ内のファイル変更のリモート Azure Databricks ワークスペース内のディレクトリへの継続的な一方向の同期を有効にするには、次のように --watch オプションを使用します。

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

一方向の同期は、通常は Ctrl + c または Ctrl + z を押して端末からコマンドを停止するまで継続します。

考えられる同期イベントのポーリングは、既定では 1 秒に 1 回行われます。この間隔を変更するには、--interval オプションをポーリング秒数とともに使用し、その後に文字 s を続けます (例: 5 秒)。

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

同期の進行状況情報は、既定ではテキスト形式で端末に出力されます。同期進行状況の出力形式を指定するには、--output オプションを使用して、text (--output が指定されていない場合の既定値) または json を指定します。次に例を示します。

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