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 use DBIx::Class::DeploymentHandler::Types;
  10 with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod',
  11      'DBIx::Class::DeploymentHandler::WithDatabaseToSchemaVersions',
  12      'DBIx::Class::DeploymentHandler::WithStandardVersionStorage';
  13
  14
  15 has schema => (
  16   isa      => 'DBIx::Class::Schema',
  17   is       => 'ro',
  18   required => 1,
  19   handles => ['schema_version'],
  20 );
  21
  22 has upgrade_directory => ( # configuration
  23   isa      => 'Str',
  24   is       => 'ro',
  25   required => 1,
  26   default  => 'sql',
  27 );
  28
  29 has backup_directory => ( # configuration
  30   isa => 'Str',
  31   is  => 'ro',
  32   predicate  => 'has_backup_directory',
  33 );
  34
  35 has to_version => ( # configuration
  36   is         => 'ro',
  37   lazy_build => 1,
  38 );
  39
  40 sub _build_to_version { $_[0]->schema->schema_version }
  41
  42 has databases => ( # configuration
  43   coerce  => 1,
  44   isa     => 'DBIx::Class::DeploymentHandler::Databases',
  45   is      => 'ro',
  46   default => sub { [qw( MySQL SQLite PostgreSQL )] },
  47 );
  48
  49 has sqltargs => ( # configuration
  50   isa => 'HashRef',
  51   is  => 'ro',
  52   default => sub { {} },
  53 );
  54
  55 method install {
  56   croak 'Install not possible as versions table already exists in database'
  57     if $self->version_storage_is_installed;
  58
  59   my $ddl = $self->_deploy;
  60
  61   $self->version_storage->add_database_version({
  62     version     => $self->to_version,
  63     ddl         => $ddl,
  64   });
  65 }
  66
  67 sub upgrade {
  68   my $self = shift;
  69   while ( my $version_list = $self->next_version_set ) {
  70     $self->_upgrade_single_step($version_list);
  71
  72     $self->add_database_version({
  73       version     => $version_list->[-1],
  74       # ddl         => $ddl,
  75       # upgrade_sql => $upgrade_sql,
  76     });
  77   }
  78 }
  79
  80 method backup { $self->storage->backup($self->backup_directory) }
  81
  82 __PACKAGE__->meta->make_immutable;
  83
  84 1;
  85
  86 __END__
  87
  88 vim: ts=2 sw=2 expandtab