lib/DBIx/Class/DeploymentHandler.pm

   1 package DBIx::Class::DeploymentHandler;
   2
   3 use Moose;
   4 use Method::Signatures::Simple;
   5 require DBIx::Class::Schema;    # loaded for type constraint
   6 require DBIx::Class::Storage;   # loaded for type constraint
   7 require DBIx::Class::ResultSet; # loaded for type constraint
   8 use Carp::Clan '^DBIx::Class::DeploymentHandler';
   9
  10 has schema => (
  11   isa      => 'DBIx::Class::Schema',
  12   is       => 'ro',
  13   required => 1,
  14   handles => [qw( ddl_filename schema_version )],
  15 );
  16
  17 has upgrade_directory => (
  18   isa      => 'Str',
  19   is       => 'ro',
  20   required => 1,
  21   default  => 'sql',
  22 );
  23
  24 has backup_directory => (
  25   isa => 'Str',
  26   is  => 'ro',
  27 );
  28
  29 has storage => (
  30   isa        => 'DBIx::Class::Storage',
  31   is         => 'ro',
  32   lazy_build => 1,
  33 );
  34
  35 method _build_storage {
  36   my $s = $self->schema->storage;
  37   $s->_determine_driver;
  38   $s
  39 }
  40
  41 has _filedata => (
  42   isa => 'ArrayRef[Str]',
  43   is  => 'rw',
  44 );
  45
  46 has do_backup => (
  47   isa     => 'Bool',
  48   is      => 'ro',
  49   default => undef,
  50 );
  51
  52 has do_diff_on_init => (
  53   isa     => 'Bool',
  54   is      => 'ro',
  55   default => undef,
  56 );
  57
  58 has version_rs => (
  59   isa        => 'DBIx::Class::ResultSet',
  60   is         => 'ro',
  61   lazy_build => 1,
  62   handles    => [qw( is_installed db_version )],
  63 );
  64
  65 has databases => (
  66   # make this coerce from Str
  67   isa => 'ArrayRef[Str]',
  68   is  => 'ro',
  69   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  70 );
  71
  72 method _build_version_rs {
  73    $self->schema->set_us_up_the_bomb;
  74    $self->schema->resultset('__VERSION')
  75 }
  76
  77 method backup { $self->storage->backup($self->backup_directory) }
  78
  79 method install($new_version) {
  80   carp 'Install not possible as versions table already exists in database'
  81     if $self->is_installed;
  82
  83   $new_version ||= $self->schema_version;
  84
  85   if ($new_version) {
  86     $self->schema->deploy;
  87
  88     $self->version_rs->create({
  89       version     => $new_version,
  90       # ddl         => $ddl,
  91       # upgrade_sql => $upgrade_sql,
  92     });
  93   }
  94 }
  95
  96 method create_upgrade_path { }
  97
  98 method ordered_schema_versions { undef }
  99
 100 method upgrade {
 101   my $db_version     = $self->db_version;
 102   my $schema_version = $self->schema_version;
 103
 104   unless ($db_version) {
 105     # croak?
 106     carp 'Upgrade not possible as database is unversioned. Please call install first.';
 107     return;
 108   }
 109
 110   if ( $db_version eq $schema_version ) {
 111     # croak?
 112     carp "Upgrade not necessary\n";
 113     return;
 114   }
 115
 116   my @version_list = $self->ordered_schema_versions ||
 117     ( $db_version, $schema_version );
 118
 119   # remove all versions in list above the required version
 120   while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
 121     pop @version_list;
 122   }
 123
 124   # remove all versions in list below the current version
 125   while ( @version_list && ( $version_list[0] ne $db_version ) ) {
 126     shift @version_list;
 127   }
 128
 129   # check we have an appropriate list of versions
 130   die if @version_list < 2;
 131
 132   # do sets of upgrade
 133   while ( @version_list >= 2 ) {
 134     $self->upgrade_single_step( $version_list[0], $version_list[1] );
 135     shift @version_list;
 136   }
 137 }
 138
 139 method upgrade_single_step($db_version, $target_version) {
 140   if ($db_version eq $target_version) {
 141     # croak?
 142     carp "Upgrade not necessary\n";
 143     return;
 144   }
 145
 146   my $upgrade_file = $self->ddl_filename(
 147     $self->storage->sqlt_type,
 148     $target_version,
 149     $self->upgrade_directory,
 150     $db_version,
 151   );
 152
 153   $self->create_upgrade_path({ upgrade_file => $upgrade_file });
 154
 155   unless (-f $upgrade_file) {
 156     # croak?
 157     carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 158     return;
 159   }
 160
 161   carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
 162
 163   $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
 164   $self->backup if $self->do_backup;
 165   $self->schema->txn_do(sub { $self->do_upgrade });
 166
 167   $self->version_rs->create({
 168     version     => $target_version,
 169     # ddl         => $ddl,
 170     # upgrade_sql => $upgrade_sql,
 171   });
 172 }
 173
 174 method create_ddl_dir($version, $preversion, $sqltargs) {
 175   my $schema = $self->schema;
 176   my $databases = $self->databases;
 177   my $dir = $self->upgrade_directory;
 178   unless( -d $dir ) {
 179     carp "Upgrade directory $dir does not exist, using ./\n";
 180     $dir = "./";
 181   }
 182
 183   my $schema_version = $schema->schema_version || '1.x';
 184   $version ||= $schema_version;
 185
 186   $sqltargs = {
 187     add_drop_table => 1,
 188     ignore_constraint_names => 1,
 189     ignore_index_names => 1,
 190     %{$sqltargs || {}}
 191   };
 192
 193   unless (DBIx::Class::Optional::Dependencies->req_ok_for ('deploy')) {
 194     $self->throw_exception("Can't create a ddl file without " . DBIx::Class::Optional::Dependencies->req_missing_for ('deploy') );
 195   }
 196
 197   my $sqlt = SQL::Translator->new( $sqltargs );
 198
 199   $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
 200   my $sqlt_schema = $sqlt->translate({ data => $schema })
 201     or $self->throw_exception ($sqlt->error);
 202
 203   foreach my $db (@$databases) {
 204     $sqlt->reset();
 205     $sqlt->{schema} = $sqlt_schema;
 206     $sqlt->producer($db);
 207
 208     my $file;
 209     my $filename = $schema->ddl_filename($db, $version, $dir);
 210     if (-e $filename && ($version eq $schema_version )) {
 211       # if we are dumping the current version, overwrite the DDL
 212       carp "Overwriting existing DDL file - $filename";
 213       unlink($filename);
 214     }
 215
 216     my $output = $sqlt->translate;
 217     if(!$output) {
 218       carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")");
 219       next;
 220     }
 221     if(!open($file, ">$filename")) {
 222       $self->throw_exception("Can't open $filename for writing ($!)");
 223       next;
 224     }
 225     print $file $output;
 226     close($file);
 227
 228     next unless ($preversion);
 229
 230     require SQL::Translator::Diff;
 231
 232     my $prefilename = $schema->ddl_filename($db, $preversion, $dir);
 233     if(!-e $prefilename) {
 234       carp("No previous schema file found ($prefilename)");
 235       next;
 236     }
 237
 238     my $difffile = $schema->ddl_filename($db, $version, $dir, $preversion);
 239     if(-e $difffile) {
 240       carp("Overwriting existing diff file - $difffile");
 241       unlink($difffile);
 242     }
 243
 244     my $source_schema;
 245     {
 246       my $t = SQL::Translator->new($sqltargs);
 247       $t->debug( 0 );
 248       $t->trace( 0 );
 249
 250       $t->parser( $db )
 251         or $self->throw_exception ($t->error);
 252
 253       my $out = $t->translate( $prefilename )
 254         or $self->throw_exception ($t->error);
 255
 256       $source_schema = $t->schema;
 257
 258       $source_schema->name( $prefilename )
 259         unless ( $source_schema->name );
 260     }
 261
 262     # The "new" style of producers have sane normalization and can support
 263     # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't
 264     # And we have to diff parsed SQL against parsed SQL.
 265     my $dest_schema = $sqlt_schema;
 266
 267     unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) {
 268       my $t = SQL::Translator->new($sqltargs);
 269       $t->debug( 0 );
 270       $t->trace( 0 );
 271
 272       $t->parser( $db )
 273         or $self->throw_exception ($t->error);
 274
 275       my $out = $t->translate( $filename )
 276         or $self->throw_exception ($t->error);
 277
 278       $dest_schema = $t->schema;
 279
 280       $dest_schema->name( $filename )
 281         unless $dest_schema->name;
 282     }
 283
 284     my $diff = SQL::Translator::Diff::schema_diff($source_schema, $db,
 285                                                   $dest_schema,   $db,
 286                                                   $sqltargs
 287                                                  );
 288     if(!open $file, ">$difffile") {
 289       $self->throw_exception("Can't write to $difffile ($!)");
 290       next;
 291     }
 292     print $file $diff;
 293     close($file);
 294   }
 295 }
 296
 297 method do_upgrade { $self->run_upgrade(qr/.*?/) }
 298
 299 method run_upgrade($stm) {
 300   return unless $self->_filedata;
 301   my @statements = grep { $_ =~ $stm } @{$self->_filedata};
 302
 303   for (@statements) {
 304     $self->storage->debugobj->query_start($_) if $self->storage->debug;
 305     $self->apply_statement($_);
 306     $self->storage->debugobj->query_end($_) if $self->storage->debug;
 307   }
 308 }
 309
 310 method apply_statement($statement) {
 311   # croak?
 312   $self->storage->dbh->do($_) or carp "SQL was: $_"
 313 }
 314
 315 method _read_sql_file($file) {
 316   return unless $file;
 317
 318   open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
 319   my @data = split /\n/, join '', <$fh>;
 320   close $fh;
 321
 322   @data = grep {
 323     $_ &&
 324     !/^--/ &&
 325     !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
 326   } split /;/,
 327     join '', @data;
 328
 329   return \@data;
 330 }
 331
 332 1;
 333
 334 __END__
 335
 336 vim: ts=2,sw=2,expandtab