docs: add database maturity badges and production scale note - #1210
Merged
Conversation
aparajon
force-pushed
the
armand/readme-db-support
branch
2 times, most recently
from
August 30, 2026 14:23
9098bb6 to
0731eed
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a “Database Support” section to the README to make SchemaBot’s supported engines and maturity level clear at a glance, and updates the lifecycle description to include PostgreSQL’s pg-sprite path.
Changes:
- Add a database support matrix (MySQL, Vitess, PostgreSQL) with maturity badges.
- Add a short maturity/positioning paragraph describing current production usage vs early-alpha PostgreSQL support.
- Update the “Apply” lifecycle bullet to include pg-sprite for PostgreSQL.
Suppressed comments (1)
README.md:63
- Now that PostgreSQL (pg-sprite) is included in the lifecycle, the next sentence reads as if "instant DDL" applies universally. "Instant DDL" is MySQL-specific terminology; scope this statement to MySQL to avoid misleading readers.
- **Apply** — execute DDL online using Spirit (MySQL), PlanetScale deploy requests (Vitess), or pg-sprite (PostgreSQL)
- **Progress** — track row copy progress, ETA, per-table/per-shard status
- **Control** — `stop` (pause), `start` (resume), `volume` (adjust speed), `cutover` (trigger table swap), `revert` (roll back)
Simple changes (e.g., adding a column) use instant DDL and complete in milliseconds. Operations that require a row copy (e.g., adding an index) run online without blocking reads or writes.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
aparajon
force-pushed
the
armand/readme-db-support
branch
6 times, most recently
from
August 30, 2026 14:45
5b23b01 to
f0b83bb
Compare
aparajon
force-pushed
the
armand/readme-db-support
branch
16 times, most recently
from
August 30, 2026 15:26
53f5a72 to
1171a51
Compare
State database support up front: maturity badges under the title (MySQL and Vitess production ready, PostgreSQL early alpha) and an intro note that SchemaBot runs the majority of Block's production schema change traffic. Link the engines from the apply lifecycle line, which previously did not mention PostgreSQL at all. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
aparajon
force-pushed
the
armand/readme-db-support
branch
from
August 30, 2026 15:27
1171a51 to
1750e39
Compare
aparajon
marked this pull request as ready for review
August 30, 2026 21:33
aparajon
requested review from
JashLal,
Kiran01bm,
eeSeeGee,
jayjanssen,
jemiahw and
morgo
as code owners
August 30, 2026 21:33
Kiran01bm
approved these changes
Aug 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why this matters
The README never says which databases SchemaBot supports or how mature each one is — PostgreSQL isn't mentioned at all, and the engines only appear mid-list in How It Works. A visitor evaluating SchemaBot has to read the docs or the code to answer "does it support my database, and can I bet production on it?". This puts that answer in the first screenful.
What it does
Rendered badge strip (under the title)
Rendered "We run what we ship" paragraph (Releases)
We run what we ship. Every tag is deployed to production at Block, where SchemaBot runs the majority of Block's schema change traffic across a large fleet of MySQL and Vitess databases (with PostgreSQL planned). We actively use SchemaBot to run schema changes against tables of many shapes and sizes, with some spanning many terabytes in MySQL and 100s of shards in Vitess. Our release cadence keeps the project continuously validated against real production workloads and gets fixes out fast. Because SchemaBot is pre-1.0, the release notes are the compatibility contract: give them a read before upgrading.
How it moves us toward the northstar
OSS adoption starts at the README: support and maturity have to be legible before anyone installs anything. This is the first step of the first-experience work — an honest support statement the upcoming
schemabot initonboarding path can build on.Opened by Claude (Fable 5).