fs コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。 Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、 Databricks ライセンス および Databricks プライバシー通知(使用データのプロビジョニングを含む)が適用されます。
Databricks CLI 内の fs コマンド グループを使用すると、Unity Catalog のボリュームと Databricks File System (DBFS) オブジェクトを自動化できます。
fsコマンドを実行するには、コマンドを databricks fsに追加します。fs コマンドのヘルプを表示するには、databricks fs -hを実行します。
fs コマンドでは、ボリューム パスが dbfs:/Volumes で始まる必要があり、DBFS のディレクトリ パスとファイル パスが dbfs:/で始まる必要があります。
ディレクトリの内容を一覧表示する
ボリューム内または DBFS 内のディレクトリの内容をリストするには、 ls コマンドを使用します。 ディレクトリへのパスを指定します。 次の例は、指定したボリュームのルートまたは DBFSルートで見つかったオブジェクトの名前を示しています。
databricks fs ls dbfs:/Volumes/main/default/my-volume
databricks fs ls dbfs:/
オブジェクトの種類、サイズ、エポック以降の変更時間 (ミリ秒単位)、オブジェクトの名前などの完全な情報を表示するには、 --long または -l オプションを使用します。 次の例は、指定したボリュームのルートまたは DBFSルート内の tmp ディレクトリで見つかったオブジェクトの完全な情報を示しています。
databricks fs ls dbfs:/Volumes/main/default/my-volume -l
databricks fs ls dbfs:/tmp -l
完全なオブジェクト パスを表示するには、 --absolute オプションを使用します。 次の例は、指定したボリュームのルートまたは DBFSルート内の tmp ディレクトリにあるオブジェクトの完全な情報とオブジェクトのフルパスを示しています。
databricks fs ls dbfs:/Volumes/main/default/my-volume -l --absolute
databricks fs ls dbfs:/tmp -l --absolute
ファイルの内容を出力
ファイルの内容を出力するには、 cat コマンドを使用します。 DBFS でファイルへのパスを指定します。 次の例では、指定したボリュームのルートまたは DBFSルート内の tmp ディレクトリにある babynames.csv という名前のファイルの内容を出力します。
databricks fs cat dbfs:/Volumes/main/default/my-volume/babynames.csv
databricks fs cat dbfs:/tmp/babynames.csv
次の例では、ファイルではなくディレクトリの内容を出力しようとするとエラーが返されます。
databricks fs cat dbfs:/Volumes/main/default/my-volume
databricks fs cat dbfs:/tmp
ディレクトリを作成する
ディレクトリを作成するには、 mkdir コマンドを使用します。 ボリュームまたは DBFS に作成するディレクトリへのパスを指定します。 ディレクトリがすでに存在する場合は、何も起こりません。 次の例では、指定したボリュームのルート内、または DBFSルート内の tmp という名前のディレクトリに、squirrel-data という名前のディレクトリを作成します。
databricks fs mkdir dbfs:/Volumes/main/default/my-volume/squirrel-data
databricks fs mkdir dbfs:/tmp/squirrel-data
ディレクトリまたはファイルをコピーします
ディレクトリまたはファイルをコピーするには、 cp コマンドを使用します。 コピーするソース ディレクトリまたはファイルへのパスとその宛先を指定します。 ローカル・ファイル・システムとDBFSの間でディレクトリとファイルをコピーしたり、DBFSパス間でディレクトリとファイルをコピーしたりできます。 既存のファイルを上書きするには、 --overwrite オプションを使用します。 ディレクトリ内のファイルを再帰的にコピーするには、 --recursive または -r オプションを使用します。
cp コマンドは、file:/ を省略すると file:/を前提としています。
次の例では、squirrel-data という名前のディレクトリとその内容を、ローカル ファイル システム パスから、指定したボリュームのルートまたは DBFSルート内のsquirrelsディレクトリにコピーします。
databricks fs cp /Users/<username>/squirrel-data dbfs:/Volumes/main/default/my-volume/squirrels -r
databricks fs cp /Users/<username>/squirrel-data dbfs:/squirrels -r
次の例では、squirrels.csv という名前のファイルを、ローカル ファイルシステムのパスから、指定したボリュームのルートまたは DBFSルート内の squirrel-data という名前のディレクトリにコピーします。 ファイルが宛先に既に存在する場合は、上書きされます。
databricks fs cp /Users/<username>/squirrels.csv dbfs:/Volumes/main/default/my-volume/squirrel-data --overwrite
databricks fs cp /Users/<username>/squirrels.csv dbfs:/squirrel-data --overwrite
ディレクトリを削除する
ディレクトリを削除するには、 rm コマンドを使用します。 DBFS の既存のディレクトリへのパスを指定します。 次の例では、指定したボリュームのルートまたは DBFSルート内の tmp ディレクトリから squirrel-data という名前のディレクトリを削除します。
databricks fs rm dbfs:/Volumes/main/default/my-volume/squirrel-data
databricks fs rm dbfs:/tmp/squirrel-data
ディレクトリが存在しない場合、何も起こらず、エラーも返されません。
ディレクトリが存在するが空でない場合は、エラーが返されます。 空でないディレクトリとその内容をすべて削除するには、 --recursive または -r オプションを使用します。 次の例では、指定したボリュームのルートまたは DBFSルート内の tmp ディレクトリから、squirrel-data という名前の空でないディレクトリを削除します。
databricks fs rm dbfs:/Volumes/main/default/my-volume/squirrel-data -r
databricks fs rm dbfs:/tmp/squirrel-data -r