Sqitch Manual

The official and comprehensive manual included the Sqitch package itself.

Setup and Configuration

sqitch - Sensible database change management
config - Get and set local, user, or system Sqitch options
init - Create a new Sqitch project
engine - Manage database engine configuration
target - Manage target database configuration
help - Display help for Sqitch and Sqitch commands

Development

add - Add a database change to plans
bundle - Bundle a Sqitch project for distribution
checkout - Revert, checkout another VCS branch, and re-deploy changes
check - Checks for divergences between planned and deployed changes
plan - Show planned database changes
rebase - Revert and redeploy database changes
rework - Rework a database change
show - Show object information or script contents
tag - Create or list tag objects

Deployment

deploy - Deploy changes to a database
log - Show Sqitch change deployment logs
revert - Revert changes to a database
status - Show the current deployment status of a database
upgrade - Upgrade the registry to the current version
verify - Verify deployed database changes

Guides

authentication - Guide to using database authentication credentials with Sqitch
configuration - Hierarchical engine and target configuration
changes - Specifying changes for Sqitch
environment - Environment variables recognized by Sqitch

Tutorials

🐘 Postgres, YugabyteDB, and CockroachDB - A tutorial introduction to Sqitch change management on PostgreSQL, YugabyteDB, and CockroachDB
💡 SQLite - A tutorial introduction to Sqitch change management on SQLite
🐬 MySQL - A tutorial introduction to Sqitch change management on MySQL
🔥 Firebird - A tutorial introduction to Sqitch change management on Firebird
☀️ Exasol - A tutorial introduction to Sqitch change management on Exasol
🔮 Oracle - A tutorial introduction to Sqitch change management on Oracle
❄️ Snowflake - A tutorial introduction to Sqitch change management on Snowflake
🔺 Vertica - A tutorial introduction to Sqitch change management on Vertica