upgrade

Convert this repository to storage format v2 (pack files).

Back to CLI Commands

upgrade switches an existing format v1 repository to storage format v2 in place. Format v2 stores new chunks in a small number of pack files instead of one file per chunk, which makes saves with many files faster and keeps the CAS folder small.

Chunks that are already stored are not rewritten. They stay as loose files and remain readable; new saves write pack files. Use gc --repack-loose later if you also want the existing loose chunks moved into packs.

upgrade is new in v0.9.8. A repository is never upgraded automatically: a format v1 repository stays v1 until you run this command.

Usage
rinne upgrade [--dry-run]
Options
--dry-run
Show what would change (current format, snapshot count, loose chunk count) without changing anything.
Examples
Preview the conversion
rinne upgrade --dry-run
Convert the repository to format v2
rinne upgrade
Optionally move the old loose chunks into pack files
rinne gc --repack-loose
Notes
  • After upgrading, Rinne v0.9.7 can no longer open this repository. v0.9.7 refuses to work with it instead of damaging it. Use downgrade to go back to format v1.
  • If the repository already uses format v2, upgrade reports that and exits successfully without changes.
  • Close other programs that use the repository (for example, Rinne GUI or Rinne v0.9.7) before upgrading. If the manifest is in use, upgrade stops and the repository stays in format v1.
  • Progress is written to stderr. If a previous upgrade was interrupted, the next run discards the partial result and converts again.