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