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; |
9af9d0b2 |
89 | my %files = map { $_ => "$dir/$_" } grep { /\.sql$/ && -f "$dir/$_" } readdir $dh; |
262166c1 |
90 | closedir $dh; |
91 | |
92 | if (-d $common) { |
93 | opendir my($dh), $common; |
9af9d0b2 |
94 | for my $filename (grep { /\.sql$/ && -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 | |
7d2a6974 |
141 | sub deploy { |
7521a845 |
142 | my $self = shift; |
2e68a8e1 |
143 | my $storage = $self->storage; |
144 | |
a7d53deb |
145 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
146 | |
566925df |
147 | my @sql = map @{$self->_read_sql_file($_)}, @{$self->_ddl_schema_consume_filenames( |
0d19af1d |
148 | $self->storage->sqlt_type, |
149 | $self->schema_version |
566925df |
150 | )}; |
151 | |
152 | foreach my $line (@sql) { |
2e68a8e1 |
153 | $storage->_query_start($line); |
154 | try { |
155 | # do a dbh_do cycle here, as we need some error checking in |
156 | # place (even though we will ignore errors) |
157 | $storage->dbh_do (sub { $_[1]->do($line) }); |
158 | } |
159 | catch { |
160 | carp "$_ (running '${line}')" |
161 | } |
162 | $storage->_query_end($line); |
2e68a8e1 |
163 | } |
a7d53deb |
164 | |
165 | $guard->commit if $self->txn_wrap; |
566925df |
166 | return join "\n", @sql; |
2e68a8e1 |
167 | } |
168 | |
7521a845 |
169 | sub prepare_install { |
170 | my $self = shift; |
2e68a8e1 |
171 | my $schema = $self->schema; |
172 | my $databases = $self->databases; |
173 | my $dir = $self->upgrade_directory; |
174 | my $sqltargs = $self->sqltargs; |
d54b8d69 |
175 | my $version = $schema->schema_version; |
176 | |
9600776d |
177 | my $sqlt = SQL::Translator->new({ |
d54b8d69 |
178 | add_drop_table => 1, |
2e68a8e1 |
179 | ignore_constraint_names => 1, |
d54b8d69 |
180 | ignore_index_names => 1, |
181 | parser => 'SQL::Translator::Parser::DBIx::Class', |
3aaf766f |
182 | %{$sqltargs} |
9600776d |
183 | }); |
2e68a8e1 |
184 | |
d53e0bfc |
185 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
186 | or croak($sqlt->error); |
2e68a8e1 |
187 | |
188 | foreach my $db (@$databases) { |
189 | $sqlt->reset; |
190 | $sqlt->{schema} = $sqlt_schema; |
191 | $sqlt->producer($db); |
192 | |
76d311e7 |
193 | my $filename = $self->_ddl_schema_produce_filename($db, $version, $dir); |
9600776d |
194 | if (-e $filename ) { |
2e68a8e1 |
195 | carp "Overwriting existing DDL file - $filename"; |
196 | unlink $filename; |
197 | } |
198 | |
199 | my $output = $sqlt->translate; |
200 | if(!$output) { |
201 | carp("Failed to translate to $db, skipping. (" . $sqlt->error . ")"); |
202 | next; |
203 | } |
387b11d2 |
204 | open my $file, q(>), $filename; |
2e68a8e1 |
205 | print {$file} $output; |
206 | close $file; |
207 | } |
208 | } |
209 | |
a41a04e5 |
210 | sub prepare_upgrade { |
9600776d |
211 | my ($self, $from_version, $to_version, $version_set) = @_; |
212 | |
9af9d0b2 |
213 | $from_version ||= '1.0'; #$self->database_version; |
9600776d |
214 | $to_version ||= $self->schema_version; |
215 | |
63e95f13 |
216 | # for updates prepared automatically (rob's stuff) |
217 | # one would want to explicitly set $version_set to |
218 | # [$to_version] |
9600776d |
219 | $version_set ||= [$from_version, $to_version]; |
76d311e7 |
220 | |
221 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up'); |
222 | } |
223 | |
224 | sub prepare_downgrade { |
225 | my ($self, $from_version, $to_version, $version_set) = @_; |
226 | |
227 | $from_version ||= $self->db_version; |
228 | $to_version ||= $self->schema_version; |
229 | |
230 | # for updates prepared automatically (rob's stuff) |
231 | # one would want to explicitly set $version_set to |
232 | # [$to_version] |
233 | $version_set ||= [$from_version, $to_version]; |
234 | |
235 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down'); |
236 | } |
237 | |
238 | method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { |
2e68a8e1 |
239 | my $schema = $self->schema; |
240 | my $databases = $self->databases; |
241 | my $dir = $self->upgrade_directory; |
242 | my $sqltargs = $self->sqltargs; |
243 | |
9600776d |
244 | my $schema_version = $schema->schema_version; |
2e68a8e1 |
245 | |
246 | $sqltargs = { |
247 | add_drop_table => 1, |
248 | ignore_constraint_names => 1, |
249 | ignore_index_names => 1, |
250 | %{$sqltargs} |
251 | }; |
252 | |
253 | my $sqlt = SQL::Translator->new( $sqltargs ); |
254 | |
255 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
d53e0bfc |
256 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
387b11d2 |
257 | or croak($sqlt->error); |
2e68a8e1 |
258 | |
259 | foreach my $db (@$databases) { |
260 | $sqlt->reset; |
261 | $sqlt->{schema} = $sqlt_schema; |
262 | $sqlt->producer($db); |
263 | |
76d311e7 |
264 | my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir); |
2e68a8e1 |
265 | unless(-e $prefilename) { |
266 | carp("No previous schema file found ($prefilename)"); |
267 | next; |
268 | } |
76d311e7 |
269 | my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; |
270 | my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); |
2e68a8e1 |
271 | if(-e $diff_file) { |
76d311e7 |
272 | carp("Overwriting existing $direction-diff file - $diff_file"); |
2e68a8e1 |
273 | unlink $diff_file; |
274 | } |
275 | |
276 | my $source_schema; |
277 | { |
278 | my $t = SQL::Translator->new({ |
279 | %{$sqltargs}, |
280 | debug => 0, |
281 | trace => 0, |
282 | }); |
283 | |
284 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
285 | or croak($t->error); |
2e68a8e1 |
286 | |
287 | my $out = $t->translate( $prefilename ) |
387b11d2 |
288 | or croak($t->error); |
2e68a8e1 |
289 | |
290 | $source_schema = $t->schema; |
291 | |
292 | $source_schema->name( $prefilename ) |
293 | unless $source_schema->name; |
294 | } |
295 | |
296 | # The "new" style of producers have sane normalization and can support |
297 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
298 | # And we have to diff parsed SQL against parsed SQL. |
299 | my $dest_schema = $sqlt_schema; |
300 | |
301 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
302 | my $t = SQL::Translator->new({ |
303 | %{$sqltargs}, |
304 | debug => 0, |
305 | trace => 0, |
306 | }); |
307 | |
308 | $t->parser( $db ) # could this really throw an exception? |
387b11d2 |
309 | or croak($t->error); |
2e68a8e1 |
310 | |
76d311e7 |
311 | my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir); |
2e68a8e1 |
312 | my $out = $t->translate( $filename ) |
387b11d2 |
313 | or croak($t->error); |
2e68a8e1 |
314 | |
315 | $dest_schema = $t->schema; |
316 | |
317 | $dest_schema->name( $filename ) |
318 | unless $dest_schema->name; |
319 | } |
320 | |
321 | my $diff = SQL::Translator::Diff::schema_diff( |
322 | $source_schema, $db, |
323 | $dest_schema, $db, |
324 | $sqltargs |
325 | ); |
387b11d2 |
326 | open my $file, q(>), $diff_file; |
2e68a8e1 |
327 | print {$file} $diff; |
328 | close $file; |
329 | } |
330 | } |
331 | |
334bced5 |
332 | method _read_sql_file($file) { |
333 | return unless $file; |
334 | |
aabd4237 |
335 | open my $fh, '<', $file; |
0d19af1d |
336 | my @data = split /;\n/, join '', <$fh>; |
334bced5 |
337 | close $fh; |
338 | |
339 | @data = grep { |
0d19af1d |
340 | $_ && # remove blank lines |
341 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
342 | } map { |
343 | s/^\s+//; s/\s+$//; # trim whitespace |
344 | join '', grep { !/^--/ } split /\n/ # remove comments |
345 | } @data; |
334bced5 |
346 | |
347 | return \@data; |
348 | } |
349 | |
7d2a6974 |
350 | sub downgrade_single_step { |
76d311e7 |
351 | my $self = shift; |
352 | my @version_set = @{ shift @_ }; |
9af9d0b2 |
353 | my @downgrade_files = @{$self->_ddl_schema_down_consume_filenames( |
76d311e7 |
354 | $self->storage->sqlt_type, |
355 | \@version_set, |
356 | )}; |
357 | |
9af9d0b2 |
358 | for my $downgrade_file (@downgrade_files) { |
9af9d0b2 |
359 | $self->_filedata($self->_read_sql_file($downgrade_file)); # I don't like this --fREW 2010-02-22 |
3249629f |
360 | |
361 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
362 | $self->_do_upgrade; |
363 | $guard->commit if $self->txn_wrap; |
76d311e7 |
364 | } |
365 | } |
366 | |
7d2a6974 |
367 | sub upgrade_single_step { |
7521a845 |
368 | my $self = shift; |
24f4524b |
369 | my @version_set = @{ shift @_ }; |
76d311e7 |
370 | my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames( |
334bced5 |
371 | $self->storage->sqlt_type, |
24f4524b |
372 | \@version_set, |
3c1b5ee8 |
373 | )}; |
334bced5 |
374 | |
392a5ccc |
375 | my $upgrade_sql; |
3c1b5ee8 |
376 | for my $upgrade_file (@upgrade_files) { |
392a5ccc |
377 | my $up = $self->_read_sql_file($upgrade_file); |
378 | $upgrade_sql .= $up; |
379 | $self->_filedata($up); # I don't like this --fREW 2010-02-22 |
3249629f |
380 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
381 | $self->_do_upgrade; |
382 | $guard->commit if $self->txn_wrap; |
3c1b5ee8 |
383 | } |
392a5ccc |
384 | return ['', $upgrade_sql]; |
334bced5 |
385 | } |
386 | |
8a7847f1 |
387 | method _do_upgrade { $self->_run_upgrade(qr/.*?/) } |
334bced5 |
388 | |
8a7847f1 |
389 | method _run_upgrade($stm) { |
334bced5 |
390 | my @statements = grep { $_ =~ $stm } @{$self->_filedata}; |
391 | |
392 | for (@statements) { |
393 | $self->storage->debugobj->query_start($_) if $self->storage->debug; |
8a7847f1 |
394 | $self->_apply_statement($_); |
334bced5 |
395 | $self->storage->debugobj->query_end($_) if $self->storage->debug; |
396 | } |
397 | } |
398 | |
8a7847f1 |
399 | method _apply_statement($statement) { |
334bced5 |
400 | # croak? |
401 | $self->storage->dbh->do($_) or carp "SQL was: $_" |
402 | } |
403 | |
aabd4237 |
404 | __PACKAGE__->meta->make_immutable; |
405 | |
2e68a8e1 |
406 | 1; |
e051bb00 |
407 | |
408 | __END__ |
409 | |
2eaf903b |
410 | vim: ts=2 sw=2 expandtab |