Skip to content

docs(schema): document epoch views and correct stale generator note#2143

Merged
kderme merged 2 commits into
masterfrom
doc/schema-md-epoch-views-and-header
Jun 25, 2026
Merged

docs(schema): document epoch views and correct stale generator note#2143
kderme merged 2 commits into
masterfrom
doc/schema-md-epoch-views-and-header

Conversation

@ArturWieczorek

Copy link
Copy Markdown
Contributor

Document epoch views and correct stale generator note

epoch is now a view (migration-2-0049), not a table: document it as the UNION of epoch_finalized + epoch_current, and add the new epoch_current view and epoch_finalized / epoch_sync_enabled tables. Also correct the header note - the schema-doc generator (BaseSchema.hs / gen-schema-docs) was removed in the Persistent->Hasql rewrite, so the file is now maintained manually.

Description

Add your description here, if it fixes a particular issue please provide a link to the issue.

Checklist

  • Commit sequence broadly makes sense
  • Commits have useful messages
  • New tests are added if needed and existing tests are updated
  • Any changes are noted in the changelog
  • Code is formatted with fourmolu on version 0.17.0.0 (which can be run with scripts/fourmolize.sh)
  • Self-reviewed the diff

Migrations

  • The pr causes a breaking change of type a,b or c
  • If there is a breaking change, the pr includes a database migration and/or a fix process for old values, so that upgrade is possible
  • Resyncing and running the migrations provided will result in the same database semantically

If there is a breaking change, especially a big one, please add a justification here. Please elaborate
more what the migration achieves, what it cannot achieve or why a migration is not possible.

…2127)

epoch is now a view (migration-2-0049), not a table: document it as the UNION
of epoch_finalized + epoch_current, and add the new epoch_current view and
epoch_finalized / epoch_sync_enabled tables. Also correct the header note - the
schema-doc generator (BaseSchema.hs / gen-schema-docs) was removed in the
Persistent->Hasql rewrite, so the file is now maintained manually.
@ArturWieczorek ArturWieczorek marked this pull request as ready for review June 25, 2026 13:44
@ArturWieczorek ArturWieczorek requested a review from a team as a code owner June 25, 2026 13:44
@kderme kderme merged commit 43e2e2c into master Jun 25, 2026
21 checks passed
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.

2 participants