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