shoney.arickathil 74399ffc68 docs(plan): WAL checkpoint — 6 tasks, databasev2 3

Plan for the approved spec. Code-free per the repo convention
(docs/plan/discarded.md:54); the executor writes the code.

- T1 wo_wal_compact: walk live rows via the bitmap, append one INSERT
  each through the EXISTING append path, fsync, rename over the live log,
  fsync the parent dir, reopen the descriptor. Test asserts BOTH that the
  log shrank AND that a replay reproduces the same rows/ids/values —
  shorter alone is worthless, a truncating bug also passes that
- T2 a stale temp file is removed at open and never read. The test uses
  PLAUSIBLE records, not garbage: garbage would be rejected anyway and
  would prove nothing
- T3 the trigger as a PURE decision (used bytes, last compaction's
  measured output, floor) so it is unit-testable without a store; env
  knobs for floor and ratio, which is what makes the policy testable at
  all. No timer, with the reason. The check is called only where nothing
  is staged, asserted by a test that stages and expects deferral
- T4 kill -9 DURING compaction, extending the existing fork-based crash
  battery. Asserts the PROPERTY — the store equals the pre- or the
  post-compaction content, never a mixture, and every acked id survives.
  Run repeatedly and state the count: it is a race, one green run proves
  little
- T5 measure space reclaimed, boot before/after, and the stop-the-world
  PAUSE against a stated budget. If the pause exceeds it, stop and report
  — the alternatives are bought against that number, not before it
- T6 closeout, including the normative ordering rule in 04-db-binding.md

Constraints carried from the spec into every task:

- recovery must NOT change; a task editing the replay path should stop
- the dump must FLUSH PERIODICALLY. stage() grows the staging buffer by
  doubling, so dumping a whole store through one buffer would hold the
  entire store in RAM — the unbounded growth databasev2 1 identified as
  how this engine dies
- a FAILED compaction is a missed optimisation, not a durability event,
  so it must not take databasev2 4's fatal path
- gate tolerances must not be waived wholesale (part A's T4 made that
  mistake), and the baseline is full-mode — writing a quick-mode baseline
  over it is a regression part A also made

Deliberately NOT a task: rebuilding the `resident: keys` offset map. It
cannot be implemented against a feature that does not exist yet, so T6
records it as an obligation at the compactor and in the story instead of
a stub nobody can test.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

2026-08-28 17:44:18 +02:00

7.2 KiB

Raw Blame History

track	iteration	was_language_iteration	status	chain
databasev2	3	32	in-progress	6

databasev2 3 — WAL checkpoint: disk space reclamation and bounded replay

Moved 2026-08-26 from the language track, where this was iteration 32. Part of Story — the database beyond RAM. Content unchanged by the move; its dependencies are restated in that track index.

Format: product/story-iteration-template. Part of Story — one language, one runtime, one database, one binary.

Inserted 2026-08-21 (stage-3 guarantee refinement found the hole): the WAL is append-only FOREVER — no checkpoint, no truncation exists in the engine or anywhere on the roadmap. Disk grows without bound and replay time grows with history, so restart cost rises with every write the program ever made. RAM reclamation already exists (deleted rows free their slot — 04-db-binding.md: "Ids are never reused; slots are"); this iteration is the DISK half. LAST in the concurrency chain: stage 3 → 22 → 31 → 24 → 23 → 32 — it wants 22's measured replay/restart numbers to justify its policy and must compose with 23's group-commit write path.

BRAINSTORMED 2026-08-28. Spec: 2026-08-28-wal-checkpoint-design.md · plan: 2026-08-28-wal-checkpoint.md (6 tasks). Read .dev/reference/postgresql for this — and the conclusion was that Postgres' design is unavailable to us, which is what makes the simpler one legitimate.

The design in one sentence: compact the log by rewriting it as one record per live row into a temp file, then rename it over the live WAL. Recovery is completely unchanged — boot still opens one file and replays it — and the crash criterion is satisfied by the filesystem rather than by code we must get right.

