add in role I forget
[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler.pm
CommitLineData
b974984a 1package DBIx::Class::DeploymentHandler;
2
3use Moose;
4use Method::Signatures::Simple;
12fdd461 5require DBIx::Class::Schema; # loaded for type constraint
6require DBIx::Class::Storage; # loaded for type constraint
7require DBIx::Class::ResultSet; # loaded for type constraint
e1f67607 8use Carp::Clan '^DBIx::Class::DeploymentHandler';
ecc3b6be 9use SQL::Translator;
9e1c29c2 10require SQL::Translator::Diff;
d76abae0 11use Try::Tiny;
b974984a 12
334bced5 13with 'DBIx::Class::DeploymentHandler::WithSqltDeployMethod';
2e68a8e1 14
cf400f48 15BEGIN {
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
b974984a 26has schema => (
61847972 27 isa => 'DBIx::Class::Schema',
28 is => 'ro',
29 required => 1,
4ea147c6 30 handles => [qw( ddl_filename schema_version )],
b974984a 31);
32
33has upgrade_directory => (
61847972 34 isa => 'Str',
35 is => 'ro',
36 required => 1,
4ea147c6 37 default => 'sql',
b974984a 38);
39
40has backup_directory => (
61847972 41 isa => 'Str',
42 is => 'ro',
8bf3eee1 43 predicate => 'has_backup_directory',
b974984a 44);
45
46has storage => (
61847972 47 isa => 'DBIx::Class::Storage',
48 is => 'ro',
49 lazy_build => 1,
b974984a 50);
51
7eec7eb7 52method _build_storage {
61847972 53 my $s = $self->schema->storage;
54 $s->_determine_driver;
55 $s
7eec7eb7 56}
12fdd461 57
b974984a 58has do_backup => (
61847972 59 isa => 'Bool',
60 is => 'ro',
61 default => undef,
b974984a 62);
63
64has do_diff_on_init => (
61847972 65 isa => 'Bool',
66 is => 'ro',
67 default => undef,
b974984a 68);
69
12fdd461 70has version_rs => (
61847972 71 isa => 'DBIx::Class::ResultSet',
72 is => 'ro',
73 lazy_build => 1,
74 handles => [qw( is_installed db_version )],
12fdd461 75);
76
9e1c29c2 77method _build_version_rs {
78 $self->schema->set_us_up_the_bomb;
79 $self->schema->resultset('__VERSION')
80}
81
9e401dc2 82has databases => (
cf400f48 83 coerce => 1,
84 isa => 'DBIx::Class::DeploymentHandler::Databases',
85 is => 'ro',
9e401dc2 86 default => sub { [qw( MySQL SQLite PostgreSQL )] },
87);
88
ecc3b6be 89has sqltargs => (
90 isa => 'HashRef',
91 is => 'ro',
92 default => sub { {} },
93);
94
741620a6 95method deploy {
46a47cd4 96 my $schema = $self->schema;
97 my $type = undef;
741620a6 98 my $sqltargs = $self->sqltargs;
46a47cd4 99 my $dir = $self->upgrade_directory;
100 my $storage = $self->storage;
741620a6 101
102 my $deploy = sub {
103 my $line = shift;
d76abae0 104 return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/);
741620a6 105 $storage->_query_start($line);
d76abae0 106 try {
741620a6 107 # do a dbh_do cycle here, as we need some error checking in
108 # place (even though we will ignore errors)
109 $storage->dbh_do (sub { $_[1]->do($line) });
d76abae0 110 }
111 catch {
112 carp "$_ (running '${line}')"
741620a6 113 }
114 $storage->_query_end($line);
115 };
d76abae0 116 my @statements = $self->deployment_statements();
741620a6 117 if (@statements > 1) {
118 foreach my $statement (@statements) {
119 $deploy->( $statement );
120 }
121 }
122 elsif (@statements == 1) {
123 foreach my $line ( split(";\n", $statements[0])) {
124 $deploy->( $line );
125 }
126 }
127}
128
b974984a 129method install($new_version) {
12fdd461 130 carp 'Install not possible as versions table already exists in database'
ceef4ff5 131 if $self->is_installed;
b974984a 132
12fdd461 133 $new_version ||= $self->schema_version;
b974984a 134
135 if ($new_version) {
741620a6 136 $self->deploy();
12fdd461 137
138 $self->version_rs->create({
61847972 139 version => $new_version,
140 # ddl => $ddl,
141 # upgrade_sql => $upgrade_sql,
12fdd461 142 });
b974984a 143 }
144}
145
8636376a 146method ordered_schema_versions { undef }
b974984a 147
148method upgrade {
12fdd461 149 my $db_version = $self->db_version;
150 my $schema_version = $self->schema_version;
b974984a 151
b974984a 152 unless ($db_version) {
61847972 153 # croak?
154 carp 'Upgrade not possible as database is unversioned. Please call install first.';
155 return;
b974984a 156 }
157
12fdd461 158 if ( $db_version eq $schema_version ) {
61847972 159 # croak?
160 carp "Upgrade not necessary\n";
161 return;
b974984a 162 }
163
12fdd461 164 my @version_list = $self->ordered_schema_versions ||
165 ( $db_version, $schema_version );
b974984a 166
167 # remove all versions in list above the required version
12fdd461 168 while ( @version_list && ( $version_list[-1] ne $schema_version ) ) {
61847972 169 pop @version_list;
b974984a 170 }
171
172 # remove all versions in list below the current version
12fdd461 173 while ( @version_list && ( $version_list[0] ne $db_version ) ) {
61847972 174 shift @version_list;
b974984a 175 }
176
177 # check we have an appropriate list of versions
12fdd461 178 die if @version_list < 2;
b974984a 179
180 # do sets of upgrade
12fdd461 181 while ( @version_list >= 2 ) {
61847972 182 $self->upgrade_single_step( $version_list[0], $version_list[1] );
183 shift @version_list;
b974984a 184 }
185}
186
2e68a8e1 187__PACKAGE__->meta->make_immutable;
188
b974984a 1891;
61847972 190
191__END__
192
193vim: ts=2,sw=2,expandtab