Commit | Line | Data |
b974984a |
1 | package DBIx::Class::DeploymentHandler; |
2 | |
3 | use Moose; |
4 | use Method::Signatures::Simple; |
12fdd461 |
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 |
e1f67607 |
8 | use Carp::Clan '^DBIx::Class::DeploymentHandler'; |
ecc3b6be |
9 | use SQL::Translator; |
b974984a |
10 | |
cf400f48 |
11 | BEGIN { |
12 | use Moose::Util::TypeConstraints; |
13 | subtype 'DBIx::Class::DeploymentHandler::Databases' |
14 | => as 'ArrayRef[Str]'; |
15 | |
16 | coerce 'DBIx::Class::DeploymentHandler::Databases' |
17 | => from 'Str' |
18 | => via { [$_] }; |
19 | no Moose::Util::TypeConstraints; |
20 | } |
21 | |
b974984a |
22 | has schema => ( |
61847972 |
23 | isa => 'DBIx::Class::Schema', |
24 | is => 'ro', |
25 | required => 1, |
4ea147c6 |
26 | handles => [qw( ddl_filename schema_version )], |
b974984a |
27 | ); |
28 | |
29 | has upgrade_directory => ( |
61847972 |
30 | isa => 'Str', |
31 | is => 'ro', |
32 | required => 1, |
4ea147c6 |
33 | default => 'sql', |
b974984a |
34 | ); |
35 | |
36 | has backup_directory => ( |
61847972 |
37 | isa => 'Str', |
38 | is => 'ro', |
b974984a |
39 | ); |
40 | |
41 | has storage => ( |
61847972 |
42 | isa => 'DBIx::Class::Storage', |
43 | is => 'ro', |
44 | lazy_build => 1, |
b974984a |
45 | ); |
46 | |
7eec7eb7 |
47 | method _build_storage { |
61847972 |
48 | my $s = $self->schema->storage; |
49 | $s->_determine_driver; |
50 | $s |
7eec7eb7 |
51 | } |
12fdd461 |
52 | |
b974984a |
53 | has _filedata => ( |
4ea147c6 |
54 | isa => 'ArrayRef[Str]', |
61847972 |
55 | is => 'rw', |
b974984a |
56 | ); |
57 | |
58 | has do_backup => ( |
61847972 |
59 | isa => 'Bool', |
60 | is => 'ro', |
61 | default => undef, |
b974984a |
62 | ); |
63 | |
64 | has do_diff_on_init => ( |
61847972 |
65 | isa => 'Bool', |
66 | is => 'ro', |
67 | default => undef, |
b974984a |
68 | ); |
69 | |
12fdd461 |
70 | has 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 | |
9e401dc2 |
77 | has databases => ( |
cf400f48 |
78 | coerce => 1, |
79 | isa => 'DBIx::Class::DeploymentHandler::Databases', |
80 | is => 'ro', |
9e401dc2 |
81 | default => sub { [qw( MySQL SQLite PostgreSQL )] }, |
82 | ); |
83 | |
ecc3b6be |
84 | has sqltargs => ( |
85 | isa => 'HashRef', |
86 | is => 'ro', |
87 | default => sub { {} }, |
88 | ); |
89 | |
30749dbf |
90 | method _build_version_rs { |
91 | $self->schema->set_us_up_the_bomb; |
92 | $self->schema->resultset('__VERSION') |
93 | } |
12fdd461 |
94 | |
95 | method backup { $self->storage->backup($self->backup_directory) } |
b974984a |
96 | |
97 | method install($new_version) { |
12fdd461 |
98 | carp 'Install not possible as versions table already exists in database' |
ceef4ff5 |
99 | if $self->is_installed; |
b974984a |
100 | |
12fdd461 |
101 | $new_version ||= $self->schema_version; |
b974984a |
102 | |
103 | if ($new_version) { |
12fdd461 |
104 | $self->schema->deploy; |
105 | |
106 | $self->version_rs->create({ |
61847972 |
107 | version => $new_version, |
108 | # ddl => $ddl, |
109 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
110 | }); |
b974984a |
111 | } |
112 | } |
113 | |
12fdd461 |
114 | method create_upgrade_path { } |
b974984a |
115 | |
8636376a |
116 | method ordered_schema_versions { undef } |
b974984a |
117 | |
118 | method upgrade { |
12fdd461 |
119 | my $db_version = $self->db_version; |
120 | my $schema_version = $self->schema_version; |
b974984a |
121 | |
b974984a |
122 | unless ($db_version) { |
61847972 |
123 | # croak? |
124 | carp 'Upgrade not possible as database is unversioned. Please call install first.'; |
125 | return; |
b974984a |
126 | } |
127 | |
12fdd461 |
128 | if ( $db_version eq $schema_version ) { |
61847972 |
129 | # croak? |
130 | carp "Upgrade not necessary\n"; |
131 | return; |
b974984a |
132 | } |
133 | |
12fdd461 |
134 | my @version_list = $self->ordered_schema_versions || |
135 | ( $db_version, $schema_version ); |
b974984a |
136 | |
137 | # remove all versions in list above the required version |
12fdd461 |
138 | while ( @version_list && ( $version_list[-1] ne $schema_version ) ) { |
61847972 |
139 | pop @version_list; |
b974984a |
140 | } |
141 | |
142 | # remove all versions in list below the current version |
12fdd461 |
143 | while ( @version_list && ( $version_list[0] ne $db_version ) ) { |
61847972 |
144 | shift @version_list; |
b974984a |
145 | } |
146 | |
147 | # check we have an appropriate list of versions |
12fdd461 |
148 | die if @version_list < 2; |
b974984a |
149 | |
150 | # do sets of upgrade |
12fdd461 |
151 | while ( @version_list >= 2 ) { |
61847972 |
152 | $self->upgrade_single_step( $version_list[0], $version_list[1] ); |
153 | shift @version_list; |
b974984a |
154 | } |
155 | } |
156 | |
157 | method upgrade_single_step($db_version, $target_version) { |
b974984a |
158 | if ($db_version eq $target_version) { |
e1f67607 |
159 | # croak? |
b974984a |
160 | carp "Upgrade not necessary\n"; |
161 | return; |
162 | } |
163 | |
b974984a |
164 | my $upgrade_file = $self->ddl_filename( |
12fdd461 |
165 | $self->storage->sqlt_type, |
166 | $target_version, |
167 | $self->upgrade_directory, |
168 | $db_version, |
169 | ); |
b974984a |
170 | |
171 | $self->create_upgrade_path({ upgrade_file => $upgrade_file }); |
172 | |
173 | unless (-f $upgrade_file) { |
e1f67607 |
174 | # croak? |
b974984a |
175 | carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n"; |
176 | return; |
177 | } |
178 | |
179 | carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n"; |
180 | |
e1f67607 |
181 | $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22 |
12fdd461 |
182 | $self->backup if $self->do_backup; |
183 | $self->schema->txn_do(sub { $self->do_upgrade }); |
b974984a |
184 | |
12fdd461 |
185 | $self->version_rs->create({ |
61847972 |
186 | version => $target_version, |
187 | # ddl => $ddl, |
188 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
189 | }); |
b974984a |
190 | } |
191 | |
ecc3b6be |
192 | method create_ddl_dir($version, $preversion) { |
193 | my $schema = $self->schema; |
9e401dc2 |
194 | my $databases = $self->databases; |
ecc3b6be |
195 | my $dir = $self->upgrade_directory; |
196 | my $sqltargs = $self->sqltargs; |
9e401dc2 |
197 | unless( -d $dir ) { |
198 | carp "Upgrade directory $dir does not exist, using ./\n"; |
8164e4d0 |
199 | $dir = "./"; |
200 | } |
8164e4d0 |
201 | |
202 | my $schema_version = $schema->schema_version || '1.x'; |
203 | $version ||= $schema_version; |
204 | |
205 | $sqltargs = { |
206 | add_drop_table => 1, |
207 | ignore_constraint_names => 1, |
208 | ignore_index_names => 1, |
209 | %{$sqltargs || {}} |
210 | }; |
211 | |
8164e4d0 |
212 | my $sqlt = SQL::Translator->new( $sqltargs ); |
213 | |
214 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
215 | my $sqlt_schema = $sqlt->translate({ data => $schema }) |
216 | or $self->throw_exception ($sqlt->error); |
217 | |
218 | foreach my $db (@$databases) { |
c88c9aaa |
219 | $sqlt->reset; |
8164e4d0 |
220 | $sqlt->{schema} = $sqlt_schema; |
221 | $sqlt->producer($db); |
222 | |
c88c9aaa |
223 | my $filename = $self->ddl_filename($db, $version, $dir); |
8164e4d0 |
224 | if (-e $filename && ($version eq $schema_version )) { |
225 | # if we are dumping the current version, overwrite the DDL |
226 | carp "Overwriting existing DDL file - $filename"; |
c88c9aaa |
227 | unlink $filename; |
8164e4d0 |
228 | } |
229 | |
230 | my $output = $sqlt->translate; |
231 | if(!$output) { |
232 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
233 | next; |
234 | } |
c88c9aaa |
235 | my $file; |
236 | unless( open $file, q(>), $filename ) { |
8164e4d0 |
237 | $self->throw_exception("Can't open $filename for writing ($!)"); |
238 | next; |
239 | } |
c88c9aaa |
240 | print {$file} $output; |
241 | close $file; |
8164e4d0 |
242 | |
c88c9aaa |
243 | next unless $preversion; |
8164e4d0 |
244 | |
245 | require SQL::Translator::Diff; |
246 | |
c88c9aaa |
247 | my $prefilename = $self->ddl_filename($db, $preversion, $dir); |
248 | unless(-e $prefilename) { |
8164e4d0 |
249 | carp("No previous schema file found ($prefilename)"); |
250 | next; |
251 | } |
252 | |
c88c9aaa |
253 | my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion); |
254 | if(-e $diff_file) { |
255 | carp("Overwriting existing diff file - $diff_file"); |
256 | unlink $diff_file; |
8164e4d0 |
257 | } |
258 | |
259 | my $source_schema; |
260 | { |
c88c9aaa |
261 | my $t = SQL::Translator->new({ |
262 | %{$sqltargs}, |
263 | debug => 0, |
264 | trace => 0, |
265 | }); |
8164e4d0 |
266 | |
c88c9aaa |
267 | $t->parser( $db ) # could this really throw an exception? |
8164e4d0 |
268 | or $self->throw_exception ($t->error); |
269 | |
270 | my $out = $t->translate( $prefilename ) |
271 | or $self->throw_exception ($t->error); |
272 | |
273 | $source_schema = $t->schema; |
274 | |
275 | $source_schema->name( $prefilename ) |
c88c9aaa |
276 | unless $source_schema->name; |
8164e4d0 |
277 | } |
278 | |
279 | # The "new" style of producers have sane normalization and can support |
280 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
281 | # And we have to diff parsed SQL against parsed SQL. |
282 | my $dest_schema = $sqlt_schema; |
283 | |
284 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
c88c9aaa |
285 | my $t = SQL::Translator->new({ |
286 | %{$sqltargs}, |
287 | debug => 0, |
288 | trace => 0, |
289 | }); |
8164e4d0 |
290 | |
c88c9aaa |
291 | $t->parser( $db ) # could this really throw an exception? |
8164e4d0 |
292 | or $self->throw_exception ($t->error); |
293 | |
294 | my $out = $t->translate( $filename ) |
295 | or $self->throw_exception ($t->error); |
296 | |
297 | $dest_schema = $t->schema; |
298 | |
299 | $dest_schema->name( $filename ) |
300 | unless $dest_schema->name; |
301 | } |
302 | |
c88c9aaa |
303 | my $diff = SQL::Translator::Diff::schema_diff( |
304 | $source_schema, $db, |
305 | $dest_schema, $db, |
306 | $sqltargs |
307 | ); |
308 | unless(open $file, q(>), $diff_file) { |
309 | $self->throw_exception("Can't write to $diff_file ($!)"); |
8164e4d0 |
310 | next; |
311 | } |
c88c9aaa |
312 | print {$file} $diff; |
313 | close $file; |
8164e4d0 |
314 | } |
315 | } |
316 | |
12fdd461 |
317 | method do_upgrade { $self->run_upgrade(qr/.*?/) } |
b974984a |
318 | |
319 | method run_upgrade($stm) { |
12fdd461 |
320 | return unless $self->_filedata; |
321 | my @statements = grep { $_ =~ $stm } @{$self->_filedata}; |
b974984a |
322 | |
12fdd461 |
323 | for (@statements) { |
324 | $self->storage->debugobj->query_start($_) if $self->storage->debug; |
325 | $self->apply_statement($_); |
326 | $self->storage->debugobj->query_end($_) if $self->storage->debug; |
327 | } |
b974984a |
328 | } |
329 | |
330 | method apply_statement($statement) { |
e1f67607 |
331 | # croak? |
12fdd461 |
332 | $self->storage->dbh->do($_) or carp "SQL was: $_" |
b974984a |
333 | } |
334 | |
8cf0010a |
335 | method _read_sql_file($file) { |
336 | return unless $file; |
b974984a |
337 | |
338 | open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)"); |
339 | my @data = split /\n/, join '', <$fh>; |
340 | close $fh; |
341 | |
342 | @data = grep { |
8cf0010a |
343 | $_ && |
344 | !/^--/ && |
345 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m |
b974984a |
346 | } split /;/, |
8cf0010a |
347 | join '', @data; |
b974984a |
348 | |
349 | return \@data; |
350 | } |
351 | |
b974984a |
352 | 1; |
61847972 |
353 | |
354 | __END__ |
355 | |
356 | vim: ts=2,sw=2,expandtab |