Skip to content

Commit 3ab2252

Browse files
committed
docs: document blob upload CLI flags for zodb-convert
Add changelog entries and update README Options section with --background-blobs, --deferred-blobs, and --upload-blobs flags.
1 parent b4d31d8 commit 3ab2252

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

CHANGES.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
- Add `--background-blobs` flag: upload blobs to S3 in a background thread pool,
6+
decoupled from PG writes. Significantly faster for large migrations where S3
7+
latency is the bottleneck. Only effective with parallel workers (`-w`).
8+
- Add `--deferred-blobs PATH` flag: write blob upload tasks to a manifest file
9+
instead of uploading to S3 during migration. Process the manifest later with
10+
`--upload-blobs`.
11+
- Add `--upload-blobs MANIFEST` flag: upload deferred blobs from a manifest file
12+
(created by `--deferred-blobs`) with parallel workers and retry logic.
13+
314
## 1.0.0b9
415

516
- Support `--incremental -w N` together. Previously, `--incremental`

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,13 @@ Where `convert.conf` contains only the destination storage section.
103103

104104
- `--dry-run` — show what would be copied without making changes
105105
- `--incremental` — resume from the last transaction in the destination
106+
- `-w N` / `--workers N` — number of parallel writer threads (default: 1)
107+
- `--background-blobs` — upload blobs to S3 in a background thread pool,
108+
decoupled from PG writes (faster for large migrations)
109+
- `--deferred-blobs PATH` — write blob upload tasks to a manifest file
110+
instead of uploading during migration
111+
- `--upload-blobs MANIFEST` — upload deferred blobs from a manifest file
112+
(created by `--deferred-blobs`)
106113
- `-v` / `--verbose` — increase verbosity (`-v` for INFO, `-vv` for DEBUG)
107114

108115
## Source Code and Contributions

0 commit comments

Comments
 (0)