require SQL::Translator::Diff;
require DBIx::Class::Storage; # loaded for type constraint
use autodie;
-use File::Path;
+use File::Path 'mkpath';
+use DBIx::Class::DeploymentHandler::Types;
+use File::Spec::Functions;
+
with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
is => 'rw',
);
-method __ddl_in_with_prefix($type, $versions, $prefix) {
+has txn_wrap => (
+ is => 'ro',
+ isa => 'Bool',
+ default => 1,
+);
+
+method __ddl_consume_with_prefix($type, $versions, $prefix) {
my $base_dir = $self->upgrade_directory;
- my $main = File::Spec->catfile( $base_dir, $type );
- my $generic = File::Spec->catfile( $base_dir, '_generic' );
- my $common = File::Spec->catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
+ 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 = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
+ $dir = catfile($main, $prefix, join q(-), @{$versions})
} elsif (-d $generic) {
- $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
+ $dir = catfile($main, $prefix, join q(-), @{$versions})
} else {
die 'PREPARE TO SQL'
}
return [@files{sort keys %files}]
}
-method _ddl_schema_in_filenames($type, $version) {
- $self->__ddl_in_with_prefix($type, [ $version ], 'schema')
+method _ddl_schema_consume_filenames($type, $version) {
+ $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
}
-method _ddl_schema_out_filename($type, $version, $dir) {
- my $dirname = File::Spec->catfile(
- $dir, $type, 'schema', $version
- );
- File::Path::mkpath($dirname) unless -d $dirname;
+method _ddl_schema_produce_filename($type, $version) {
+ my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version );
+ mkpath($dirname) unless -d $dirname;
- return File::Spec->catfile(
- $dirname, '001-auto.sql'
- );
+ return catfile( $dirname, '001-auto.sql' );
}
-method _ddl_schema_up_in_filenames($type, $versions, $dir) {
- $self->__ddl_in_with_prefix($type, $versions, 'up')
+method _ddl_schema_up_consume_filenames($type, $versions) {
+ $self->__ddl_consume_with_prefix($type, $versions, 'up')
}
-method _ddl_schema_down_in_filenames($type, $versions, $dir) {
- $self->__ddl_in_with_prefix($type, $versions, 'down')
+method _ddl_schema_down_consume_filenames($type, $versions) {
+ $self->__ddl_consume_with_prefix($type, $versions, 'down')
}
-method _ddl_schema_up_out_filename($type, $versions, $dir) {
- my $dirname = File::Spec->catfile(
- $dir, $type, 'up', join( q(-), @{$versions} )
- );
- File::Path::mkpath($dirname) unless -d $dirname;
+method _ddl_schema_up_produce_filename($type, $versions) {
+ my $dir = $self->upgrade_directory;
- return File::Spec->catfile(
- $dirname, '001-auto.sql'
- );
-}
+ my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions});
+ mkpath($dirname) unless -d $dirname;
-method _ddl_schema_down_out_filename($type, $versions, $dir) {
- my $dirname = File::Spec->catfile(
- $dir, $type, 'down', join( q(-), @{$versions} )
- );
- File::Path::mkpath($dirname) unless -d $dirname;
-
- return File::Spec->catfile(
- $dirname, '001-auto.sql'
+ return catfile( $dirname, '001-auto.sql'
);
}
-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;
-
- my @filenames = @{$self->_ddl_schema_in_filenames($type, $version)};
-
- for my $filename (@filenames) {
- 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,
- );
-
-#< frew> now note that deploy in the same file calls deployment_statements
-#< ribasushi> right
-#< frew> ALWAYS in array context
-#< ribasushi> right, that's the only way
-#< ribasushi> but create_ddl_dir
-#< ribasushi> calls in scalar
-#< ribasushi> because this is how you get stuff writable to a file
-#< ribasushi> in list you get individual statements for dbh->do
-#< frew> right
-#< frew> ok...
-#< frew> so for *me* I need it *always* in scalar
-#< frew> because I *only* use it to generate the file
-#< ribasushi> correct
- 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]);
+method _ddl_schema_down_produce_filename($type, $versions, $dir) {
+ my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} );
+ mkpath($dirname) unless -d $dirname;
- return $wa ? @ret : $ret[0];
+ return catfile( $dirname, '001-auto.sql');
}
sub _deploy {
my $self = shift;
my $storage = $self->storage;
- my $deploy = sub {
- my $line = shift;
-#< frew> k, also, we filter out comments and transaction stuff and blank lines
-#< frew> is that really necesary?
-#< frew> and what if I want to run my upgrade in a txn? seems like something you'd
-# always want to do really
-#< ribasushi> again - some stuff chokes
-#< frew> ok, so I see filtering out -- and \s*
-#< frew> but I think the txn filtering should be optional and default to NOT filter it
-# out
-#< ribasushi> then you have a problem
-#< frew> tell me
-#< ribasushi> someone runs a deploy in txn_do
-#< ribasushi> the inner begin will blow up
-#< frew> because it's a nested TXN?
-#< ribasushi> (you an't begin twice on most dbs)
-#< ribasushi> right
-#< ribasushi> on sqlite - for sure
-#< frew> so...read the docs and set txn_filter to true?
-#< ribasushi> more like wrap deploy in a txn
-#< frew> I like that better
-#< ribasushi> and make sure the ddl has no literal txns in them
-#< frew> sure
-#< ribasushi> this way you have stuff under control
-#< frew> so we have txn_wrap default to true
-#< frew> and if people wanna do that by hand they can
-
- 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;
}
sub prepare_install {
my $sqltargs = $self->sqltargs;
my $version = $schema->schema_version;
- unless( -d $dir ) {
- carp "Upgrade directory $dir does not exist, using ./\n";
- $dir = './';
- }
-
-
my $sqlt = SQL::Translator->new({
add_drop_table => 1,
ignore_constraint_names => 1,
ignore_index_names => 1,
parser => 'SQL::Translator::Parser::DBIx::Class',
- %{$sqltargs || {}}
+ %{$sqltargs}
});
- my $sqlt_schema = $sqlt->translate({ data => $schema })
- or $self->throw_exception ($sqlt->error);
+ 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_schema_out_filename($db, $version, $dir);
+ my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
if (-e $filename ) {
carp "Overwriting existing DDL file - $filename";
unlink $filename;
# 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;
$sqltargs = {
my $sqlt = SQL::Translator->new( $sqltargs );
$sqlt->parser('SQL::Translator::Parser::DBIx::Class');
- my $sqlt_schema = $sqlt->translate({ data => $schema })
+ my $sqlt_schema = $sqlt->translate( data => $schema )
or $self->throw_exception ($sqlt->error);
foreach my $db (@$databases) {
$sqlt->{schema} = $sqlt_schema;
$sqlt->producer($db);
- my $prefilename = $self->_ddl_schema_out_filename($db, $from_version, $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_schema_up_out_filename($db, $version_set, $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 up-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);
- my $filename = $self->_ddl_schema_out_filename($db, $to_version, $dir);
+ my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
my $out = $t->translate( $filename )
or $self->throw_exception ($t->error);
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 or carp("Can't open sql file, $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;
}
+# these are exactly the same for now
+sub _downgrade_single_step {
+ my $self = shift;
+ my @version_set = @{ shift @_ };
+ my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
+ $self->storage->sqlt_type,
+ \@version_set,
+ )};
+
+ for my $upgrade_file (@upgrade_files) {
+ unless (-f $upgrade_file) {
+ # croak?
+ carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
+ return;
+ }
+
+ $self->_filedata($self->_read_sql_file($upgrade_file)); # 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;
+ }
+}
+
sub _upgrade_single_step {
my $self = shift;
my @version_set = @{ shift @_ };
- my @upgrade_files = @{$self->_ddl_schema_up_in_filenames(
+ my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
$self->storage->sqlt_type,
\@version_set,
)};
}
$self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
- $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;
}
}
projects / dbsrgits/DBIx-Class-DeploymentHandler.git / blobdiff