Skip to content

docs: add database maturity badges and production scale note - #1210

Merged
aparajon merged 1 commit into
mainfrom
armand/readme-db-support
Aug 30, 2026
Merged

docs: add database maturity badges and production scale note#1210
aparajon merged 1 commit into
mainfrom
armand/readme-db-support

Conversation

@aparajon

@aparajon aparajon commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

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

  • Adds per-database maturity badges directly under the title: MySQL GA, Vitess GA, PostgreSQL early alpha.
  • Expands the "We run what we ship" paragraph in Releases with the evidence behind those badges: SchemaBot runs the majority of Block's schema change traffic across a large fleet of MySQL and Vitess databases, including tables spanning many terabytes and keyspaces spanning 100s of shards.
  • Links each engine from the Apply lifecycle line — Spirit, PlanetScale deploy requests, pg-sprite — adding PostgreSQL to the lifecycle description.
Rendered badge strip (under the title)

MySQL: GA
Vitess: GA
PostgreSQL: early alpha

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 init onboarding path can build on.

Opened by Claude (Fable 5).

Copilot AI lite review requested due to automatic review settings August 30, 2026 14:22
@aparajon
aparajon force-pushed the armand/readme-db-support branch 2 times, most recently from 9098bb6 to 0731eed Compare August 30, 2026 14:23

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
Comment thread README.md Outdated
@aparajon
aparajon force-pushed the armand/readme-db-support branch 6 times, most recently from 5b23b01 to f0b83bb Compare August 30, 2026 14:45
@aparajon aparajon changed the title docs: add database support matrix with maturity badges docs: add database maturity badges and production scale note Aug 30, 2026
@aparajon
aparajon force-pushed the armand/readme-db-support branch 16 times, most recently from 53f5a72 to 1171a51 Compare August 30, 2026 15:26
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
aparajon force-pushed the armand/readme-db-support branch from 1171a51 to 1750e39 Compare August 30, 2026 15:27
@aparajon
aparajon marked this pull request as ready for review August 30, 2026 21:33
@aparajon
aparajon merged commit 093b673 into main Aug 30, 2026
37 checks passed
@aparajon
aparajon deleted the armand/readme-db-support branch August 30, 2026 22:29
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.

3 participants