Skip to content

Document RocksDB backup & restore operations#590

Draft
cb1kenobi wants to merge 4 commits into
mainfrom
docs/rocksdb-backup-operations
Draft

Document RocksDB backup & restore operations#590
cb1kenobi wants to merge 4 commits into
mainfrom
docs/rocksdb-backup-operations

Conversation

@cb1kenobi

Copy link
Copy Markdown
Member

Summary

Documents the RocksDB backup & restore feature shipping in 5.2 (companion to HarperFast/harper#1831):

  • Operations API (reference/operations-api/operations.md) — create_backup, list_backups, verify_backup, delete_backup, purge_backups, restore_backup, plus RocksDB support for get_backup (streams a gzipped-by-default tar; gzip=false for plain tar). Includes a "when can a database be restored?" matrix — online vs offline, with system and component-held databases requiring the server stopped.
  • CLI (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 remote target=.
  • Configuration (reference/configuration/options.md) — the backupPath storage option (default <rootPath>/backup).
  • Release notes (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

cb1kenobi and others added 2 commits July 16, 2026 02:12
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
gemini-code-assist[bot]

This comment was marked as resolved.

@github-actions
github-actions Bot temporarily deployed to pr-590 July 16, 2026 07:17 Inactive
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your 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>
@github-actions
github-actions Bot temporarily deployed to pr-590 July 16, 2026 07:59 Inactive
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your 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>
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-590

This preview will update automatically when you push new commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant