comments for clarity and move backup stuff out of DM
[dbsrgits/DBIx-Class-DeploymentHandler.git] / 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 );
28
29 has upgrade_directory => ( # configuration
30   isa      => 'Str',
31   is       => 'ro',
32   required => 1,
33   default  => 'sql',
34 );
35
36 has backup_directory => ( # configuration
37   isa => 'Str',
38   is  => 'ro',
39   predicate  => 'has_backup_directory',
40 );
41
42 has do_backup => ( # configuration
43   isa     => 'Bool',
44   is      => 'ro',
45   default => undef,
46 );
47
48 has version_rs => (
49   isa        => 'DBIx::Class::ResultSet',
50   is         => 'ro',
51   lazy_build => 1, # builder comes from another role...
52                    # which is... probably not how we want it
53   handles    => [qw( is_installed )],
54 );
55
56 has to_version => ( # configuration
57   is         => 'ro',
58   lazy_build => 1, # builder comes from another role...
59                    # which is... probably not how we want it
60 );
61
62 has databases => ( # configuration
63   coerce  => 1,
64   isa     => 'DBIx::Class::DeploymentHandler::Databases',
65   is      => 'ro',
66   default => sub { [qw( MySQL SQLite PostgreSQL )] },
67 );
68
69 has sqltargs => ( # configuration
70   isa => 'HashRef',
71   is  => 'ro',
72   default => sub { {} },
73 );
74
75 method install {
76   carp 'Install not possible as versions table already exists in database'
77     if $self->is_installed;
78
79   my $new_version = $self->to_version;
80
81   if ($new_version) {
82     $self->_deploy;
83
84     $self->version_rs->create({
85       version     => $new_version,
86       # ddl         => $ddl,
87       # upgrade_sql => $upgrade_sql,
88     });
89   }
90 }
91
92 sub upgrade {
93   while ( my $version_list = $_[0]->next_version_set ) {
94     $_[0]->_upgrade_single_step($version_list);
95   }
96 }
97
98 method backup { $self->storage->backup($self->backup_directory) }
99
100 __PACKAGE__->meta->make_immutable;
101
102 1;
103
104 __END__
105
106 vim: ts=2 sw=2 expandtab