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 | |
334bced5 |
59 | has _filedata => ( |
60 | isa => 'ArrayRef[Str]', |
61 | is => 'rw', |
aabd4237 |
62 | default => sub { [] }, |
334bced5 |
63 | ); |
64 | |
a7d53deb |
65 | has txn_wrap => ( |
66 | is => 'ro', |
67 | isa => 'Bool', |
68 | default => 1, |
69 | ); |
70 | |
76d311e7 |
71 | method __ddl_consume_with_prefix($type, $versions, $prefix) { |
262166c1 |
72 | my $base_dir = $self->upgrade_directory; |
73 | |
76d08d08 |
74 | my $main = catfile( $base_dir, $type ); |
75 | my $generic = catfile( $base_dir, '_generic' ); |
76 | my $common = |
77 | catfile( $base_dir, '_common', $prefix, join q(-), @{$versions} ); |
262166c1 |
78 | |
79 | my $dir; |
80 | if (-d $main) { |
76d08d08 |
81 | $dir = catfile($main, $prefix, join q(-), @{$versions}) |
262166c1 |
82 | } elsif (-d $generic) { |
9af9d0b2 |
83 | $dir = catfile($generic, $prefix, join q(-), @{$versions}); |
262166c1 |
84 | } else { |
9af9d0b2 |
85 | croak "neither $main or $generic exist; please write/generate some SQL"; |
262166c1 |
86 | } |
87 | |
88 | opendir my($dh), $dir; |
41219a5d |
89 | my %files = map { $_ => "$dir/$_" } grep { /\.(?:sql|pl)$/ && -f "$dir/$_" } readdir $dh; |
262166c1 |
90 | closedir $dh; |
91 | |
92 | if (-d $common) { |
93 | opendir my($dh), $common; |
41219a5d |
94 | for my $filename (grep { /\.(?:sql|pl)$/ && -f catfile($common,$_) } readdir $dh) { |
262166c1 |
95 | unless ($files{$filename}) { |
9af9d0b2 |
96 | $files{$filename} = catfile($common,$filename); |
262166c1 |
97 | } |
98 | } |
99 | closedir $dh; |
100 | } |
101 | |
102 | return [@files{sort keys %files}] |
103 | } |
3c1b5ee8 |
104 | |
76d311e7 |
105 | method _ddl_schema_consume_filenames($type, $version) { |
106 | $self->__ddl_consume_with_prefix($type, [ $version ], 'schema') |
3c1b5ee8 |
107 | } |
108 | |
76d311e7 |
109 | method _ddl_schema_produce_filename($type, $version) { |
76d08d08 |
110 | my $dirname = catfile( $self->upgrade_directory, $type, 'schema', $version ); |
111 | mkpath($dirname) unless -d $dirname; |
d54b8d69 |
112 | |
76d08d08 |
113 | return catfile( $dirname, '001-auto.sql' ); |
d54b8d69 |
114 | } |
115 | |
76d311e7 |
116 | method _ddl_schema_up_consume_filenames($type, $versions) { |
117 | $self->__ddl_consume_with_prefix($type, $versions, 'up') |
3c1b5ee8 |
118 | } |
119 | |
76d311e7 |
120 | method _ddl_schema_down_consume_filenames($type, $versions) { |
121 | $self->__ddl_consume_with_prefix($type, $versions, 'down') |
a41a04e5 |
122 | } |
123 | |
76d311e7 |
124 | method _ddl_schema_up_produce_filename($type, $versions) { |
125 | my $dir = $self->upgrade_directory; |
126 | |
76d08d08 |
127 | my $dirname = catfile( $dir, $type, 'up', join q(-), @{$versions}); |
128 | mkpath($dirname) unless -d $dirname; |
a41a04e5 |
129 | |
76d08d08 |
130 | return catfile( $dirname, '001-auto.sql' |
a41a04e5 |
131 | ); |
132 | } |
133 | |
76d311e7 |
134 | method _ddl_schema_down_produce_filename($type, $versions, $dir) { |
76d08d08 |
135 | my $dirname = catfile( $dir, $type, 'down', join q(-), @{$versions} ); |
136 | mkpath($dirname) unless -d $dirname; |
24f4524b |
137 | |
76d08d08 |
138 | return catfile( $dirname, '001-auto.sql'); |
24f4524b |
139 | } |
140 | |
41219a5d |
141 | method _run_sql_and_perl($filenames) { |
142 | my @files = @{$filenames}; |
143 | my $storage = $self->storage; |
2e68a8e1 |
144 | |
a7d53deb |
145 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
146 | |
41219a5d |
147 | my $sql; |
148 | for my $filename (@files) { |
149 | if ($filename =~ /\.sql$/) { |
150 | my @sql = @{$self->_read_sql_file($filename)}; |
151 | $sql .= join "\n", @sql; |
152 | |
153 | foreach my $line (@sql) { |
154 | $storage->_query_start($line); |
155 | try { |
156 | # do a dbh_do cycle here, as we need some error checking in |
157 | # place (even though we will ignore errors) |
158 | $storage->dbh_do (sub { $_[1]->do($line) }); |
159 | } |
160 | catch { |
161 | carp "$_ (running '${line}')" |
162 | } |
163 | $storage->_query_end($line); |
164 | } |
0841a743 |
165 | } elsif ( $filename =~ /^(.+)\.pl$/ ) { |
166 | my $package = $1; |
167 | my $filedata = do { local( @ARGV, $/ ) = $filename; <> }; |
168 | # make the package name more palateable to perl |
169 | $package =~ s/\W/_/g; |
170 | |
171 | no warnings 'redefine'; |
172 | eval "package $package;\n\n$filedata"; |
173 | use warnings; |
174 | |
98c9484a |
175 | if (my $fn = $package->can('run')) { |
176 | $fn->($self->schema); |
177 | } else { |
178 | carp "$filename should define a run method that takes a schema but it didn't!"; |
179 | } |
41219a5d |
180 | } else { |
181 | croak "A file got to deploy that wasn't sql or perl!"; |
2e68a8e1 |
182 | } |
2e68a8e1 |
183 | } |
a7d53deb |
184 | |
185 | $guard->commit if $self->txn_wrap; |
41219a5d |
186 | |
187 | return $sql; |
188 | } |
189 | |
190 | sub deploy { |
191 | my $self = shift; |
192 | |
193 | return $self->_run_sql_and_perl($self->_ddl_schema_consume_filenames( |
194 | $self->storage->sqlt_type, |
195 | $self->schema_version |
196 | )); |
2e68a8e1 |
197 | } |
198 | |
7521a845 |
199 | sub prepare_install { |
200 | my $self = shift; |
2e68a8e1 |
201 | my $schema = $self->schema; |
202 | my $databases = $self->databases; |
203 | my $dir = $self->upgrade_directory; |
204 | my $sqltargs = $self->sqltargs; |
d54b8d69 |
205 | my $version = $schema->schema_version; |
206 | |
9600776d |
207 | my $sqlt = SQL::Translator->new({ |
d54b8d69 |
208 | add_drop_table => 1, |
2e68a8e1 |
209 | ignore_constraint_names => 1, |
d54b8d69 |
210 | ignore_index_names => 1, |
211 | parser => 'SQL::Translator::Parser::DBIx::Class', |
3aaf766f |
212 | %{$sqltargs} |
9600776d |
213 | }); |
2e68a8e1 |
214 | |
d53e0bfc |
215 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
216 | or croak($sqlt->error); |
2e68a8e1 |
217 | |
218 | foreach my $db (@$databases) { |
219 | $sqlt->reset; |
220 | $sqlt->{schema} = $sqlt_schema; |
221 | $sqlt->producer($db); |
222 | |
76d311e7 |
223 | my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir); |
9600776d |
224 | if (-e $filename ) { |
2e68a8e1 |
225 | carp "Overwriting existing DDL file - $filename"; |
226 | unlink $filename; |
227 | } |
228 | |
229 | my $output = $sqlt->translate; |
230 | if(!$output) { |
231 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
232 | next; |
233 | } |
387b11d2 |
234 | open my $file, q(>), $filename; |
2e68a8e1 |
235 | print {$file} $output; |
236 | close $file; |
237 | } |
238 | } |
239 | |
a41a04e5 |
240 | sub prepare_upgrade { |
9600776d |
241 | my ($self, $from_version, $to_version, $version_set) = @_; |
63e95f13 |
242 | # for updates prepared automatically (rob's stuff) |
243 | # one would want to explicitly set $version_set to |
244 | # [$to_version] |
76d311e7 |
245 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up'); |
246 | } |
247 | |
248 | sub prepare_downgrade { |
249 | my ($self, $from_version, $to_version, $version_set) = @_; |
250 | |
76d311e7 |
251 | # for updates prepared automatically (rob's stuff) |
252 | # one would want to explicitly set $version_set to |
253 | # [$to_version] |
76d311e7 |
254 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down'); |
255 | } |
256 | |
257 | method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { |
2e68a8e1 |
258 | my $schema = $self->schema; |
259 | my $databases = $self->databases; |
260 | my $dir = $self->upgrade_directory; |
261 | my $sqltargs = $self->sqltargs; |
262 | |
9600776d |
263 | my $schema_version = $schema->schema_version; |
2e68a8e1 |
264 | |
265 | $sqltargs = { |
266 | add_drop_table => 1, |
267 | ignore_constraint_names => 1, |
268 | ignore_index_names => 1, |
269 | %{$sqltargs} |
270 | }; |
271 | |
272 | my $sqlt = SQL::Translator->new( $sqltargs ); |
273 | |
274 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
d53e0bfc |
275 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
276 | or croak($sqlt->error); |
2e68a8e1 |
277 | |
278 | foreach my $db (@$databases) { |
279 | $sqlt->reset; |
280 | $sqlt->{schema} = $sqlt_schema; |
281 | $sqlt->producer($db); |
282 | |
76d311e7 |
283 | my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir); |
2e68a8e1 |
284 | unless(-e $prefilename) { |
285 | carp("No previous schema file found ($prefilename)"); |
286 | next; |
287 | } |
76d311e7 |
288 | my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; |
289 | my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); |
2e68a8e1 |
290 | if(-e $diff_file) { |
76d311e7 |
291 | carp("Overwriting existing $direction-diff file - $diff_file"); |
2e68a8e1 |
292 | unlink $diff_file; |
293 | } |
294 | |
295 | my $source_schema; |
296 | { |
297 | my $t = SQL::Translator->new({ |
298 | %{$sqltargs}, |
299 | debug => 0, |
300 | trace => 0, |
301 | }); |
302 | |
303 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
304 | or croak($t->error); |
2e68a8e1 |
305 | |
306 | my $out = $t->translate( $prefilename ) |
387b11d2 |
307 | or croak($t->error); |
2e68a8e1 |
308 | |
309 | $source_schema = $t->schema; |
310 | |
311 | $source_schema->name( $prefilename ) |
312 | unless $source_schema->name; |
313 | } |
314 | |
315 | # The "new" style of producers have sane normalization and can support |
316 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
317 | # And we have to diff parsed SQL against parsed SQL. |
318 | my $dest_schema = $sqlt_schema; |
319 | |
320 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
321 | my $t = SQL::Translator->new({ |
322 | %{$sqltargs}, |
323 | debug => 0, |
324 | trace => 0, |
325 | }); |
326 | |
327 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
328 | or croak($t->error); |
2e68a8e1 |
329 | |
76d311e7 |
330 | my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir); |
2e68a8e1 |
331 | my $out = $t->translate( $filename ) |
387b11d2 |
332 | or croak($t->error); |
2e68a8e1 |
333 | |
334 | $dest_schema = $t->schema; |
335 | |
336 | $dest_schema->name( $filename ) |
337 | unless $dest_schema->name; |
338 | } |
339 | |
340 | my $diff = SQL::Translator::Diff::schema_diff( |
341 | $source_schema, $db, |
342 | $dest_schema, $db, |
343 | $sqltargs |
344 | ); |
387b11d2 |
345 | open my $file, q(>), $diff_file; |
2e68a8e1 |
346 | print {$file} $diff; |
347 | close $file; |
348 | } |
349 | } |
350 | |
334bced5 |
351 | method _read_sql_file($file) { |
352 | return unless $file; |
353 | |
aabd4237 |
354 | open my $fh, '<', $file; |
0d19af1d |
355 | my @data = split /;\n/, join '', <$fh>; |
334bced5 |
356 | close $fh; |
357 | |
358 | @data = grep { |
0d19af1d |
359 | $_ && # remove blank lines |
360 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
361 | } map { |
362 | s/^\s+//; s/\s+$//; # trim whitespace |
363 | join '', grep { !/^--/ } split /\n/ # remove comments |
364 | } @data; |
334bced5 |
365 | |
366 | return \@data; |
367 | } |
368 | |
7d2a6974 |
369 | sub downgrade_single_step { |
76d311e7 |
370 | my $self = shift; |
371 | my @version_set = @{ shift @_ }; |
41219a5d |
372 | |
373 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_down_consume_filenames( |
76d311e7 |
374 | $self->storage->sqlt_type, |
375 | \@version_set, |
41219a5d |
376 | )); |
3249629f |
377 | |
41219a5d |
378 | return ['', $sql]; |
76d311e7 |
379 | } |
380 | |
7d2a6974 |
381 | sub upgrade_single_step { |
7521a845 |
382 | my $self = shift; |
24f4524b |
383 | my @version_set = @{ shift @_ }; |
41219a5d |
384 | |
385 | my $sql = $self->_run_sql_and_perl($self->_ddl_schema_up_consume_filenames( |
334bced5 |
386 | $self->storage->sqlt_type, |
24f4524b |
387 | \@version_set, |
41219a5d |
388 | )); |
389 | return ['', $sql]; |
334bced5 |
390 | } |
391 | |
aabd4237 |
392 | __PACKAGE__->meta->make_immutable; |
393 | |
2e68a8e1 |
394 | 1; |
e051bb00 |
395 | |
396 | __END__ |
397 | |
2eaf903b |
398 | vim: ts=2 sw=2 expandtab |