Skip to content

docs: add read-model rebuild command documentation#170

Closed
Uchechukwu-Ekezie wants to merge 1 commit into
accesslayerorg:mainfrom
OpenSourceCOntr:docs/read-model-rebuild-160
Closed

docs: add read-model rebuild command documentation#170
Uchechukwu-Ekezie wants to merge 1 commit into
accesslayerorg:mainfrom
OpenSourceCOntr:docs/read-model-rebuild-160

Conversation

@Uchechukwu-Ekezie
Copy link
Copy Markdown
Contributor

Fixes #160

What changed

  • Added docs/read-model-rebuild.md covering the full rebuild lifecycle
  • Documents: when to rebuild, prerequisites (snapshot, operator coordination), step-by-step flow, expected duration table, and rollback guidance
  • Includes safety notes: no concurrent rebuilds, always snapshot before starting, truncate-and-restart if interrupted

Why

Operators and contributors currently have no guidance for rebuilding derived read models. Without a runbook they risk partial rebuilds, data inconsistency, or extended downtime.

How to test

  1. Review docs/read-model-rebuild.md for completeness against the issue acceptance criteria
  2. Confirm the flow matches the existing Prisma/indexer patterns in the repo

- Document when to trigger a rebuild (migration, bug fix, backfill, corruption)
- Cover prerequisites: data consistency, operator coordination, snapshot backup
- Describe the full rebuild flow: pause indexer → truncate → replay → verify → resume
- Include expected duration table by row count and rollback guidance

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented Apr 25, 2026

@Uchechukwu-Ekezie Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Add read-model rebuild command documentation

1 participant