Files
hq/02-DECISIONS/0003-schema-changes-are-numbered-migrations.md
T
jschoubben e1febe8e0f Renumber the records 1 to 23
The consolidation left a sparse sequence -- 1, 4, 6, 7, 9, 10, 12, 15, 16, 18,
19, 25, 34, 35, 36, 37, 40, 42, 44, 45, 48, 49, 58 -- where the gaps were only
the archaeology of what used to be there.

Renumbered contiguously. Renames run in ascending order, so every target number
is already free and no two files ever collide.

The reference rewrite is one simultaneous pass rather than a sequence of
replacements. Numbers moved into slots other numbers were vacating -- the node
host went 37 to 16 while the lab went 16 to 9 -- so replacing one at a time
would have cascaded and silently pointed things at the wrong record.

Seven plain-text references survived the merges as prose rather than links,
naming records that no longer existed: the enrolment token, the link boundary,
what a declaration is, reachability, the repository structure. Each mapped to
the consolidated record that now holds it.

Verified rather than assumed: every [ADR NNNN](path) link now has matching text
and target, checked across the whole repository, and the checker passes.

Frontmatter `consolidates:` lists dropped -- they named records that are gone,
and each consolidated record already says in prose what it absorbed.
2026-08-28 23:28:34 +02:00

3.2 KiB

status, date, deciders, reconstructed
status date deciders reconstructed
accepted 2026-05-14 jochen true

3. Schema and state changes are numbered migrations, in the same language as the code

Reconstructed after the fact from the evidence cited below.

Context

Modules own persistent state. That state has to change as they change, across nodes that are at different versions, some of which have data that predates the change.

Two things were being done that do not survive contact with a second node. Schema was created at startup, so what a table looked like depended on which version last started. And migrations were shell scripts, so they could not use the types, connection handling or helpers the module already had, and were not compiled or checked with it.

Considered options

  1. Startup SQL / create-if-missing. Rejected. It converges only for a node that started with the newest version. A node that never restarts never migrates; a node that restarts on an old version can undo a change.
  2. Shell migrations. Rejected. Unchecked, untyped, and a separate dialect from the module they belong to. Also, as later discovered, packaged differently — and therefore occasionally not packaged at all.
  3. Numbered migrations in the module's own language, compiled with it. Chosen.

Decision

Every schema or state change is a numbered migration file, written in the same language as the module and compiled with it. There is no startup schema creation and no ad-hoc statement.

Rules that come with it:

  • The initial migration is frozen once it has run anywhere. It is never modified; a change is a new number.
  • Every statement is idempotent — guarded so that re-running is safe.
  • A change needs both a baseline for a fresh installation and an incremental migration for installations that already exist. Code referencing a column requires that the migration creating it exists.
  • Migration numbers are unique. A duplicate prefix is a defect, not a style issue.

Consequences

  • A node at any version converges to the current schema by running the migrations it has not run.
  • Migrations are checked by the same compiler as the code, and a migration that does not compile fails the build rather than the deployment.
  • The rules are enforced unevenly. Duplicate prefixes have shipped repeatedly and been fixed by renumbering afterwards; the mesh now validates for them, which is the check this rule needed in order to be real.
  • A migration directory is a feature like any other, which means it is packaged like any other — and when packaging is wrong, migrations silently do not ship. This has happened.
  • Freezing the initial migration means a fresh installation replays the entire history. That cost grows and nothing currently bounds it.

References

  • fix(agents): convert workflow migrations to TypeScript (#50), 2026-05-14.
  • feat(dev_validate): guard against duplicate migration numeric prefixes (#379), 2026-06-26 — the rule acquiring a check.
  • Knowledge base: migrations/schema-drift, noxflow/troubleshooting/migration-number-collision.
  • Packaging failures: troubleshooting/shell-migrations-never-packaged, troubleshooting/provision-migration-never-applied.