close
Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
diff.md
diff.md
 
 
fmt.md
fmt.md
 
 
lint.md
lint.md
 
 
migrate.md
migrate.md
 
 
move.md
move.md
 
 

README.md

How to use Spirit

Spirit is a single binary with subcommands for MySQL schema and data operations:

Subcommand Purpose
spirit migrate Online schema change tool — applies ALTER TABLE statements to large tables without blocking reads or writes
spirit move Logical table mover — copies whole schemas (or a subset of tables) between different MySQL servers
spirit lint Schema linter — validates an entire MySQL schema against built-in lint rules
spirit diff Schema differ — compares two MySQL schemas and lints the changes
spirit fmt Schema file formatter — canonicalizes CREATE TABLE .sql files by round-tripping them through MySQL

Which subcommand should I use?

  • Use spirit migrate when you need to alter the schema of a table on the same MySQL server (e.g., add a column, add an index, change a charset).
  • Use spirit move when you need to copy tables from one MySQL server to another (e.g., migrating to a new cluster, resharding).
  • Use spirit lint to validate a MySQL schema against built-in lint rules.
  • Use spirit diff to compare two MySQL schemas and lint the differences.
  • Use spirit fmt to canonicalize CREATE TABLE .sql files so they match MySQL's internal representation (e.g., BOOLEAN → TINYINT(1)).

Both migrate and move share the same core engine: they stream binlog changes, copy rows in parallel, verify data with a checksum, and perform an atomic cutover. The move subcommand always uses the buffered copy algorithm, while migrate defaults to unbuffered INSERT .. SELECT (with --buffered available as an option).

Building

cd cmd/spirit && go build

Requirements

  • MySQL 8.0+
  • binlog_format=ROW
  • log_bin=ON
  • log_slave_updates=ON

See the individual usage docs linked above for the full list of configuration options.