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