X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator.pm;h=ed05b01f70b77e302321839037a752e9f6d63f72;hb=1f0d0633940a59386e5c0ebec602d0650a3694ed;hp=25910065c6db307450e7559a7dd96edb3a61f171;hpb=e217d19c58c8beba917e751dd1089281fa1a74ee;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 2591006..ed05b01 100644 --- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm +++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm @@ -1,13 +1,35 @@ package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator; use Moose; + +# ABSTRACT: Manage your SQL and Perl migrations in nicely laid out directories + +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; + use SQL::Translator; require SQL::Translator::Diff; + require DBIx::Class::Storage; # loaded for type constraint +use DBIx::Class::DeploymentHandler::Types; + +use File::Path 'mkpath'; +use File::Spec::Functions; with 'DBIx::Class::DeploymentHandler::HandlesDeploy'; -use Carp 'carp'; + +has schema => ( + isa => 'DBIx::Class::Schema', + is => 'ro', + required => 1, +); has storage => ( isa => 'DBIx::Class::Storage', @@ -21,30 +43,18 @@ method _build_storage { $s } -has sqltargs => ( +has sql_translator_args => ( isa => 'HashRef', is => 'ro', default => sub { {} }, ); -has upgrade_directory => ( +has script_directory => ( isa => 'Str', is => 'ro', required => 1, 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', @@ -52,80 +62,116 @@ has databases => ( default => sub { [qw( MySQL SQLite PostgreSQL )] }, ); -has schema => ( - isa => 'DBIx::Class::Schema', - is => 'ro', - required => 1, - handles => [qw( schema_version )], +has txn_wrap => ( + is => 'ro', + isa => 'Bool', + default => 1, ); -has _filedata => ( - isa => 'ArrayRef[Str]', - is => 'rw', +has schema_version => ( + is => 'ro', + isa => 'Str', + lazy_build => 1, ); -method _ddl_filename($type, $versions, $dir) { - my $filename = ref $self->schema; - $filename =~ s/::/-/g; +# 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 } - $filename = File::Spec->catfile( - $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql" - ); - - return $filename; -} +has _json => ( + is => 'ro', + lazy_build => 1, +); -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; - } +sub _build__json { require JSON; JSON->new->pretty } - # 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}; +method __ddl_consume_with_prefix($type, $versions, $prefix) { + my $base_dir = $self->script_directory; - my $tr = SQL::Translator->new( - producer => "SQL::Translator::Producer::${type}", - %$sqltargs, - parser => 'SQL::Translator::Parser::DBIx::Class', - data => $schema, - ); + my $main = catfile( $base_dir, $type ); + my $generic = catfile( $base_dir, '_generic' ); + my $common = + catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} ); - my @ret; - my $wa = wantarray; - if ($wa) { - @ret = $tr->translate; + 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"; } - else { - $ret[0] = $tr->translate; + + opendir my($dh), $dir; + my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl|sql-\w+)$/ && -f "$dir/$_" } readdir $dh; + closedir $dh; + + if (-d $common) { + opendir my($dh), $common; + for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { + unless ($files{$filename}) { + $files{$filename} = catfile($common,$filename); + } + } + closedir $dh; } - $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error) - unless (@ret && defined $ret[0]); + return [@files{sort keys %files}] +} - return $wa ? @ret : $ret[0]; +method _ddl_preinstall_consume_filenames($type, $version) { + $self->__ddl_consume_with_prefix($type, [ $version ], 'preinstall') } -sub _deploy { - my $self = shift; - my $storage = $self->storage; +method _ddl_schema_consume_filenames($type, $version) { + $self->__ddl_consume_with_prefix($type, [ $version ], 'schema') +} + +method _ddl_schema_produce_filename($type, $version) { + my $dirname = catfile( $self->script_directory, $type, 'schema', $version ); + mkpath($dirname) unless -d $dirname; + + return catfile( $dirname, '001-auto.sql-json' ); +} + +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->script_directory; + + my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions}); + mkpath($dirname) unless -d $dirname; + + return catfile( $dirname, '001-auto.sql-json' ); +} + +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-json'); +} + +method _run_sql_array($sql) { + my $storage = $self->storage; - my $deploy = sub { - my $line = shift; - return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/); + $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]; + + log_trace { '[DBICDH] Running SQL ' . Dumper($sql) }; + foreach my $line (@{$sql}) { $storage->_query_start($line); try { # do a dbh_do cycle here, as we need some error checking in @@ -136,92 +182,236 @@ sub _deploy { 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 ); + return join "\n", @$sql +} + +method _run_sql($filename) { + log_debug { "[DBICDH] 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" }; + my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; + + no warnings 'redefine'; + my $fn = eval "$filedata"; + use warnings; + log_trace { '[DBICDH] Running Perl ' . Dumper($fn) }; + + if ($@) { + carp "$filename failed to compile: $@"; + } elsif (ref $fn eq 'CODE') { + $fn->($self->schema) + } else { + carp "$filename should define an anonymouse sub that takes a schema but it didn't!"; + } +} + +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) { + my @files = @{$filenames}; + my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; + + my $sql = ''; + for my $filename (@files) { + if ($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 { + croak "A file ($filename) got to deploy that wasn't sql or perl!"; } } + + $guard->commit if $self->txn_wrap; + + return $sql; } -sub prepare_install { +sub deploy { 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 = (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, + $version, + )); +} + +sub preinstall { + 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( + $storage_type, + $version, + )}; + + for my $filename (@files) { + # We ignore sql for now (till I figure out what to do with it) + if ( $filename =~ /^(.+)\.pl$/ ) { + my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; + + no warnings 'redefine'; + my $fn = eval "$filedata"; + use warnings; + + if ($@) { + carp "$filename failed to compile: $@"; + } elsif (ref $fn eq 'CODE') { + $fn->() + } else { + carp "$filename should define an anonymous sub but it didn't!"; + } + } else { + croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!"; + } } +} - my $version = $schema->schema_version || '1.x'; - my $schema_version = $schema->schema_version || '1.x'; - $version ||= $schema_version; +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; + my $dir = $self->script_directory; + my $version = $self->schema_version; - $sqltargs = { - add_drop_table => 1, + my $sqlt = SQL::Translator->new({ + no_comments => 1, + 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->$to_file($db, $version, $dir); + if (-e $filename ) { carp "Overwriting existing DDL file - $filename"; unlink $filename; } - my $output = $sqlt->translate; - if(!$output) { + my $sql = $self->_generate_final_sql($sqlt); + if(!$sql) { 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; - } - print {$file} $output; + open my $file, q(>), $filename; + print {$file} $sql; close $file; } } -sub prepare_update { - my ($self, $version, $preversion) = @_; - my $schema = $self->schema; - my $databases = $self->databases; - my $dir = $self->upgrade_directory; - my $sqltargs = $self->sqltargs; +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 ); + mkpath($dirname) unless -d $dirname; - unless( -d $dir ) { - carp "Upgrade directory $dir does not exist, using ./\n"; - $dir = "./"; + return catfile( $dirname, "001-auto-$source_name.sql-json" ); } +} + +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" }; + my $rs_install_file = + $self->_resultsource_install_filename($source->source_name); + + my $files = [ + $self->$rs_install_file( + $self->storage->sqlt_type, + $version, + ) + ]; + $self->_run_sql_and_perl($files); +} + +sub prepare_resultsource_install { + my $self = 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({ + parser_args => { sources => [$source->source_name], } + }, $filename); +} - my $schema_version = $schema->schema_version || '1.x'; - $version ||= $schema_version; +sub prepare_deploy { + log_info { '[DBICDH] preparing deploy' }; + my $self = shift; + $self->_prepare_install({}, '_ddl_schema_produce_filename'); +} + +sub prepare_upgrade { + 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, $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->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} @@ -230,23 +420,23 @@ sub prepare_update { 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; } @@ -259,10 +449,11 @@ sub prepare_update { }); $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); + my $sql = $self->_default_read_sql_file_as_string($prefilename); + my $out = $t->translate( \$sql ) + or croak($t->error); $source_schema = $t->schema; @@ -283,11 +474,12 @@ sub prepare_update { }); $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 $out = $t->translate( $filename ) - or $self->throw_exception ($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; @@ -295,88 +487,307 @@ sub prepare_update { unless $dest_schema->name; } - my $diff = SQL::Translator::Diff::schema_diff( - $source_schema, $db, - $dest_schema, $db, - $sqltargs - ); - my $file; - unless(open $file, q(>), $diff_file) { - $self->throw_exception("Can't write to $diff_file ($!)"); - next; - } - print {$file} $diff; + open my $file, q(>), $diff_file; + print {$file} + $self->_generate_final_diff($source_schema, $dest_schema, $db, $sqltargs); 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; - 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; - return \@data; } -sub _upgrade_single_step { - my $self = shift; - my @version_set = @{ shift @_ }; - my $db_version = $self->db_version; - my $upgrade_file = $self->_ddl_filename( - $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"; - - $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 }); - - $self->version_rs->create({ - version => $version_set[-1], - # ddl => $ddl, - # upgrade_sql => $upgrade_sql, - }); +method _default_read_sql_file_as_string($file) { + return join q(), map "$_;\n", @{$self->_json->decode( + do { local( @ARGV, $/ ) = $file; <> } # slurp + )}; } -method _do_upgrade { $self->_run_upgrade(qr/.*?/) } +sub downgrade_single_step { + my $self = shift; + my $version_set = (shift @_)->{version_set}; + log_info { qq([DBICDH] downgrade_single_step'ing ) . Dumper($version_set) }; -method _run_upgrade($stm) { - return unless $self->_filedata; - my @statements = grep { $_ =~ $stm } @{$self->_filedata}; + my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames( + $self->storage->sqlt_type, + $version_set, + )); - for (@statements) { - $self->storage->debugobj->query_start($_) if $self->storage->debug; - $self->_apply_statement($_); - $self->storage->debugobj->query_end($_) if $self->storage->debug; - } + return ['', $sql]; } -method _apply_statement($statement) { - # croak? - $self->storage->dbh->do($_) or carp "SQL was: $_" +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, + $version_set, + )); + return ['', $sql]; } __PACKAGE__->meta->make_immutable; 1; +# vim: ts=2 sw=2 expandtab + __END__ -vim: ts=2 sw=2 expandtab +=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. + +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: + + $sql_migration_dir + |- SQLite + | |- down + | | `- 2-1 + | | `- 001-auto.sql + | |- schema + | | `- 1 + | | `- 001-auto.sql + | `- up + | |- 1-2 + | | `- 001-auto.sql + | `- 2-3 + | `- 001-auto.sql + |- _common + | |- down + | | `- 2-1 + | | `- 002-remove-customers.pl + | `- up + | `- 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 + | `- 2-1 + | `- 001-auto.sql + |- preinstall + | `- 1 + | |- 001-create_database.pl + | `- 002-create_users_and_permissions.pl + |- schema + | `- 1 + | `- 001-auto.sql + `- up + `- 1-2 + `- 001-auto.sql + +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, + + $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. + +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. + +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 +just like the other steps in the process, but nothing is passed to them. +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. + +=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. +A very basic perl script might look like: + + #!perl + + use strict; + use warnings; + + sub { + my $schema = shift; + + $schema->resultset('Users')->create({ + name => 'root', + password => 'root', + }) + } + +=attr schema + +The L (B) that is used to talk to the database +and generate the DDL. + +=attr storage + +The L that is I used to talk to the database +and generate the DDL. This is automatically created with L. + +=attr sql_translator_args + +The arguments that get passed to L when it's used. + +=attr script_directory + +The directory (default C<'sql'>) that scripts are stored in + +=attr databases + +The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to +generate files for + +=attr txn_wrap + +Set to true (which is the default) to wrap all upgrades and deploys in a single +transaction. + +=attr schema_version + +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