Skip to content

[P3][docs] Document backup and restore procedure for WAL files #42

Closed

Description

@cevheri

Summary

No export/dump CLI command and no documented backup story. File-copy backup is valid for WAL-is-database model but never stated for operators.

Audit ID: Section 4 Low — Wave 3
Location: docs/CLI.md:41

Fix

Document in docs/CLI.md and/or README:

  • Consistent backup = copy .libredb file while no writer has it open (or use kernel lock / CLI lock guidance).
  • Restore = copy back + open().
  • Optional future: libredb export JSON — out of scope unless small.

Acceptance criteria

  • Backup/restore procedure documented.
  • Warn against copying while live writer active (link B4).
  • No changeset (docs).

Activity

  1. added
    documentationImprovements or additions to documentation
    area/docsPre-announcement audit
    on Jul 2, 2026
  2. cevheri commented on Jul 3, 2026

    @cevheri
    MemberAuthor

    Implemented and shipped in PR #43 (merge commit 69f7161), released as v0.2.0. The PR description's comma-separated Closes list only auto-closed the first reference — closing manually. For #39/#28-style partials: the shipped scope is done; the real-browser verification half of #39 continues under #10, and the typed-error contract (#28) shipped as LibreDbError with stable codes across kernel, adapters, lenses, and CLI.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsPre-announcement auditdocumentationImprovements or additions to documentationpriority/lowPre-announcement audit

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions