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::ResultSet; # loaded for type constraint
   7 use Carp::Clan '^DBIx::Class::DeploymentHandler';
   8
   9 with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod';
  10 with 'DBIx::Class::DeploymentHandler::WithDatabaseToSchemaVersions';
  11
  12 BEGIN {
  13   use Moose::Util::TypeConstraints;
  14   subtype 'DBIx::Class::DeploymentHandler::Databases'
  15     => as 'ArrayRef[Str]';
  16
  17   coerce 'DBIx::Class::DeploymentHandler::Databases'
  18     => from 'Str'
  19     => via { [$_] };
  20   no Moose::Util::TypeConstraints;
  21 }
  22
  23 has schema => (
  24   isa      => 'DBIx::Class::Schema',
  25   is       => 'ro',
  26   required => 1,
  27   handles => [qw( ddl_filename schema_version )],
  28 );
  29
  30 has upgrade_directory => ( # configuration
  31   isa      => 'Str',
  32   is       => 'ro',
  33   required => 1,
  34   default  => 'sql',
  35 );
  36
  37 has backup_directory => ( # configuration
  38   isa => 'Str',
  39   is  => 'ro',
  40   predicate  => 'has_backup_directory',
  41 );
  42
  43 has do_backup => ( # configuration
  44   isa     => 'Bool',
  45   is      => 'ro',
  46   default => undef,
  47 );
  48
  49 has version_rs => (
  50   isa        => 'DBIx::Class::ResultSet',
  51   is         => 'ro',
  52   lazy_build => 1,
  53   handles    => [qw( is_installed db_version )],
  54 );
  55
  56 has to_version => (
  57   is         => 'ro',
  58   lazy_build => 1,
  59 );
  60
  61 method _build_version_rs {
  62    $self->schema->set_us_up_the_bomb;
  63    $self->schema->resultset('__VERSION')
  64 }
  65
  66 has databases => ( # configuration
  67   coerce  => 1,
  68   isa     => 'DBIx::Class::DeploymentHandler::Databases',
  69   is      => 'ro',
  70   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  71 );
  72
  73 has sqltargs => ( # configuration
  74   isa => 'HashRef',
  75   is  => 'ro',
  76   default => sub { {} },
  77 );
  78
  79 method install($new_version) {
  80   carp 'Install not possible as versions table already exists in database'
  81     if $self->is_installed;
  82
  83   $new_version ||= $self->schema_version;
  84
  85   if ($new_version) {
  86     $self->deploy;
  87
  88     $self->version_rs->create({
  89       version     => $new_version,
  90       # ddl         => $ddl,
  91       # upgrade_sql => $upgrade_sql,
  92     });
  93   }
  94 }
  95
  96 method upgrade {
  97   my $db_version     = $self->db_version;
  98   my $schema_version = $self->schema_version;
  99
 100   unless ($db_version) {
 101     # croak?
 102     carp 'Upgrade not possible as database is unversioned. Please call install first.';
 103     return;
 104   }
 105
 106   while ( my $version_list = $self->next_version_set ) {
 107     $self->upgrade_single_step( $version_list->[0], $version_list->[1] );
 108   }
 109 }
 110
 111 __PACKAGE__->meta->make_immutable;
 112
 113 1;
 114
 115 __END__
 116
 117 vim: ts=2 sw=2 expandtab