Commit | Line | Data |
45d0d9d5 |
1 | package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator; |
334bced5 |
2 | use Moose; |
9af9d0b2 |
3 | |
9a3a62f1 |
4 | # ABSTRACT: Manage your SQL and Perl migrations in nicely laid out directories |
5 | |
9af9d0b2 |
6 | use autodie; |
7 | use Carp qw( carp croak ); |
8465e767 |
8 | use DBIx::Class::DeploymentHandler::Logger; |
9 | use Log::Contextual qw(:log :dlog), -default_logger => |
10 | DBIx::Class::DeploymentHandler::Logger->new({ |
11 | env_prefix => 'DBICDH' |
12 | }); |
9af9d0b2 |
13 | |
2e68a8e1 |
14 | use Method::Signatures::Simple; |
7f50d101 |
15 | use Try::Tiny; |
9af9d0b2 |
16 | |
d23c7c77 |
17 | use SQL::Translator; |
18 | require SQL::Translator::Diff; |
9af9d0b2 |
19 | |
d23c7c77 |
20 | require DBIx::Class::Storage; # loaded for type constraint |
41863428 |
21 | use DBIx::Class::DeploymentHandler::Types; |
22 | |
9af9d0b2 |
23 | use File::Path 'mkpath'; |
24 | use File::Spec::Functions; |
2e68a8e1 |
25 | |
7521a845 |
26 | with 'DBIx::Class::DeploymentHandler::HandlesDeploy'; |
3c1b5ee8 |
27 | |
93460690 |
28 | has ignore_ddl => ( |
29 | isa => 'Bool', |
30 | is => 'ro', |
31 | default => undef, |
32 | ); |
33 | |
d54b8d69 |
34 | has schema => ( |
35 | isa => 'DBIx::Class::Schema', |
36 | is => 'ro', |
37 | required => 1, |
d54b8d69 |
38 | ); |
39 | |
334bced5 |
40 | has storage => ( |
41 | isa => 'DBIx::Class::Storage', |
42 | is => 'ro', |
43 | lazy_build => 1, |
44 | ); |
45 | |
2eaf903b |
46 | method _build_storage { |
47 | my $s = $self->schema->storage; |
48 | $s->_determine_driver; |
49 | $s |
50 | } |
51 | |
02a7b8ac |
52 | has sql_translator_args => ( |
334bced5 |
53 | isa => 'HashRef', |
54 | is => 'ro', |
55 | default => sub { {} }, |
56 | ); |
91adde75 |
57 | has script_directory => ( |
334bced5 |
58 | isa => 'Str', |
59 | is => 'ro', |
60 | required => 1, |
61 | default => 'sql', |
62 | ); |
63 | |
334bced5 |
64 | has databases => ( |
65 | coerce => 1, |
66 | isa => 'DBIx::Class::DeploymentHandler::Databases', |
67 | is => 'ro', |
68 | default => sub { [qw( MySQL SQLite PostgreSQL )] }, |
69 | ); |
70 | |
a7d53deb |
71 | has txn_wrap => ( |
72 | is => 'ro', |
73 | isa => 'Bool', |
74 | default => 1, |
75 | ); |
76 | |
73caa630 |
77 | has schema_version => ( |
78 | is => 'ro', |
e86c0c07 |
79 | isa => 'Str', |
73caa630 |
80 | lazy_build => 1, |
81 | ); |
82 | |
6df6dcb9 |
83 | # this will probably never get called as the DBICDH |
84 | # will be passing down a schema_version normally, which |
85 | # is built the same way, but we leave this in place |
73caa630 |
86 | method _build_schema_version { $self->schema->schema_version } |
87 | |
76d311e7 |
88 | method __ddl_consume_with_prefix($type, $versions, $prefix) { |
91adde75 |
89 | my $base_dir = $self->script_directory; |
262166c1 |
90 | |
76d08d08 |
91 | my $main = catfile( $base_dir, $type ); |
76d08d08 |
92 | my $common = |
93 | catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} ); |
262166c1 |
94 | |
95 | my $dir; |
96 | if (-d $main) { |
76d08d08 |
97 | $dir = catfile($main, $prefix, join q(-), @{$versions}) |
262166c1 |
98 | } else { |
38857f30 |
99 | if ($self->ignore_ddl) { |
100 | return [] |
101 | } else { |
102 | croak "$main does not exist; please write/generate some SQL" |
103 | } |
262166c1 |
104 | } |
105 | |
ef44838b |
106 | my %files; |
107 | try { |
108 | opendir my($dh), $dir; |
109 | %files = |
110 | map { $_ => "$dir/$_" } |
111 | grep { /\.(?:sql|pl|sql-\w+)$/ && -f "$dir/$_" } |
112 | readdir $dh; |
113 | closedir $dh; |
114 | } catch { |
115 | die $_ unless $self->ignore_ddl; |
116 | }; |
262166c1 |
117 | if (-d $common) { |
118 | opendir my($dh), $common; |
41219a5d |
119 | for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { |
262166c1 |
120 | unless ($files{$filename}) { |
9af9d0b2 |
121 | $files{$filename} = catfile($common,$filename); |
262166c1 |
122 | } |
123 | } |
124 | closedir $dh; |
125 | } |
126 | |
127 | return [@files{sort keys %files}] |
128 | } |
3c1b5ee8 |
129 | |
fc4b7602 |
130 | method _ddl_preinstall_consume_filenames($type, $version) { |
131 | $self->__ddl_consume_with_prefix($type, [ $version ], 'preinstall') |
132 | } |
133 | |
76d311e7 |
134 | method _ddl_schema_consume_filenames($type, $version) { |
58eb99c3 |
135 | $self->__ddl_consume_with_prefix($type, [ $version ], 'deploy') |
3c1b5ee8 |
136 | } |
137 | |
58eb99c3 |
138 | method _ddl_protoschema_upgrade_consume_filenames($versions) { |
f9c6ab50 |
139 | my $base_dir = $self->script_directory; |
140 | |
58eb99c3 |
141 | my $dir = catfile( $base_dir, '_preprocess_schema', 'upgrade', join q(-), @{$versions}); |
f9c6ab50 |
142 | |
143 | return [] unless -d $dir; |
144 | |
145 | opendir my($dh), $dir; |
146 | my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh; |
147 | closedir $dh; |
148 | |
149 | return [@files{sort keys %files}] |
150 | } |
151 | |
58eb99c3 |
152 | method _ddl_protoschema_downgrade_consume_filenames($versions) { |
f9c6ab50 |
153 | my $base_dir = $self->script_directory; |
154 | |
58eb99c3 |
155 | my $dir = catfile( $base_dir, '_preprocess_schema', 'downgrade', join q(-), @{$versions}); |
f9c6ab50 |
156 | |
157 | return [] unless -d $dir; |
158 | |
159 | opendir my($dh), $dir; |
160 | my %files = map { $_ => "$dir/$_" } grep { /\.pl$/ && -f "$dir/$_" } readdir $dh; |
161 | closedir $dh; |
162 | |
163 | return [@files{sort keys %files}] |
164 | } |
165 | |
7e08eddd |
166 | method _ddl_protoschema_produce_filename($version) { |
58eb99c3 |
167 | my $dirname = catfile( $self->script_directory, '_source', 'deploy', $version ); |
7e08eddd |
168 | mkpath($dirname) unless -d $dirname; |
169 | |
170 | return catfile( $dirname, '001-auto.yml' ); |
171 | } |
172 | |
76d311e7 |
173 | method _ddl_schema_produce_filename($type, $version) { |
58eb99c3 |
174 | my $dirname = catfile( $self->script_directory, $type, 'deploy', $version ); |
76d08d08 |
175 | mkpath($dirname) unless -d $dirname; |
d54b8d69 |
176 | |
09bc35e3 |
177 | return catfile( $dirname, '001-auto.sql' ); |
d54b8d69 |
178 | } |
179 | |
58eb99c3 |
180 | method _ddl_schema_upgrade_consume_filenames($type, $versions) { |
181 | $self->__ddl_consume_with_prefix($type, $versions, 'upgrade') |
3c1b5ee8 |
182 | } |
183 | |
58eb99c3 |
184 | method _ddl_schema_downgrade_consume_filenames($type, $versions) { |
185 | $self->__ddl_consume_with_prefix($type, $versions, 'downgrade') |
a41a04e5 |
186 | } |
187 | |
58eb99c3 |
188 | method _ddl_schema_upgrade_produce_filename($type, $versions) { |
91adde75 |
189 | my $dir = $self->script_directory; |
76d311e7 |
190 | |
58eb99c3 |
191 | my $dirname = catfile( $dir, $type, 'upgrade', join q(-), @{$versions}); |
76d08d08 |
192 | mkpath($dirname) unless -d $dirname; |
a41a04e5 |
193 | |
e62add58 |
194 | return catfile( $dirname, '001-auto.sql' ); |
a41a04e5 |
195 | } |
196 | |
58eb99c3 |
197 | method _ddl_schema_downgrade_produce_filename($type, $versions, $dir) { |
198 | my $dirname = catfile( $dir, $type, 'downgrade', join q(-), @{$versions} ); |
76d08d08 |
199 | mkpath($dirname) unless -d $dirname; |
24f4524b |
200 | |
09bc35e3 |
201 | return catfile( $dirname, '001-auto.sql'); |
24f4524b |
202 | } |
203 | |
f36afe83 |
204 | method _run_sql_array($sql) { |
41219a5d |
205 | my $storage = $self->storage; |
5d7b27cf |
206 | |
1f0d0633 |
207 | $sql = [grep { |
208 | $_ && # remove blank lines |
209 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
210 | } map { |
211 | s/^\s+//; s/\s+$//; # trim whitespace |
212 | join '', grep { !/^--/ } split /\n/ # remove comments |
213 | } @$sql]; |
214 | |
f4075791 |
215 | Dlog_trace { "Running SQL $_" } $sql; |
f36afe83 |
216 | foreach my $line (@{$sql}) { |
5d7b27cf |
217 | $storage->_query_start($line); |
10a62c3d |
218 | # the whole reason we do this is so that we can see the line that was run |
5d7b27cf |
219 | try { |
5d7b27cf |
220 | $storage->dbh_do (sub { $_[1]->do($line) }); |
221 | } |
222 | catch { |
10a62c3d |
223 | die "$_ (running line '$line')" |
5d7b27cf |
224 | } |
225 | $storage->_query_end($line); |
226 | } |
4d09f712 |
227 | return join "\n", @$sql |
f36afe83 |
228 | } |
229 | |
230 | method _run_sql($filename) { |
f4075791 |
231 | log_debug { "Running SQL from $filename" }; |
f36afe83 |
232 | return $self->_run_sql_array($self->_read_sql_file($filename)); |
5d7b27cf |
233 | } |
2e68a8e1 |
234 | |
5d7b27cf |
235 | method _run_perl($filename) { |
f4075791 |
236 | log_debug { "Running Perl from $filename" }; |
5d7b27cf |
237 | my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; |
c8a2f7bd |
238 | |
5d7b27cf |
239 | no warnings 'redefine'; |
240 | my $fn = eval "$filedata"; |
241 | use warnings; |
f4075791 |
242 | Dlog_trace { "Running Perl $_" } $fn; |
5d7b27cf |
243 | |
244 | if ($@) { |
245 | carp "$filename failed to compile: $@"; |
246 | } elsif (ref $fn eq 'CODE') { |
247 | $fn->($self->schema) |
248 | } else { |
249 | carp "$filename should define an anonymouse sub that takes a schema but it didn't!"; |
250 | } |
251 | } |
5d7b27cf |
252 | |
ef44838b |
253 | method _run_sql_and_perl($filenames, $sql_to_run) { |
5d7b27cf |
254 | my @files = @{$filenames}; |
255 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
256 | |
ef44838b |
257 | $self->_run_sql_array($sql_to_run) if $self->ignore_ddl; |
258 | |
259 | my $sql = ($sql_to_run)?join ";\n", @$sql_to_run:''; |
260 | FILENAME: |
41219a5d |
261 | for my $filename (@files) { |
ef44838b |
262 | if ($self->ignore_ddl && $filename =~ /^[^_]*-auto.*\.sql$/) { |
263 | next FILENAME |
264 | } elsif ($filename =~ /\.sql$/) { |
5d7b27cf |
265 | $sql .= $self->_run_sql($filename) |
398b1385 |
266 | } elsif ( $filename =~ /\.pl$/ ) { |
5d7b27cf |
267 | $self->_run_perl($filename) |
41219a5d |
268 | } else { |
fc4b7602 |
269 | croak "A file ($filename) got to deploy that wasn't sql or perl!"; |
2e68a8e1 |
270 | } |
2e68a8e1 |
271 | } |
a7d53deb |
272 | |
273 | $guard->commit if $self->txn_wrap; |
41219a5d |
274 | |
275 | return $sql; |
276 | } |
277 | |
278 | sub deploy { |
279 | my $self = shift; |
be140a5f |
280 | my $version = (shift @_ || {})->{version} || $self->schema_version; |
f4075791 |
281 | log_info { "deploying version $version" }; |
ef44838b |
282 | my $sqlt_type = $self->storage->sqlt_type; |
283 | my $sql; |
284 | if ($self->ignore_ddl) { |
285 | $sql = $self->_sql_from_yaml({}, |
286 | '_ddl_protoschema_produce_filename', $sqlt_type |
287 | ); |
288 | } |
289 | return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( |
290 | $sqlt_type, |
291 | $version, |
292 | ), $sql); |
2e68a8e1 |
293 | } |
294 | |
80ff6f6d |
295 | sub preinstall { |
9faec51a |
296 | my $self = shift; |
297 | my $args = shift; |
298 | my $version = $args->{version} || $self->schema_version; |
f4075791 |
299 | log_info { "preinstalling version $version" }; |
9faec51a |
300 | my $storage_type = $args->{storage_type} || $self->storage->sqlt_type; |
fc4b7602 |
301 | |
302 | my @files = @{$self->_ddl_preinstall_consume_filenames( |
9faec51a |
303 | $storage_type, |
fc4b7602 |
304 | $version, |
305 | )}; |
306 | |
307 | for my $filename (@files) { |
308 | # We ignore sql for now (till I figure out what to do with it) |
309 | if ( $filename =~ /^(.+)\.pl$/ ) { |
fc4b7602 |
310 | my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; |
fc4b7602 |
311 | |
9faec51a |
312 | no warnings 'redefine'; |
5b5defbc |
313 | my $fn = eval "$filedata"; |
fc4b7602 |
314 | use warnings; |
5b5defbc |
315 | |
9faec51a |
316 | if ($@) { |
3fa64c79 |
317 | carp "$filename failed to compile: $@"; |
9faec51a |
318 | } elsif (ref $fn eq 'CODE') { |
fc4b7602 |
319 | $fn->() |
320 | } else { |
5b5defbc |
321 | carp "$filename should define an anonymous sub but it didn't!"; |
fc4b7602 |
322 | } |
323 | } else { |
324 | croak "A file ($filename) got to preinstall_scripts that wasn't sql or perl!"; |
325 | } |
326 | } |
327 | } |
328 | |
f9c6ab50 |
329 | method _sqldiff_from_yaml($from_version, $to_version, $db, $direction) { |
91adde75 |
330 | my $dir = $self->script_directory; |
28563f97 |
331 | my $sqltargs = { |
332 | add_drop_table => 1, |
333 | ignore_constraint_names => 1, |
334 | ignore_index_names => 1, |
335 | %{$self->sql_translator_args} |
336 | }; |
d54b8d69 |
337 | |
28563f97 |
338 | my $source_schema; |
339 | { |
340 | my $prefilename = $self->_ddl_protoschema_produce_filename($from_version, $dir); |
341 | |
342 | # should probably be a croak |
343 | carp("No previous schema file found ($prefilename)") |
344 | unless -e $prefilename; |
345 | |
346 | my $t = SQL::Translator->new({ |
347 | %{$sqltargs}, |
348 | debug => 0, |
349 | trace => 0, |
350 | parser => 'SQL::Translator::Parser::YAML', |
351 | }); |
352 | |
353 | my $out = $t->translate( $prefilename ) |
354 | or croak($t->error); |
355 | |
356 | $source_schema = $t->schema; |
357 | |
358 | $source_schema->name( $prefilename ) |
359 | unless $source_schema->name; |
360 | } |
361 | |
362 | my $dest_schema; |
363 | { |
364 | my $filename = $self->_ddl_protoschema_produce_filename($to_version, $dir); |
365 | |
366 | # should probably be a croak |
367 | carp("No next schema file found ($filename)") |
368 | unless -e $filename; |
369 | |
370 | my $t = SQL::Translator->new({ |
371 | %{$sqltargs}, |
372 | debug => 0, |
373 | trace => 0, |
374 | parser => 'SQL::Translator::Parser::YAML', |
375 | }); |
376 | |
377 | my $out = $t->translate( $filename ) |
378 | or croak($t->error); |
379 | |
380 | $dest_schema = $t->schema; |
381 | |
382 | $dest_schema->name( $filename ) |
383 | unless $dest_schema->name; |
384 | } |
f9c6ab50 |
385 | |
386 | my $transform_files_method = "_ddl_protoschema_${direction}_consume_filenames"; |
387 | my $transforms = $self->_coderefs_per_files( |
388 | $self->$transform_files_method([$from_version, $to_version]) |
389 | ); |
390 | $_->($source_schema, $dest_schema) for @$transforms; |
391 | |
28563f97 |
392 | return [SQL::Translator::Diff::schema_diff( |
393 | $source_schema, $db, |
394 | $dest_schema, $db, |
395 | $sqltargs |
396 | )]; |
397 | } |
398 | |
399 | method _sql_from_yaml($sqltargs, $from_file, $db) { |
400 | my $schema = $self->schema; |
401 | my $version = $self->schema_version; |
93460690 |
402 | |
9600776d |
403 | my $sqlt = SQL::Translator->new({ |
ef44838b |
404 | add_drop_table => 0, |
7e08eddd |
405 | parser => 'SQL::Translator::Parser::YAML', |
28563f97 |
406 | %{$sqltargs}, |
407 | producer => $db, |
9600776d |
408 | }); |
2e68a8e1 |
409 | |
e62add58 |
410 | my $yaml_filename = $self->$from_file($version); |
2e68a8e1 |
411 | |
28563f97 |
412 | my @sql = $sqlt->translate($yaml_filename); |
413 | if(!@sql) { |
414 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
415 | return undef; |
416 | } |
417 | return \@sql; |
418 | } |
419 | |
420 | sub _prepare_install { |
421 | my $self = shift; |
422 | my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} }; |
423 | my $from_file = shift; |
424 | my $to_file = shift; |
425 | my $dir = $self->script_directory; |
426 | my $databases = $self->databases; |
427 | my $version = $self->schema_version; |
428 | |
2e68a8e1 |
429 | foreach my $db (@$databases) { |
28563f97 |
430 | my $sql = $self->_sql_from_yaml($sqltargs, $from_file, $db ) or next; |
2e68a8e1 |
431 | |
c8a2f7bd |
432 | my $filename = $self->$to_file($db, $version, $dir); |
9600776d |
433 | if (-e $filename ) { |
2e68a8e1 |
434 | carp "Overwriting existing DDL file - $filename"; |
435 | unlink $filename; |
436 | } |
387b11d2 |
437 | open my $file, q(>), $filename; |
28563f97 |
438 | print {$file} join ";\n", @$sql; |
2e68a8e1 |
439 | close $file; |
440 | } |
441 | } |
442 | |
c8a2f7bd |
443 | sub _resultsource_install_filename { |
444 | my ($self, $source_name) = @_; |
445 | return sub { |
446 | my ($self, $type, $version) = @_; |
58eb99c3 |
447 | my $dirname = catfile( $self->script_directory, $type, 'deploy', $version ); |
c8a2f7bd |
448 | mkpath($dirname) unless -d $dirname; |
449 | |
09bc35e3 |
450 | return catfile( $dirname, "001-auto-$source_name.sql" ); |
c8a2f7bd |
451 | } |
452 | } |
453 | |
e62add58 |
454 | sub _resultsource_protoschema_filename { |
455 | my ($self, $source_name) = @_; |
456 | return sub { |
457 | my ($self, $version) = @_; |
58eb99c3 |
458 | my $dirname = catfile( $self->script_directory, '_source', $version ); |
e62add58 |
459 | mkpath($dirname) unless -d $dirname; |
460 | |
461 | return catfile( $dirname, "001-auto-$source_name.yml" ); |
462 | } |
463 | } |
464 | |
c8a2f7bd |
465 | sub install_resultsource { |
be140a5f |
466 | my ($self, $args) = @_; |
467 | my $source = $args->{result_source}; |
468 | my $version = $args->{version}; |
f4075791 |
469 | log_info { 'installing_resultsource ' . $source->source_name . ", version $version" }; |
c8a2f7bd |
470 | my $rs_install_file = |
471 | $self->_resultsource_install_filename($source->source_name); |
472 | |
473 | my $files = [ |
474 | $self->$rs_install_file( |
475 | $self->storage->sqlt_type, |
476 | $version, |
477 | ) |
478 | ]; |
479 | $self->_run_sql_and_perl($files); |
480 | } |
481 | |
482 | sub prepare_resultsource_install { |
483 | my $self = shift; |
be140a5f |
484 | my $source = (shift @_)->{result_source}; |
f4075791 |
485 | log_info { 'preparing install for resultsource ' . $source->source_name }; |
c8a2f7bd |
486 | |
e62add58 |
487 | my $install_filename = $self->_resultsource_install_filename($source->source_name); |
488 | my $proto_filename = $self->_resultsource_protoschema_filename($source->source_name); |
6cae2f56 |
489 | $self->prepare_protoschema({ |
c8a2f7bd |
490 | parser_args => { sources => [$source->source_name], } |
e62add58 |
491 | }, $proto_filename); |
492 | $self->_prepare_install({}, $proto_filename, $install_filename); |
c8a2f7bd |
493 | } |
494 | |
91557c90 |
495 | sub prepare_deploy { |
f4075791 |
496 | log_info { 'preparing deploy' }; |
c8a2f7bd |
497 | my $self = shift; |
6cae2f56 |
498 | $self->prepare_protoschema({}, '_ddl_protoschema_produce_filename'); |
e62add58 |
499 | $self->_prepare_install({}, '_ddl_protoschema_produce_filename', '_ddl_schema_produce_filename'); |
c8a2f7bd |
500 | } |
501 | |
a41a04e5 |
502 | sub prepare_upgrade { |
be140a5f |
503 | my ($self, $args) = @_; |
0df68524 |
504 | log_info { |
f4075791 |
505 | "preparing upgrade from $args->{from_version} to $args->{to_version}" |
0df68524 |
506 | }; |
be140a5f |
507 | $self->_prepare_changegrade( |
58eb99c3 |
508 | $args->{from_version}, $args->{to_version}, $args->{version_set}, 'upgrade' |
be140a5f |
509 | ); |
76d311e7 |
510 | } |
511 | |
512 | sub prepare_downgrade { |
be140a5f |
513 | my ($self, $args) = @_; |
0df68524 |
514 | log_info { |
f4075791 |
515 | "preparing downgrade from $args->{from_version} to $args->{to_version}" |
0df68524 |
516 | }; |
be140a5f |
517 | $self->_prepare_changegrade( |
58eb99c3 |
518 | $args->{from_version}, $args->{to_version}, $args->{version_set}, 'downgrade' |
be140a5f |
519 | ); |
76d311e7 |
520 | } |
521 | |
f9c6ab50 |
522 | method _coderefs_per_files($files) { |
523 | no warnings 'redefine'; |
524 | [map eval do { local( @ARGV, $/ ) = $_; <> }, @$files] |
525 | } |
526 | |
76d311e7 |
527 | method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { |
2e68a8e1 |
528 | my $schema = $self->schema; |
529 | my $databases = $self->databases; |
91adde75 |
530 | my $dir = $self->script_directory; |
2e68a8e1 |
531 | |
73caa630 |
532 | my $schema_version = $self->schema_version; |
e62add58 |
533 | my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; |
e62add58 |
534 | foreach my $db (@$databases) { |
535 | my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); |
536 | if(-e $diff_file) { |
537 | carp("Overwriting existing $direction-diff file - $diff_file"); |
538 | unlink $diff_file; |
2e68a8e1 |
539 | } |
540 | |
387b11d2 |
541 | open my $file, q(>), $diff_file; |
f9c6ab50 |
542 | print {$file} join ";\n", @{$self->_sqldiff_from_yaml($from_version, $to_version, $db, $direction)}; |
2e68a8e1 |
543 | close $file; |
544 | } |
545 | } |
546 | |
334bced5 |
547 | method _read_sql_file($file) { |
548 | return unless $file; |
549 | |
aabd4237 |
550 | open my $fh, '<', $file; |
0d19af1d |
551 | my @data = split /;\n/, join '', <$fh>; |
334bced5 |
552 | close $fh; |
553 | |
09bc35e3 |
554 | @data = grep { |
555 | $_ && # remove blank lines |
556 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
557 | } map { |
558 | s/^\s+//; s/\s+$//; # trim whitespace |
559 | join '', grep { !/^--/ } split /\n/ # remove comments |
560 | } @data; |
334bced5 |
561 | |
09bc35e3 |
562 | return \@data; |
1f0d0633 |
563 | } |
564 | |
7d2a6974 |
565 | sub downgrade_single_step { |
76d311e7 |
566 | my $self = shift; |
be140a5f |
567 | my $version_set = (shift @_)->{version_set}; |
f4075791 |
568 | Dlog_info { "downgrade_single_step'ing $_" } $version_set; |
41219a5d |
569 | |
ef44838b |
570 | my $sqlt_type = $self->storage->sqlt_type; |
571 | my $sql_to_run; |
572 | if ($self->ignore_ddl) { |
573 | $sql_to_run = $self->_sqldiff_from_yaml( |
58eb99c3 |
574 | $version_set->[0], $version_set->[1], $sqlt_type, 'downgrade', |
ef44838b |
575 | ); |
576 | } |
58eb99c3 |
577 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_downgrade_consume_filenames( |
ef44838b |
578 | $sqlt_type, |
627581cd |
579 | $version_set, |
ef44838b |
580 | ), $sql_to_run); |
3249629f |
581 | |
41219a5d |
582 | return ['', $sql]; |
76d311e7 |
583 | } |
584 | |
7d2a6974 |
585 | sub upgrade_single_step { |
7521a845 |
586 | my $self = shift; |
be140a5f |
587 | my $version_set = (shift @_)->{version_set}; |
f4075791 |
588 | Dlog_info { "upgrade_single_step'ing $_" } $version_set; |
41219a5d |
589 | |
ef44838b |
590 | my $sqlt_type = $self->storage->sqlt_type; |
591 | my $sql_to_run; |
592 | if ($self->ignore_ddl) { |
593 | $sql_to_run = $self->_sqldiff_from_yaml( |
58eb99c3 |
594 | $version_set->[0], $version_set->[1], $sqlt_type, 'upgrade', |
ef44838b |
595 | ); |
596 | } |
58eb99c3 |
597 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_upgrade_consume_filenames( |
ef44838b |
598 | $sqlt_type, |
627581cd |
599 | $version_set, |
ef44838b |
600 | ), $sql_to_run); |
41219a5d |
601 | return ['', $sql]; |
334bced5 |
602 | } |
603 | |
6cae2f56 |
604 | sub prepare_protoschema { |
7e08eddd |
605 | my $self = shift; |
e62add58 |
606 | my $sqltargs = { %{$self->sql_translator_args}, %{shift @_} }; |
607 | my $to_file = shift; |
7e08eddd |
608 | my $filename |
e62add58 |
609 | = $self->$to_file($self->schema_version); |
7e08eddd |
610 | |
e62add58 |
611 | # we do this because the code that uses this sets parser args, |
612 | # so we just need to merge in the package |
613 | $sqltargs->{parser_args}{package} = $self->schema; |
7e08eddd |
614 | my $sqlt = SQL::Translator->new({ |
615 | parser => 'SQL::Translator::Parser::DBIx::Class', |
616 | producer => 'SQL::Translator::Producer::YAML', |
e62add58 |
617 | %{ $sqltargs }, |
7e08eddd |
618 | }); |
619 | |
620 | my $yml = $sqlt->translate; |
621 | |
622 | croak("Failed to translate to YAML: " . $sqlt->error) |
623 | unless $yml; |
624 | |
625 | if (-e $filename ) { |
626 | carp "Overwriting existing DDL-YML file - $filename"; |
627 | unlink $filename; |
628 | } |
629 | |
630 | open my $file, q(>), $filename; |
631 | print {$file} $yml; |
632 | close $file; |
633 | } |
634 | |
aabd4237 |
635 | __PACKAGE__->meta->make_immutable; |
636 | |
2e68a8e1 |
637 | 1; |
e051bb00 |
638 | |
e52174e3 |
639 | # vim: ts=2 sw=2 expandtab |
640 | |
e051bb00 |
641 | __END__ |
642 | |
bcc72297 |
643 | =head1 DESCRIPTION |
644 | |
e62add58 |
645 | This class is the meat of L<DBIx::Class::DeploymentHandler>. It takes care |
646 | of generating serialized schemata as well as sql files to move from one |
647 | version of a schema to the rest. One of the hallmark features of this class |
648 | is that it allows for multiple sql files for deploy and upgrade, allowing |
649 | developers to fine tune deployment. In addition it also allows for perl |
650 | files to be run at any stage of the process. |
bcc72297 |
651 | |
652 | For basic usage see L<DBIx::Class::DeploymentHandler::HandlesDeploy>. What's |
653 | documented here is extra fun stuff or private methods. |
654 | |
655 | =head1 DIRECTORY LAYOUT |
656 | |
39c88a9a |
657 | Arguably this is the best feature of L<DBIx::Class::DeploymentHandler>. |
658 | It's spiritually based upon L<DBIx::Migration::Directories>, but has a |
659 | lot of extensions and modifications, so even if you are familiar with it, |
660 | please read this. I feel like the best way to describe the layout is with |
661 | the following example: |
92c34cab |
662 | |
663 | $sql_migration_dir |
58eb99c3 |
664 | |- _source |
665 | | |- deploy |
03882cab |
666 | | |- 1 |
667 | | | `- 001-auto.yml |
668 | | |- 2 |
669 | | | `- 001-auto.yml |
670 | | `- 3 |
671 | | `- 001-auto.yml |
92c34cab |
672 | |- SQLite |
58eb99c3 |
673 | | |- downgrade |
4f85efc6 |
674 | | | `- 2-1 |
e62add58 |
675 | | | `- 001-auto.sql |
58eb99c3 |
676 | | |- deploy |
92c34cab |
677 | | | `- 1 |
e62add58 |
678 | | | `- 001-auto.sql |
58eb99c3 |
679 | | `- upgrade |
92c34cab |
680 | | |- 1-2 |
e62add58 |
681 | | | `- 001-auto.sql |
92c34cab |
682 | | `- 2-3 |
e62add58 |
683 | | `- 001-auto.sql |
92c34cab |
684 | |- _common |
58eb99c3 |
685 | | |- downgrade |
4f85efc6 |
686 | | | `- 2-1 |
92c34cab |
687 | | | `- 002-remove-customers.pl |
58eb99c3 |
688 | | `- upgrade |
92c34cab |
689 | | `- 1-2 |
690 | | `- 002-generate-customers.pl |
92c34cab |
691 | `- MySQL |
58eb99c3 |
692 | |- downgrade |
4f85efc6 |
693 | | `- 2-1 |
e62add58 |
694 | | `- 001-auto.sql |
80ff6f6d |
695 | |- preinstall |
696 | | `- 1 |
697 | | |- 001-create_database.pl |
698 | | `- 002-create_users_and_permissions.pl |
58eb99c3 |
699 | |- deploy |
92c34cab |
700 | | `- 1 |
e62add58 |
701 | | `- 001-auto.sql |
58eb99c3 |
702 | `- upgrade |
92c34cab |
703 | `- 1-2 |
e62add58 |
704 | `- 001-auto.sql |
92c34cab |
705 | |
706 | So basically, the code |
707 | |
708 | $dm->deploy(1) |
709 | |
710 | on an C<SQLite> database that would simply run |
58eb99c3 |
711 | C<$sql_migration_dir/SQLite/deploy/1/001-auto.sql>. Next, |
92c34cab |
712 | |
713 | $dm->upgrade_single_step([1,2]) |
714 | |
58eb99c3 |
715 | would run C<$sql_migration_dir/SQLite/upgrade/1-2/001-auto.sql> followed by |
716 | C<$sql_migration_dir/_common/upgrade/1-2/002-generate-customers.pl>. |
92c34cab |
717 | |
0824f31f |
718 | C<.pl> files don't have to be in the C<_common> directory, but most of the time |
39c88a9a |
719 | they should be, because perl scripts are generally database independent. |
92c34cab |
720 | |
80ff6f6d |
721 | Note that unlike most steps in the process, C<preinstall> will not run SQL, as |
722 | there may not even be an database at preinstall time. It will run perl scripts |
723 | just like the other steps in the process, but nothing is passed to them. |
724 | Until people have used this more it will remain freeform, but a recommended use |
725 | of preinstall is to have it prompt for username and password, and then call the |
726 | appropriate C<< CREATE DATABASE >> commands etc. |
727 | |
03882cab |
728 | =head2 Directory Specification |
729 | |
730 | The following subdirectories are recognized by this DeployMethod: |
731 | |
732 | =over 2 |
733 | |
58eb99c3 |
734 | =item C<_source> This directory can contain the following directories: |
03882cab |
735 | |
736 | =over 2 |
737 | |
39c88a9a |
738 | =item C<deploy> This directory merely contains directories named after schema |
739 | versions, which in turn contain C<yaml> files that are serialized versions |
740 | of the schema at that version. These files are not for editing by hand. |
741 | |
742 | =back |
743 | |
744 | =item C<_preprocess_schema> This directory can contain the following |
745 | directories: |
746 | |
747 | =over 2 |
748 | |
58eb99c3 |
749 | =item C<downgrade> This directory merely contains directories named after |
03882cab |
750 | migrations, which are of the form C<$from_version-$to_version>. Inside of |
751 | these directories you may put Perl scripts which are to return a subref |
752 | that takes the arguments C<< $from_schema, $to_schema >>, which are |
753 | L<SQL::Translator::Schema> objects. |
754 | |
58eb99c3 |
755 | =item C<upgrade> This directory merely contains directories named after |
03882cab |
756 | migrations, which are of the form C<$from_version-$to_version>. Inside of |
757 | these directories you may put Perl scripts which are to return a subref |
758 | that takes the arguments C<< $from_schema, $to_schema >>, which are |
759 | L<SQL::Translator::Schema> objects. |
760 | |
03882cab |
761 | =back |
762 | |
5b766a24 |
763 | =item C<$storage_type> This is a set of scripts that gets run depending on what |
764 | your storage type is. If you are not sure what your storage type is, take a |
765 | look at the producers listed for L<SQL::Translator>. Also note, C<_common> |
766 | is a special case. C<_common> will get merged into whatever other files you |
767 | already have. This directory can containt the following directories itself: |
71d00500 |
768 | |
769 | =over 2 |
770 | |
58eb99c3 |
771 | =item C<preinstall> Gets run before the C<deploy> is C<deploy>ed. Has the |
772 | same structure as the C<deploy> subdirectory as well; that is, it has a |
773 | directory for each schema version. Unlike C<deploy>, C<upgrade>, and C<downgrade> |
71d00500 |
774 | though, it can only run C<.pl> files, and the coderef in the perl files get |
775 | no arguments passed to them. |
776 | |
58eb99c3 |
777 | =item C<deploy> Gets run when the schema is C<deploy>ed. Structure is a |
71d00500 |
778 | directory per schema version, and then files are merged with C<_common> and run |
779 | in filename order. C<.sql> files are merely run, as expected. C<.pl> files are |
780 | run according to L</PERL SCRIPTS>. |
781 | |
58eb99c3 |
782 | =item C<upgrade> Gets run when the schema is C<upgrade>d. Structure is a directory |
71d00500 |
783 | per upgrade step, (for example, C<1-2> for upgrading from version 1 to version |
784 | 2,) and then files are merged with C<_common> and run in filename order. |
785 | C<.sql> files are merely run, as expected. C<.pl> files are run according |
786 | to L</PERL SCRIPTS>. |
787 | |
58eb99c3 |
788 | =item C<downgrade> Gets run when the schema is C<downgrade>d. Structure is a directory |
71d00500 |
789 | per downgrade step, (for example, C<2-1> for downgrading from version 2 to version |
790 | 1,) and then files are merged with C<_common> and run in filename order. |
791 | C<.sql> files are merely run, as expected. C<.pl> files are run according |
792 | to L</PERL SCRIPTS>. |
793 | |
794 | |
795 | =back |
796 | |
03882cab |
797 | =back |
798 | |
92c34cab |
799 | =head1 PERL SCRIPTS |
800 | |
7d0b0f2b |
801 | A perl script for this tool is very simple. It merely needs to contain an |
802 | anonymous sub that takes a L<DBIx::Class::Schema> as it's only argument. |
92c34cab |
803 | A very basic perl script might look like: |
804 | |
805 | #!perl |
806 | |
807 | use strict; |
808 | use warnings; |
809 | |
7d0b0f2b |
810 | sub { |
92c34cab |
811 | my $schema = shift; |
812 | |
813 | $schema->resultset('Users')->create({ |
814 | name => 'root', |
815 | password => 'root', |
816 | }) |
817 | } |
bcc72297 |
818 | |
39c88a9a |
819 | =attr ignore_ddl |
820 | |
821 | This attribute will, when set to true (default is false), cause the DM to use |
822 | L<SQL::Translator> to use the C<_source>'s serialized SQL::Translator::Schema |
823 | instead of any pregenerated SQL. If you have a development server this is |
824 | probably the best plan of action as you will not be putting as many generated |
825 | files in your version control. Goes well with with C<databases> of C<[]>. |
826 | |
eb28403b |
827 | =attr schema |
a65184c8 |
828 | |
bcc72297 |
829 | The L<DBIx::Class::Schema> (B<required>) that is used to talk to the database |
830 | and generate the DDL. |
831 | |
eb28403b |
832 | =attr storage |
a65184c8 |
833 | |
bcc72297 |
834 | The L<DBIx::Class::Storage> that is I<actually> used to talk to the database |
835 | and generate the DDL. This is automatically created with L</_build_storage>. |
836 | |
02a7b8ac |
837 | =attr sql_translator_args |
cfc9edf9 |
838 | |
02a7b8ac |
839 | The arguments that get passed to L<SQL::Translator> when it's used. |
a65184c8 |
840 | |
91adde75 |
841 | =attr script_directory |
cfc9edf9 |
842 | |
91adde75 |
843 | The directory (default C<'sql'>) that scripts are stored in |
cfc9edf9 |
844 | |
eb28403b |
845 | =attr databases |
cfc9edf9 |
846 | |
847 | The types of databases (default C<< [qw( MySQL SQLite PostgreSQL )] >>) to |
848 | generate files for |
849 | |
eb28403b |
850 | =attr txn_wrap |
851 | |
bcc72297 |
852 | Set to true (which is the default) to wrap all upgrades and deploys in a single |
853 | transaction. |
854 | |
73caa630 |
855 | =attr schema_version |
856 | |
857 | The version the schema on your harddrive is at. Defaults to |
858 | C<< $self->schema->schema_version >>. |