Document RocksDB backup & restore operations#590
Draft
cb1kenobi wants to merge 4 commits into
Draft
Conversation
Covers the new backup/restore Operations API operations (create_backup, list_backups, verify_backup, delete_backup, purge_backups, restore_backup) and RocksDB support for get_backup (gzipped-by-default tar; gzip=false for plain tar; remote target support). Documents when a database can be restored online vs offline (system db and component-held dbs require the server stopped), the backupPath storage option, and the 5.2 release note. Companion to HarperFast/harper#1831. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…perations # Conflicts: # release-notes/v5-lincoln/5.2.md
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-590 This preview will update automatically when you push new commits. |
Companion to HarperFast/harper#1831. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-590 This preview will update automatically when you push new commits. |
…_count) Matches HarperFast/harper#1831, which now returns snake_case. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-590 This preview will update automatically when you push new commits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the RocksDB backup & restore feature shipping in 5.2 (companion to HarperFast/harper#1831):
reference/operations-api/operations.md) —create_backup,list_backups,verify_backup,delete_backup,purge_backups,restore_backup, plus RocksDB support forget_backup(streams a gzipped-by-defaulttar;gzip=falsefor plaintar). Includes a "when can a database be restored?" matrix — online vs offline, withsystemand component-held databases requiring the server stopped.reference/cli/commands.md) — the backup operations are runnable from the CLI under their operation name (no hyphenated alias), work whether Harper is running (forwarded) or stopped (direct file access), and accept a remotetarget=.reference/configuration/options.md) — thebackupPathstorage option (default<rootPath>/backup).release-notes/v5-lincoln/5.2.md) — Backup & Restore entry.Reviewers not assigned — leaving that to you.
Generated by an LLM (Claude Opus 4.8).
🤖 Generated with Claude Code