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 require SQL::Translator::Diff;
  11 use Try::Tiny;
  12
  13 with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod';
  14
  15 BEGIN {
  16   use Moose::Util::TypeConstraints;
  17   subtype 'DBIx::Class::DeploymentHandler::Databases'
  18     => as 'ArrayRef[Str]';
  19
  20   coerce 'DBIx::Class::DeploymentHandler::Databases'
  21     => from 'Str'
  22     => via { [$_] };
  23   no Moose::Util::TypeConstraints;
  24 }
  25
  26 has schema => (
  27   isa      => 'DBIx::Class::Schema',
  28   is       => 'ro',
  29   required => 1,
  30   handles => [qw( ddl_filename schema_version )],
  31 );
  32
  33 has upgrade_directory => ( # configuration
  34   isa      => 'Str',
  35   is       => 'ro',
  36   required => 1,
  37   default  => 'sql',
  38 );
  39
  40 has backup_directory => ( # configuration
  41   isa => 'Str',
  42   is  => 'ro',
  43   predicate  => 'has_backup_directory',
  44 );
  45
  46 has storage => (
  47   isa        => 'DBIx::Class::Storage',
  48   is         => 'ro',
  49   lazy_build => 1,
  50 );
  51
  52 method _build_storage {
  53   my $s = $self->schema->storage;
  54   $s->_determine_driver;
  55   $s
  56 }
  57
  58 has do_backup => ( # configuration
  59   isa     => 'Bool',
  60   is      => 'ro',
  61   default => undef,
  62 );
  63
  64 has version_rs => (
  65   isa        => 'DBIx::Class::ResultSet',
  66   is         => 'ro',
  67   lazy_build => 1,
  68   handles    => [qw( is_installed db_version )],
  69 );
  70
  71 method _build_version_rs {
  72    $self->schema->set_us_up_the_bomb;
  73    $self->schema->resultset('__VERSION')
  74 }
  75
  76 has databases => ( # configuration
  77   coerce  => 1,
  78   isa     => 'DBIx::Class::DeploymentHandler::Databases',
  79   is      => 'ro',
  80   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  81 );
  82
  83 has sqltargs => ( # configuration
  84   isa => 'HashRef',
  85   is  => 'ro',
  86   default => sub { {} },
  87 );
  88
  89 method install($new_version) {
  90   carp 'Install not possible as versions table already exists in database'
  91     if $self->is_installed;
  92
  93   $new_version ||= $self->schema_version;
  94
  95   if ($new_version) {
  96     $self->deploy;
  97
  98     $self->version_rs->create({
  99       version     => $new_version,
 100       # ddl         => $ddl,
 101       # upgrade_sql => $upgrade_sql,
 102     });
 103   }
 104 }
 105
 106 method ordered_schema_versions { undef }
 107
 108 method upgrade {
 109   my $db_version     = $self->db_version;
 110   my $schema_version = $self->schema_version;
 111
 112   unless ($db_version) {
 113     # croak?
 114     carp 'Upgrade not possible as database is unversioned. Please call install first.';
 115     return;
 116   }
 117
 118   if ( $db_version eq $schema_version ) {
 119     # croak?
 120     carp "Upgrade not necessary\n";
 121     return;
 122   }
 123
 124   my @version_list = $self->ordered_schema_versions ||
 125     ( $db_version, $schema_version );
 126
 127   # remove all versions in list above the required version
 128   while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
 129     pop @version_list;
 130   }
 131
 132   # remove all versions in list below the current version
 133   while ( @version_list && ( $version_list[0] ne $db_version ) ) {
 134     shift @version_list;
 135   }
 136
 137   # check we have an appropriate list of versions
 138   die if @version_list < 2;
 139
 140   # do sets of upgrade
 141   while ( @version_list >= 2 ) {
 142     $self->upgrade_single_step( $version_list[0], $version_list[1] );
 143     shift @version_list;
 144   }
 145 }
 146
 147 __PACKAGE__->meta->make_immutable;
 148
 149 1;
 150
 151 __END__
 152
 153 vim: ts=2 sw=2 expandtab