package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
use Moose;
+
+use autodie;
+use Carp qw( carp croak );
+
use Method::Signatures::Simple;
use Try::Tiny;
+
use SQL::Translator;
require SQL::Translator::Diff;
+
require DBIx::Class::Storage; # loaded for type constraint
+use DBIx::Class::DeploymentHandler::Types;
-use Carp 'carp';
+use File::Path 'mkpath';
+use File::Spec::Functions;
+
+with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
+
+has schema => (
+ isa => 'DBIx::Class::Schema',
+ is => 'ro',
+ required => 1,
+ handles => [qw( schema_version )],
+);
has storage => (
isa => 'DBIx::Class::Storage',
$s
}
-has backup_directory => (
- isa => 'Str',
- is => 'ro',
-);
-
-has do_backup => (
- isa => 'Bool',
- is => 'ro',
- default => undef,
-);
-
has sqltargs => (
isa => 'HashRef',
is => 'ro',
default => 'sql',
);
-has version_rs => (
- isa => 'DBIx::Class::ResultSet',
- is => 'ro',
- lazy_build => 1,
- handles => [qw( is_installed db_version )],
-);
-
-method _build_version_rs {
- $self->schema->set_us_up_the_bomb;
- $self->schema->resultset('__VERSION')
-}
-
has databases => (
coerce => 1,
isa => 'DBIx::Class::DeploymentHandler::Databases',
default => sub { [qw( MySQL SQLite PostgreSQL )] },
);
-has schema => (
- isa => 'DBIx::Class::Schema',
- is => 'ro',
- required => 1,
- handles => [qw( schema_version )],
-);
-
has _filedata => (
isa => 'ArrayRef[Str]',
is => 'rw',
+ default => sub { [] },
);
-method _ddl_filename($type, $versions, $dir) {
- my $filename = ref $self->schema;
- $filename =~ s/::/-/g;
+has txn_wrap => (
+ is => 'ro',
+ isa => 'Bool',
+ default => 1,
+);
- $filename = File::Spec->catfile(
- $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql"
- );
+method __ddl_consume_with_prefix($type, $versions, $prefix) {
+ my $base_dir = $self->upgrade_directory;
+
+ my $main = catfile( $base_dir, $type );
+ my $generic = catfile( $base_dir, '_generic' );
+ my $common =
+ catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
+
+ my $dir;
+ if (-d $main) {
+ $dir = catfile($main, $prefix, join q(-), @{$versions})
+ } elsif (-d $generic) {
+ $dir = catfile($generic, $prefix, join q(-), @{$versions});
+ } else {
+ croak "neither $main or $generic exist; please write/generate some SQL";
+ }
- return $filename;
-}
+ opendir my($dh), $dir;
+ my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir $dh;
+ closedir $dh;
-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;
+ if (-d $common) {
+ opendir my($dh), $common;
+ for my $filename (grep { /\.sql$/ && -f catfile($common,$_) } readdir $dh) {
+ unless ($files{$filename}) {
+ $files{$filename} = catfile($common,$filename);
+ }
+ }
+ closedir $dh;
}
- # 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};
+ return [@files{sort keys %files}]
+}
+
+method _ddl_schema_consume_filenames($type, $version) {
+ $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
+}
- my $tr = SQL::Translator->new(
- producer => "SQL::Translator::Producer::${type}",
- %$sqltargs,
- parser => 'SQL::Translator::Parser::DBIx::Class',
- data => $schema,
- );
+method _ddl_schema_produce_filename($type, $version) {
+ my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+ mkpath($dirname) unless -d $dirname;
- my @ret;
- my $wa = wantarray;
- if ($wa) {
- @ret = $tr->translate;
- }
- else {
- $ret[0] = $tr->translate;
- }
+ return catfile( $dirname, '001-auto.sql' );
+}
+
+method _ddl_schema_up_consume_filenames($type, $versions) {
+ $self->__ddl_consume_with_prefix($type, $versions, 'up')
+}
+
+method _ddl_schema_down_consume_filenames($type, $versions) {
+ $self->__ddl_consume_with_prefix($type, $versions, 'down')
+}
+
+method _ddl_schema_up_produce_filename($type, $versions) {
+ my $dir = $self->upgrade_directory;
+
+ my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
+ mkpath($dirname) unless -d $dirname;
- $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
- unless (@ret && defined $ret[0]);
+ return catfile( $dirname, '001-auto.sql'
+ );
+}
- return $wa ? @ret : $ret[0];
+method _ddl_schema_down_produce_filename($type, $versions, $dir) {
+ my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
+ mkpath($dirname) unless -d $dirname;
+
+ return catfile( $dirname, '001-auto.sql');
}
-method _deploy {
+sub _deploy {
+ my $self = shift;
my $storage = $self->storage;
- my $deploy = sub {
- my $line = shift;
- return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
+ my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
+
+ my @sql = map @{$self->_read_sql_file($_)}, @{$self->_ddl_schema_consume_filenames(
+ $self->storage->sqlt_type,
+ $self->schema_version
+ )};
+
+ foreach my $line (@sql) {
$storage->_query_start($line);
try {
# do a dbh_do cycle here, as we need some error checking in
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 );
- }
}
+
+ $guard->commit if $self->txn_wrap;
+ return join "\n", @sql;
}
-method prepare_install {
+sub prepare_install {
+ my $self = shift;
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;
+ my $version = $schema->schema_version;
- $sqltargs = {
- add_drop_table => 1,
+ my $sqlt = SQL::Translator->new({
+ add_drop_table => 1,
ignore_constraint_names => 1,
- ignore_index_names => 1,
- %{$sqltargs || {}}
- };
-
- my $sqlt = SQL::Translator->new( $sqltargs );
+ ignore_index_names => 1,
+ parser => 'SQL::Translator::Parser::DBIx::Class',
+ %{$sqltargs}
+ });
- $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
- my $sqlt_schema = $sqlt->translate({ data => $schema })
- or $self->throw_exception ($sqlt->error);
+ my $sqlt_schema = $sqlt->translate( data => $schema )
+ or croak($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
+ my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
+ if (-e $filename ) {
carp "Overwriting existing DDL file - $filename";
unlink $filename;
}
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;
- }
+ open my $file, q(>), $filename;
print {$file} $output;
close $file;
}
}
-method prepare_update($version, $preversion) {
+sub prepare_upgrade {
+ my ($self, $from_version, $to_version, $version_set) = @_;
+
+ $from_version ||= '1.0'; #$self->database_version;
+ $to_version ||= $self->schema_version;
+
+ # for updates prepared automatically (rob's stuff)
+ # one would want to explicitly set $version_set to
+ # [$to_version]
+ $version_set ||= [$from_version, $to_version];
+
+ $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
+}
+
+sub prepare_downgrade {
+ my ($self, $from_version, $to_version, $version_set) = @_;
+
+ $from_version ||= $self->db_version;
+ $to_version ||= $self->schema_version;
+
+ # for updates prepared automatically (rob's stuff)
+ # one would want to explicitly set $version_set to
+ # [$to_version]
+ $version_set ||= [$from_version, $to_version];
+
+ $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
+}
+
+method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
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;
+ my $schema_version = $schema->schema_version;
$sqltargs = {
add_drop_table => 1,
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);
+ my $sqlt_schema = $sqlt->translate( data => $schema )
+ or croak($sqlt->error);
foreach my $db (@$databases) {
$sqlt->reset;
$sqlt->{schema} = $sqlt_schema;
$sqlt->producer($db);
- my $prefilename = $self->_ddl_filename($db, [ $preversion ], $dir);
+ my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
unless(-e $prefilename) {
carp("No previous schema file found ($prefilename)");
next;
}
-
- my $diff_file = $self->_ddl_filename($db, [ $preversion, $version ], $dir );
+ my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
+ my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
if(-e $diff_file) {
- carp("Overwriting existing diff file - $diff_file");
+ carp("Overwriting existing $direction-diff file - $diff_file");
unlink $diff_file;
}
});
$t->parser( $db ) # could this really throw an exception?
- or $self->throw_exception ($t->error);
+ or croak($t->error);
my $out = $t->translate( $prefilename )
- or $self->throw_exception ($t->error);
+ or croak($t->error);
$source_schema = $t->schema;
});
$t->parser( $db ) # could this really throw an exception?
- or $self->throw_exception ($t->error);
+ or croak($t->error);
- my $filename = $self->_ddl_filename($db, [ $version ], $dir);
+ my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
my $out = $t->translate( $filename )
- or $self->throw_exception ($t->error);
+ or croak($t->error);
$dest_schema = $t->schema;
$dest_schema, $db,
$sqltargs
);
- my $file;
- unless(open $file, q(>), $diff_file) {
- $self->throw_exception("Can't write to $diff_file ($!)");
- next;
- }
+ open my $file, q(>), $diff_file;
print {$file} $diff;
close $file;
}
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>;
+ open my $fh, '<', $file;
+ my @data = split /;\n/, join '', <$fh>;
close $fh;
@data = grep {
- $_ &&
- !/^--/ &&
- !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
- } split /;/,
- join '', @data;
+ $_ && # remove blank lines
+ !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
+ } map {
+ s/^\s+//; s/\s+$//; # trim whitespace
+ join '', grep { !/^--/ } split /\n/ # remove comments
+ } @data;
return \@data;
}
-method _upgrade_single_step {
+sub _downgrade_single_step {
+ my $self = shift;
my @version_set = @{ shift @_ };
- my $db_version = $self->db_version;
- my $upgrade_file = $self->_ddl_filename(
+ my @downgrade_files = @{$self->_ddl_schema_down_consume_filenames(
$self->storage->sqlt_type,
\@version_set,
- $self->upgrade_directory,
- );
-
- 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";
+ for my $downgrade_file (@downgrade_files) {
+ $self->_filedata($self->_read_sql_file($downgrade_file)); # I don't like this --fREW 2010-02-22
- $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 });
+ my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
+ $self->_do_upgrade;
+ $guard->commit if $self->txn_wrap;
+ }
+}
- $self->version_rs->create({
- version => $version_set[-1],
- # ddl => $ddl,
- # upgrade_sql => $upgrade_sql,
- });
+sub _upgrade_single_step {
+ my $self = shift;
+ my @version_set = @{ shift @_ };
+ my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
+ $self->storage->sqlt_type,
+ \@version_set,
+ )};
+
+ my $upgrade_sql;
+ for my $upgrade_file (@upgrade_files) {
+ my $up = $self->_read_sql_file($upgrade_file);
+ $upgrade_sql .= $up;
+ $self->_filedata($up); # I don't like this --fREW 2010-02-22
+ my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
+ $self->_do_upgrade;
+ $guard->commit if $self->txn_wrap;
+ }
+ return ['', $upgrade_sql];
}
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->dbh->do($_) or carp "SQL was: $_"
}
-method backup { $self->storage->backup($self->backup_directory) }
-
__PACKAGE__->meta->make_immutable;
1;