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