NAME

GitDDL::Migrator - database migration utility for git managed SQL extended GitDDL

SYNOPSIS

    use GitDDL::Migrator;
    my $gd = GitDDL::Migrator->new(
        work_tree => '/path/to/project', # git working directory
        ddl_file  => 'sql/schema_ddl.sql',
        dsn       => ['dbi:mysql:my_project', 'root', ''],
    );

DESCRIPTION

GitDDL::Migrator is database migration utility extended GitDDL.

GitDDL is very cool module. It's very simple and developer friendly. I use it in development, but features of it are not enough in operation phase.

Features needed at operation phases are: e.g.

save migration history
rollback to previous version
specify version
specify SQL (sometimes SQL::Translator's output is wrong)
check differences from versioned SQL and real database

Then for solving them, I wrote GitDDL::Migrator.

METHODS

"GitDDL::Migrator->new(%options)"

Create GitDDL::Migrator object. Available options are:

"work_tree" => 'Str' (Required): Git working tree path includes target DDL file.
"ddl_file" => 'Str' (Required): DDL file ( .sql file) path in repository.
If DDL file located at /repos/project/sql/schema.sql and work_tree root is /repos/project, then this option should be sql/schema.sql
"dsn" => 'ArrayRef' (Required): DSN parameter that pass to DBI module.
"version_table" => 'Str' (optional): database table name that contains its git commit version. (default: git_ddl_version)
"ignore_tables" => 'ArrayRef' (optional): tables for ignoring when calling "check_ddl_mismatch()". (default: empty)