lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator.pm

   1 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator;
   2 use Moose;
   3 use Method::Signatures::Simple;
   4 use Try::Tiny;
   5 use SQL::Translator;
   6 require SQL::Translator::Diff;
   7 require DBIx::Class::Storage;   # loaded for type constraint
   8 use autodie;
   9 use File::Path;
  10
  11 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
  12
  13 use Carp 'carp';
  14
  15 has schema => (
  16   isa      => 'DBIx::Class::Schema',
  17   is       => 'ro',
  18   required => 1,
  19   handles => [qw( schema_version )],
  20 );
  21
  22 has storage => (
  23   isa        => 'DBIx::Class::Storage',
  24   is         => 'ro',
  25   lazy_build => 1,
  26 );
  27
  28 method _build_storage {
  29   my $s = $self->schema->storage;
  30   $s->_determine_driver;
  31   $s
  32 }
  33
  34 has sqltargs => (
  35   isa => 'HashRef',
  36   is  => 'ro',
  37   default => sub { {} },
  38 );
  39 has upgrade_directory => (
  40   isa      => 'Str',
  41   is       => 'ro',
  42   required => 1,
  43   default  => 'sql',
  44 );
  45
  46 has databases => (
  47   coerce  => 1,
  48   isa     => 'DBIx::Class::DeploymentHandler::Databases',
  49   is      => 'ro',
  50   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  51 );
  52
  53 has _filedata => (
  54   isa => 'ArrayRef[Str]',
  55   is  => 'rw',
  56 );
  57
  58 has txn_wrap => (
  59   is => 'ro',
  60   isa => 'Bool',
  61   default => 1,
  62 );
  63
  64 method __ddl_consume_with_prefix($type, $versions, $prefix) {
  65   my $base_dir = $self->upgrade_directory;
  66
  67   my $main    = File::Spec->catfile( $base_dir, $type                         );
  68   my $generic = File::Spec->catfile( $base_dir, '_generic'                    );
  69   my $common =  File::Spec->catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} );
  70
  71   my $dir;
  72   if (-d $main) {
  73     $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
  74   } elsif (-d $generic) {
  75     $dir = File::Spec->catfile($main, $prefix, join q(-), @{$versions})
  76   } else {
  77     die 'PREPARE TO SQL'
  78   }
  79
  80   opendir my($dh), $dir;
  81   my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir($dh);
  82   closedir $dh;
  83
  84   if (-d $common) {
  85     opendir my($dh), $common;
  86     for my $filename (grep { /\.sql$/ && -f "$common/$_" } readdir($dh)) {
  87       unless ($files{$filename}) {
  88         $files{$filename} = "$common/$_";
  89       }
  90     }
  91     closedir $dh;
  92   }
  93
  94   return [@files{sort keys %files}]
  95 }
  96
  97 method _ddl_schema_consume_filenames($type, $version) {
  98   $self->__ddl_consume_with_prefix($type, [ $version ], 'schema')
  99 }
 100
 101 method _ddl_schema_produce_filename($type, $version) {
 102   my $base_dir = $self->upgrade_directory;
 103   my $dirname = File::Spec->catfile(
 104     $base_dir, $type, 'schema', $version
 105   );
 106   File::Path::mkpath($dirname) unless -d $dirname;
 107
 108   return File::Spec->catfile(
 109     $dirname, '001-auto.sql'
 110   );
 111 }
 112
 113 method _ddl_schema_up_consume_filenames($type, $versions) {
 114   $self->__ddl_consume_with_prefix($type, $versions, 'up')
 115 }
 116
 117 method _ddl_schema_down_consume_filenames($type, $versions) {
 118   $self->__ddl_consume_with_prefix($type, $versions, 'down')
 119 }
 120
 121 method _ddl_schema_up_produce_filename($type, $versions) {
 122   my $dir = $self->upgrade_directory;
 123
 124   my $dirname = File::Spec->catfile(
 125     $dir, $type, 'up', join( q(-), @{$versions} )
 126   );
 127   File::Path::mkpath($dirname) unless -d $dirname;
 128
 129   return File::Spec->catfile(
 130     $dirname, '001-auto.sql'
 131   );
 132 }
 133
 134 method _ddl_schema_down_produce_filename($type, $versions, $dir) {
 135   my $dirname = File::Spec->catfile(
 136     $dir, $type, 'down', join( q(-), @{$versions} )
 137   );
 138   File::Path::mkpath($dirname) unless -d $dirname;
 139
 140   return File::Spec->catfile(
 141     $dirname, '001-auto.sql'
 142   );
 143 }
 144
 145 sub _deploy {
 146   my $self = shift;
 147   my $storage  = $self->storage;
 148
 149   my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
 150
 151   my @sql = map @{$self->_read_sql_file($_)}, @{$self->_ddl_schema_consume_filenames(
 152       $self->storage->sqlt_type,
 153       $self->schema_version
 154     )};
 155
 156   foreach my $line (@sql) {
 157     $storage->_query_start($line);
 158     try {
 159       # do a dbh_do cycle here, as we need some error checking in
 160       # place (even though we will ignore errors)
 161       $storage->dbh_do (sub { $_[1]->do($line) });
 162     }
 163     catch {
 164       carp "$_ (running '${line}')"
 165     }
 166     $storage->_query_end($line);
 167   }
 168
 169   $guard->commit if $self->txn_wrap;
 170   return join "\n", @sql;
 171 }
 172
 173 sub prepare_install {
 174   my $self = shift;
 175   my $schema    = $self->schema;
 176   my $databases = $self->databases;
 177   my $dir       = $self->upgrade_directory;
 178   my $sqltargs  = $self->sqltargs;
 179   my $version = $schema->schema_version;
 180
 181   my $sqlt = SQL::Translator->new({
 182     add_drop_table          => 1,
 183     ignore_constraint_names => 1,
 184     ignore_index_names      => 1,
 185     parser                  => 'SQL::Translator::Parser::DBIx::Class',
 186     %{$sqltargs}
 187   });
 188
 189   my $sqlt_schema = $sqlt->translate( data => $schema )
 190     or $self->throw_exception($sqlt->error);
 191
 192   foreach my $db (@$databases) {
 193     $sqlt->reset;
 194     $sqlt->{schema} = $sqlt_schema;
 195     $sqlt->producer($db);
 196
 197     my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir);
 198     if (-e $filename ) {
 199       carp "Overwriting existing DDL file - $filename";
 200       unlink $filename;
 201     }
 202
 203     my $output = $sqlt->translate;
 204     if(!$output) {
 205       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
 206       next;
 207     }
 208     my $file;
 209     unless( open $file, q(>), $filename ) {
 210       $self->throw_exception("Can't open $filename for writing ($!)");
 211       next;
 212     }
 213     print {$file} $output;
 214     close $file;
 215   }
 216 }
 217
 218 sub prepare_upgrade {
 219   my ($self, $from_version, $to_version, $version_set) = @_;
 220
 221   $from_version ||= $self->db_version;
 222   $to_version   ||= $self->schema_version;
 223
 224   # for updates prepared automatically (rob's stuff)
 225   # one would want to explicitly set $version_set to
 226   # [$to_version]
 227   $version_set  ||= [$from_version, $to_version];
 228
 229   $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up');
 230 }
 231
 232 sub prepare_downgrade {
 233   my ($self, $from_version, $to_version, $version_set) = @_;
 234
 235   $from_version ||= $self->db_version;
 236   $to_version   ||= $self->schema_version;
 237
 238   # for updates prepared automatically (rob's stuff)
 239   # one would want to explicitly set $version_set to
 240   # [$to_version]
 241   $version_set  ||= [$from_version, $to_version];
 242
 243   $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down');
 244 }
 245
 246 method _prepare_changegrade($from_version, $to_version, $version_set, $direction) {
 247   my $schema    = $self->schema;
 248   my $databases = $self->databases;
 249   my $dir       = $self->upgrade_directory;
 250   my $sqltargs  = $self->sqltargs;
 251
 252   my $schema_version = $schema->schema_version;
 253
 254   $sqltargs = {
 255     add_drop_table => 1,
 256     ignore_constraint_names => 1,
 257     ignore_index_names => 1,
 258     %{$sqltargs}
 259   };
 260
 261   my $sqlt = SQL::Translator->new( $sqltargs );
 262
 263   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
 264   my $sqlt_schema = $sqlt->translate( data => $schema )
 265     or $self->throw_exception ($sqlt->error);
 266
 267   foreach my $db (@$databases) {
 268     $sqlt->reset;
 269     $sqlt->{schema} = $sqlt_schema;
 270     $sqlt->producer($db);
 271
 272     my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir);
 273     unless(-e $prefilename) {
 274       carp("No previous schema file found ($prefilename)");
 275       next;
 276     }
 277     my $diff_file_method = "_ddl_schema_${direction}_produce_filename";
 278     my $diff_file = $self->$diff_file_method($db, $version_set, $dir );
 279     if(-e $diff_file) {
 280       carp("Overwriting existing $direction-diff file - $diff_file");
 281       unlink $diff_file;
 282     }
 283
 284     my $source_schema;
 285     {
 286       my $t = SQL::Translator->new({
 287          %{$sqltargs},
 288          debug => 0,
 289          trace => 0,
 290       });
 291
 292       $t->parser( $db ) # could this really throw an exception?
 293         or $self->throw_exception ($t->error);
 294
 295       my $out = $t->translate( $prefilename )
 296         or $self->throw_exception ($t->error);
 297
 298       $source_schema = $t->schema;
 299
 300       $source_schema->name( $prefilename )
 301         unless  $source_schema->name;
 302     }
 303
 304     # The "new" style of producers have sane normalization and can support
 305     # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
 306     # And we have to diff parsed SQL against parsed SQL.
 307     my $dest_schema = $sqlt_schema;
 308
 309     unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
 310       my $t = SQL::Translator->new({
 311          %{$sqltargs},
 312          debug => 0,
 313          trace => 0,
 314       });
 315
 316       $t->parser( $db ) # could this really throw an exception?
 317         or $self->throw_exception ($t->error);
 318
 319       my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir);
 320       my $out = $t->translate( $filename )
 321         or $self->throw_exception ($t->error);
 322
 323       $dest_schema = $t->schema;
 324
 325       $dest_schema->name( $filename )
 326         unless $dest_schema->name;
 327     }
 328
 329     my $diff = SQL::Translator::Diff::schema_diff(
 330        $source_schema, $db,
 331        $dest_schema,   $db,
 332        $sqltargs
 333     );
 334     my $file;
 335     unless(open $file, q(>), $diff_file) {
 336       $self->throw_exception("Can't write to $diff_file ($!)");
 337       next;
 338     }
 339     print {$file} $diff;
 340     close $file;
 341   }
 342 }
 343
 344 method _read_sql_file($file) {
 345   return unless $file;
 346
 347   open my $fh, '<', $file or carp("Can't open sql file, $file ($!)");
 348   my @data = split /;\n/, join '', <$fh>;
 349   close $fh;
 350
 351   @data = grep {
 352     $_ && # remove blank lines
 353     !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's
 354   } map {
 355     s/^\s+//; s/\s+$//; # trim whitespace
 356     join '', grep { !/^--/ } split /\n/ # remove comments
 357   } @data;
 358
 359   return \@data;
 360 }
 361
 362 # these are exactly the same for now
 363 sub _downgrade_single_step {
 364   my $self = shift;
 365   my @version_set = @{ shift @_ };
 366   my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
 367     $self->storage->sqlt_type,
 368     \@version_set,
 369   )};
 370
 371   for my $upgrade_file (@upgrade_files) {
 372     unless (-f $upgrade_file) {
 373       # croak?
 374       carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 375       return;
 376     }
 377
 378     $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
 379
 380     my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
 381     $self->_do_upgrade;
 382     $guard->commit if $self->txn_wrap;
 383   }
 384 }
 385
 386 sub _upgrade_single_step {
 387   my $self = shift;
 388   my @version_set = @{ shift @_ };
 389   my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames(
 390     $self->storage->sqlt_type,
 391     \@version_set,
 392   )};
 393
 394   for my $upgrade_file (@upgrade_files) {
 395     unless (-f $upgrade_file) {
 396       # croak?
 397       carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 398       return;
 399     }
 400
 401     $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
 402     my $guard = $self->schema->txn_scope_guard if $self->txn_wrap;
 403     $self->_do_upgrade;
 404     $guard->commit if $self->txn_wrap;
 405   }
 406 }
 407
 408 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
 409
 410 method _run_upgrade($stm) {
 411   return unless $self->_filedata;
 412   my @statements = grep { $_ =~ $stm } @{$self->_filedata};
 413
 414   for (@statements) {
 415     $self->storage->debugobj->query_start($_) if $self->storage->debug;
 416     $self->_apply_statement($_);
 417     $self->storage->debugobj->query_end($_) if $self->storage->debug;
 418   }
 419 }
 420
 421 method _apply_statement($statement) {
 422   # croak?
 423   $self->storage->dbh->do($_) or carp "SQL was: $_"
 424 }
 425
 426 1;
 427
 428 __END__
 429
 430 vim: ts=2 sw=2 expandtab