Commit | Line | Data |
758ab1cd |
1 | package SQL::Translator::Producer::SQLite; |
2 | |
20770e44 |
3 | =head1 NAME |
4 | |
5 | SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator |
6 | |
7 | =head1 SYNOPSIS |
8 | |
9 | use SQL::Translator; |
10 | |
11 | my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' ); |
12 | $t->translate; |
13 | |
14 | =head1 DESCRIPTION |
15 | |
16 | This module will produce text output of the schema suitable for SQLite. |
17 | |
18 | =cut |
19 | |
758ab1cd |
20 | use strict; |
d0fcb05d |
21 | use warnings; |
758ab1cd |
22 | use Data::Dumper; |
b21bf652 |
23 | use SQL::Translator::Schema::Constants; |
7b4b17aa |
24 | use SQL::Translator::Utils qw(debug header_comment parse_dbms_version); |
27df230e |
25 | use SQL::Translator::Generator::DDL::SQLite; |
758ab1cd |
26 | |
0c04c5a2 |
27 | our ( $DEBUG, $WARN ); |
0c04c5a2 |
28 | our $VERSION = '1.59'; |
11ad2df9 |
29 | $DEBUG = 0 unless defined $DEBUG; |
30 | $WARN = 0 unless defined $WARN; |
758ab1cd |
31 | |
11ad2df9 |
32 | our $max_id_length = 30; |
ae602737 |
33 | my %global_names; |
2d23c1e1 |
34 | |
35 | # HIDEOUS TEMPORARY DEFAULT WITHOUT QUOTING! |
36 | our $NO_QUOTES = 1; |
37 | { |
38 | |
39 | my ($quoting_generator, $nonquoting_generator); |
40 | sub _generator { |
41 | $NO_QUOTES |
42 | ? $nonquoting_generator ||= SQL::Translator::Generator::DDL::SQLite->new(quote_chars => []) |
43 | : $quoting_generator ||= SQL::Translator::Generator::DDL::SQLite->new |
44 | } |
45 | } |
758ab1cd |
46 | |
758ab1cd |
47 | sub produce { |
a1d94525 |
48 | my $translator = shift; |
49 | local $DEBUG = $translator->debug; |
50 | local $WARN = $translator->show_warnings; |
51 | my $no_comments = $translator->no_comments; |
52 | my $add_drop_table = $translator->add_drop_table; |
53 | my $schema = $translator->schema; |
d12f72ff |
54 | my $producer_args = $translator->producer_args; |
7b4b17aa |
55 | my $sqlite_version = parse_dbms_version( |
56 | $producer_args->{sqlite_version}, 'perl' |
57 | ); |
f9c96971 |
58 | my $no_txn = $producer_args->{no_transaction}; |
758ab1cd |
59 | |
1a24938d |
60 | debug("PKG: Beginning production\n"); |
758ab1cd |
61 | |
ae602737 |
62 | %global_names = (); #reset |
63 | |
2d23c1e1 |
64 | # only quote if quotes were requested for real |
65 | # 0E0 indicates "the default of true" was assumed |
66 | local $NO_QUOTES = 0 |
67 | if $translator->quote_identifiers and $translator->quote_identifiers ne '0E0'; |
b6b0696f |
68 | |
69 | my $head = (header_comment() . "\n") unless $no_comments; |
70 | |
24d9fe69 |
71 | my @create = (); |
b6b0696f |
72 | |
73 | push @create, "BEGIN TRANSACTION" unless $no_txn; |
758ab1cd |
74 | |
b21bf652 |
75 | for my $table ( $schema->get_tables ) { |
24d9fe69 |
76 | push @create, create_table($table, { no_comments => $no_comments, |
d12f72ff |
77 | sqlite_version => $sqlite_version, |
4d438549 |
78 | add_drop_table => $add_drop_table,}); |
a5a882f0 |
79 | } |
80 | |
ec59a597 |
81 | for my $view ( $schema->get_views ) { |
24d9fe69 |
82 | push @create, create_view($view, { |
a25ac5d2 |
83 | add_drop_view => $add_drop_table, |
84 | no_comments => $no_comments, |
85 | }); |
ec59a597 |
86 | } |
87 | |
d0fcb05d |
88 | for my $trigger ( $schema->get_triggers ) { |
89 | push @create, create_trigger($trigger, { |
90 | add_drop_trigger => $add_drop_table, |
91 | no_comments => $no_comments, |
92 | }); |
93 | } |
94 | |
b6b0696f |
95 | push @create, "COMMIT" unless $no_txn; |
96 | |
f9c96971 |
97 | if (wantarray) { |
b6b0696f |
98 | return ($head||(), @create); |
f9c96971 |
99 | } else { |
b6b0696f |
100 | return join ('', |
101 | $head||(), |
102 | join(";\n\n", @create ), |
103 | ";\n", |
104 | ); |
f9c96971 |
105 | } |
758ab1cd |
106 | } |
107 | |
758ab1cd |
108 | sub mk_name { |
ae602737 |
109 | my ($name, $scope, $critical) = @_; |
758ab1cd |
110 | |
111 | $scope ||= \%global_names; |
112 | if ( my $prev = $scope->{ $name } ) { |
113 | my $name_orig = $name; |
114 | $name .= sprintf( "%02d", ++$prev ); |
ea93df61 |
115 | substr($name, $max_id_length - 3) = "00" |
11ad2df9 |
116 | if length( $name ) > $max_id_length; |
758ab1cd |
117 | |
118 | warn "The name '$name_orig' has been changed to ", |
119 | "'$name' to make it unique.\n" if $WARN; |
120 | |
121 | $scope->{ $name_orig }++; |
122 | } |
123 | |
124 | $scope->{ $name }++; |
2d23c1e1 |
125 | return _generator()->quote($name); |
758ab1cd |
126 | } |
127 | |
ec59a597 |
128 | sub create_view { |
129 | my ($view, $options) = @_; |
a25ac5d2 |
130 | my $add_drop_view = $options->{add_drop_view}; |
ec59a597 |
131 | |
2d23c1e1 |
132 | my $view_name = _generator()->quote($view->name); |
d8cf2279 |
133 | $global_names{$view->name} = 1; |
56785c01 |
134 | |
ec59a597 |
135 | debug("PKG: Looking at view '${view_name}'\n"); |
136 | |
137 | # Header. Should this look like what mysqldump produces? |
138 | my $extra = $view->extra; |
4c0d31c1 |
139 | my @create; |
140 | push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view; |
141 | |
142 | my $create_view = 'CREATE'; |
143 | $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary}; |
144 | $create_view .= ' VIEW'; |
145 | $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists}; |
146 | $create_view .= " ${view_name}"; |
ec59a597 |
147 | |
148 | if( my $sql = $view->sql ){ |
4c0d31c1 |
149 | $create_view .= " AS\n ${sql}"; |
ec59a597 |
150 | } |
4c0d31c1 |
151 | push @create, $create_view; |
152 | |
153 | # Tack the comment onto the first statement. |
154 | unless ($options->{no_comments}) { |
155 | $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0]; |
156 | } |
157 | |
158 | return @create; |
ec59a597 |
159 | } |
160 | |
161 | |
bfb5a568 |
162 | sub create_table |
163 | { |
164 | my ($table, $options) = @_; |
758ab1cd |
165 | |
2d23c1e1 |
166 | my $table_name = _generator()->quote($table->name); |
d8cf2279 |
167 | $global_names{$table->name} = 1; |
56785c01 |
168 | |
bfb5a568 |
169 | my $no_comments = $options->{no_comments}; |
170 | my $add_drop_table = $options->{add_drop_table}; |
3db73ef8 |
171 | my $sqlite_version = $options->{sqlite_version} || 0; |
bfb5a568 |
172 | |
173 | debug("PKG: Looking at table '$table_name'\n"); |
174 | |
d0fcb05d |
175 | my ( @index_defs, @constraint_defs ); |
bfb5a568 |
176 | my @fields = $table->get_fields or die "No fields in $table_name"; |
177 | |
4d438549 |
178 | my $temp = $options->{temporary_table} ? 'TEMPORARY ' : ''; |
bfb5a568 |
179 | # |
180 | # Header. |
181 | # |
7b4b17aa |
182 | my $exists = ($sqlite_version >= 3.003) ? ' IF EXISTS' : ''; |
24d9fe69 |
183 | my @create; |
d0fcb05d |
184 | my ($comment, $create_table) = ""; |
185 | $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments; |
186 | if ($add_drop_table) { |
187 | push @create, $comment . qq[DROP TABLE$exists $table_name]; |
188 | } else { |
189 | $create_table = $comment; |
190 | } |
191 | |
192 | $create_table .= "CREATE ${temp}TABLE $table_name (\n"; |
bfb5a568 |
193 | |
194 | # |
195 | # Comments |
196 | # |
197 | if ( $table->comments and !$no_comments ){ |
24d9fe69 |
198 | $create_table .= "-- Comments: \n-- "; |
199 | $create_table .= join "\n-- ", $table->comments; |
200 | $create_table .= "\n--\n\n"; |
bfb5a568 |
201 | } |
202 | |
203 | # |
204 | # How many fields in PK? |
205 | # |
206 | my $pk = $table->primary_key; |
207 | my @pk_fields = $pk ? $pk->fields : (); |
208 | |
209 | # |
210 | # Fields |
211 | # |
212 | my ( @field_defs, $pk_set ); |
213 | for my $field ( @fields ) { |
214 | push @field_defs, create_field($field); |
215 | } |
216 | |
ea93df61 |
217 | if ( |
218 | scalar @pk_fields > 1 |
219 | || |
220 | ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs ) |
bfb5a568 |
221 | ) { |
2d23c1e1 |
222 | push @field_defs, 'PRIMARY KEY (' . join(', ', map _generator()->quote($_), @pk_fields ) . ')'; |
bfb5a568 |
223 | } |
224 | |
225 | # |
226 | # Indices |
227 | # |
228 | my $idx_name_default = 'A'; |
229 | for my $index ( $table->get_indices ) { |
230 | push @index_defs, create_index($index); |
231 | } |
232 | |
233 | # |
234 | # Constraints |
235 | # |
236 | my $c_name_default = 'A'; |
237 | for my $c ( $table->get_constraints ) { |
0dbd2362 |
238 | if ($c->type eq "FOREIGN KEY") { |
239 | push @field_defs, create_foreignkey($c); |
240 | } |
ea93df61 |
241 | next unless $c->type eq UNIQUE; |
bfb5a568 |
242 | push @constraint_defs, create_constraint($c); |
243 | } |
244 | |
24d9fe69 |
245 | $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)"; |
bfb5a568 |
246 | |
d0fcb05d |
247 | return (@create, $create_table, @index_defs, @constraint_defs ); |
bfb5a568 |
248 | } |
249 | |
0dbd2362 |
250 | sub create_foreignkey { |
251 | my $c = shift; |
252 | |
ea4a3ecc |
253 | my @fields = $c->fields; |
254 | my @rfields = map { $_ || () } $c->reference_fields; |
255 | unless ( @rfields ) { |
256 | my $rtable_name = $c->reference_table; |
257 | if ( my $ref_table = $c->schema->get_table( $rtable_name ) ) { |
258 | push @rfields, $ref_table->primary_key; |
259 | |
260 | die "FK constraint on " . $rtable_name . '.' . join('', @fields) . " has no reference fields\n" |
261 | unless @rfields; |
262 | } |
263 | else { |
264 | die "Can't find reference table '$rtable_name' in schema\n"; |
265 | } |
266 | } |
267 | |
268 | my $fk_sql = sprintf 'FOREIGN KEY (%s) REFERENCES %s(%s)', |
2d23c1e1 |
269 | join (', ', map { _generator()->quote($_) } @fields ), |
270 | _generator()->quote($c->reference_table), |
271 | join (', ', map { _generator()->quote($_) } @rfields ) |
ea4a3ecc |
272 | ; |
273 | |
274 | $fk_sql .= " ON DELETE " . $c->{on_delete} if $c->{on_delete}; |
275 | $fk_sql .= " ON UPDATE " . $c->{on_update} if $c->{on_update}; |
0dbd2362 |
276 | |
277 | return $fk_sql; |
278 | } |
279 | |
2d23c1e1 |
280 | sub create_field { return _generator()->field($_[0]) } |
bfb5a568 |
281 | |
282 | sub create_index |
283 | { |
284 | my ($index, $options) = @_; |
285 | |
286 | my $name = $index->name; |
ae602737 |
287 | $name = mk_name($name); |
4d438549 |
288 | |
ea93df61 |
289 | my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : ''; |
bfb5a568 |
290 | |
291 | # strip any field size qualifiers as SQLite doesn't like these |
2d23c1e1 |
292 | my @fields = map { s/\(\d+\)$//; _generator()->quote($_) } $index->fields; |
cc74bccc |
293 | (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema |
2d23c1e1 |
294 | $index_table_name = _generator()->quote($index_table_name); |
cc74bccc |
295 | warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN; |
ea93df61 |
296 | my $index_def = |
907f8cea |
297 | "CREATE ${type}INDEX $name ON " . $index_table_name . |
298 | ' (' . join( ', ', @fields ) . ')'; |
bfb5a568 |
299 | |
300 | return $index_def; |
301 | } |
302 | |
303 | sub create_constraint |
304 | { |
305 | my ($c, $options) = @_; |
306 | |
307 | my $name = $c->name; |
ae602737 |
308 | $name = mk_name($name); |
2d23c1e1 |
309 | my @fields = map _generator()->quote($_), $c->fields; |
cc74bccc |
310 | (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema |
2d23c1e1 |
311 | $index_table_name = _generator()->quote($index_table_name); |
cc74bccc |
312 | warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN; |
bfb5a568 |
313 | |
ea93df61 |
314 | my $c_def = |
907f8cea |
315 | "CREATE UNIQUE INDEX $name ON " . $index_table_name . |
316 | ' (' . join( ', ', @fields ) . ')'; |
bfb5a568 |
317 | |
318 | return $c_def; |
319 | } |
320 | |
d0fcb05d |
321 | sub create_trigger { |
322 | my ($trigger, $options) = @_; |
323 | my $add_drop = $options->{add_drop_trigger}; |
324 | |
410d4a42 |
325 | my @statements; |
d0fcb05d |
326 | |
410d4a42 |
327 | my $trigger_name = $trigger->name; |
56785c01 |
328 | $global_names{$trigger_name} = 1; |
329 | |
d0fcb05d |
330 | my $events = $trigger->database_events; |
410d4a42 |
331 | for my $evt ( @$events ) { |
d0fcb05d |
332 | |
410d4a42 |
333 | my $trig_name = $trigger_name; |
334 | if (@$events > 1) { |
335 | $trig_name .= "_$evt"; |
d0fcb05d |
336 | |
410d4a42 |
337 | warn "Multiple database events supplied for trigger '$trigger_name', ", |
338 | "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN; |
339 | } |
d0fcb05d |
340 | |
2d23c1e1 |
341 | $trig_name = _generator()->quote($trig_name); |
410d4a42 |
342 | push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop; |
d0fcb05d |
343 | |
f9c96971 |
344 | |
410d4a42 |
345 | $DB::single = 1; |
346 | my $action = ""; |
347 | if (not ref $trigger->action) { |
348 | $action .= "BEGIN " . $trigger->action . " END"; |
f9c96971 |
349 | } |
410d4a42 |
350 | else { |
351 | $action = $trigger->action->{for_each} . " " |
352 | if $trigger->action->{for_each}; |
353 | |
354 | $action = $trigger->action->{when} . " " |
355 | if $trigger->action->{when}; |
d0fcb05d |
356 | |
410d4a42 |
357 | my $steps = $trigger->action->{steps} || []; |
358 | |
359 | $action .= "BEGIN "; |
360 | $action .= $_ . "; " for (@$steps); |
361 | $action .= "END"; |
362 | } |
363 | |
364 | push @statements, sprintf ( |
365 | 'CREATE TRIGGER %s %s %s on %s %s', |
366 | $trig_name, |
367 | $trigger->perform_action_when, |
368 | $evt, |
2d23c1e1 |
369 | _generator()->quote($trigger->on_table), |
410d4a42 |
370 | $action |
371 | ); |
372 | } |
d0fcb05d |
373 | |
410d4a42 |
374 | return @statements; |
d0fcb05d |
375 | } |
376 | |
4d438549 |
377 | sub alter_table { } # Noop |
378 | |
379 | sub add_field { |
380 | my ($field) = @_; |
381 | |
382 | return sprintf("ALTER TABLE %s ADD COLUMN %s", |
2d23c1e1 |
383 | _generator()->quote($field->table->name), create_field($field)) |
4d438549 |
384 | } |
385 | |
386 | sub alter_create_index { |
387 | my ($index) = @_; |
388 | |
389 | # This might cause name collisions |
390 | return create_index($index); |
391 | } |
392 | |
393 | sub alter_create_constraint { |
394 | my ($constraint) = @_; |
395 | |
396 | return create_constraint($constraint) if $constraint->type eq 'UNIQUE'; |
397 | } |
398 | |
399 | sub alter_drop_constraint { alter_drop_index(@_) } |
400 | |
401 | sub alter_drop_index { |
402 | my ($constraint) = @_; |
403 | |
ecf7f25d |
404 | return sprintf("DROP INDEX %s", |
2d23c1e1 |
405 | _generator()->quote($constraint->name)); |
4d438549 |
406 | } |
407 | |
408 | sub batch_alter_table { |
409 | my ($table, $diffs) = @_; |
410 | |
4d438549 |
411 | # If we have any of the following |
412 | # |
413 | # rename_field |
414 | # alter_field |
415 | # drop_field |
416 | # |
417 | # we need to do the following <http://www.sqlite.org/faq.html#q11> |
418 | # |
419 | # BEGIN TRANSACTION; |
420 | # CREATE TEMPORARY TABLE t1_backup(a,b); |
421 | # INSERT INTO t1_backup SELECT a,b FROM t1; |
422 | # DROP TABLE t1; |
423 | # CREATE TABLE t1(a,b); |
424 | # INSERT INTO t1 SELECT a,b FROM t1_backup; |
425 | # DROP TABLE t1_backup; |
426 | # COMMIT; |
427 | # |
428 | # Fun, eh? |
46bf5655 |
429 | # |
430 | # If we have rename_field we do similarly. |
431 | |
432 | my $table_name = $table->name; |
433 | my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}}; |
4d438549 |
434 | |
435 | if ( @{$diffs->{rename_field}} == 0 && |
436 | @{$diffs->{alter_field}} == 0 && |
46bf5655 |
437 | @{$diffs->{drop_field}} == 0 |
438 | ) { |
ea93df61 |
439 | # return join("\n", map { |
440 | return map { |
4d438549 |
441 | my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_"; |
24d9fe69 |
442 | map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} } |
ea93df61 |
443 | |
444 | } grep { @{$diffs->{$_}} } |
46bf5655 |
445 | qw/rename_table |
446 | alter_drop_constraint |
447 | alter_drop_index |
448 | drop_field |
449 | add_field |
450 | alter_field |
451 | rename_field |
452 | alter_create_index |
453 | alter_create_constraint |
24d9fe69 |
454 | alter_table/; |
4d438549 |
455 | } |
456 | |
4d438549 |
457 | my @sql; |
46bf5655 |
458 | my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table; |
ea93df61 |
459 | |
1e54de2f |
460 | if(@{$diffs->{drop_field}}) { |
461 | $old_table =$diffs->{drop_field}[0]->table; |
462 | } |
463 | |
464 | my %temp_table_fields; |
4d438549 |
465 | do { |
46bf5655 |
466 | local $table->{name} = $table_name . '_temp_alter'; |
4d438549 |
467 | # We only want the table - dont care about indexes on tmp table |
468 | my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1}); |
469 | push @sql,$table_sql; |
1e54de2f |
470 | |
471 | %temp_table_fields = map { $_ => 1} $table->get_fields; |
4d438549 |
472 | }; |
473 | |
2d23c1e1 |
474 | push @sql, "INSERT INTO @{[_generator()->quote($table_name.'_temp_alter')]}( @{[ join(', ', map _generator()->quote($_), grep { $temp_table_fields{$_} } $old_table->get_fields)]}) SELECT @{[ join(', ', map _generator()->quote($_), grep { $temp_table_fields{$_} } $old_table->get_fields)]} FROM @{[_generator()->quote($old_table)]}", |
475 | "DROP TABLE @{[_generator()->quote($old_table)]}", |
4d438549 |
476 | create_table($table, { no_comments => 1 }), |
2d23c1e1 |
477 | "INSERT INTO @{[_generator()->quote($table_name)]} SELECT @{[ join(', ', map _generator()->quote($_), $table->get_fields)]} FROM @{[_generator()->quote($table_name.'_temp_alter')]}", |
478 | "DROP TABLE @{[_generator()->quote($table_name.'_temp_alter')]}"; |
24d9fe69 |
479 | return @sql; |
480 | # return join("", @sql, ""); |
4d438549 |
481 | } |
482 | |
483 | sub drop_table { |
484 | my ($table) = @_; |
2d23c1e1 |
485 | $table = _generator()->quote($table); |
24d9fe69 |
486 | return "DROP TABLE $table"; |
4d438549 |
487 | } |
488 | |
46bf5655 |
489 | sub rename_table { |
490 | my ($old_table, $new_table, $options) = @_; |
491 | |
2d23c1e1 |
492 | $old_table = _generator()->quote($old_table); |
493 | $new_table = _generator()->quote($new_table); |
46bf5655 |
494 | |
d8cf2279 |
495 | return "ALTER TABLE $old_table RENAME TO $new_table"; |
46bf5655 |
496 | |
497 | } |
498 | |
934e1b39 |
499 | # No-op. Just here to signify that we are a new style parser. |
500 | sub preproces_schema { } |
501 | |
bfb5a568 |
502 | 1; |
758ab1cd |
503 | |
20770e44 |
504 | =pod |
505 | |
506 | =head1 SEE ALSO |
507 | |
508 | SQL::Translator, http://www.sqlite.org/. |
758ab1cd |
509 | |
510 | =head1 AUTHOR |
511 | |
11ad2df9 |
512 | Ken Youens-Clark C<< <kclark@cpan.orgE> >>. |
4d438549 |
513 | |
514 | Diff code added by Ash Berlin C<< <ash@cpan.org> >>. |
20770e44 |
515 | |
516 | =cut |