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