use Moose;
use Method::Signatures::Simple;
require DBIx::Class::Schema; # loaded for type constraint
-require DBIx::Class::Storage; # loaded for type constraint
require DBIx::Class::ResultSet; # loaded for type constraint
use Carp::Clan '^DBIx::Class::DeploymentHandler';
-use SQL::Translator;
-require SQL::Translator::Diff;
-use Try::Tiny;
+
+with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod';
+with 'DBIx::Class::DeploymentHandler::WithDatabaseToSchemaVersions';
BEGIN {
use Moose::Util::TypeConstraints;
isa => 'DBIx::Class::Schema',
is => 'ro',
required => 1,
- handles => [qw( ddl_filename schema_version )],
);
-has upgrade_directory => (
+has upgrade_directory => ( # configuration
isa => 'Str',
is => 'ro',
required => 1,
default => 'sql',
);
-has backup_directory => (
+has backup_directory => ( # configuration
isa => 'Str',
is => 'ro',
+ predicate => 'has_backup_directory',
);
-has storage => (
- isa => 'DBIx::Class::Storage',
- is => 'ro',
- lazy_build => 1,
-);
-
-method _build_storage {
- my $s = $self->schema->storage;
- $s->_determine_driver;
- $s
-}
-
-has _filedata => (
- isa => 'ArrayRef[Str]',
- is => 'rw',
-);
-
-has do_backup => (
- isa => 'Bool',
- is => 'ro',
- default => undef,
-);
-
-has do_diff_on_init => (
+has do_backup => ( # configuration
isa => 'Bool',
is => 'ro',
default => undef,
has version_rs => (
isa => 'DBIx::Class::ResultSet',
is => 'ro',
- lazy_build => 1,
- handles => [qw( is_installed db_version )],
+ lazy_build => 1, # builder comes from another role...
+ # which is... probably not how we want it
+ handles => [qw( is_installed )],
);
-method _build_version_rs {
- $self->schema->set_us_up_the_bomb;
- $self->schema->resultset('__VERSION')
-}
+has to_version => ( # configuration
+ is => 'ro',
+ lazy_build => 1, # builder comes from another role...
+ # which is... probably not how we want it
+);
-has databases => (
+has databases => ( # configuration
coerce => 1,
isa => 'DBIx::Class::DeploymentHandler::Databases',
is => 'ro',
default => sub { [qw( MySQL SQLite PostgreSQL )] },
);
-has sqltargs => (
+has sqltargs => ( # configuration
isa => 'HashRef',
is => 'ro',
default => sub { {} },
);
-method deployment_statements {
- my $dir = $self->upgrade_directory;
- my $schema = $self->schema;
- my $type = $self->storage->sqlt_type;
- my $sqltargs = $self->sqltargs;
- my $version = $self->schema_version || '1.x';
-
- my $filename = $self->ddl_filename($type, $version, $dir);
- if(-f $filename) {
- my $file;
- open $file, q(<), $filename
- or carp "Can't open $filename ($!)";
- my @rows = <$file>;
- close $file;
- return join '', @rows;
- }
-
- # sources needs to be a parser arg, but for simplicty allow at top level
- # coming in
- $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
- if exists $sqltargs->{sources};
-
- my $tr = SQL::Translator->new(
- producer => "SQL::Translator::Producer::${type}",
- %$sqltargs,
- parser => 'SQL::Translator::Parser::DBIx::Class',
- data => $schema,
- );
-
- my @ret;
- my $wa = wantarray;
- if ($wa) {
- @ret = $tr->translate;
- }
- else {
- $ret[0] = $tr->translate;
- }
-
- $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
- unless (@ret && defined $ret[0]);
-
- return $wa ? @ret : $ret[0];
-}
-
-method deploy {
- my $schema = $self->schema;
- my $type = undef;
- my $sqltargs = $self->sqltargs;
- my $dir = $self->upgrade_directory;
- my $storage = $self->storage;
-
- my $deploy = sub {
- my $line = shift;
- return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
- $storage->_query_start($line);
- try {
- # do a dbh_do cycle here, as we need some error checking in
- # place (even though we will ignore errors)
- $storage->dbh_do (sub { $_[1]->do($line) });
- }
- catch {
- carp "$_ (running '${line}')"
- }
- $storage->_query_end($line);
- };
- my @statements = $self->deployment_statements();
- if (@statements > 1) {
- foreach my $statement (@statements) {
- $deploy->( $statement );
- }
- }
- elsif (@statements == 1) {
- foreach my $line ( split(";\n", $statements[0])) {
- $deploy->( $line );
- }
- }
-}
-
-method backup { $self->storage->backup($self->backup_directory) }
-
-method install($new_version) {
+method install {
carp 'Install not possible as versions table already exists in database'
if $self->is_installed;
- $new_version ||= $self->schema_version;
+ my $new_version = $self->to_version;
if ($new_version) {
- $self->deploy();
+ $self->_deploy;
$self->version_rs->create({
version => $new_version,
}
}
-method create_upgrade_path { }
-
-method ordered_schema_versions { undef }
-
-method upgrade {
- my $db_version = $self->db_version;
- my $schema_version = $self->schema_version;
-
- unless ($db_version) {
- # croak?
- carp 'Upgrade not possible as database is unversioned. Please call install first.';
- return;
- }
-
- if ( $db_version eq $schema_version ) {
- # croak?
- carp "Upgrade not necessary\n";
- return;
- }
-
- my @version_list = $self->ordered_schema_versions ||
- ( $db_version, $schema_version );
-
- # remove all versions in list above the required version
- while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
- pop @version_list;
- }
-
- # remove all versions in list below the current version
- while ( @version_list && ( $version_list[0] ne $db_version ) ) {
- shift @version_list;
- }
-
- # check we have an appropriate list of versions
- die if @version_list < 2;
-
- # do sets of upgrade
- while ( @version_list >= 2 ) {
- $self->upgrade_single_step( $version_list[0], $version_list[1] );
- shift @version_list;
+sub upgrade {
+ while ( my $version_list = $_[0]->next_version_set ) {
+ $_[0]->_upgrade_single_step($version_list);
}
}
-method upgrade_single_step($db_version, $target_version) {
- if ($db_version eq $target_version) {
- # croak?
- carp "Upgrade not necessary\n";
- return;
- }
-
- my $upgrade_file = $self->ddl_filename(
- $self->storage->sqlt_type,
- $target_version,
- $self->upgrade_directory,
- $db_version,
- );
-
- $self->create_upgrade_path({ upgrade_file => $upgrade_file });
-
- unless (-f $upgrade_file) {
- # croak?
- carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
- return;
- }
-
- carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
-
- $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
- $self->backup if $self->do_backup;
- $self->schema->txn_do(sub { $self->do_upgrade });
-
- $self->version_rs->create({
- version => $target_version,
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
-}
-
-method create_install_ddl {
- my $schema = $self->schema;
- my $databases = $self->databases;
- my $dir = $self->upgrade_directory;
- my $sqltargs = $self->sqltargs;
- unless( -d $dir ) {
- carp "Upgrade directory $dir does not exist, using ./\n";
- $dir = "./";
- }
-
- my $version = $schema->schema_version || '1.x';
- my $schema_version = $schema->schema_version || '1.x';
- $version ||= $schema_version;
-
- $sqltargs = {
- add_drop_table => 1,
- ignore_constraint_names => 1,
- ignore_index_names => 1,
- %{$sqltargs || {}}
- };
-
- my $sqlt = SQL::Translator->new( $sqltargs );
-
- $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
- my $sqlt_schema = $sqlt->translate({ data => $schema })
- or $self->throw_exception ($sqlt->error);
-
- foreach my $db (@$databases) {
- $sqlt->reset;
- $sqlt->{schema} = $sqlt_schema;
- $sqlt->producer($db);
-
- my $filename = $self->ddl_filename($db, $version, $dir);
- if (-e $filename && ($version eq $schema_version )) {
- # if we are dumping the current version, overwrite the DDL
- carp "Overwriting existing DDL file - $filename";
- unlink $filename;
- }
-
- my $output = $sqlt->translate;
- if(!$output) {
- carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
- next;
- }
- my $file;
- unless( open $file, q(>), $filename ) {
- $self->throw_exception("Can't open $filename for writing ($!)");
- next;
- }
- print {$file} $output;
- close $file;
- }
-}
-
-method create_update_ddl($version, $preversion) {
- my $schema = $self->schema;
- my $databases = $self->databases;
- my $dir = $self->upgrade_directory;
- my $sqltargs = $self->sqltargs;
-
- unless( -d $dir ) {
- carp "Upgrade directory $dir does not exist, using ./\n";
- $dir = "./";
- }
-
- my $schema_version = $schema->schema_version || '1.x';
- $version ||= $schema_version;
-
- $sqltargs = {
- add_drop_table => 1,
- ignore_constraint_names => 1,
- ignore_index_names => 1,
- %{$sqltargs}
- };
-
- my $sqlt = SQL::Translator->new( $sqltargs );
-
- $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
- my $sqlt_schema = $sqlt->translate({ data => $schema })
- or $self->throw_exception ($sqlt->error);
-
- foreach my $db (@$databases) {
- $sqlt->reset;
- $sqlt->{schema} = $sqlt_schema;
- $sqlt->producer($db);
-
- my $prefilename = $self->ddl_filename($db, $preversion, $dir);
- unless(-e $prefilename) {
- carp("No previous schema file found ($prefilename)");
- next;
- }
-
- my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion);
- if(-e $diff_file) {
- carp("Overwriting existing diff file - $diff_file");
- unlink $diff_file;
- }
-
- my $source_schema;
- {
- my $t = SQL::Translator->new({
- %{$sqltargs},
- debug => 0,
- trace => 0,
- });
-
- $t->parser( $db ) # could this really throw an exception?
- or $self->throw_exception ($t->error);
-
- my $out = $t->translate( $prefilename )
- or $self->throw_exception ($t->error);
-
- $source_schema = $t->schema;
-
- $source_schema->name( $prefilename )
- unless $source_schema->name;
- }
-
- # The "new" style of producers have sane normalization and can support
- # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
- # And we have to diff parsed SQL against parsed SQL.
- my $dest_schema = $sqlt_schema;
-
- unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
- my $t = SQL::Translator->new({
- %{$sqltargs},
- debug => 0,
- trace => 0,
- });
-
- $t->parser( $db ) # could this really throw an exception?
- or $self->throw_exception ($t->error);
-
- my $filename = $self->ddl_filename($db, $version, $dir);
- my $out = $t->translate( $filename )
- or $self->throw_exception ($t->error);
-
- $dest_schema = $t->schema;
-
- $dest_schema->name( $filename )
- unless $dest_schema->name;
- }
-
- my $diff = SQL::Translator::Diff::schema_diff(
- $source_schema, $db,
- $dest_schema, $db,
- $sqltargs
- );
- my $file;
- unless(open $file, q(>), $diff_file) {
- $self->throw_exception("Can't write to $diff_file ($!)");
- next;
- }
- print {$file} $diff;
- close $file;
- }
-}
-
-method create_ddl_dir($version, $preversion) {
- $self->create_install_ddl;
- $self->create_update_ddl($version, $preversion) if $preversion;
-}
-
-method do_upgrade { $self->run_upgrade(qr/.*?/) }
-
-method run_upgrade($stm) {
- return unless $self->_filedata;
- my @statements = grep { $_ =~ $stm } @{$self->_filedata};
-
- for (@statements) {
- $self->storage->debugobj->query_start($_) if $self->storage->debug;
- $self->apply_statement($_);
- $self->storage->debugobj->query_end($_) if $self->storage->debug;
- }
-}
-
-method apply_statement($statement) {
- # croak?
- $self->storage->dbh->do($_) or carp "SQL was: $_"
-}
-
-method _read_sql_file($file) {
- return unless $file;
-
- open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
- my @data = split /\n/, join '', <$fh>;
- close $fh;
-
- @data = grep {
- $_ &&
- !/^--/ &&
- !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
- } split /;/,
- join '', @data;
+method backup { $self->storage->backup($self->backup_directory) }
- return \@data;
-}
+__PACKAGE__->meta->make_immutable;
1;
__END__
-vim: ts=2,sw=2,expandtab
+vim: ts=2 sw=2 expandtab
projects / dbsrgits/DBIx-Class-DeploymentHandler.git / blobdiff