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
   9 with 'DBIx::Class::DeploymentHandler::HandlesDeploy';
  10 use Carp 'carp';
  11
  12 has storage => (
  13   isa        => 'DBIx::Class::Storage',
  14   is         => 'ro',
  15   lazy_build => 1,
  16 );
  17
  18 method _build_storage {
  19   my $s = $self->schema->storage;
  20   $s->_determine_driver;
  21   $s
  22 }
  23
  24 has backup_directory => (
  25   isa => 'Str',
  26   is  => 'ro',
  27 );
  28
  29 has do_backup => (
  30   isa     => 'Bool',
  31   is      => 'ro',
  32   default => undef,
  33 );
  34
  35 has sqltargs => (
  36   isa => 'HashRef',
  37   is  => 'ro',
  38   default => sub { {} },
  39 );
  40 has upgrade_directory => (
  41   isa      => 'Str',
  42   is       => 'ro',
  43   required => 1,
  44   default  => 'sql',
  45 );
  46
  47 has version_rs => (
  48   isa        => 'DBIx::Class::ResultSet',
  49   is         => 'ro',
  50   lazy_build => 1,
  51   handles    => [qw( is_installed db_version )],
  52 );
  53
  54 method _build_version_rs {
  55    $self->schema->set_us_up_the_bomb;
  56    $self->schema->resultset('__VERSION')
  57 }
  58
  59 has databases => (
  60   coerce  => 1,
  61   isa     => 'DBIx::Class::DeploymentHandler::Databases',
  62   is      => 'ro',
  63   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  64 );
  65
  66 has schema => (
  67   isa      => 'DBIx::Class::Schema',
  68   is       => 'ro',
  69   required => 1,
  70   handles => [qw( schema_version )],
  71 );
  72
  73 has _filedata => (
  74   isa => 'ArrayRef[Str]',
  75   is  => 'rw',
  76 );
  77
  78 method _ddl_filename($type, $versions, $dir) {
  79   my $filename = ref $self->schema;
  80   $filename =~ s/::/-/g;
  81
  82   $filename = File::Spec->catfile(
  83     $dir, "$filename-" . join( q(-), @{$versions} ) . "-$type.sql"
  84   );
  85
  86   return $filename;
  87 }
  88
  89 method _deployment_statements {
  90   my $dir      = $self->upgrade_directory;
  91   my $schema   = $self->schema;
  92   my $type     = $self->storage->sqlt_type;
  93   my $sqltargs = $self->sqltargs;
  94   my $version  = $self->schema_version || '1.x';
  95
  96   my $filename = $self->_ddl_filename($type, [ $version ], $dir);
  97   if(-f $filename) {
  98       my $file;
  99       open $file, q(<), $filename
 100         or carp "Can't open $filename ($!)";
 101       my @rows = <$file>;
 102       close $file;
 103       return join '', @rows;
 104   }
 105
 106   # sources needs to be a parser arg, but for simplicty allow at top level
 107   # coming in
 108   $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources}
 109       if exists $sqltargs->{sources};
 110
 111   my $tr = SQL::Translator->new(
 112     producer => "SQL::Translator::Producer::${type}",
 113     %$sqltargs,
 114     parser => 'SQL::Translator::Parser::DBIx::Class',
 115     data => $schema,
 116   );
 117
 118   my @ret;
 119   my $wa = wantarray;
 120   if ($wa) {
 121     @ret = $tr->translate;
 122   }
 123   else {
 124     $ret[0] = $tr->translate;
 125   }
 126
 127   $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error)
 128     unless (@ret && defined $ret[0]);
 129
 130   return $wa ? @ret : $ret[0];
 131 }
 132
 133 sub _deploy {
 134   my $self = shift;
 135   my $storage  = $self->storage;
 136
 137   my $deploy = sub {
 138     my $line = shift;
 139     return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
 140     $storage->_query_start($line);
 141     try {
 142       # do a dbh_do cycle here, as we need some error checking in
 143       # place (even though we will ignore errors)
 144       $storage->dbh_do (sub { $_[1]->do($line) });
 145     }
 146     catch {
 147       carp "$_ (running '${line}')"
 148     }
 149     $storage->_query_end($line);
 150   };
 151   my @statements = $self->_deployment_statements();
 152   if (@statements > 1) {
 153     foreach my $statement (@statements) {
 154       $deploy->( $statement );
 155     }
 156   }
 157   elsif (@statements == 1) {
 158     foreach my $line ( split(";\n", $statements[0])) {
 159       $deploy->( $line );
 160     }
 161   }
 162 }
 163
 164 sub prepare_install {
 165   my $self = shift;
 166   my $schema    = $self->schema;
 167   my $databases = $self->databases;
 168   my $dir       = $self->upgrade_directory;
 169   my $sqltargs  = $self->sqltargs;
 170   unless( -d $dir ) {
 171     carp "Upgrade directory $dir does not exist, using ./\n";
 172     $dir = "./";
 173   }
 174
 175   my $version = $schema->schema_version || '1.x';
 176   my $schema_version = $schema->schema_version || '1.x';
 177   $version ||= $schema_version;
 178
 179   $sqltargs = {
 180     add_drop_table => 1,
 181     ignore_constraint_names => 1,
 182     ignore_index_names => 1,
 183     %{$sqltargs || {}}
 184   };
 185
 186   my $sqlt = SQL::Translator->new( $sqltargs );
 187
 188   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
 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_filename($db, [ $version ], $dir);
 198     if (-e $filename && ($version eq $schema_version )) {
 199       # if we are dumping the current version, overwrite the DDL
 200       carp "Overwriting existing DDL file - $filename";
 201       unlink $filename;
 202     }
 203
 204     my $output = $sqlt->translate;
 205     if(!$output) {
 206       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
 207       next;
 208     }
 209     my $file;
 210     unless( open $file, q(>), $filename ) {
 211       $self->throw_exception("Can't open $filename for writing ($!)");
 212       next;
 213     }
 214     print {$file} $output;
 215     close $file;
 216   }
 217 }
 218
 219 sub prepare_update {
 220   my ($self, $version, $preversion) = @_;
 221   my $schema    = $self->schema;
 222   my $databases = $self->databases;
 223   my $dir       = $self->upgrade_directory;
 224   my $sqltargs  = $self->sqltargs;
 225
 226   unless( -d $dir ) {
 227     carp "Upgrade directory $dir does not exist, using ./\n";
 228     $dir = "./";
 229   }
 230
 231   my $schema_version = $schema->schema_version || '1.x';
 232   $version ||= $schema_version;
 233
 234   $sqltargs = {
 235     add_drop_table => 1,
 236     ignore_constraint_names => 1,
 237     ignore_index_names => 1,
 238     %{$sqltargs}
 239   };
 240
 241   my $sqlt = SQL::Translator->new( $sqltargs );
 242
 243   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
 244   my $sqlt_schema = $sqlt->translate({ data => $schema })
 245     or $self->throw_exception ($sqlt->error);
 246
 247   foreach my $db (@$databases) {
 248     $sqlt->reset;
 249     $sqlt->{schema} = $sqlt_schema;
 250     $sqlt->producer($db);
 251
 252     my $prefilename = $self->_ddl_filename($db, [ $preversion ], $dir);
 253     unless(-e $prefilename) {
 254       carp("No previous schema file found ($prefilename)");
 255       next;
 256     }
 257
 258     my $diff_file = $self->_ddl_filename($db, [ $preversion, $version ], $dir );
 259     if(-e $diff_file) {
 260       carp("Overwriting existing diff file - $diff_file");
 261       unlink $diff_file;
 262     }
 263
 264     my $source_schema;
 265     {
 266       my $t = SQL::Translator->new({
 267          %{$sqltargs},
 268          debug => 0,
 269          trace => 0,
 270       });
 271
 272       $t->parser( $db ) # could this really throw an exception?
 273         or $self->throw_exception ($t->error);
 274
 275       my $out = $t->translate( $prefilename )
 276         or $self->throw_exception ($t->error);
 277
 278       $source_schema = $t->schema;
 279
 280       $source_schema->name( $prefilename )
 281         unless  $source_schema->name;
 282     }
 283
 284     # The "new" style of producers have sane normalization and can support
 285     # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
 286     # And we have to diff parsed SQL against parsed SQL.
 287     my $dest_schema = $sqlt_schema;
 288
 289     unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
 290       my $t = SQL::Translator->new({
 291          %{$sqltargs},
 292          debug => 0,
 293          trace => 0,
 294       });
 295
 296       $t->parser( $db ) # could this really throw an exception?
 297         or $self->throw_exception ($t->error);
 298
 299       my $filename = $self->_ddl_filename($db, [ $version ], $dir);
 300       my $out = $t->translate( $filename )
 301         or $self->throw_exception ($t->error);
 302
 303       $dest_schema = $t->schema;
 304
 305       $dest_schema->name( $filename )
 306         unless $dest_schema->name;
 307     }
 308
 309     my $diff = SQL::Translator::Diff::schema_diff(
 310        $source_schema, $db,
 311        $dest_schema,   $db,
 312        $sqltargs
 313     );
 314     my $file;
 315     unless(open $file, q(>), $diff_file) {
 316       $self->throw_exception("Can't write to $diff_file ($!)");
 317       next;
 318     }
 319     print {$file} $diff;
 320     close $file;
 321   }
 322 }
 323
 324 method _read_sql_file($file) {
 325   return unless $file;
 326
 327   open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
 328   my @data = split /\n/, join '', <$fh>;
 329   close $fh;
 330
 331   @data = grep {
 332     $_ &&
 333     !/^--/ &&
 334     !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
 335   } split /;/,
 336     join '', @data;
 337
 338   return \@data;
 339 }
 340
 341 sub _upgrade_single_step {
 342   my $self = shift;
 343   my @version_set = @{ shift @_ };
 344   my $db_version = $self->db_version;
 345   my $upgrade_file = $self->_ddl_filename(
 346     $self->storage->sqlt_type,
 347     \@version_set,
 348     $self->upgrade_directory,
 349   );
 350
 351   unless (-f $upgrade_file) {
 352     # croak?
 353     carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 354     return;
 355   }
 356
 357   carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
 358
 359   $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
 360   $self->backup if $self->do_backup;
 361   $self->schema->txn_do(sub { $self->_do_upgrade });
 362
 363   $self->version_rs->create({
 364     version     => $version_set[-1],
 365     # ddl         => $ddl,
 366     # upgrade_sql => $upgrade_sql,
 367   });
 368 }
 369
 370 method _do_upgrade { $self->_run_upgrade(qr/.*?/) }
 371
 372 method _run_upgrade($stm) {
 373   return unless $self->_filedata;
 374   my @statements = grep { $_ =~ $stm } @{$self->_filedata};
 375
 376   for (@statements) {
 377     $self->storage->debugobj->query_start($_) if $self->storage->debug;
 378     $self->_apply_statement($_);
 379     $self->storage->debugobj->query_end($_) if $self->storage->debug;
 380   }
 381 }
 382
 383 method _apply_statement($statement) {
 384   # croak?
 385   $self->storage->dbh->do($_) or carp "SQL was: $_"
 386 }
 387
 388 method backup { $self->storage->backup($self->backup_directory) }
 389
 390 __PACKAGE__->meta->make_immutable;
 391
 392 1;
 393
 394 __END__
 395
 396 vim: ts=2 sw=2 expandtab