Commit | Line | Data |
45d0d9d5 |
1 | package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator; |
334bced5 |
2 | use Moose; |
9af9d0b2 |
3 | |
4 | use autodie; |
5 | use Carp qw( carp croak ); |
6 | |
2e68a8e1 |
7 | use Method::Signatures::Simple; |
7f50d101 |
8 | use Try::Tiny; |
9af9d0b2 |
9 | |
d23c7c77 |
10 | use SQL::Translator; |
11 | require SQL::Translator::Diff; |
9af9d0b2 |
12 | |
d23c7c77 |
13 | require DBIx::Class::Storage; # loaded for type constraint |
41863428 |
14 | use DBIx::Class::DeploymentHandler::Types; |
15 | |
9af9d0b2 |
16 | use File::Path 'mkpath'; |
17 | use File::Spec::Functions; |
2e68a8e1 |
18 | |
7521a845 |
19 | with 'DBIx::Class::DeploymentHandler::HandlesDeploy'; |
3c1b5ee8 |
20 | |
d54b8d69 |
21 | has schema => ( |
22 | isa => 'DBIx::Class::Schema', |
23 | is => 'ro', |
24 | required => 1, |
25 | handles => [qw( schema_version )], |
26 | ); |
27 | |
334bced5 |
28 | has storage => ( |
29 | isa => 'DBIx::Class::Storage', |
30 | is => 'ro', |
31 | lazy_build => 1, |
32 | ); |
33 | |
2eaf903b |
34 | method _build_storage { |
35 | my $s = $self->schema->storage; |
36 | $s->_determine_driver; |
37 | $s |
38 | } |
39 | |
334bced5 |
40 | has sqltargs => ( |
41 | isa => 'HashRef', |
42 | is => 'ro', |
43 | default => sub { {} }, |
44 | ); |
45 | has upgrade_directory => ( |
46 | isa => 'Str', |
47 | is => 'ro', |
48 | required => 1, |
49 | default => 'sql', |
50 | ); |
51 | |
334bced5 |
52 | has databases => ( |
53 | coerce => 1, |
54 | isa => 'DBIx::Class::DeploymentHandler::Databases', |
55 | is => 'ro', |
56 | default => sub { [qw( MySQL SQLite PostgreSQL )] }, |
57 | ); |
58 | |
a7d53deb |
59 | has txn_wrap => ( |
60 | is => 'ro', |
61 | isa => 'Bool', |
62 | default => 1, |
63 | ); |
64 | |
76d311e7 |
65 | method __ddl_consume_with_prefix($type, $versions, $prefix) { |
262166c1 |
66 | my $base_dir = $self->upgrade_directory; |
67 | |
76d08d08 |
68 | my $main = catfile( $base_dir, $type ); |
69 | my $generic = catfile( $base_dir, '_generic' ); |
70 | my $common = |
71 | catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} ); |
262166c1 |
72 | |
73 | my $dir; |
74 | if (-d $main) { |
76d08d08 |
75 | $dir = catfile($main, $prefix, join q(-), @{$versions}) |
262166c1 |
76 | } elsif (-d $generic) { |
9af9d0b2 |
77 | $dir = catfile($generic, $prefix, join q(-), @{$versions}); |
262166c1 |
78 | } else { |
9af9d0b2 |
79 | croak "neither $main or $generic exist; please write/generate some SQL"; |
262166c1 |
80 | } |
81 | |
82 | opendir my($dh), $dir; |
41219a5d |
83 | my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl)$/ && -f "$dir/$_" } readdir $dh; |
262166c1 |
84 | closedir $dh; |
85 | |
86 | if (-d $common) { |
87 | opendir my($dh), $common; |
41219a5d |
88 | for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { |
262166c1 |
89 | unless ($files{$filename}) { |
9af9d0b2 |
90 | $files{$filename} = catfile($common,$filename); |
262166c1 |
91 | } |
92 | } |
93 | closedir $dh; |
94 | } |
95 | |
96 | return [@files{sort keys %files}] |
97 | } |
3c1b5ee8 |
98 | |
76d311e7 |
99 | method _ddl_schema_consume_filenames($type, $version) { |
100 | $self->__ddl_consume_with_prefix($type, [ $version ], 'schema') |
3c1b5ee8 |
101 | } |
102 | |
76d311e7 |
103 | method _ddl_schema_produce_filename($type, $version) { |
76d08d08 |
104 | my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version ); |
105 | mkpath($dirname) unless -d $dirname; |
d54b8d69 |
106 | |
76d08d08 |
107 | return catfile( $dirname, '001-auto.sql' ); |
d54b8d69 |
108 | } |
109 | |
76d311e7 |
110 | method _ddl_schema_up_consume_filenames($type, $versions) { |
111 | $self->__ddl_consume_with_prefix($type, $versions, 'up') |
3c1b5ee8 |
112 | } |
113 | |
76d311e7 |
114 | method _ddl_schema_down_consume_filenames($type, $versions) { |
115 | $self->__ddl_consume_with_prefix($type, $versions, 'down') |
a41a04e5 |
116 | } |
117 | |
76d311e7 |
118 | method _ddl_schema_up_produce_filename($type, $versions) { |
119 | my $dir = $self->upgrade_directory; |
120 | |
76d08d08 |
121 | my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions}); |
122 | mkpath($dirname) unless -d $dirname; |
a41a04e5 |
123 | |
76d08d08 |
124 | return catfile( $dirname, '001-auto.sql' |
a41a04e5 |
125 | ); |
126 | } |
127 | |
76d311e7 |
128 | method _ddl_schema_down_produce_filename($type, $versions, $dir) { |
76d08d08 |
129 | my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} ); |
130 | mkpath($dirname) unless -d $dirname; |
24f4524b |
131 | |
76d08d08 |
132 | return catfile( $dirname, '001-auto.sql'); |
24f4524b |
133 | } |
134 | |
41219a5d |
135 | method _run_sql_and_perl($filenames) { |
136 | my @files = @{$filenames}; |
137 | my $storage = $self->storage; |
2e68a8e1 |
138 | |
c8a2f7bd |
139 | |
a7d53deb |
140 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
141 | |
41219a5d |
142 | my $sql; |
143 | for my $filename (@files) { |
144 | if ($filename =~ /\.sql$/) { |
145 | my @sql = @{$self->_read_sql_file($filename)}; |
146 | $sql .= join "\n", @sql; |
147 | |
148 | foreach my $line (@sql) { |
149 | $storage->_query_start($line); |
150 | try { |
151 | # do a dbh_do cycle here, as we need some error checking in |
152 | # place (even though we will ignore errors) |
153 | $storage->dbh_do (sub { $_[1]->do($line) }); |
154 | } |
155 | catch { |
156 | carp "$_ (running '${line}')" |
157 | } |
158 | $storage->_query_end($line); |
159 | } |
0841a743 |
160 | } elsif ( $filename =~ /^(.+)\.pl$/ ) { |
161 | my $package = $1; |
162 | my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; |
163 | # make the package name more palateable to perl |
164 | $package =~ s/\W/_/g; |
165 | |
166 | no warnings 'redefine'; |
167 | eval "package $package;\n\n$filedata"; |
168 | use warnings; |
169 | |
98c9484a |
170 | if (my $fn = $package->can('run')) { |
171 | $fn->($self->schema); |
172 | } else { |
173 | carp "$filename should define a run method that takes a schema but it didn't!"; |
174 | } |
41219a5d |
175 | } else { |
176 | croak "A file got to deploy that wasn't sql or perl!"; |
2e68a8e1 |
177 | } |
2e68a8e1 |
178 | } |
a7d53deb |
179 | |
180 | $guard->commit if $self->txn_wrap; |
41219a5d |
181 | |
182 | return $sql; |
183 | } |
184 | |
185 | sub deploy { |
186 | my $self = shift; |
187 | |
188 | return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( |
189 | $self->storage->sqlt_type, |
190 | $self->schema_version |
191 | )); |
2e68a8e1 |
192 | } |
193 | |
c8a2f7bd |
194 | sub _prepare_install { |
7521a845 |
195 | my $self = shift; |
c8a2f7bd |
196 | my $sqltargs = { %{$self->sqltargs}, %{shift @_} }; |
197 | my $to_file = shift; |
2e68a8e1 |
198 | my $schema = $self->schema; |
199 | my $databases = $self->databases; |
200 | my $dir = $self->upgrade_directory; |
d54b8d69 |
201 | my $version = $schema->schema_version; |
202 | |
9600776d |
203 | my $sqlt = SQL::Translator->new({ |
d54b8d69 |
204 | add_drop_table => 1, |
2e68a8e1 |
205 | ignore_constraint_names => 1, |
d54b8d69 |
206 | ignore_index_names => 1, |
207 | parser => 'SQL::Translator::Parser::DBIx::Class', |
3aaf766f |
208 | %{$sqltargs} |
9600776d |
209 | }); |
2e68a8e1 |
210 | |
d53e0bfc |
211 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
212 | or croak($sqlt->error); |
2e68a8e1 |
213 | |
214 | foreach my $db (@$databases) { |
215 | $sqlt->reset; |
216 | $sqlt->{schema} = $sqlt_schema; |
217 | $sqlt->producer($db); |
218 | |
c8a2f7bd |
219 | my $filename = $self->$to_file($db, $version, $dir); |
9600776d |
220 | if (-e $filename ) { |
2e68a8e1 |
221 | carp "Overwriting existing DDL file - $filename"; |
222 | unlink $filename; |
223 | } |
224 | |
225 | my $output = $sqlt->translate; |
226 | if(!$output) { |
227 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
228 | next; |
229 | } |
387b11d2 |
230 | open my $file, q(>), $filename; |
2e68a8e1 |
231 | print {$file} $output; |
232 | close $file; |
233 | } |
234 | } |
235 | |
c8a2f7bd |
236 | sub _resultsource_install_filename { |
237 | my ($self, $source_name) = @_; |
238 | return sub { |
239 | my ($self, $type, $version) = @_; |
240 | my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version ); |
241 | mkpath($dirname) unless -d $dirname; |
242 | |
243 | return catfile( $dirname, "001-auto-$source_name.sql" ); |
244 | } |
245 | } |
246 | |
247 | sub install_resultsource { |
248 | my ($self, $source, $version) = @_; |
249 | |
250 | my $rs_install_file = |
251 | $self->_resultsource_install_filename($source->source_name); |
252 | |
253 | my $files = [ |
254 | $self->$rs_install_file( |
255 | $self->storage->sqlt_type, |
256 | $version, |
257 | ) |
258 | ]; |
259 | $self->_run_sql_and_perl($files); |
260 | } |
261 | |
262 | sub prepare_resultsource_install { |
263 | my $self = shift; |
264 | my $source = shift; |
265 | |
266 | my $filename = $self->_resultsource_install_filename($source->source_name); |
267 | $self->_prepare_install({ |
268 | parser_args => { sources => [$source->source_name], } |
269 | }, $filename); |
270 | } |
271 | |
272 | sub prepare_install { |
273 | my $self = shift; |
274 | $self->_prepare_install({}, '_ddl_schema_produce_filename'); |
275 | } |
276 | |
a41a04e5 |
277 | sub prepare_upgrade { |
9600776d |
278 | my ($self, $from_version, $to_version, $version_set) = @_; |
76d311e7 |
279 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up'); |
280 | } |
281 | |
282 | sub prepare_downgrade { |
283 | my ($self, $from_version, $to_version, $version_set) = @_; |
284 | |
76d311e7 |
285 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down'); |
286 | } |
287 | |
288 | method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { |
2e68a8e1 |
289 | my $schema = $self->schema; |
290 | my $databases = $self->databases; |
291 | my $dir = $self->upgrade_directory; |
292 | my $sqltargs = $self->sqltargs; |
293 | |
9600776d |
294 | my $schema_version = $schema->schema_version; |
2e68a8e1 |
295 | |
296 | $sqltargs = { |
297 | add_drop_table => 1, |
298 | ignore_constraint_names => 1, |
299 | ignore_index_names => 1, |
300 | %{$sqltargs} |
301 | }; |
302 | |
303 | my $sqlt = SQL::Translator->new( $sqltargs ); |
304 | |
305 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
d53e0bfc |
306 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
307 | or croak($sqlt->error); |
2e68a8e1 |
308 | |
309 | foreach my $db (@$databases) { |
310 | $sqlt->reset; |
311 | $sqlt->{schema} = $sqlt_schema; |
312 | $sqlt->producer($db); |
313 | |
76d311e7 |
314 | my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir); |
2e68a8e1 |
315 | unless(-e $prefilename) { |
316 | carp("No previous schema file found ($prefilename)"); |
317 | next; |
318 | } |
76d311e7 |
319 | my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; |
320 | my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); |
2e68a8e1 |
321 | if(-e $diff_file) { |
76d311e7 |
322 | carp("Overwriting existing $direction-diff file - $diff_file"); |
2e68a8e1 |
323 | unlink $diff_file; |
324 | } |
325 | |
326 | my $source_schema; |
327 | { |
328 | my $t = SQL::Translator->new({ |
329 | %{$sqltargs}, |
330 | debug => 0, |
331 | trace => 0, |
332 | }); |
333 | |
334 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
335 | or croak($t->error); |
2e68a8e1 |
336 | |
337 | my $out = $t->translate( $prefilename ) |
387b11d2 |
338 | or croak($t->error); |
2e68a8e1 |
339 | |
340 | $source_schema = $t->schema; |
341 | |
342 | $source_schema->name( $prefilename ) |
343 | unless $source_schema->name; |
344 | } |
345 | |
346 | # The "new" style of producers have sane normalization and can support |
347 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
348 | # And we have to diff parsed SQL against parsed SQL. |
349 | my $dest_schema = $sqlt_schema; |
350 | |
351 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
352 | my $t = SQL::Translator->new({ |
353 | %{$sqltargs}, |
354 | debug => 0, |
355 | trace => 0, |
356 | }); |
357 | |
358 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
359 | or croak($t->error); |
2e68a8e1 |
360 | |
76d311e7 |
361 | my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir); |
2e68a8e1 |
362 | my $out = $t->translate( $filename ) |
387b11d2 |
363 | or croak($t->error); |
2e68a8e1 |
364 | |
365 | $dest_schema = $t->schema; |
366 | |
367 | $dest_schema->name( $filename ) |
368 | unless $dest_schema->name; |
369 | } |
370 | |
371 | my $diff = SQL::Translator::Diff::schema_diff( |
372 | $source_schema, $db, |
373 | $dest_schema, $db, |
374 | $sqltargs |
375 | ); |
387b11d2 |
376 | open my $file, q(>), $diff_file; |
2e68a8e1 |
377 | print {$file} $diff; |
378 | close $file; |
379 | } |
380 | } |
381 | |
334bced5 |
382 | method _read_sql_file($file) { |
383 | return unless $file; |
384 | |
aabd4237 |
385 | open my $fh, '<', $file; |
0d19af1d |
386 | my @data = split /;\n/, join '', <$fh>; |
334bced5 |
387 | close $fh; |
388 | |
389 | @data = grep { |
0d19af1d |
390 | $_ && # remove blank lines |
391 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
392 | } map { |
393 | s/^\s+//; s/\s+$//; # trim whitespace |
394 | join '', grep { !/^--/ } split /\n/ # remove comments |
395 | } @data; |
334bced5 |
396 | |
397 | return \@data; |
398 | } |
399 | |
7d2a6974 |
400 | sub downgrade_single_step { |
76d311e7 |
401 | my $self = shift; |
627581cd |
402 | my $version_set = shift @_; |
41219a5d |
403 | |
404 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames( |
76d311e7 |
405 | $self->storage->sqlt_type, |
627581cd |
406 | $version_set, |
41219a5d |
407 | )); |
3249629f |
408 | |
41219a5d |
409 | return ['', $sql]; |
76d311e7 |
410 | } |
411 | |
7d2a6974 |
412 | sub upgrade_single_step { |
7521a845 |
413 | my $self = shift; |
627581cd |
414 | my $version_set = shift @_; |
41219a5d |
415 | |
416 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames( |
334bced5 |
417 | $self->storage->sqlt_type, |
627581cd |
418 | $version_set, |
41219a5d |
419 | )); |
420 | return ['', $sql]; |
334bced5 |
421 | } |
422 | |
aabd4237 |
423 | __PACKAGE__->meta->make_immutable; |
424 | |
2e68a8e1 |
425 | 1; |
e051bb00 |
426 | |
e52174e3 |
427 | # vim: ts=2 sw=2 expandtab |
428 | |
e051bb00 |
429 | __END__ |
430 | |
eb28403b |
431 | =attr schema |
a65184c8 |
432 | |
eb28403b |
433 | =attr storage |
a65184c8 |
434 | |
eb28403b |
435 | =attr sqltargs |
cfc9edf9 |
436 | |
437 | #rename |
a65184c8 |
438 | |
eb28403b |
439 | =attr upgrade_directory |
cfc9edf9 |
440 | |
441 | The directory (default C<'sql'>) that upgrades are stored in |
442 | |
eb28403b |
443 | =attr databases |
cfc9edf9 |
444 | |
445 | The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to |
446 | generate files for |
447 | |
eb28403b |
448 | =attr txn_wrap |
449 | |
450 | =method __ddl_consume_with_prefix |
a65184c8 |
451 | |
eb28403b |
452 | =method _ddl_schema_consume_filenames |
a65184c8 |
453 | |
eb28403b |
454 | =method _ddl_schema_produce_filename |
a65184c8 |
455 | |
eb28403b |
456 | =method _ddl_schema_up_consume_filenames |
a65184c8 |
457 | |
eb28403b |
458 | =method _ddl_schema_down_consume_filenames |
a65184c8 |
459 | |
eb28403b |
460 | =method _ddl_schema_up_produce_filenames |
a65184c8 |
461 | |
eb28403b |
462 | =method _ddl_schema_down_produce_filenames |
a65184c8 |
463 | |
eb28403b |
464 | =method _resultsource_install_filename |
a65184c8 |
465 | |
eb28403b |
466 | =method _run_sql_and_perl |
467 | |
468 | =method _prepare_install |
a65184c8 |
469 | |
eb28403b |
470 | =method _prepare_changegrade |
a65184c8 |
471 | |
eb28403b |
472 | =method _read_sql_file |
473 | |
474 | =method deploy |
a65184c8 |
475 | |
eb28403b |
476 | =method install_resultsource |
a65184c8 |
477 | |
eb28403b |
478 | =method prepare_resultsouce_install |
a65184c8 |
479 | |
eb28403b |
480 | =method prepare_install |
a65184c8 |
481 | |
eb28403b |
482 | =method prepare_upgrade |
a65184c8 |
483 | |
eb28403b |
484 | =method prepare_downgrade |
a65184c8 |
485 | |
eb28403b |
486 | =method upgrade_single_step |
a65184c8 |
487 | |
eb28403b |
488 | =method downgrade_single_step |
489 | |