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 'carp';
   9
  10 has schema => (
  11    isa      => 'DBIx::Class::Schema',
  12    is       => 'ro',
  13    required => 1,
  14    handles => [qw{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 => '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 method _build_version_rs { $self->schema->resultset('VersionResult') }
  66
  67 method backup { $self->storage->backup($self->backup_directory) }
  68
  69 method install($new_version) {
  70   carp 'Install not possible as versions table already exists in database'
  71     unless $self->is_installed;
  72
  73   $new_version ||= $self->schema_version;
  74
  75   if ($new_version) {
  76     $self->schema->deploy;
  77
  78     $self->version_rs->create({
  79        version     => $new_version,
  80        # ddl         => $ddl,
  81        # upgrade_sql => $upgrade_sql,
  82     });
  83   }
  84 }
  85
  86 method create_upgrade_path { }
  87
  88 method ordered_schema_versions { }
  89
  90 method upgrade {
  91   my $db_version     = $self->db_version;
  92   my $schema_version = $self->schema_version;
  93
  94   unless ($db_version) {
  95       carp 'Upgrade not possible as database is unversioned. Please call install first.';
  96       return;
  97   }
  98
  99   if ( $db_version eq $schema_version ) {
 100       carp "Upgrade not necessary\n";
 101       return;
 102   }
 103
 104   my @version_list = $self->ordered_schema_versions ||
 105     ( $db_version, $schema_version );
 106
 107   # remove all versions in list above the required version
 108   while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
 109       pop @version_list;
 110   }
 111
 112   # remove all versions in list below the current version
 113   while ( @version_list && ( $version_list[0] ne $db_version ) ) {
 114       shift @version_list;
 115   }
 116
 117   # check we have an appropriate list of versions
 118   die if @version_list < 2;
 119
 120   # do sets of upgrade
 121   while ( @version_list >= 2 ) {
 122       $self->upgrade_single_step( $version_list[0], $version_list[1] );
 123       shift @version_list;
 124   }
 125 }
 126
 127 method upgrade_single_step($db_version, $target_version) {
 128   if ($db_version eq $target_version) {
 129     carp "Upgrade not necessary\n";
 130     return;
 131   }
 132
 133   # strangely the first time this is called can
 134   # differ to subsequent times. so we call it
 135   # here to be sure.
 136   # XXX - just fix it
 137   $self->storage->sqlt_type;
 138
 139   my $upgrade_file = $self->ddl_filename(
 140     $self->storage->sqlt_type,
 141     $target_version,
 142     $self->upgrade_directory,
 143     $db_version,
 144   );
 145
 146   $self->create_upgrade_path({ upgrade_file => $upgrade_file });
 147
 148   unless (-f $upgrade_file) {
 149     carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 150     return;
 151   }
 152
 153   carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
 154
 155   # backup if necessary then apply upgrade
 156   $self->_filedata($self->_read_sql_file($upgrade_file));
 157   $self->backup if $self->do_backup;
 158   $self->schema->txn_do(sub { $self->do_upgrade });
 159
 160   # set row in dbix_class_schema_versions table
 161   $self->version_rs->create({
 162      version     => $target_version,
 163      # ddl         => $ddl,
 164      # upgrade_sql => $upgrade_sql,
 165   });
 166 }
 167
 168 method do_upgrade { $self->run_upgrade(qr/.*?/) }
 169
 170 method run_upgrade($stm) {
 171   return unless $self->_filedata;
 172   my @statements = grep { $_ =~ $stm } @{$self->_filedata};
 173
 174   for (@statements) {
 175     $self->storage->debugobj->query_start($_) if $self->storage->debug;
 176     $self->apply_statement($_);
 177     $self->storage->debugobj->query_end($_) if $self->storage->debug;
 178   }
 179 }
 180
 181 method apply_statement($statement) {
 182   $self->storage->dbh->do($_) or carp "SQL was: $_"
 183 }
 184
 185 sub _create_db_to_schema_diff {
 186   my $self = shift;
 187
 188   my %driver_to_db_map = (
 189     'mysql' => 'MySQL'
 190   );
 191
 192   my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
 193   unless ($db) {
 194     print "Sorry, this is an unsupported DB\n";
 195     return;
 196   }
 197
 198   $self->throw_exception($self->storage->_sqlt_version_error)
 199     unless $self->storage->_sqlt_version_ok;
 200
 201   my $db_tr = SQL::Translator->new({
 202     add_drop_table => 1,
 203     parser         => 'DBI',
 204     parser_args    => { dbh  => $self->storage->dbh },
 205     producer       => $db,
 206   });
 207
 208   my $dbic_tr = SQL::Translator->new({
 209     parser   => 'SQL::Translator::Parser::DBIx::Class',
 210     data     => $self,
 211     producer => $db,
 212   });
 213
 214   $db_tr->schema->name('db_schema');
 215   $dbic_tr->schema->name('dbic_schema');
 216
 217   # is this really necessary?
 218   foreach my $tr ($db_tr, $dbic_tr) {
 219     my $data = $tr->data;
 220     $tr->parser->($tr, $$data);
 221   }
 222
 223   my $diff = SQL::Translator::Diff::schema_diff(
 224     $db_tr->schema,   $db,
 225     $dbic_tr->schema, $db, {
 226       ignore_constraint_names => 1,
 227       ignore_index_names      => 1,
 228       caseopt                 => 1,
 229     }
 230   );
 231
 232   my $filename = $self->ddl_filename(
 233     $db,
 234     $self->schema_version,
 235     $self->upgrade_directory,
 236     'PRE',
 237   );
 238
 239   open my $file, '>', $filename
 240     or $self->throw_exception("Can't open $filename for writing ($!)");
 241   print {$file} $diff;
 242   close $file;
 243
 244   carp "WARNING: There may be differences between your DB and your DBIC schema.\n" .
 245        "Please review and if necessary run the SQL in $filename to sync your DB.\n";
 246 }
 247
 248 method _read_sql_file($file) {
 249   return unless $file;
 250
 251   open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
 252   my @data = split /\n/, join '', <$fh>;
 253   close $fh;
 254
 255   @data = grep {
 256     $_ &&
 257     !/^--/ &&
 258     !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
 259   } split /;/,
 260     join '', @data;
 261
 262   return \@data;
 263 }
 264
 265 1;