Extra Large Directory Volume Archive Backup
The extra large directory usesbackup large-dir, which is independent ofbak_typein bak.toml '; you need to configure local_tmp_home , optional [object_storage] , and specify data_dir in prj.toml `.
Backup to local
enforce_provisioning_action
1.prj.toml
# Project identifiers for relative path and directory identification
prj_key = "test_717_file"
# Local Data Storage Directory
data_dir = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\data"
2.bak.toml
[public]
# Backups are also saved locally
bak_location_type = "local"
# Keep last 3 historical backups locally
history_bak_num = 3
# Log level is debug mode (outputs the most detailed logs)
log_level = "DEBUG"
# 日志目录：放在 Temp 下的 my_test_peppykeep
log_dir = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\logs"
# 备份产出目录
local_bak_home = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\backup"
# 临时目录（必须符合规则）
local_tmp_home = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\.tmp"
# The maximum length of the backup queue is 1 (serial execution, no concurrency)
max_bak_queue_size = 1
Perform the preliminary checks: §
Open Terminal Execution
peppykeep backup large-dir run --config-home %USERPROFILE%\.peppykeep\conf
When the pre-test is successful, the output is as follows:
Action : backup large-dir run
Project : test_717_file
DataDir : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\data
ChunkSize : 4.0 GiB
Compression : none
Upload : false
Resume : false
TaskRoot : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp/tasks
Next : Re-run with --apply to execute.
Result
| Field | Description |
|---|---|
| Action | The type of operation currently performed, fixed asbackup large-dir run |
| Project | Project identifier, corresponding to prj_key, this time test_717_file |
| DataDir | The path to the data directory to back up, this time C:\ Users\ admin\ AppData\ Local\ Temp\ my_test_peppykeep\ data |
| ChunkSize | Threshold size per shard, this time 4.0 GiB |
| Compression | Compression mode, this time none (uncompressed) |
| Upload | Whether to enable object storage uploads, this time false (save locally only) |
| Resume | Whether to continue the previous task, this time isfalse(new task) |
| TaskRoot | Task storage root directory, this time is C:\ Users\ admin\ AppData\ Local\ Temp\ my_test_peppykeep\ .tmp/tasks |
| Next | Prompt: rerun with ’–apply` parameter if you really want to execute |
Perform a backup
Performing Extra Large Directory Volume Archive Backups
peppykeep backup large-dir run --apply --config-home %USERPROFILE%\.peppykeep\conf
After executing the backup command, the output on success is as follows:
=== Completed ===
Action : backup large-dir run
TaskId : 1784010973296
TaskDir : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784010973296
Manifest : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784010973296\manifest.json
State : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784010973296\state.json
FileCount : 0
TotalSize : 0 B
Parts : 0
ChunkSize : 4.0 GiB
Compression : none
Upload : false
ManifestUploaded : false
Status : Command completed successfully.
Result
| Field | Description |
|---|---|
| Action | The type of operation currently performed, fixed asbackup large-dir run |
| TaskId | Unique identifier of the task used to track this backup task |
| TaskDir | Task working directory, where task-related files are stored |
| Manifest | Manifest file path, list of files to record backup and metadata |
| State | Status file path to record the progress of the backup (for breakpoint continuation) |
| FileCount | Number of files backed up this time, total 0 files (directory is empty) |
| TotalSize | Total size of backup data, this time 0 bytes (no data to backup) |
| Parts | Number of shards, this time 0 (no data, no shards required) |
| ChunkSize | Threshold size per shard, this time 4 GiB |
| Compression | Compression mode, this time uncompressed |
| Upload | Whether to enable object storage uploads, this time false (save locally only) |
| ManifestUploaded | Whether the manifest file has been uploaded to the object store, this time isfalse |
| Status | Task execution status, this execution was successful ✅(but no data was backed up) |
Backup to Object Storage
enforce_provisioning_action
1.prj.toml
# Project identifiers for relative path and directory identification
prj_key = "test_717_file"
# Local Data Storage Directory
data_dir = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\data"
2.bak.toml
[public]
# Save backups both locally and remotely
bak_location_type = "local_and_remote"
# Keep last 3 historical backups locally
history_bak_num = 3
# Log level is debug mode (outputs the most detailed logs)
log_level = "DEBUG"
# 日志目录：放在 Temp 下的 my_test_peppykeep
log_dir = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\logs"
# 备份产出目录
local_bak_home = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\backup"
# 临时目录（必须符合规则）
local_tmp_home = "C:\\Users\\admin\\AppData\\Local\\Temp\\my_test_peppykeep\\.tmp"
# The maximum length of the backup queue is 1 (serial execution, no concurrency)
max_bak_queue_size = 1
Perform the preliminary checks: §
Open Terminal Execution
peppykeep backup large-dir run --config-home %USERPROFILE%\.peppykeep\conf
When the pre-test is successful, the output is as follows:
=== Dry Run ===
Action : backup large-dir run
Project : test_717_file
DataDir : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\data
ChunkSize : 4.0 GiB
Compression : none
Upload : true
Resume : false
TaskRoot : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp/tasks
Next : Re-run with --apply to execute.
Result
| Field | Description |
|---|---|
| Action | The type of operation currently performed, fixed asbackup large-dir run |
| Project | Project identifier, corresponding to prj_key, this time test_717_file |
| DataDir | The path to the data directory to back up, this time C:\ Users\ admin\ AppData\ Local\ Temp\ my_test_peppykeep\ data |
| ChunkSize | Threshold size per shard, this time 4.0 GiB |
| Compression | Compression mode, this time none (uncompressed) |
| Upload | Whether to enable the object storage upload, this time istrue(upload to the object storage after the backup is completed) |
| Resume | Whether to continue the previous task, this time isfalse(new task) |
| TaskRoot | Task storage root directory, this time is C:\ Users\ admin\ AppData\ Local\ Temp\ my_test_peppykeep\ .tmp/tasks |
| Next | Prompt: rerun with ’–apply` parameter if you really want to execute |
Perform a backup
Performing Extra Large Directory Volume Archive Backups
peppykeep backup large-dir run --apply --config-home %USERPROFILE%\.peppykeep\conf
After executing the backup command, the output on success is as follows:
=== Completed ===
Action : backup large-dir run
TaskId : 1784011083252
TaskDir : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784011083252
Manifest : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784011083252\manifest.json
State : C:\Users\admin\AppData\Local\Temp\my_test_peppykeep\.tmp\tasks\test_717_file-1784011083252\state.json
FileCount : 0
TotalSize : 0 B
Parts : 0
ChunkSize : 4.0 GiB
Compression : none
Upload : true
ManifestUploaded : true
Status : Command completed successfully.
Result description (S3 as an example)
| Field | Description |
|---|---|
| Action | The type of operation currently performed, fixed asbackup large-dir run |
| TaskId | Unique identifier of the task used to track this backup task |
| TaskDir | Task working directory, where task-related files are stored |
| Manifest | Manifest file path, list of files to record backup and metadata |
| State | Status file path to record the progress of the backup (for breakpoint continuation) |
| FileCount | Number of files backed up this time (0 when sample directory is empty) |
| TotalSize | Total size of backup data |
| Parts | Number of shards (0 when no data is available) |
| ChunkSize | Threshold size per shard, this time 4 GiB |
| Compression | Compression mode, this time uncompressed |
| Upload | Whether to enable the object storage upload, this time istrue(upload to the object storage after the backup is completed) |
| ManifestUploaded | Whether the manifest file has been uploaded to the object store, this time true (uploaded) |
| Status | Task execution status, this execution was successful ✅ |