winget install --id=SchemaSmith.SchemaSmith -e SchemaSmith is a state-based database schema deployment toolset. Declare your schema as JSON and SchemaQuench converges any target to match it; SchemaTongs extracts an existing database to that JSON; DataTongs manages reference data. Works across SQL Server, PostgreSQL, MySQL, and MariaDB.
Terraform for SQL Server, Postgres, MySQL, and MariaDB databases
> SchemaSmith v2.7.1 released. SQL Server table features now actually apply in a SchemaQuench deploy (CDC, Change Tracking, FILESTREAM columns, and the UnsupportedFeaturePolicy degrade/fail check), and CDC net changes can be declared. Release notes · CHANGELOG
Featured in: 
SchemaSmith is a state-based database schema management toolset for SQL Server, PostgreSQL, MySQL, and MariaDB. Define your desired database state as metadata — tables, views, procedures, indexes, constraints, data — and SchemaSmith transforms any target server to match. Same toolset, same package format, four engines — no migration scripts to author or order.
Self-contained, single-file executables for Windows, Linux, and macOS. No .NET runtime install needed.
⭐ Find SchemaSmith useful? Star the repo — it helps other database teams discover it.
ShouldApplyExpression, secondary-server fan-out, FK-aware data delivery, checkpoint/resume, WhatIf analysis, indexed views (SQL Server), materialized views (PostgreSQL), and a token system that reaches every script.For the complete feature reference, see docs/FEATURE_LIST.md.
| OS | x64 | ARM64 |
|---|---|---|
| Windows | win-x64 | win-arm64 |
| Linux | linux-x64 | linux-arm64 |
| macOS | osx-x64 | osx-arm64 |
These are the minimum engine versions SchemaSmith supports. The floor is enforced automatically — a below-floor target aborts the run with a clear message before anything is deployed.
| Engine | Minimum supported |
|---|---|
| SQL Server | 2008 (major version 10) |
| PostgreSQL | 12 |
| MySQL | 5.7 |
| MariaDB | 10.2 |
The floor is enforced from the detected server version — below it, the run aborts before any change. SchemaSmith reaches these floors by generating version-correct SQL for each target rather than demanding a uniform version: newer-version features are taken by an equivalent path (or degraded through a policy with a downgrade manifest) instead of refused. For SQL Server the target database's compatibility_level is also checked (100+). Full detail — the compatibility-level floor, the per-version feature adaptations, and how to raise the floor per product — is in the Engine Version Compatibility reference.
choco install schemasmith
Installs schemaquench, schematongs, datatongs, and schemashears onto your PATH as a single combined package. Binaries are Authenticode-signed via Azure Trusted Signing — no SmartScreen warnings.
winget install SchemaSmith.SchemaSmith
Installs all four CLI commands (SchemaQuench, SchemaTongs, DataTongs, SchemaShears) onto your PATH from the Authenticode-signed release zip.
curl -fsSL https://schemasmith.com/dl/install.sh | sh
Installs the CLI tools (schemaquench, schematongs, datatongs, schemashears) from the official release binaries — to /usr/local/bin as root, otherwise ~/.local/bin. Resolves the latest release automatically; pin a version with INSTALL_VERSION=x.y.z or redirect with INSTALL_DIR=. Targets glibc-based Linux and macOS (Alpine/musl isn't supported — use the .deb / .rpm packages or a glibc base image).
Download self-contained ZIP packages from the latest release. Extract and run — no .NET runtime required.
yay -S schemasmith-bin
Installs the CLI tools (schemaquench, schematongs, datatongs, schemashears) from the official release binaries. Works with any AUR helper.
dotnet build SchemaSmith.sln
For self-contained publishing of the CLI tools:
# Windows
.\build-schemaquench.cmd
# Linux/macOS
./build-schemaquench.sh
SchemaQuench ships as a container image on Docker Hub and GHCR — run a deploy with no .NET install:
# Docker Hub
docker run --rm \
-e SmithySettings_SchemaPackagePath=/pkg \
-e SmithySettings_Target__Server=db.example.com \
-e SmithySettings_Target__User=deploy \
-e SmithySettings_Target__Password="$DB_PASSWORD" \
-v "$PWD/schema:/pkg" \
schemasmithyfree/schemaquench:latest
# GHCR (reliable pulls behind corporate NAT / Docker Hub's anonymous rate limit)
docker run --rm -v "$PWD/schema:/pkg" \
-e SmithySettings_SchemaPackagePath=/pkg \
ghcr.io/schema-smith/schemaquench:2.7.0 --Validate
Tags: latest, X.Y.Z (immutable), X.Y, X. Multi-arch (linux/amd64 + linux/arm64). Configure via SmithySettings_ environment variables (__ denotes nesting) or a mounted SchemaQuench.settings.json; append --Key:value overrides as needed.
Run SchemaQuench in a workflow with the SchemaSmith Deploy action — WhatIf on pull requests, deploy on merge:
- name: WhatIf on PR
if: github.event_name == 'pull_request'
uses: Schema-Smith/SchemaSmith@v2.7.0
with:
mode: whatif
product-path: ./schema
server: ${{ secrets.DB_SERVER }}
user: ${{ secrets.DB_USER }}
password: ${{ secrets.DB_PASSWORD }}
- name: Deploy on merge
if: github.ref == 'refs/heads/main'
uses: Schema-Smith/SchemaSmith@v2.7.0
with:
mode: deploy
product-path: ./schema
server: ${{ secrets.DB_SERVER }}
user: ${{ secrets.DB_USER }}
password: ${{ secrets.DB_PASSWORD }}
The action fetches the matching self-contained binary for the runner OS at run time — no runtime install. Pinning a release tag (@v2.7.0 above) is recommended for production — a tag pins both the action and the CLI version it runs; @main tracks the latest action instead (the version input defaults from the ref).
version, mode (deploy / whatif / validate / test-connection / preview-targets), product-path, server, user, password (passed via env, never on the command line), extra-args (raw --Key:value passthrough — port, template/database/schema filters, Drop* toggles, connection properties, and more).exit-code, log-dir, summary-path (the SchemaQuench - Summary.md/.json — e.g. post a WhatIf summary as a PR comment).Pick a platform and run the matching run-demo script:
# SQL Server
cd Demos/SqlServer && ./run-demo.sh
# PostgreSQL
cd Demos/PostgreSQL && ./run-demo.sh
# MySQL
cd Demos/MySQL && ./run-demo.sh
# MariaDB
cd Demos/MariaDB && ./run-demo.sh
Each script builds SchemaQuench from source (if not already built), starts a containerized database server, and deploys the AdventureWorks, Chinook, Northwind, and Sakila demo products. Use run-demo.cmd on Windows. Connection details for each platform live in the .env file inside the platform folder.
Integration tests run against all four supported platforms in parallel and expect database servers on these local ports:
| Platform | Host | Port |
|---|---|---|
| SQL Server | 127.0.0.1 | 1440 |
| PostgreSQL | 127.0.0.1 | 5432 |
| MySQL | 127.0.0.1 | 3306 |
| MariaDB | 127.0.0.1 | 3317 |
MariaDB runs on the MySQL engine but binds its own port (3317), so all four containers run side by side.
The simplest way to bring them up is to run the demo for each platform — the same containers serve as the integration-test backends:
cd Demos/SqlServer && ./run-demo.sh
cd Demos/PostgreSQL && ./run-demo.sh
cd Demos/MySQL && ./run-demo.sh
cd Demos/MariaDB && ./run-demo.sh
Then run tests:
dotnet test SchemaSmith.sln
Integration tests for a platform whose container isn't running will be skipped or fail — start only the platforms you need to exercise locally.
Four sample databases ship across all four platforms:
See Demos/README.md for the per-platform layout, credentials, and SQL Server tutorials.
To report a vulnerability, see SECURITY.md. For how the tools handle credentials and network access, how releases are built and signed, and answers to common security-review questions, see SECURITY-POSTURE.md.
SchemaSmith Community Edition is licensed under SSCL v2.0. Use it freely to manage databases for your own products and services — SQL Server, PostgreSQL, MySQL, or MariaDB — with no restrictions on organization size, revenue, database size, or environment count. Not permitted: redistributing SchemaSmith as a standalone product, bundling it as a component of another product marketed to third parties, or offering it as a hosted or managed service. See the LICENSE for the full terms.
For SBOM and license-scanning tools, SSCL v2.0 is declared as the SPDX custom identifier LicenseRef-SSCL-2.0 (SSCL is not on the SPDX License List).
Questions from a security, procurement, or legal review — source-available status, what counts as redistribution, patents, warranty, governing law — are answered in the License FAQ.
External contributors:
For the full list see the GitHub contributors page, and CONTRIBUTING.md for how to get involved.