X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=2cd469ef11cd21ac424d482f27eecee25f08a737;hb=39c88a9a837c14a58334d8977879534e2cafc2c8;hp=ed05b01f70b77e302321839037a752e9f6d63f72;hpb=1f0d0633940a59386e5c0ebec602d0650a3694ed;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm index ed05b01..2cd469e 100644 --- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm +++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm @@ -5,11 +5,11 @@ use Moose; use autodie; use Carp qw( carp croak ); -use Log::Contextual::WarnLogger; -use Log::Contextual qw(:log :dlog), -default_logger => Log::Contextual::WarnLogger->new({ - env_prefix => 'DBICDH' -}); -use Data::Dumper::Concise; +use DBIx::Class::DeploymentHandler::Logger; +use Log::Contextual qw(:log :dlog), -default_logger => + DBIx::Class::DeploymentHandler::Logger->new({ + env_prefix => 'DBICDH' + }); use Method::Signatures::Simple; use Try::Tiny; @@ -25,6 +25,12 @@ use File::Spec::Functions; with 'DBIx::Class::DeploymentHandler::HandlesDeploy'; +has ignore_ddl => ( + isa => 'Bool', + is => 'ro', + default => undef, +); + has schema => ( isa => 'DBIx::Class::Schema', is => 'ro', @@ -79,34 +85,35 @@ has schema_version => ( # is built the same way, but we leave this in place method _build_schema_version { $self->schema->schema_version } -has _json => ( - is => 'ro', - lazy_build => 1, -); - -sub _build__json { require JSON; JSON->new->pretty } - method __ddl_consume_with_prefix($type, $versions, $prefix) { my $base_dir = $self->script_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"; + if ($self->ignore_ddl) { + return [] + } else { + croak "$main does not exist; please write/generate some SQL" + } } - opendir my($dh), $dir; - my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl|sql-\w+)$/ && -f "$dir/$_" } readdir $dh; - closedir $dh; - + my %files; + try { + opendir my($dh), $dir; + %files = + map { $_ => "$dir/$_" } + grep { /\.(?:sql|pl|sql-\w+)$/ && -f "$dir/$_" } + readdir $dh; + closedir $dh; + } catch { + die $_ unless $self->ignore_ddl; + }; if (-d $common) { opendir my($dh), $common; for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { @@ -125,38 +132,73 @@ method _ddl_preinstall_consume_filenames($type, $version) { } method _ddl_schema_consume_filenames($type, $version) { - $self->__ddl_consume_with_prefix($type, [ $version ], 'schema') + $self->__ddl_consume_with_prefix($type, [ $version ], 'deploy') +} + +method _ddl_protoschema_upgrade_consume_filenames($versions) { + my $base_dir = $self->script_directory; + + my $dir = catfile( $base_dir, '_preprocess_schema', 'upgrade', join q(-), @{$versions}); + + return [] unless -d $dir; + + opendir my($dh), $dir; + my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh; + closedir $dh; + + return [@files{sort keys %files}] +} + +method _ddl_protoschema_downgrade_consume_filenames($versions) { + my $base_dir = $self->script_directory; + + my $dir = catfile( $base_dir, '_preprocess_schema', 'downgrade', join q(-), @{$versions}); + + return [] unless -d $dir; + + opendir my($dh), $dir; + my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh; + closedir $dh; + + return [@files{sort keys %files}] +} + +method _ddl_protoschema_produce_filename($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) { - my $dirname = catfile( $self->script_directory, $type, 'schema', $version ); + my $dirname = catfile( $self->script_directory, $type, 'deploy', $version ); mkpath($dirname) unless -d $dirname; - return catfile( $dirname, '001-auto.sql-json' ); + 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_upgrade_consume_filenames($type, $versions) { + $self->__ddl_consume_with_prefix($type, $versions, 'upgrade') } -method _ddl_schema_down_consume_filenames($type, $versions) { - $self->__ddl_consume_with_prefix($type, $versions, 'down') +method _ddl_schema_downgrade_consume_filenames($type, $versions) { + $self->__ddl_consume_with_prefix($type, $versions, 'downgrade') } -method _ddl_schema_up_produce_filename($type, $versions) { +method _ddl_schema_upgrade_produce_filename($type, $versions) { my $dir = $self->script_directory; - my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions}); + my $dirname = catfile( $dir, $type, 'upgrade', join q(-), @{$versions}); mkpath($dirname) unless -d $dirname; - return catfile( $dirname, '001-auto.sql-json' ); + return catfile( $dirname, '001-auto.sql' ); } -method _ddl_schema_down_produce_filename($type, $versions, $dir) { - my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} ); +method _ddl_schema_downgrade_produce_filename($type, $versions, $dir) { + my $dirname = catfile( $dir, $type, 'downgrade', join q(-), @{$versions} ); mkpath($dirname) unless -d $dirname; - return catfile( $dirname, '001-auto.sql-json'); + return catfile( $dirname, '001-auto.sql'); } method _run_sql_array($sql) { @@ -170,16 +212,15 @@ method _run_sql_array($sql) { join '', grep { !/^--/ } split /\n/ # remove comments } @$sql]; - log_trace { '[DBICDH] Running SQL ' . Dumper($sql) }; + Dlog_trace { "Running SQL $_" } $sql; foreach my $line (@{$sql}) { $storage->_query_start($line); + # the whole reason we do this is so that we can see the line that was run 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}')" + die "$_ (running line '$line')" } $storage->_query_end($line); } @@ -187,18 +228,18 @@ method _run_sql_array($sql) { } method _run_sql($filename) { - log_debug { "[DBICDH] Running SQL from $filename" }; + log_debug { "Running SQL from $filename" }; return $self->_run_sql_array($self->_read_sql_file($filename)); } method _run_perl($filename) { - log_debug { "[DBICDH] Running Perl from $filename" }; + log_debug { "Running Perl from $filename" }; my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; no warnings 'redefine'; my $fn = eval "$filedata"; use warnings; - log_trace { '[DBICDH] Running Perl ' . Dumper($fn) }; + Dlog_trace { "Running Perl $_" } $fn; if ($@) { carp "$filename failed to compile: $@"; @@ -209,26 +250,19 @@ method _run_perl($filename) { } } -method _run_serialized_sql($filename, $type) { - if (lc $type eq 'json') { - return $self->_run_sql_array($self->_json->decode( - do { local( @ARGV, $/ ) = $filename; <> } # slurp - )) - } else { - croak "$type is not one of the supported serialzed types" - } -} - -method _run_sql_and_perl($filenames) { +method _run_sql_and_perl($filenames, $sql_to_run) { my @files = @{$filenames}; my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; - my $sql = ''; + $self->_run_sql_array($sql_to_run) if $self->ignore_ddl; + + my $sql = ($sql_to_run)?join ";\n", @$sql_to_run:''; + FILENAME: for my $filename (@files) { - if ($filename =~ /\.sql$/) { + if ($self->ignore_ddl && $filename =~ /^[^_]*-auto.*\.sql$/) { + next FILENAME + } elsif ($filename =~ /\.sql$/) { $sql .= $self->_run_sql($filename) - } elsif ( $filename =~ /\.sql-(\w+)$/ ) { - $sql .= $self->_run_serialized_sql($filename, $1) } elsif ( $filename =~ /\.pl$/ ) { $self->_run_perl($filename) } else { @@ -244,19 +278,25 @@ method _run_sql_and_perl($filenames) { sub deploy { my $self = shift; my $version = (shift @_ || {})->{version} || $self->schema_version; - log_info { "[DBICDH] deploying version $version" }; - + log_info { "deploying version $version" }; + my $sqlt_type = $self->storage->sqlt_type; + my $sql; + if ($self->ignore_ddl) { + $sql = $self->_sql_from_yaml({}, + '_ddl_protoschema_produce_filename', $sqlt_type + ); + } return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( - $self->storage->sqlt_type, + $sqlt_type, $version, - )); + ), $sql); } sub preinstall { my $self = shift; my $args = shift; my $version = $args->{version} || $self->schema_version; - log_info { "[DBICDH] preinstalling version $version" }; + log_info { "preinstalling version $version" }; my $storage_type = $args->{storage_type} || $self->storage->sqlt_type; my @files = @{$self->_ddl_preinstall_consume_filenames( @@ -286,62 +326,139 @@ sub preinstall { } } -sub _prepare_install { - my $self = shift; - my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} }; - my $to_file = shift; - my $schema = $self->schema; - my $databases = $self->databases; +method _sqldiff_from_yaml($from_version, $to_version, $db, $direction) { my $dir = $self->script_directory; + my $sqltargs = { + add_drop_table => 1, + ignore_constraint_names => 1, + ignore_index_names => 1, + %{$self->sql_translator_args} + }; + + my $source_schema; + { + my $prefilename = $self->_ddl_protoschema_produce_filename($from_version, $dir); + + # should probably be a croak + carp("No previous schema file found ($prefilename)") + unless -e $prefilename; + + my $t = SQL::Translator->new({ + %{$sqltargs}, + debug => 0, + trace => 0, + parser => 'SQL::Translator::Parser::YAML', + }); + + my $out = $t->translate( $prefilename ) + or croak($t->error); + + $source_schema = $t->schema; + + $source_schema->name( $prefilename ) + unless $source_schema->name; + } + + my $dest_schema; + { + my $filename = $self->_ddl_protoschema_produce_filename($to_version, $dir); + + # should probably be a croak + carp("No next schema file found ($filename)") + unless -e $filename; + + my $t = SQL::Translator->new({ + %{$sqltargs}, + debug => 0, + trace => 0, + parser => 'SQL::Translator::Parser::YAML', + }); + + my $out = $t->translate( $filename ) + or croak($t->error); + + $dest_schema = $t->schema; + + $dest_schema->name( $filename ) + unless $dest_schema->name; + } + + my $transform_files_method = "_ddl_protoschema_${direction}_consume_filenames"; + my $transforms = $self->_coderefs_per_files( + $self->$transform_files_method([$from_version, $to_version]) + ); + $_->($source_schema, $dest_schema) for @$transforms; + + return [SQL::Translator::Diff::schema_diff( + $source_schema, $db, + $dest_schema, $db, + $sqltargs + )]; +} + +method _sql_from_yaml($sqltargs, $from_file, $db) { + my $schema = $self->schema; my $version = $self->schema_version; my $sqlt = SQL::Translator->new({ - no_comments => 1, - add_drop_table => 1, - ignore_constraint_names => 1, - ignore_index_names => 1, - parser => 'SQL::Translator::Parser::DBIx::Class', - %{$sqltargs} + add_drop_table => 0, + parser => 'SQL::Translator::Parser::YAML', + %{$sqltargs}, + producer => $db, }); - my $sqlt_schema = $sqlt->translate( data => $schema ) - or croak($sqlt->error); + my $yaml_filename = $self->$from_file($version); + + my @sql = $sqlt->translate($yaml_filename); + if(!@sql) { + carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); + return undef; + } + return \@sql; +} + +sub _prepare_install { + my $self = shift; + my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} }; + my $from_file = shift; + my $to_file = shift; + my $dir = $self->script_directory; + my $databases = $self->databases; + my $version = $self->schema_version; foreach my $db (@$databases) { - $sqlt->reset; - $sqlt->{schema} = $sqlt_schema; - $sqlt->producer($db); + my $sql = $self->_sql_from_yaml($sqltargs, $from_file, $db ) or next; my $filename = $self->$to_file($db, $version, $dir); if (-e $filename ) { carp "Overwriting existing DDL file - $filename"; unlink $filename; } - - my $sql = $self->_generate_final_sql($sqlt); - if(!$sql) { - carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); - next; - } open my $file, q(>), $filename; - print {$file} $sql; + print {$file} join ";\n", @$sql; close $file; } } -method _generate_final_sql($sqlt) { - my @output = $sqlt->translate; - $self->_json->encode(\@output); -} - sub _resultsource_install_filename { my ($self, $source_name) = @_; return sub { my ($self, $type, $version) = @_; - my $dirname = catfile( $self->script_directory, $type, 'schema', $version ); + my $dirname = catfile( $self->script_directory, $type, 'deploy', $version ); + mkpath($dirname) unless -d $dirname; + + return catfile( $dirname, "001-auto-$source_name.sql" ); + } +} + +sub _resultsource_protoschema_filename { + my ($self, $source_name) = @_; + return sub { + my ($self, $version) = @_; + my $dirname = catfile( $self->script_directory, '_source', $version ); mkpath($dirname) unless -d $dirname; - return catfile( $dirname, "001-auto-$source_name.sql-json" ); + return catfile( $dirname, "001-auto-$source_name.yml" ); } } @@ -349,7 +466,7 @@ sub install_resultsource { my ($self, $args) = @_; my $source = $args->{result_source}; my $version = $args->{version}; - log_info { '[DBICDH] installing_resultsource ' . $source->source_name . ", version $version" }; + log_info { 'installing_resultsource ' . $source->source_name . ", version $version" }; my $rs_install_file = $self->_resultsource_install_filename($source->source_name); @@ -365,145 +482,68 @@ sub install_resultsource { sub prepare_resultsource_install { my $self = shift; my $source = (shift @_)->{result_source}; - log_info { '[DBICDH] preparing install for resultsource ' . $source->source_name }; + log_info { 'preparing install for resultsource ' . $source->source_name }; - my $filename = $self->_resultsource_install_filename($source->source_name); - $self->_prepare_install({ + my $install_filename = $self->_resultsource_install_filename($source->source_name); + my $proto_filename = $self->_resultsource_protoschema_filename($source->source_name); + $self->prepare_protoschema({ parser_args => { sources => [$source->source_name], } - }, $filename); + }, $proto_filename); + $self->_prepare_install({}, $proto_filename, $install_filename); } sub prepare_deploy { - log_info { '[DBICDH] preparing deploy' }; + log_info { 'preparing deploy' }; my $self = shift; - $self->_prepare_install({}, '_ddl_schema_produce_filename'); + $self->prepare_protoschema({}, '_ddl_protoschema_produce_filename'); + $self->_prepare_install({}, '_ddl_protoschema_produce_filename', '_ddl_schema_produce_filename'); } sub prepare_upgrade { my ($self, $args) = @_; log_info { - '[DBICDH] preparing upgrade ' . - "from $args->{from_version} to $args->{to_version}" + "preparing upgrade from $args->{from_version} to $args->{to_version}" }; $self->_prepare_changegrade( - $args->{from_version}, $args->{to_version}, $args->{version_set}, 'up' + $args->{from_version}, $args->{to_version}, $args->{version_set}, 'upgrade' ); } sub prepare_downgrade { my ($self, $args) = @_; log_info { - '[DBICDH] preparing downgrade ' . - "from $args->{from_version} to $args->{to_version}" + "preparing downgrade from $args->{from_version} to $args->{to_version}" }; $self->_prepare_changegrade( - $args->{from_version}, $args->{to_version}, $args->{version_set}, 'down' + $args->{from_version}, $args->{to_version}, $args->{version_set}, 'downgrade' ); } +method _coderefs_per_files($files) { + no warnings 'redefine'; + [map eval do { local( @ARGV, $/ ) = $_; <> }, @$files] +} + method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { my $schema = $self->schema; my $databases = $self->databases; my $dir = $self->script_directory; - my $sqltargs = $self->sql_translator_args; my $schema_version = $self->schema_version; - - $sqltargs = { - add_drop_table => 1, - no_comments => 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 croak($sqlt->error); - + my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; foreach my $db (@$databases) { - $sqlt->reset; - $sqlt->{schema} = $sqlt_schema; - $sqlt->producer($db); - - 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_method = "_ddl_schema_${direction}_produce_filename"; 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; } - my $source_schema; - { - my $t = SQL::Translator->new({ - %{$sqltargs}, - debug => 0, - trace => 0, - }); - - $t->parser( $db ) # could this really throw an exception? - or croak($t->error); - - my $sql = $self->_default_read_sql_file_as_string($prefilename); - my $out = $t->translate( \$sql ) - or croak($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 croak($t->error); - - my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir); - my $sql = $self->_default_read_sql_file_as_string($filename); - my $out = $t->translate( \$sql ) - or croak($t->error); - - $dest_schema = $t->schema; - - $dest_schema->name( $filename ) - unless $dest_schema->name; - } - open my $file, q(>), $diff_file; - print {$file} - $self->_generate_final_diff($source_schema, $dest_schema, $db, $sqltargs); + print {$file} join ";\n", @{$self->_sqldiff_from_yaml($from_version, $to_version, $db, $direction)}; close $file; } } -method _generate_final_diff($source_schema, $dest_schema, $db, $sqltargs) { - $self->_json->encode([ - SQL::Translator::Diff::schema_diff( - $source_schema, $db, - $dest_schema, $db, - $sqltargs - ) - ]) -} - method _read_sql_file($file) { return unless $file; @@ -511,24 +551,33 @@ method _read_sql_file($file) { my @data = split /;\n/, join '', <$fh>; close $fh; - return \@data; -} + @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; -method _default_read_sql_file_as_string($file) { - return join q(), map "$_;\n", @{$self->_json->decode( - do { local( @ARGV, $/ ) = $file; <> } # slurp - )}; + return \@data; } sub downgrade_single_step { my $self = shift; my $version_set = (shift @_)->{version_set}; - log_info { qq([DBICDH] downgrade_single_step'ing ) . Dumper($version_set) }; - - my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames( - $self->storage->sqlt_type, + Dlog_info { "downgrade_single_step'ing $_" } $version_set; + + my $sqlt_type = $self->storage->sqlt_type; + my $sql_to_run; + if ($self->ignore_ddl) { + $sql_to_run = $self->_sqldiff_from_yaml( + $version_set->[0], $version_set->[1], $sqlt_type, 'downgrade', + ); + } + my $sql = $self->_run_sql_and_perl($self->_ddl_schema_downgrade_consume_filenames( + $sqlt_type, $version_set, - )); + ), $sql_to_run); return ['', $sql]; } @@ -536,15 +585,53 @@ sub downgrade_single_step { sub upgrade_single_step { my $self = shift; my $version_set = (shift @_)->{version_set}; - log_info { qq([DBICDH] upgrade_single_step'ing ) . Dumper($version_set) }; - - my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames( - $self->storage->sqlt_type, + Dlog_info { "upgrade_single_step'ing $_" } $version_set; + + my $sqlt_type = $self->storage->sqlt_type; + my $sql_to_run; + if ($self->ignore_ddl) { + $sql_to_run = $self->_sqldiff_from_yaml( + $version_set->[0], $version_set->[1], $sqlt_type, 'upgrade', + ); + } + my $sql = $self->_run_sql_and_perl($self->_ddl_schema_upgrade_consume_filenames( + $sqlt_type, $version_set, - )); + ), $sql_to_run); return ['', $sql]; } +sub prepare_protoschema { + my $self = shift; + my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} }; + my $to_file = shift; + my $filename + = $self->$to_file($self->schema_version); + + # we do this because the code that uses this sets parser args, + # so we just need to merge in the package + $sqltargs->{parser_args}{package} = $self->schema; + my $sqlt = SQL::Translator->new({ + parser => 'SQL::Translator::Parser::DBIx::Class', + producer => 'SQL::Translator::Producer::YAML', + %{ $sqltargs }, + }); + + my $yml = $sqlt->translate; + + croak("Failed to translate to YAML: " . $sqlt->error) + unless $yml; + + if (-e $filename ) { + carp "Overwriting existing DDL-YML file - $filename"; + unlink $filename; + } + + open my $file, q(>), $filename; + print {$file} $yml; + close $file; +} + __PACKAGE__->meta->make_immutable; 1; @@ -555,66 +642,64 @@ __END__ =head1 DESCRIPTION -This class is the meat of L. It takes care of -generating sql files representing schemata as well as sql files to move from -one version of a schema to the rest. One of the hallmark features of this -class is that it allows for multiple sql files for deploy and upgrade, allowing -developers to fine tune deployment. In addition it also allows for perl files -to be run at any stage of the process. +This class is the meat of L. It takes care +of generating serialized schemata as well as sql files to move from one +version of a schema to the rest. One of the hallmark features of this class +is that it allows for multiple sql files for deploy and upgrade, allowing +developers to fine tune deployment. In addition it also allows for perl +files to be run at any stage of the process. For basic usage see L. What's documented here is extra fun stuff or private methods. =head1 DIRECTORY LAYOUT -Arguably this is the best feature of L. It's -heavily based upon L, but has some extensions and -modifications, so even if you are familiar with it, please read this. I feel -like the best way to describe the layout is with the following example: +Arguably this is the best feature of L. +It's spiritually based upon L, but has a +lot of extensions and modifications, so even if you are familiar with it, +please read this. I feel like the best way to describe the layout is with +the following example: $sql_migration_dir + |- _source + | |- deploy + | |- 1 + | | `- 001-auto.yml + | |- 2 + | | `- 001-auto.yml + | `- 3 + | `- 001-auto.yml |- SQLite - | |- down + | |- downgrade | | `- 2-1 | | `- 001-auto.sql - | |- schema + | |- deploy | | `- 1 | | `- 001-auto.sql - | `- up + | `- upgrade | |- 1-2 | | `- 001-auto.sql | `- 2-3 | `- 001-auto.sql |- _common - | |- down + | |- downgrade | | `- 2-1 | | `- 002-remove-customers.pl - | `- up + | `- upgrade | `- 1-2 | `- 002-generate-customers.pl - |- _generic - | |- down - | | `- 2-1 - | | `- 001-auto.sql - | |- schema - | | `- 1 - | | `- 001-auto.sql - | `- up - | `- 1-2 - | |- 001-auto.sql - | `- 002-create-stored-procedures.sql `- MySQL - |- down + |- downgrade | `- 2-1 | `- 001-auto.sql |- preinstall | `- 1 | |- 001-create_database.pl | `- 002-create_users_and_permissions.pl - |- schema + |- deploy | `- 1 | `- 001-auto.sql - `- up + `- upgrade `- 1-2 `- 001-auto.sql @@ -623,19 +708,15 @@ So basically, the code $dm->deploy(1) on an C database that would simply run -C<$sql_migration_dir/SQLite/schema/1/001-auto.sql>. Next, +C<$sql_migration_dir/SQLite/deploy/1/001-auto.sql>. Next, $dm->upgrade_single_step([1,2]) -would run C<$sql_migration_dir/SQLite/up/1-2/001-auto.sql> followed by -C<$sql_migration_dir/_common/up/1-2/002-generate-customers.pl>. - -Now, a C<.pl> file doesn't have to be in the C<_common> directory, but most of -the time it probably should be, since perl scripts will mostly be database -independent. +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<_generic> exists for when you for some reason are sure that your SQL is -generic enough to run on all databases. Good luck with that one. +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. Note that unlike most steps in the process, C will not run SQL, as there may not even be an database at preinstall time. It will run perl scripts @@ -644,6 +725,77 @@ Until people have used this more it will remain freeform, but a recommended use of preinstall is to have it prompt for username and password, and then call the appropriate C<< CREATE DATABASE >> commands etc. +=head2 Directory Specification + +The following subdirectories are recognized by this DeployMethod: + +=over 2 + +=item C<_source> This directory can contain the following directories: + +=over 2 + +=item C This directory merely contains directories named after schema +versions, which in turn contain C files that are serialized versions +of the schema at that version. These files are not for editing by hand. + +=back + +=item C<_preprocess_schema> This directory can contain the following +directories: + +=over 2 + +=item C This directory merely contains directories named after +migrations, which are of the form C<$from_version-$to_version>. Inside of +these directories you may put Perl scripts which are to return a subref +that takes the arguments C<< $from_schema, $to_schema >>, which are +L objects. + +=item C This directory merely contains directories named after +migrations, which are of the form C<$from_version-$to_version>. Inside of +these directories you may put Perl scripts which are to return a subref +that takes the arguments C<< $from_schema, $to_schema >>, which are +L objects. + +=back + +=item C<$storage_type> This is a set of scripts that gets run depending on what +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: + +=over 2 + +=item C Gets run before the C is Ced. Has the +same structure as the C subdirectory as well; that is, it has a +directory for each schema version. Unlike C, C, and C +though, it can only run C<.pl> files, and the coderef in the perl files get +no arguments passed to them. + +=item C Gets run when the schema is Ced. Structure is a +directory per schema version, and then files are merged with C<_common> and run +in filename order. C<.sql> files are merely run, as expected. C<.pl> files are +run according to L. + +=item C Gets run when the schema is Cd. Structure is a directory +per upgrade step, (for example, C<1-2> for upgrading from version 1 to version +2,) and then files are merged with C<_common> and run in filename order. +C<.sql> files are merely run, as expected. C<.pl> files are run according +to L. + +=item C Gets run when the schema is Cd. Structure is a directory +per downgrade step, (for example, C<2-1> for downgrading from version 2 to version +1,) and then files are merged with C<_common> and run in filename order. +C<.sql> files are merely run, as expected. C<.pl> files are run according +to L. + + +=back + +=back + =head1 PERL SCRIPTS A perl script for this tool is very simple. It merely needs to contain an @@ -664,6 +816,14 @@ A very basic perl script might look like: }) } +=attr ignore_ddl + +This attribute will, when set to true (default is false), cause the DM to use +L to use the C<_source>'s serialized SQL::Translator::Schema +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 schema The L (B) that is used to talk to the database @@ -696,98 +856,3 @@ transaction. The version the schema on your harddrive is at. Defaults to C<< $self->schema->schema_version >>. - -=begin comment - -=head2 __ddl_consume_with_prefix - - $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' ) - -This is the meat of the multi-file upgrade/deploy stuff. It returns a list of -files in the order that they should be run for a generic "type" of upgrade. -You should not be calling this in user code. - -=head2 _ddl_schema_consume_filenames - - $dm->__ddl_schema_consume_filenames( 'SQLite', [qw( 1.00 )] ) - -Just a curried L. Get's a list of files for an -initial deploy. - -=head2 _ddl_schema_produce_filename - - $dm->__ddl_schema_produce_filename( 'SQLite', [qw( 1.00 )] ) - -Returns a single file in which an initial schema will be stored. - -=head2 _ddl_schema_up_consume_filenames - - $dm->_ddl_schema_up_consume_filenames( 'SQLite', [qw( 1.00 )] ) - -Just a curried L. Get's a list of files for an -upgrade. - -=head2 _ddl_schema_down_consume_filenames - - $dm->_ddl_schema_down_consume_filenames( 'SQLite', [qw( 1.00 )] ) - -Just a curried L. Get's a list of files for a -downgrade. - -=head2 _ddl_schema_up_produce_filenames - - $dm->_ddl_schema_up_produce_filename( 'SQLite', [qw( 1.00 1.01 )] ) - -Returns a single file in which the sql to upgrade from one schema to another -will be stored. - -=head2 _ddl_schema_down_produce_filename - - $dm->_ddl_schema_down_produce_filename( 'SQLite', [qw( 1.00 1.01 )] ) - -Returns a single file in which the sql to downgrade from one schema to another -will be stored. - -=head2 _resultsource_install_filename - - my $filename_fn = $dm->_resultsource_install_filename('User'); - $dm->$filename_fn('SQLite', '1.00') - -Returns a function which in turn returns a single filename used to install a -single resultsource. Weird interface is convenient for me. Deal with it. - -=head2 _run_sql_and_perl - - $dm->_run_sql_and_perl([qw( list of filenames )]) - -Simply put, this runs the list of files passed to it. If the file ends in -C<.sql> it runs it as sql and if it ends in C<.pl> it runs it as a perl file. - -Depending on L all of the files run will be wrapped in a single -transaction. - -=head2 _prepare_install - - $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' }) - -Generates the sql file for installing the database. First arg is simply -L args and the second is a coderef that returns the filename -to store the sql in. - -=head2 _prepare_changegrade - - $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up') - -Generates the sql file for migrating from one schema version to another. First -arg is the version to start from, second is the version to go to, third is the -L, and last is the -direction of the changegrade, be it 'up' or 'down'. - -=head2 _read_sql_file - - $dm->_read_sql_file('foo.sql') - -Reads a sql file and returns lines in an C. Strips out comments, -transactions, and blank lines. - -=end comment