X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-DeploymentHandler.git;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=e34a6b84aa5437df93a57c5b80dbc18f4299c297;hp=25d981ade07cac9fe02e980e4fc84ca69b89eb74;hb=57a30fa87043ef203551cc84797133cc88dd03bd;hpb=60e09fce2e152494cd2b9d6d771b8f0909e235e8 diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm index 25d981a..e34a6b8 100644 --- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm +++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm @@ -11,7 +11,6 @@ use Log::Contextual qw(:log :dlog), -package_logger => env_prefix => 'DBICDH' }); -use Method::Signatures::Simple; use Try::Tiny; use SQL::Translator; @@ -31,6 +30,12 @@ has ignore_ddl => ( default => undef, ); +has force_overwrite => ( + isa => 'Bool', + is => 'ro', + default => undef, +); + has schema => ( isa => 'DBIx::Class::Schema', is => 'ro', @@ -43,7 +48,8 @@ has storage => ( lazy_build => 1, ); -method _build_storage { +sub _build_storage { + my $self = shift; my $s = $self->schema->storage; $s->_determine_driver; $s @@ -83,15 +89,22 @@ has schema_version => ( # this will probably never get called as the DBICDH # will be passing down a schema_version normally, which # is built the same way, but we leave this in place -method _build_schema_version { $self->schema->schema_version } +sub _build_schema_version { + my $self = shift; + $self->schema->schema_version +} -method __ddl_consume_with_prefix($type, $versions, $prefix) { +sub __ddl_consume_with_prefix { + my ($self, $type, $versions, $prefix) = @_; my $base_dir = $self->script_directory; my $main = catfile( $base_dir, $type ); my $common = catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} ); + my $common_any = + catfile( $base_dir, '_common', $prefix, '_any' ); + my $dir; if (-d $main) { $dir = catfile($main, $prefix, join q(-), @{$versions}) @@ -102,6 +115,7 @@ method __ddl_consume_with_prefix($type, $versions, $prefix) { croak "$main does not exist; please write/generate some SQL" } } + my $dir_any = catfile($main, $prefix, '_any'); my %files; try { @@ -114,11 +128,11 @@ method __ddl_consume_with_prefix($type, $versions, $prefix) { } catch { die $_ unless $self->ignore_ddl; }; - if (-d $common) { - opendir my($dh), $common; - for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { + for my $dirname (grep { -d $_ } $common, $common_any, $dir_any) { + opendir my($dh), $dirname; + for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($dirname,$_) } readdir $dh) { unless ($files{$filename}) { - $files{$filename} = catfile($common,$filename); + $files{$filename} = catfile($dirname,$filename); } } closedir $dh; @@ -127,15 +141,32 @@ method __ddl_consume_with_prefix($type, $versions, $prefix) { return [@files{sort keys %files}] } -method _ddl_initialize_consume_filenames($type, $version) { +sub _ddl_initialize_consume_filenames { + my ($self, $type, $version) = @_; $self->__ddl_consume_with_prefix($type, [ $version ], 'initialize') } -method _ddl_schema_consume_filenames($type, $version) { +sub _ddl_schema_consume_filenames { + my ($self, $type, $version) = @_; $self->__ddl_consume_with_prefix($type, [ $version ], 'deploy') } -method _ddl_protoschema_upgrade_consume_filenames($versions) { +sub _ddl_protoschema_deploy_consume_filenames { + my ($self, $version) = @_; + my $base_dir = $self->script_directory; + + my $dir = catfile( $base_dir, '_source', 'deploy', $version); + return [] unless -d $dir; + + opendir my($dh), $dir; + my %files = map { $_ => "$dir/$_" } grep { /\.yml$/ && -f "$dir/$_" } readdir $dh; + closedir $dh; + + return [@files{sort keys %files}] +} + +sub _ddl_protoschema_upgrade_consume_filenames { + my ($self, $versions) = @_; my $base_dir = $self->script_directory; my $dir = catfile( $base_dir, '_preprocess_schema', 'upgrade', join q(-), @{$versions}); @@ -149,7 +180,8 @@ method _ddl_protoschema_upgrade_consume_filenames($versions) { return [@files{sort keys %files}] } -method _ddl_protoschema_downgrade_consume_filenames($versions) { +sub _ddl_protoschema_downgrade_consume_filenames { + my ($self, $versions) = @_; my $base_dir = $self->script_directory; my $dir = catfile( $base_dir, '_preprocess_schema', 'downgrade', join q(-), @{$versions}); @@ -163,29 +195,34 @@ method _ddl_protoschema_downgrade_consume_filenames($versions) { return [@files{sort keys %files}] } -method _ddl_protoschema_produce_filename($version) { +sub _ddl_protoschema_produce_filename { + my ($self, $version) = @_; my $dirname = catfile( $self->script_directory, '_source', 'deploy', $version ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, '001-auto.yml' ); } -method _ddl_schema_produce_filename($type, $version) { +sub _ddl_schema_produce_filename { + my ($self, $type, $version) = @_; my $dirname = catfile( $self->script_directory, $type, 'deploy', $version ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, '001-auto.sql' ); } -method _ddl_schema_upgrade_consume_filenames($type, $versions) { +sub _ddl_schema_upgrade_consume_filenames { + my ($self, $type, $versions) = @_; $self->__ddl_consume_with_prefix($type, $versions, 'upgrade') } -method _ddl_schema_downgrade_consume_filenames($type, $versions) { +sub _ddl_schema_downgrade_consume_filenames { + my ($self, $type, $versions) = @_; $self->__ddl_consume_with_prefix($type, $versions, 'downgrade') } -method _ddl_schema_upgrade_produce_filename($type, $versions) { +sub _ddl_schema_upgrade_produce_filename { + my ($self, $type, $versions) = @_; my $dir = $self->script_directory; my $dirname = catfile( $dir, $type, 'upgrade', join q(-), @{$versions}); @@ -194,23 +231,19 @@ method _ddl_schema_upgrade_produce_filename($type, $versions) { return catfile( $dirname, '001-auto.sql' ); } -method _ddl_schema_downgrade_produce_filename($type, $versions, $dir) { +sub _ddl_schema_downgrade_produce_filename { + my ($self, $type, $versions, $dir) = @_; my $dirname = catfile( $dir, $type, 'downgrade', join q(-), @{$versions} ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, '001-auto.sql'); } -method _run_sql_array($sql) { +sub _run_sql_array { + my ($self, $sql) = @_; my $storage = $self->storage; - $sql = [grep { - $_ && # remove blank lines - !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's - } map { - s/^\s+//; s/\s+$//; # trim whitespace - join '', grep { !/^--/ } split /\n/ # remove comments - } @$sql]; + $sql = [ _split_sql_chunk( @$sql ) ]; Dlog_trace { "Running SQL $_" } $sql; foreach my $line (@{$sql}) { @@ -227,12 +260,38 @@ method _run_sql_array($sql) { return join "\n", @$sql } -method _run_sql($filename) { +# split a chunk o' SQL into statements +sub _split_sql_chunk { + my @sql = map { split /;\n/, $_ } @_; + + for ( @sql ) { + # strip transactions + s/^(?:BEGIN|BEGIN TRANSACTION|COMMIT).*//mgi; + + # trim whitespaces + s/^\s+|\s+$//mg; + + # remove comments + s/^--.*//gm; + + # remove blank lines + s/^\n//mg; + + # put on single line + s/\n/ /g; + } + + return @sql; +} + +sub _run_sql { + my ($self, $filename) = @_; log_debug { "Running SQL from $filename" }; return $self->_run_sql_array($self->_read_sql_file($filename)); } -method _run_perl($filename) { +sub _run_perl { + my ($self, $filename, $versions) = @_; log_debug { "Running Perl from $filename" }; my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; @@ -242,15 +301,16 @@ method _run_perl($filename) { Dlog_trace { "Running Perl $_" } $fn; if ($@) { - carp "$filename failed to compile: $@"; + croak "$filename failed to compile: $@"; } elsif (ref $fn eq 'CODE') { - $fn->($self->schema) + $fn->($self->schema, $versions) } else { - carp "$filename should define an anonymouse sub that takes a schema but it didn't!"; + croak "$filename should define an anonymouse sub that takes a schema but it didn't!"; } } -method _run_sql_and_perl($filenames, $sql_to_run) { +sub _run_sql_and_perl { + my ($self, $filenames, $sql_to_run, $versions) = @_; my @files = @{$filenames}; my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; @@ -264,7 +324,7 @@ method _run_sql_and_perl($filenames, $sql_to_run) { } elsif ($filename =~ /\.sql$/) { $sql .= $self->_run_sql($filename) } elsif ( $filename =~ /\.pl$/ ) { - $self->_run_perl($filename) + $self->_run_perl($filename, $versions) } else { croak "A file ($filename) got to deploy that wasn't sql or perl!"; } @@ -283,13 +343,13 @@ sub deploy { my $sql; if ($self->ignore_ddl) { $sql = $self->_sql_from_yaml({}, - '_ddl_protoschema_produce_filename', $sqlt_type + '_ddl_protoschema_deploy_consume_filenames', $sqlt_type ); } return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( $sqlt_type, $version, - ), $sql); + ), $sql, [$version]); } sub initialize { @@ -314,11 +374,11 @@ sub initialize { use warnings; if ($@) { - carp "$filename failed to compile: $@"; + croak "$filename failed to compile: $@"; } elsif (ref $fn eq 'CODE') { $fn->() } else { - carp "$filename should define an anonymous sub but it didn't!"; + croak "$filename should define an anonymous sub but it didn't!"; } } else { croak "A file ($filename) got to initialize_scripts that wasn't sql or perl!"; @@ -326,7 +386,8 @@ sub initialize { } } -method _sqldiff_from_yaml($from_version, $to_version, $db, $direction) { +sub _sqldiff_from_yaml { + my ($self, $from_version, $to_version, $db, $direction) = @_; my $dir = $self->script_directory; my $sqltargs = { add_drop_table => 1, @@ -396,23 +457,30 @@ method _sqldiff_from_yaml($from_version, $to_version, $db, $direction) { )]; } -method _sql_from_yaml($sqltargs, $from_file, $db) { +sub _sql_from_yaml { + my ($self, $sqltargs, $from_file, $db) = @_; my $schema = $self->schema; my $version = $self->schema_version; - my $sqlt = SQL::Translator->new({ - add_drop_table => 0, - parser => 'SQL::Translator::Parser::YAML', - %{$sqltargs}, - producer => $db, - }); - - my $yaml_filename = $self->$from_file($version); + my @sql; - my @sql = $sqlt->translate($yaml_filename); - if(!@sql) { - carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); - return undef; + my $actual_file = $self->$from_file($version); + for my $yaml_filename (@{ + DlogS_trace { "generating SQL from Serialized SQL Files: $_" } + (ref $actual_file?$actual_file:[$actual_file]) + }) { + my $sqlt = SQL::Translator->new({ + add_drop_table => 0, + parser => 'SQL::Translator::Parser::YAML', + %{$sqltargs}, + producer => $db, + }); + + push @sql, $sqlt->translate($yaml_filename); + if(!@sql) { + carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); + return undef; + } } return \@sql; } @@ -431,8 +499,12 @@ sub _prepare_install { my $filename = $self->$to_file($db, $version, $dir); if (-e $filename ) { - carp "Overwriting existing DDL file - $filename"; - unlink $filename; + if ($self->force_overwrite) { + carp "Overwriting existing DDL file - $filename"; + unlink $filename; + } else { + die "Cannot overwrite '$filename', either enable force_overwrite or delete it" + } } open my $file, q(>), $filename; print {$file} join ";\n", @$sql; @@ -455,7 +527,7 @@ sub _resultsource_protoschema_filename { my ($self, $source_name) = @_; return sub { my ($self, $version) = @_; - my $dirname = catfile( $self->script_directory, '_source', $version ); + my $dirname = catfile( $self->script_directory, '_source', 'deploy', $version ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, "001-auto-$source_name.yml" ); @@ -464,8 +536,10 @@ sub _resultsource_protoschema_filename { sub install_resultsource { my ($self, $args) = @_; - my $source = $args->{result_source}; - my $version = $args->{version}; + my $source = $args->{result_source} + or die 'result_source must be passed to install_resultsource'; + my $version = $args->{version} + or die 'version must be passed to install_resultsource'; log_info { 'installing_resultsource ' . $source->source_name . ", version $version" }; my $rs_install_file = $self->_resultsource_install_filename($source->source_name); @@ -476,7 +550,7 @@ sub install_resultsource { $version, ) ]; - $self->_run_sql_and_perl($files); + $self->_run_sql_and_perl($files, '', [$version]); } sub prepare_resultsource_install { @@ -495,7 +569,10 @@ sub prepare_resultsource_install { sub prepare_deploy { log_info { 'preparing deploy' }; my $self = shift; - $self->prepare_protoschema({}, '_ddl_protoschema_produce_filename'); + $self->prepare_protoschema({ + # Exclude __VERSION so that it gets installed separately + parser_args => { sources => [grep { $_ ne '__VERSION' } $self->schema->sources], } + }, '_ddl_protoschema_produce_filename'); $self->_prepare_install({}, '_ddl_protoschema_produce_filename', '_ddl_schema_produce_filename'); } @@ -519,12 +596,14 @@ sub prepare_downgrade { ); } -method _coderefs_per_files($files) { +sub _coderefs_per_files { + my ($self, $files) = @_; no warnings 'redefine'; [map eval do { local( @ARGV, $/ ) = $_; <> }, @$files] } -method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { +sub _prepare_changegrade { + my ($self, $from_version, $to_version, $version_set, $direction) = @_; my $schema = $self->schema; my $databases = $self->databases; my $dir = $self->script_directory; @@ -534,8 +613,12 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction foreach my $db (@$databases) { my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); if(-e $diff_file) { - carp("Overwriting existing $direction-diff file - $diff_file"); - unlink $diff_file; + if ($self->force_overwrite) { + carp("Overwriting existing $direction-diff file - $diff_file"); + unlink $diff_file; + } else { + die "Cannot overwrite '$diff_file', either enable force_overwrite or delete it" + } } open my $file, q(>), $diff_file; @@ -544,22 +627,14 @@ method _prepare_changegrade($from_version, $to_version, $version_set, $direction } } -method _read_sql_file($file) { +sub _read_sql_file { + my ($self, $file) = @_; return unless $file; - open my $fh, '<', $file; - my @data = split /;\n/, join '', <$fh>; - close $fh; - - @data = grep { - $_ && # remove blank lines - !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's - } map { - s/^\s+//; s/\s+$//; # trim whitespace - join '', grep { !/^--/ } split /\n/ # remove comments - } @data; + local $/ = undef; #sluuuuuurp - return \@data; + open my $fh, '<', $file; + return [ _split_sql_chunk( <$fh> ) ]; } sub downgrade_single_step { @@ -577,7 +652,7 @@ sub downgrade_single_step { my $sql = $self->_run_sql_and_perl($self->_ddl_schema_downgrade_consume_filenames( $sqlt_type, $version_set, - ), $sql_to_run); + ), $sql_to_run, $version_set); return ['', $sql]; } @@ -597,7 +672,7 @@ sub upgrade_single_step { my $sql = $self->_run_sql_and_perl($self->_ddl_schema_upgrade_consume_filenames( $sqlt_type, $version_set, - ), $sql_to_run); + ), $sql_to_run, $version_set); return ['', $sql]; } @@ -623,8 +698,12 @@ sub prepare_protoschema { unless $yml; if (-e $filename ) { - carp "Overwriting existing DDL-YML file - $filename"; - unlink $filename; + if ($self->force_overwrite) { + carp "Overwriting existing DDL-YML file - $filename"; + unlink $filename; + } else { + die "Cannot overwrite '$filename', either enable force_overwrite or delete it" + } } open my $file, q(>), $filename; @@ -687,7 +766,9 @@ the following example: | | `- 002-remove-customers.pl | `- upgrade | `- 1-2 - | `- 002-generate-customers.pl + | | `- 002-generate-customers.pl + | `- _any + | `- 999-bump-action.pl `- MySQL |- downgrade | `- 2-1 @@ -713,7 +794,9 @@ C<$sql_migration_dir/SQLite/deploy/1/001-auto.sql>. Next, $dm->upgrade_single_step([1,2]) would run C<$sql_migration_dir/SQLite/upgrade/1-2/001-auto.sql> followed by -C<$sql_migration_dir/_common/upgrade/1-2/002-generate-customers.pl>. +C<$sql_migration_dir/_common/upgrade/1-2/002-generate-customers.pl>, and +finally punctuated by +C<$sql_migration_dir/_common/upgrade/_any/999-bump-action.pl>. C<.pl> files don't have to be in the C<_common> directory, but most of the time they should be, because perl scripts are generally database independent. @@ -764,7 +847,7 @@ L objects. your storage type is. If you are not sure what your storage type is, take a look at the producers listed for L. Also note, C<_common> is a special case. C<_common> will get merged into whatever other files you -already have. This directory can containt the following directories itself: +already have. This directory can contain the following directories itself: =over 2 @@ -796,10 +879,17 @@ to L. =back +Note that there can be an C<_any> in the place of any of the versions (like +C<1-2> or C<1>), which means those scripts will be run B time. So if +you have an C<_any> in C<_common/upgrade>, that script will get run for every +upgrade. + =head1 PERL SCRIPTS A perl script for this tool is very simple. It merely needs to contain an -anonymous sub that takes a L as it's only argument. +anonymous sub that takes a L and the version set as it's +arguments. + A very basic perl script might look like: #!perl @@ -807,14 +897,25 @@ A very basic perl script might look like: use strict; use warnings; - sub { + use DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::ScriptHelpers + 'schema_from_schema_loader'; + + schema_from_schema_loader({ naming => 'v4' }, sub { my $schema = shift; + # [1] for deploy, [1,2] for upgrade or downgrade, probably used with _any + my $versions = shift; + $schema->resultset('Users')->create({ name => 'root', password => 'root', }) - } + }) + +Note that the above uses +L. +Using a raw coderef is strongly discouraged as it is likely to break as you +modify your schema. =attr ignore_ddl @@ -824,6 +925,12 @@ instead of any pregenerated SQL. If you have a development server this is probably the best plan of action as you will not be putting as many generated files in your version control. Goes well with with C of C<[]>. +=attr force_overwrite + +When this attribute is true generated files will be overwritten when the +methods which create such files are run again. The default is false, in which +case the program will die with a message saying which file needs to be deleted. + =attr schema The L (B) that is used to talk to the database