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; |
d76abae0 |
10 | use Try::Tiny; |
b974984a |
11 | |
cf400f48 |
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 | |
b974984a |
23 | has schema => ( |
61847972 |
24 | isa => 'DBIx::Class::Schema', |
25 | is => 'ro', |
26 | required => 1, |
4ea147c6 |
27 | handles => [qw( ddl_filename schema_version )], |
b974984a |
28 | ); |
29 | |
30 | has upgrade_directory => ( |
61847972 |
31 | isa => 'Str', |
32 | is => 'ro', |
33 | required => 1, |
4ea147c6 |
34 | default => 'sql', |
b974984a |
35 | ); |
36 | |
37 | has backup_directory => ( |
61847972 |
38 | isa => 'Str', |
39 | is => 'ro', |
b974984a |
40 | ); |
41 | |
42 | has storage => ( |
61847972 |
43 | isa => 'DBIx::Class::Storage', |
44 | is => 'ro', |
45 | lazy_build => 1, |
b974984a |
46 | ); |
47 | |
7eec7eb7 |
48 | method _build_storage { |
61847972 |
49 | my $s = $self->schema->storage; |
50 | $s->_determine_driver; |
51 | $s |
7eec7eb7 |
52 | } |
12fdd461 |
53 | |
b974984a |
54 | has _filedata => ( |
4ea147c6 |
55 | isa => 'ArrayRef[Str]', |
61847972 |
56 | is => 'rw', |
b974984a |
57 | ); |
58 | |
59 | has do_backup => ( |
61847972 |
60 | isa => 'Bool', |
61 | is => 'ro', |
62 | default => undef, |
b974984a |
63 | ); |
64 | |
65 | has do_diff_on_init => ( |
61847972 |
66 | isa => 'Bool', |
67 | is => 'ro', |
68 | default => undef, |
b974984a |
69 | ); |
70 | |
12fdd461 |
71 | has version_rs => ( |
61847972 |
72 | isa => 'DBIx::Class::ResultSet', |
73 | is => 'ro', |
74 | lazy_build => 1, |
75 | handles => [qw( is_installed db_version )], |
12fdd461 |
76 | ); |
77 | |
9e401dc2 |
78 | has databases => ( |
cf400f48 |
79 | coerce => 1, |
80 | isa => 'DBIx::Class::DeploymentHandler::Databases', |
81 | is => 'ro', |
9e401dc2 |
82 | default => sub { [qw( MySQL SQLite PostgreSQL )] }, |
83 | ); |
84 | |
ecc3b6be |
85 | has sqltargs => ( |
86 | isa => 'HashRef', |
87 | is => 'ro', |
88 | default => sub { {} }, |
89 | ); |
90 | |
46a47cd4 |
91 | method deployment_statements { |
92 | my $dir = $self->upgrade_directory; |
93 | my $schema = $self->schema; |
94 | my $type = $self->storage->sqlt_type; |
95 | my $sqltargs = $self->sqltargs; |
d76abae0 |
96 | my $version = $self->schema_version || '1.x'; |
46a47cd4 |
97 | |
d76abae0 |
98 | my $filename = $self->ddl_filename($type, $version, $dir); |
99 | if(-f $filename) { |
741620a6 |
100 | my $file; |
d76abae0 |
101 | open $file, q(<), $filename |
102 | or carp "Can't open $filename ($!)"; |
741620a6 |
103 | my @rows = <$file>; |
d76abae0 |
104 | close $file; |
105 | return join '', @rows; |
741620a6 |
106 | } |
107 | |
108 | # sources needs to be a parser arg, but for simplicty allow at top level |
109 | # coming in |
110 | $sqltargs->{parser_args}{sources} = delete $sqltargs->{sources} |
111 | if exists $sqltargs->{sources}; |
112 | |
113 | my $tr = SQL::Translator->new( |
114 | producer => "SQL::Translator::Producer::${type}", |
115 | %$sqltargs, |
116 | parser => 'SQL::Translator::Parser::DBIx::Class', |
117 | data => $schema, |
118 | ); |
119 | |
120 | my @ret; |
121 | my $wa = wantarray; |
122 | if ($wa) { |
123 | @ret = $tr->translate; |
124 | } |
125 | else { |
126 | $ret[0] = $tr->translate; |
127 | } |
128 | |
129 | $schema->throw_exception( 'Unable to produce deployment statements: ' . $tr->error) |
130 | unless (@ret && defined $ret[0]); |
131 | |
132 | return $wa ? @ret : $ret[0]; |
133 | } |
134 | |
135 | method deploy { |
46a47cd4 |
136 | my $schema = $self->schema; |
137 | my $type = undef; |
741620a6 |
138 | my $sqltargs = $self->sqltargs; |
46a47cd4 |
139 | my $dir = $self->upgrade_directory; |
140 | my $storage = $self->storage; |
741620a6 |
141 | |
142 | my $deploy = sub { |
143 | my $line = shift; |
d76abae0 |
144 | return if(!$line || $line =~ /^--|^BEGIN TRANSACTION|^COMMIT|^\s+$/); |
741620a6 |
145 | $storage->_query_start($line); |
d76abae0 |
146 | try { |
741620a6 |
147 | # do a dbh_do cycle here, as we need some error checking in |
148 | # place (even though we will ignore errors) |
149 | $storage->dbh_do (sub { $_[1]->do($line) }); |
d76abae0 |
150 | } |
151 | catch { |
152 | carp "$_ (running '${line}')" |
741620a6 |
153 | } |
154 | $storage->_query_end($line); |
155 | }; |
d76abae0 |
156 | my @statements = $self->deployment_statements(); |
741620a6 |
157 | if (@statements > 1) { |
158 | foreach my $statement (@statements) { |
159 | $deploy->( $statement ); |
160 | } |
161 | } |
162 | elsif (@statements == 1) { |
163 | foreach my $line ( split(";\n", $statements[0])) { |
164 | $deploy->( $line ); |
165 | } |
166 | } |
167 | } |
168 | |
30749dbf |
169 | method _build_version_rs { |
170 | $self->schema->set_us_up_the_bomb; |
171 | $self->schema->resultset('__VERSION') |
172 | } |
12fdd461 |
173 | |
174 | method backup { $self->storage->backup($self->backup_directory) } |
b974984a |
175 | |
176 | method install($new_version) { |
12fdd461 |
177 | carp 'Install not possible as versions table already exists in database' |
ceef4ff5 |
178 | if $self->is_installed; |
b974984a |
179 | |
12fdd461 |
180 | $new_version ||= $self->schema_version; |
b974984a |
181 | |
182 | if ($new_version) { |
741620a6 |
183 | $self->deploy(); |
12fdd461 |
184 | |
185 | $self->version_rs->create({ |
61847972 |
186 | version => $new_version, |
187 | # ddl => $ddl, |
188 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
189 | }); |
b974984a |
190 | } |
191 | } |
192 | |
12fdd461 |
193 | method create_upgrade_path { } |
b974984a |
194 | |
8636376a |
195 | method ordered_schema_versions { undef } |
b974984a |
196 | |
197 | method upgrade { |
12fdd461 |
198 | my $db_version = $self->db_version; |
199 | my $schema_version = $self->schema_version; |
b974984a |
200 | |
b974984a |
201 | unless ($db_version) { |
61847972 |
202 | # croak? |
203 | carp 'Upgrade not possible as database is unversioned. Please call install first.'; |
204 | return; |
b974984a |
205 | } |
206 | |
12fdd461 |
207 | if ( $db_version eq $schema_version ) { |
61847972 |
208 | # croak? |
209 | carp "Upgrade not necessary\n"; |
210 | return; |
b974984a |
211 | } |
212 | |
12fdd461 |
213 | my @version_list = $self->ordered_schema_versions || |
214 | ( $db_version, $schema_version ); |
b974984a |
215 | |
216 | # remove all versions in list above the required version |
12fdd461 |
217 | while ( @version_list && ( $version_list[-1] ne $schema_version ) ) { |
61847972 |
218 | pop @version_list; |
b974984a |
219 | } |
220 | |
221 | # remove all versions in list below the current version |
12fdd461 |
222 | while ( @version_list && ( $version_list[0] ne $db_version ) ) { |
61847972 |
223 | shift @version_list; |
b974984a |
224 | } |
225 | |
226 | # check we have an appropriate list of versions |
12fdd461 |
227 | die if @version_list < 2; |
b974984a |
228 | |
229 | # do sets of upgrade |
12fdd461 |
230 | while ( @version_list >= 2 ) { |
61847972 |
231 | $self->upgrade_single_step( $version_list[0], $version_list[1] ); |
232 | shift @version_list; |
b974984a |
233 | } |
234 | } |
235 | |
236 | method upgrade_single_step($db_version, $target_version) { |
b974984a |
237 | if ($db_version eq $target_version) { |
e1f67607 |
238 | # croak? |
b974984a |
239 | carp "Upgrade not necessary\n"; |
240 | return; |
241 | } |
242 | |
b974984a |
243 | my $upgrade_file = $self->ddl_filename( |
12fdd461 |
244 | $self->storage->sqlt_type, |
245 | $target_version, |
246 | $self->upgrade_directory, |
247 | $db_version, |
248 | ); |
b974984a |
249 | |
250 | $self->create_upgrade_path({ upgrade_file => $upgrade_file }); |
251 | |
252 | unless (-f $upgrade_file) { |
e1f67607 |
253 | # croak? |
b974984a |
254 | carp "Upgrade not possible, no upgrade file found ($upgrade_file), please create one\n"; |
255 | return; |
256 | } |
257 | |
258 | carp "DB version ($db_version) is lower than the schema version (".$self->schema_version."). Attempting upgrade.\n"; |
259 | |
e1f67607 |
260 | $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22 |
12fdd461 |
261 | $self->backup if $self->do_backup; |
262 | $self->schema->txn_do(sub { $self->do_upgrade }); |
b974984a |
263 | |
12fdd461 |
264 | $self->version_rs->create({ |
61847972 |
265 | version => $target_version, |
266 | # ddl => $ddl, |
267 | # upgrade_sql => $upgrade_sql, |
12fdd461 |
268 | }); |
b974984a |
269 | } |
270 | |
ecc3b6be |
271 | method create_ddl_dir($version, $preversion) { |
272 | my $schema = $self->schema; |
9e401dc2 |
273 | my $databases = $self->databases; |
ecc3b6be |
274 | my $dir = $self->upgrade_directory; |
275 | my $sqltargs = $self->sqltargs; |
9e401dc2 |
276 | unless( -d $dir ) { |
277 | carp "Upgrade directory $dir does not exist, using ./\n"; |
8164e4d0 |
278 | $dir = "./"; |
279 | } |
8164e4d0 |
280 | |
281 | my $schema_version = $schema->schema_version || '1.x'; |
282 | $version ||= $schema_version; |
283 | |
284 | $sqltargs = { |
285 | add_drop_table => 1, |
286 | ignore_constraint_names => 1, |
287 | ignore_index_names => 1, |
288 | %{$sqltargs || {}} |
289 | }; |
290 | |
8164e4d0 |
291 | my $sqlt = SQL::Translator->new( $sqltargs ); |
292 | |
293 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
294 | my $sqlt_schema = $sqlt->translate({ data => $schema }) |
295 | or $self->throw_exception ($sqlt->error); |
296 | |
297 | foreach my $db (@$databases) { |
c88c9aaa |
298 | $sqlt->reset; |
8164e4d0 |
299 | $sqlt->{schema} = $sqlt_schema; |
300 | $sqlt->producer($db); |
301 | |
c88c9aaa |
302 | my $filename = $self->ddl_filename($db, $version, $dir); |
8164e4d0 |
303 | if (-e $filename && ($version eq $schema_version )) { |
304 | # if we are dumping the current version, overwrite the DDL |
305 | carp "Overwriting existing DDL file - $filename"; |
c88c9aaa |
306 | unlink $filename; |
8164e4d0 |
307 | } |
308 | |
309 | my $output = $sqlt->translate; |
310 | if(!$output) { |
311 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
312 | next; |
313 | } |
c88c9aaa |
314 | my $file; |
315 | unless( open $file, q(>), $filename ) { |
8164e4d0 |
316 | $self->throw_exception("Can't open $filename for writing ($!)"); |
317 | next; |
318 | } |
c88c9aaa |
319 | print {$file} $output; |
320 | close $file; |
8164e4d0 |
321 | |
c88c9aaa |
322 | next unless $preversion; |
8164e4d0 |
323 | |
324 | require SQL::Translator::Diff; |
325 | |
c88c9aaa |
326 | my $prefilename = $self->ddl_filename($db, $preversion, $dir); |
327 | unless(-e $prefilename) { |
8164e4d0 |
328 | carp("No previous schema file found ($prefilename)"); |
329 | next; |
330 | } |
331 | |
c88c9aaa |
332 | my $diff_file = $self->ddl_filename($db, $version, $dir, $preversion); |
333 | if(-e $diff_file) { |
334 | carp("Overwriting existing diff file - $diff_file"); |
335 | unlink $diff_file; |
8164e4d0 |
336 | } |
337 | |
338 | my $source_schema; |
339 | { |
c88c9aaa |
340 | my $t = SQL::Translator->new({ |
341 | %{$sqltargs}, |
342 | debug => 0, |
343 | trace => 0, |
344 | }); |
8164e4d0 |
345 | |
c88c9aaa |
346 | $t->parser( $db ) # could this really throw an exception? |
8164e4d0 |
347 | or $self->throw_exception ($t->error); |
348 | |
349 | my $out = $t->translate( $prefilename ) |
350 | or $self->throw_exception ($t->error); |
351 | |
352 | $source_schema = $t->schema; |
353 | |
354 | $source_schema->name( $prefilename ) |
c88c9aaa |
355 | unless $source_schema->name; |
8164e4d0 |
356 | } |
357 | |
358 | # The "new" style of producers have sane normalization and can support |
359 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
360 | # And we have to diff parsed SQL against parsed SQL. |
361 | my $dest_schema = $sqlt_schema; |
362 | |
363 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
c88c9aaa |
364 | my $t = SQL::Translator->new({ |
365 | %{$sqltargs}, |
366 | debug => 0, |
367 | trace => 0, |
368 | }); |
8164e4d0 |
369 | |
c88c9aaa |
370 | $t->parser( $db ) # could this really throw an exception? |
8164e4d0 |
371 | or $self->throw_exception ($t->error); |
372 | |
373 | my $out = $t->translate( $filename ) |
374 | or $self->throw_exception ($t->error); |
375 | |
376 | $dest_schema = $t->schema; |
377 | |
378 | $dest_schema->name( $filename ) |
379 | unless $dest_schema->name; |
380 | } |
381 | |
c88c9aaa |
382 | my $diff = SQL::Translator::Diff::schema_diff( |
383 | $source_schema, $db, |
384 | $dest_schema, $db, |
385 | $sqltargs |
386 | ); |
387 | unless(open $file, q(>), $diff_file) { |
388 | $self->throw_exception("Can't write to $diff_file ($!)"); |
8164e4d0 |
389 | next; |
390 | } |
c88c9aaa |
391 | print {$file} $diff; |
392 | close $file; |
8164e4d0 |
393 | } |
394 | } |
395 | |
12fdd461 |
396 | method do_upgrade { $self->run_upgrade(qr/.*?/) } |
b974984a |
397 | |
398 | method run_upgrade($stm) { |
12fdd461 |
399 | return unless $self->_filedata; |
400 | my @statements = grep { $_ =~ $stm } @{$self->_filedata}; |
b974984a |
401 | |
12fdd461 |
402 | for (@statements) { |
403 | $self->storage->debugobj->query_start($_) if $self->storage->debug; |
404 | $self->apply_statement($_); |
405 | $self->storage->debugobj->query_end($_) if $self->storage->debug; |
406 | } |
b974984a |
407 | } |
408 | |
409 | method apply_statement($statement) { |
e1f67607 |
410 | # croak? |
12fdd461 |
411 | $self->storage->dbh->do($_) or carp "SQL was: $_" |
b974984a |
412 | } |
413 | |
8cf0010a |
414 | method _read_sql_file($file) { |
415 | return unless $file; |
b974984a |
416 | |
417 | open my $fh, '<', $file or carp("Can't open upgrade file, $file ($!)"); |
418 | my @data = split /\n/, join '', <$fh>; |
419 | close $fh; |
420 | |
421 | @data = grep { |
8cf0010a |
422 | $_ && |
423 | !/^--/ && |
424 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/m |
b974984a |
425 | } split /;/, |
8cf0010a |
426 | join '', @data; |
b974984a |
427 | |
428 | return \@data; |
429 | } |
430 | |
b974984a |
431 | 1; |
61847972 |
432 | |
433 | __END__ |
434 | |
435 | vim: ts=2,sw=2,expandtab |