# supaschema

> From declarative schema to fully synced database in milliseconds. No ORM, no Docker, no shadow database.

## Docs

- [supaschema check: Validate Migration Replay Safety](https://supaschema.com/commands/check.md): check statically validates SQL migration files for replay-safety, lock hazards, and parser issues. Supports --reporter text, github, sarif, and json.
- [supaschema diff: Generate SQL Migrations from Schema](https://supaschema.com/commands/diff.md): diff compares two schema sources and emits a replay-safe SQL migration. Supports --from, --to, --out, --watch, --fail-on-diff, and more.
- [supaschema migrations: Reconcile Migration Files and History](https://supaschema.com/commands/migrations.md): migrations compares SQL files on disk against a database's applied history to surface ghost versions, out-of-order files, and pending migrations.
- [supaschema Utility Commands: plan, audit, and corpus](https://supaschema.com/commands/other.md): Reference for supaschema utility commands: plan, inspect, fingerprint, audit, corpus, doctor, init, completion, explain, and selfcheck.
- [supaschema sync: Gate and Apply Pending Migrations](https://supaschema.com/commands/sync.md): sync checks pending migrations pass static validation, then optionally drives the Supabase CLI to apply them locally or push them remotely.
- [supaschema types: Generate TypeScript Types from Schema](https://supaschema.com/commands/types.md): types generates Supabase-compatible TypeScript interfaces and Zod validators directly from your schema files — no database connection required.
- [supaschema verify: Prove Idempotency and Convergence](https://supaschema.com/commands/verify.md): verify applies your migration twice in throwaway databases and compares catalog fingerprints to prove idempotency and convergence to the declared schema.
- [Declarative Schema Management with supaschema](https://supaschema.com/concepts/declarative-schema.md): Learn how supaschema's declarative approach keeps your PostgreSQL schema in SQL files and auto-generates safe, idempotent migrations on every change.
- [The supaschema Migration Pipeline: All Six Stages](https://supaschema.com/concepts/migration-pipeline.md): How supaschema extracts, diffs, renders, checks, and verifies a migration from schema files to production-ready SQL, without ever touching your database.
- [Schema Sources: How supaschema Reads Your Schema](https://supaschema.com/concepts/sources.md): supaschema reads schemas from SQL files on disk, Git refs, a live database, SQL dump files, or saved catalog snapshots. No Docker or shadow database required.
- [supaschema Config File Reference: All Options Explained](https://supaschema.com/configuration/config-file.md): All supaschema.config.json options explained: schema paths, migrations directory, adapter, destructive changes, timeouts, and validators.
- [Named Environments and Database URLs in supaschema](https://supaschema.com/configuration/environments.md): Configure named environments in supaschema.config.json to target local, staging, and production databases without repeating connection strings.
- [Using Hints to Authorize Destructive Schema Changes](https://supaschema.com/configuration/hints.md): Hints let you explicitly approve destructive changes like column drops, type changes, and renames that supaschema blocks by default.
- [Automate PostgreSQL Schema Validation in GitHub Actions](https://supaschema.com/guides/ci-github-actions.md): Add a GitHub Actions workflow that diffs schema on every PR, checks replay safety, and proves idempotency with a throwaway database.
- [Handling Destructive PostgreSQL Schema Changes Safely](https://supaschema.com/guides/destructive-changes.md): How to drop columns, change column types, rename tables, and handle other destructive schema operations safely using explicit supaschema hints.
- [Using supaschema with Supabase Projects and the CLI](https://supaschema.com/guides/supabase-integration.md): Configure supaschema alongside the Supabase CLI for local development, staging pushes, and production-safe declarative schema management.
- [Generate TypeScript Types and Zod Schemas from PostgreSQL](https://supaschema.com/guides/type-generation.md): Use supaschema types to generate database.types.ts and database.zod.ts from your schema files with no database connection required.
- [supaschema: Installation, Setup, and Configuration](https://supaschema.com/installation.md): Install supaschema from npm as a dev dependency, initialize your project configuration, and use the doctor command to verify your environment is ready.
- [supaschema: Declarative PostgreSQL Schema Management](https://supaschema.com/introduction.md): supaschema generates replay-safe PostgreSQL migrations from declarative SQL files — no Docker, no shadow database, no ORM, and no live database required.
- [supaschema Quickstart: Generate Your First Migration](https://supaschema.com/quickstart.md): Install supaschema, write a declarative schema file, generate a replay-safe PostgreSQL migration, and validate it — all without a running database.
- [supaschema Diagnostic Codes Reference — All SUPA_* Codes](https://supaschema.com/reference/diagnostics.md): Complete reference for every SUPA_* diagnostic code emitted by supaschema — severity levels, what triggers each code, and how to resolve it.
- [supaschema Node.js Library API — Full Function Reference](https://supaschema.com/reference/library-api.md): Complete Node.js API reference for supaschema: extract, diff, plan, renderMigration, check, verify, sync, generate types, and more — fully typed.
- [supaschema DDL Support Matrix — PostgreSQL Object Coverage](https://supaschema.com/reference/support-matrix.md): Which PostgreSQL DDL object types supaschema extracts, diffs, and renders as idempotent migration SQL — with render strategies and known limitations.

## Optional

- [GitHub](https://github.com/jmclaughlin724/supaschema)
- [npm](https://www.npmjs.com/package/supaschema)