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