Why one file works here and not in Postgres. Postgres never compacts its WAL: its records are page deltas, so a compacted redo log is not a store, and it must keep heap files, a control file, a redo pointer and a second recovery source. Ours are full row images — apply_record implements UPDATE as remove-then-recreate — so a compacted log is a complete store. That one difference deletes the control file, the redo pointer, the cutoff offset and the separate process from the design.

Forks settled: no snapshot format (the compacted log is the snapshot); one source, not two; volume-only trigger as a ratio against the last compaction's own measured output, with an absolute floor — no timer, because Postgres' timer exists to bound loss from unflushed buffers and we have none; stop-the-world, with the pause measured against a stated budget rather than assumed acceptable.

The coupling that would otherwise be found late: compaction moves every record, so it invalidates every WAL offset iteration 2's resident: keys stores. The compactor rebuilds the offset map as it writes. Recorded now because iteration 2's storage half is unimplemented, so nothing breaks today — it would break later, looking like corruption rather than a design gap.

Measured on master 2026-08-28, grounding the whole iteration: seed 20000 leaves a 986 614-byte log; 20 000 updates take it to 2 590 262 bytes with the same live rows (2.6× history for no data), and boot+verify on that store is 155 ms.

Goals

Disk space is reclaimed. A checkpoint writes the live store as a snapshot and truncates the WAL behind it; deleted rows and overwritten versions stop occupying disk forever.
Replay is bounded. Startup replays snapshot + WAL tail, not the program's whole write history — restart time becomes a function of store size, not store age.
Every existing guarantee holds byte-for-byte. Ack-after-durable, replay-whole-or-not-at-all, torn-tail drop, ids never reused — a checkpoint changes where bytes live, never what an ack means. A crash DURING checkpoint recovers from the previous snapshot + full tail: the old WAL is not truncated until the new snapshot is durable.

Acceptance Criteria (draft — the spec refines)

Given a store with N rows after many writes and deletes, when a checkpoint completes, then disk usage reflects the live rows (plus the WAL tail), and a restart replays snapshot + tail to the byte-identical store.
Given kill -9 at ANY instant during a checkpoint, when the process restarts, then recovery produces the same consistent store as if the checkpoint had never started — no acknowledged write lost, no partial snapshot ever read.
Given the iteration-22 restart benchmark re-run after checkpoint lands, when replay time is measured on an aged store, then the bounded-replay improvement is recorded as a before/after delta.
Given writes arriving while a checkpoint runs (the DB actor serializes statements; the checkpoint must not stall them beyond the stated budget), when the mixed load completes, then every ack held its durability contract and the tail contains exactly the post-snapshot writes.

Out Of Scope

MVCC / multi-version reads — the store is update-in-place RAM; "old versions" exist only as WAL history, which is exactly what truncation reclaims.
Incremental/streaming backup, point-in-time recovery — a snapshot is a recovery artifact here, not a backup product.
Cross-shard checkpoint coordination — the WAL is owner-shard-only (stage 3's rule); one shard, one checkpoint.
Compression, dedup, tiering — measure first (22), add only what a number justifies.

Info

Forks the spec must settle:

Snapshot format — a row-image dump of the live store (simple, O(live rows)) vs a rewritten-compacted WAL (reuses replay machinery, O(live rows) too but stays in one format). Leaning: row-image dump in the WAL's existing record grammar, so replay needs no second decoder.
Trigger policy — size threshold (WAL bytes vs snapshot bytes ratio), boot-time compaction, explicit call, or some mix. Leaning: ratio threshold checked at commit, plus manual trigger for tests; decided against 22's numbers.
Write availability during checkpoint — stop-the-world dump (simplest; the DB actor just runs one long "statement") vs fork-and-dump vs incremental copy. Leaning: measure the stop-the-world pause on the 1M-row store first (22); complexity only if the pause breaks a stated budget.
Composition with 23 — the snapshot's durability barrier rides the same per-shard ring (WRITE+FSYNC chain, then the truncate); ordering vs in-flight group commits must be stated normatively in 04-db-binding.md's WAL section.

Proposed Solution

Brainstorm → spec → plan after 23 lands (the write path it composes with) using 22's aged-store replay numbers as the policy input; extend 04-db-binding.md's WAL section with the snapshot format the way the record grammar is documented today.

7.2 KiB Raw Blame History Unescape Escape