X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=4eb5c6f9b53be5ed4e72017466635d21c650c15d;hb=65622feffe796f5ffe15f705c675df5aa4cb5055;hp=c56243ba4be0adf102bdc0d906a3de90250b9890;hpb=80ff6f6de5995403431369d67fc2e441c134a4b4;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 c56243b..4eb5c6f 100644 --- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm +++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm @@ -5,6 +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 Method::Signatures::Simple; use Try::Tiny; @@ -43,7 +48,7 @@ has sql_translator_args => ( is => 'ro', default => sub { {} }, ); -has upgrade_directory => ( +has script_directory => ( isa => 'Str', is => 'ro', required => 1, @@ -65,13 +70,17 @@ has txn_wrap => ( has schema_version => ( is => 'ro', + isa => 'Str', lazy_build => 1, ); +# 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 } method __ddl_consume_with_prefix($type, $versions, $prefix) { - my $base_dir = $self->upgrade_directory; + my $base_dir = $self->script_directory; my $main = catfile( $base_dir, $type ); my $generic = catfile( $base_dir, '_generic' ); @@ -113,7 +122,7 @@ method _ddl_schema_consume_filenames($type, $version) { } method _ddl_schema_produce_filename($type, $version) { - my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version ); + my $dirname = catfile( $self->script_directory, $type, 'schema', $version ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, '001-auto.sql' ); @@ -128,7 +137,7 @@ method _ddl_schema_down_consume_filenames($type, $versions) { } method _ddl_schema_up_produce_filename($type, $versions) { - my $dir = $self->upgrade_directory; + my $dir = $self->script_directory; my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions}); mkpath($dirname) unless -d $dirname; @@ -154,8 +163,10 @@ method _run_sql_and_perl($filenames) { my $sql; for my $filename (@files) { if ($filename =~ /\.sql$/) { + log_debug { "[DBICDH] Running SQL from $filename" }; my @sql = @{$self->_read_sql_file($filename)}; $sql .= join "\n", @sql; + log_trace { "[DBICDH] Running SQL $sql" }; foreach my $line (@sql) { $storage->_query_start($line); @@ -170,15 +181,17 @@ method _run_sql_and_perl($filenames) { $storage->_query_end($line); } } elsif ( $filename =~ /^(.+)\.pl$/ ) { + log_debug { "[DBICDH] 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) }; - if ($@) { + if ($@) { carp "$filename failed to compile: $@"; - } elsif (ref $fn eq 'CODE') { + } elsif (ref $fn eq 'CODE') { $fn->($self->schema) } else { carp "$filename should define an anonymouse sub that takes a schema but it didn't!"; @@ -195,7 +208,8 @@ method _run_sql_and_perl($filenames) { sub deploy { my $self = shift; - my $version = shift || $self->schema_version; + my $version = (shift @_ || {})->{version} || $self->schema_version; + log_info { "[DBICDH] deploying version $version" }; return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( $self->storage->sqlt_type, @@ -204,11 +218,14 @@ sub deploy { } sub preinstall { - my $self = shift; - my $version = shift || $self->schema_version; + my $self = shift; + my $args = shift; + my $version = $args->{version} || $self->schema_version; + log_info { "[DBICDH] preinstalling version $version" }; + my $storage_type = $args->{storage_type} || $self->storage->sqlt_type; my @files = @{$self->_ddl_preinstall_consume_filenames( - $self->storage->sqlt_type, + $storage_type, $version, )}; @@ -217,13 +234,13 @@ sub preinstall { if ( $filename =~ /^(.+)\.pl$/ ) { my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; - no warnings 'redefine'; + no warnings 'redefine'; my $fn = eval "$filedata"; use warnings; - if ($@) { + if ($@) { carp "$filename failed to compile: $@"; - } elsif (ref $fn eq 'CODE') { + } elsif (ref $fn eq 'CODE') { $fn->() } else { carp "$filename should define an anonymous sub but it didn't!"; @@ -240,7 +257,7 @@ sub _prepare_install { my $to_file = shift; my $schema = $self->schema; my $databases = $self->databases; - my $dir = $self->upgrade_directory; + my $dir = $self->script_directory; my $version = $self->schema_version; my $sqlt = SQL::Translator->new({ @@ -280,7 +297,7 @@ sub _resultsource_install_filename { my ($self, $source_name) = @_; return sub { my ($self, $type, $version) = @_; - my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version ); + my $dirname = catfile( $self->script_directory, $type, 'schema', $version ); mkpath($dirname) unless -d $dirname; return catfile( $dirname, "001-auto-$source_name.sql" ); @@ -288,8 +305,10 @@ sub _resultsource_install_filename { } sub install_resultsource { - my ($self, $source, $version) = @_; - + my ($self, $args) = @_; + my $source = $args->{result_source}; + my $version = $args->{version}; + log_info { '[DBICDH] installing_resultsource ' . $source->source_name . ", version $version" }; my $rs_install_file = $self->_resultsource_install_filename($source->source_name); @@ -304,7 +323,8 @@ sub install_resultsource { sub prepare_resultsource_install { my $self = shift; - my $source = shift; + my $source = (shift @_)->{result_source}; + log_info { '[DBICDH] preparing install for resultsource ' . $source->source_name }; my $filename = $self->_resultsource_install_filename($source->source_name); $self->_prepare_install({ @@ -313,25 +333,37 @@ sub prepare_resultsource_install { } sub prepare_deploy { + log_info { '[DBICDH] preparing deploy' }; my $self = shift; $self->_prepare_install({}, '_ddl_schema_produce_filename'); } sub prepare_upgrade { - my ($self, $from_version, $to_version, $version_set) = @_; - $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up'); + my ($self, $args) = @_; + log_info { + '[DBICDH] preparing upgrade ' . + "from $args->{from_version} to $args->{to_version}" + }; + $self->_prepare_changegrade( + $args->{from_version}, $args->{to_version}, $args->{version_set}, 'up' + ); } sub prepare_downgrade { - my ($self, $from_version, $to_version, $version_set) = @_; - - $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down'); + my ($self, $args) = @_; + log_info { + '[DBICDH] preparing downgrade ' . + "from $args->{from_version} to $args->{to_version}" + }; + $self->_prepare_changegrade( + $args->{from_version}, $args->{to_version}, $args->{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 $dir = $self->script_directory; my $sqltargs = $self->sql_translator_args; my $schema_version = $self->schema_version; @@ -442,7 +474,8 @@ method _read_sql_file($file) { sub downgrade_single_step { my $self = shift; - my $version_set = 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, @@ -454,7 +487,8 @@ sub downgrade_single_step { sub upgrade_single_step { my $self = shift; - my $version_set = 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, @@ -596,9 +630,9 @@ and generate the DDL. This is automatically created with L. The arguments that get passed to L when it's used. -=attr upgrade_directory +=attr script_directory -The directory (default C<'sql'>) that upgrades are stored in +The directory (default C<'sql'>) that scripts are stored in =attr databases @@ -615,7 +649,9 @@ transaction. The version the schema on your harddrive is at. Defaults to C<< $self->schema->schema_version >>. -=method __ddl_consume_with_prefix +=begin comment + +=head2 __ddl_consume_with_prefix $dm->__ddl_consume_with_prefix( 'SQLite', [qw( 1.00 1.01 )], 'up' ) @@ -623,48 +659,48 @@ 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. -=method _ddl_schema_consume_filenames +=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. -=method _ddl_schema_produce_filename +=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. -=method _ddl_schema_up_consume_filenames +=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. -=method _ddl_schema_down_consume_filenames +=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. -=method _ddl_schema_up_produce_filenames +=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. -=method _ddl_schema_down_produce_filename +=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. -=method _resultsource_install_filename +=head2 _resultsource_install_filename my $filename_fn = $dm->_resultsource_install_filename('User'); $dm->$filename_fn('SQLite', '1.00') @@ -672,7 +708,7 @@ will be stored. 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. -=method _run_sql_and_perl +=head2 _run_sql_and_perl $dm->_run_sql_and_perl([qw( list of filenames )]) @@ -682,7 +718,7 @@ 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. -=method _prepare_install +=head2 _prepare_install $dm->_prepare_install({ add_drop_table => 0 }, sub { 'file_to_create' }) @@ -690,7 +726,7 @@ 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. -=method _prepare_changegrade +=head2 _prepare_changegrade $dm->_prepare_changegrade('1.00', '1.01', [qw( 1.00 1.01)], 'up') @@ -699,10 +735,11 @@ 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'. -=method _read_sql_file +=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