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 | |
7521a845 |
141 | sub _deploy { |
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 ) |
3aaf766f |
186 | or $self->throw_exception($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 | } |
204 | my $file; |
205 | unless( open $file, q(>), $filename ) { |
206 | $self->throw_exception("Can't open $filename for writing ($!)"); |
207 | next; |
208 | } |
209 | print {$file} $output; |
210 | close $file; |
211 | } |
212 | } |
213 | |
a41a04e5 |
214 | sub prepare_upgrade { |
9600776d |
215 | my ($self, $from_version, $to_version, $version_set) = @_; |
216 | |
9af9d0b2 |
217 | $from_version ||= '1.0'; #$self->database_version; |
9600776d |
218 | $to_version ||= $self->schema_version; |
219 | |
63e95f13 |
220 | # for updates prepared automatically (rob's stuff) |
221 | # one would want to explicitly set $version_set to |
222 | # [$to_version] |
9600776d |
223 | $version_set ||= [$from_version, $to_version]; |
76d311e7 |
224 | |
225 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'up'); |
226 | } |
227 | |
228 | sub prepare_downgrade { |
229 | my ($self, $from_version, $to_version, $version_set) = @_; |
230 | |
231 | $from_version ||= $self->db_version; |
232 | $to_version ||= $self->schema_version; |
233 | |
234 | # for updates prepared automatically (rob's stuff) |
235 | # one would want to explicitly set $version_set to |
236 | # [$to_version] |
237 | $version_set ||= [$from_version, $to_version]; |
238 | |
239 | $self->_prepare_changegrade($from_version, $to_version, $version_set, 'down'); |
240 | } |
241 | |
242 | method _prepare_changegrade($from_version, $to_version, $version_set, $direction) { |
2e68a8e1 |
243 | my $schema = $self->schema; |
244 | my $databases = $self->databases; |
245 | my $dir = $self->upgrade_directory; |
246 | my $sqltargs = $self->sqltargs; |
247 | |
9600776d |
248 | my $schema_version = $schema->schema_version; |
2e68a8e1 |
249 | |
250 | $sqltargs = { |
251 | add_drop_table => 1, |
252 | ignore_constraint_names => 1, |
253 | ignore_index_names => 1, |
254 | %{$sqltargs} |
255 | }; |
256 | |
257 | my $sqlt = SQL::Translator->new( $sqltargs ); |
258 | |
259 | $sqlt->parser('SQL::Translator::Parser::DBIx::Class'); |
d53e0bfc |
260 | my $sqlt_schema = $sqlt->translate( data => $schema ) |
2e68a8e1 |
261 | or $self->throw_exception ($sqlt->error); |
262 | |
263 | foreach my $db (@$databases) { |
264 | $sqlt->reset; |
265 | $sqlt->{schema} = $sqlt_schema; |
266 | $sqlt->producer($db); |
267 | |
76d311e7 |
268 | my $prefilename = $self->_ddl_schema_produce_filename($db, $from_version, $dir); |
2e68a8e1 |
269 | unless(-e $prefilename) { |
270 | carp("No previous schema file found ($prefilename)"); |
271 | next; |
272 | } |
76d311e7 |
273 | my $diff_file_method = "_ddl_schema_${direction}_produce_filename"; |
274 | my $diff_file = $self->$diff_file_method($db, $version_set, $dir ); |
2e68a8e1 |
275 | if(-e $diff_file) { |
76d311e7 |
276 | carp("Overwriting existing $direction-diff file - $diff_file"); |
2e68a8e1 |
277 | unlink $diff_file; |
278 | } |
279 | |
280 | my $source_schema; |
281 | { |
282 | my $t = SQL::Translator->new({ |
283 | %{$sqltargs}, |
284 | debug => 0, |
285 | trace => 0, |
286 | }); |
287 | |
288 | $t->parser( $db ) # could this really throw an exception? |
289 | or $self->throw_exception ($t->error); |
290 | |
291 | my $out = $t->translate( $prefilename ) |
292 | or $self->throw_exception ($t->error); |
293 | |
294 | $source_schema = $t->schema; |
295 | |
296 | $source_schema->name( $prefilename ) |
297 | unless $source_schema->name; |
298 | } |
299 | |
300 | # The "new" style of producers have sane normalization and can support |
301 | # diffing a SQL file against a DBIC->SQLT schema. Old style ones don't |
302 | # And we have to diff parsed SQL against parsed SQL. |
303 | my $dest_schema = $sqlt_schema; |
304 | |
305 | unless ( "SQL::Translator::Producer::$db"->can('preprocess_schema') ) { |
306 | my $t = SQL::Translator->new({ |
307 | %{$sqltargs}, |
308 | debug => 0, |
309 | trace => 0, |
310 | }); |
311 | |
312 | $t->parser( $db ) # could this really throw an exception? |
313 | or $self->throw_exception ($t->error); |
314 | |
76d311e7 |
315 | my $filename = $self->_ddl_schema_produce_filename($db, $to_version, $dir); |
2e68a8e1 |
316 | my $out = $t->translate( $filename ) |
317 | or $self->throw_exception ($t->error); |
318 | |
319 | $dest_schema = $t->schema; |
320 | |
321 | $dest_schema->name( $filename ) |
322 | unless $dest_schema->name; |
323 | } |
324 | |
325 | my $diff = SQL::Translator::Diff::schema_diff( |
326 | $source_schema, $db, |
327 | $dest_schema, $db, |
328 | $sqltargs |
329 | ); |
330 | my $file; |
331 | unless(open $file, q(>), $diff_file) { |
332 | $self->throw_exception("Can't write to $diff_file ($!)"); |
333 | next; |
334 | } |
335 | print {$file} $diff; |
336 | close $file; |
337 | } |
338 | } |
339 | |
334bced5 |
340 | method _read_sql_file($file) { |
341 | return unless $file; |
342 | |
aabd4237 |
343 | open my $fh, '<', $file; |
0d19af1d |
344 | my @data = split /;\n/, join '', <$fh>; |
334bced5 |
345 | close $fh; |
346 | |
347 | @data = grep { |
0d19af1d |
348 | $_ && # remove blank lines |
349 | !/^(BEGIN|BEGIN TRANSACTION|COMMIT)/ # strip txn's |
350 | } map { |
351 | s/^\s+//; s/\s+$//; # trim whitespace |
352 | join '', grep { !/^--/ } split /\n/ # remove comments |
353 | } @data; |
334bced5 |
354 | |
355 | return \@data; |
356 | } |
357 | |
76d311e7 |
358 | sub _downgrade_single_step { |
359 | my $self = shift; |
360 | my @version_set = @{ shift @_ }; |
9af9d0b2 |
361 | my @downgrade_files = @{$self->_ddl_schema_down_consume_filenames( |
76d311e7 |
362 | $self->storage->sqlt_type, |
363 | \@version_set, |
364 | )}; |
365 | |
9af9d0b2 |
366 | for my $downgrade_file (@downgrade_files) { |
9af9d0b2 |
367 | $self->_filedata($self->_read_sql_file($downgrade_file)); # I don't like this --fREW 2010-02-22 |
3249629f |
368 | |
369 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
370 | $self->_do_upgrade; |
371 | $guard->commit if $self->txn_wrap; |
76d311e7 |
372 | } |
373 | } |
374 | |
7521a845 |
375 | sub _upgrade_single_step { |
376 | my $self = shift; |
24f4524b |
377 | my @version_set = @{ shift @_ }; |
76d311e7 |
378 | my @upgrade_files = @{$self->_ddl_schema_up_consume_filenames( |
334bced5 |
379 | $self->storage->sqlt_type, |
24f4524b |
380 | \@version_set, |
3c1b5ee8 |
381 | )}; |
334bced5 |
382 | |
3c1b5ee8 |
383 | for my $upgrade_file (@upgrade_files) { |
3c1b5ee8 |
384 | $self->_filedata($self->_read_sql_file($upgrade_file)); # I don't like this --fREW 2010-02-22 |
3249629f |
385 | my $guard = $self->schema->txn_scope_guard if $self->txn_wrap; |
386 | $self->_do_upgrade; |
387 | $guard->commit if $self->txn_wrap; |
3c1b5ee8 |
388 | } |
334bced5 |
389 | } |
390 | |
8a7847f1 |
391 | method _do_upgrade { $self->_run_upgrade(qr/.*?/) } |
334bced5 |
392 | |
8a7847f1 |
393 | method _run_upgrade($stm) { |
334bced5 |
394 | my @statements = grep { $_ =~ $stm } @{$self->_filedata}; |
395 | |
396 | for (@statements) { |
397 | $self->storage->debugobj->query_start($_) if $self->storage->debug; |
8a7847f1 |
398 | $self->_apply_statement($_); |
334bced5 |
399 | $self->storage->debugobj->query_end($_) if $self->storage->debug; |
400 | } |
401 | } |
402 | |
8a7847f1 |
403 | method _apply_statement($statement) { |
334bced5 |
404 | # croak? |
405 | $self->storage->dbh->do($_) or carp "SQL was: $_" |
406 | } |
407 | |
aabd4237 |
408 | __PACKAGE__->meta->make_immutable; |
409 | |
2e68a8e1 |
410 | 1; |
e051bb00 |
411 | |
412 | __END__ |
413 | |
2eaf903b |
414 | vim: ts=2 sw=2 expandtab |