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{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     # croak?
  96     carp 'Upgrade not possible as database is unversioned. Please call install first.';
  97     return;
  98   }
  99
 100   if ( $db_version eq $schema_version ) {
 101     # croak?
 102     carp "Upgrade not necessary\n";
 103     return;
 104   }
 105
 106   my @version_list = $self->ordered_schema_versions ||
 107     ( $db_version, $schema_version );
 108
 109   # remove all versions in list above the required version
 110   while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
 111     pop @version_list;
 112   }
 113
 114   # remove all versions in list below the current version
 115   while ( @version_list && ( $version_list[0] ne $db_version ) ) {
 116     shift @version_list;
 117   }
 118
 119   # check we have an appropriate list of versions
 120   die if @version_list < 2;
 121
 122   # do sets of upgrade
 123   while ( @version_list >= 2 ) {
 124     $self->upgrade_single_step( $version_list[0], $version_list[1] );
 125     shift @version_list;
 126   }
 127 }
 128
 129 method upgrade_single_step($db_version, $target_version) {
 130   if ($db_version eq $target_version) {
 131     # croak?
 132     carp "Upgrade not necessary\n";
 133     return;
 134   }
 135
 136   my $upgrade_file = $self->ddl_filename(
 137     $self->storage->sqlt_type,
 138     $target_version,
 139     $self->upgrade_directory,
 140     $db_version,
 141   );
 142
 143   $self->create_upgrade_path({ upgrade_file => $upgrade_file });
 144
 145   unless (-f $upgrade_file) {
 146     # croak?
 147     carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n";
 148     return;
 149   }
 150
 151   carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n";
 152
 153   $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22
 154   $self->backup if $self->do_backup;
 155   $self->schema->txn_do(sub { $self->do_upgrade });
 156
 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   # croak?
 179   $self->storage->dbh->do($_) or carp "SQL was: $_"
 180 }
 181
 182 sub _create_db_to_schema_diff {
 183   my $self = shift;
 184
 185   my %driver_to_db_map = (
 186     'mysql' => 'MySQL'
 187   );
 188
 189   my $db = $driver_to_db_map{$self->storage->dbh->{Driver}{Name}};
 190   unless ($db) {
 191     # croak?
 192     print "Sorry, this is an unsupported DB\n";
 193     return;
 194   }
 195
 196   $self->throw_exception($self->storage->_sqlt_version_error)
 197     unless $self->storage->_sqlt_version_ok;
 198
 199   my $db_tr = SQL::Translator->new({
 200     add_drop_table => 1,
 201     parser         => 'DBI',
 202     parser_args    => { dbh  => $self->storage->dbh },
 203     producer       => $db,
 204   });
 205
 206   my $dbic_tr = SQL::Translator->new({
 207     parser   => 'SQL::Translator::Parser::DBIx::Class',
 208     data     => $self,
 209     producer => $db,
 210   });
 211
 212   $db_tr->schema->name('db_schema');
 213   $dbic_tr->schema->name('dbic_schema');
 214
 215   # is this really necessary?
 216   foreach my $tr ($db_tr, $dbic_tr) {
 217     my $data = $tr->data;
 218     $tr->parser->($tr, $$data);
 219   }
 220
 221   my $diff = SQL::Translator::Diff::schema_diff(
 222     $db_tr->schema,   $db,
 223     $dbic_tr->schema, $db, {
 224       ignore_constraint_names => 1,
 225       ignore_index_names      => 1,
 226       caseopt                 => 1,
 227     }
 228   );
 229
 230   my $filename = $self->ddl_filename(
 231     $db,
 232     $self->schema_version,
 233     $self->upgrade_directory,
 234     'PRE',
 235   );
 236
 237   open my $file, '>', $filename
 238     or $self->throw_exception("Can't open $filename for writing ($!)");
 239   print {$file} $diff;
 240   close $file;
 241
 242   carp "WARNING: There may be differences between your DB and your DBIC schema.\n" .
 243        "Please review and if necessary run the SQL in $filename to sync your DB.\n";
 244 }
 245
 246 method _read_sql_file($file) {
 247   return unless $file;
 248
 249   open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)");
 250   my @data = split /\n/, join '', <$fh>;
 251   close $fh;
 252
 253   @data = grep {
 254     $_ &&
 255     !/^--/ &&
 256     !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m
 257   } split /;/,
 258     join '', @data;
 259
 260   return \@data;
 261 }
 262
 263 1;
 264
 265 __END__
 266
 267 vim: ts=2,sw=2,expandtab