SchemaSmith Documentation

Documentation

Browse documentation by database platform.

How the documentation is organized

SchemaSmith’s documentation is built in three layers — platform-neutral concepts, database-specific reference, and CLI tool details. Whether you’re new to schema-as-code or going deep, knowing how the layers fit gets you to the right docs faster.

  • Concepts — Start here for the state-based model that powers SchemaSmith: schema packages, migration scripts, script tokens, data delivery, and rollback. You’ll learn how the model works independent of your database engine.
  • Per-platform reference — SQL Server, PostgreSQL, and MySQL are peers, but each gets its own native schema definitions and templates — platform-specific setup, reference, and extraction rules. One definition doesn’t deploy across all three; each platform manages its own.
  • Tools — The three CLIs — SchemaTongs (extract), SchemaQuench (deploy), DataTongs (reference data) — each have their own reference docs for syntax, options, and behavior.

Start with Getting Started or Core Concepts to learn the model, then your platform’s reference, then the tool docs as you build your workflow.

Pick your platform

SchemaSmith manages schemas for three databases. Each has its own tables, types, and templates.

SQL Server

Extract, version, and deploy Microsoft SQL Server schemas with SchemaTongs, SchemaQuench, and DataTongs.

PostgreSQL

Extract, version, and deploy PostgreSQL schemas with SchemaTongs, SchemaQuench, and DataTongs.

MySQL

Extract, version, and deploy MySQL schemas with SchemaTongs, SchemaQuench, and DataTongs.

Explore further

Cross-platform reference and long-form guides for going deeper.

Core Concepts

Cross-platform fundamentals — schema packages, migrations, data delivery, rollback, multi-tenant deployments, the recycle bin, and how the SchemaSmith model works under the hood.

Tool Reference

Reference for the three command-line tools: SchemaTongs (extract), SchemaQuench (deploy), and DataTongs (data load and unload).

Deep-Dive Guides

Long-form guides on zero-downtime deployments, rollback strategies, schema drift, dependency management, and database DevOps.