Commit | Line | Data |
e287b229 |
1 | use MooseX::Declare; |
4f4fd192 |
2 | role SQL::Translator::Producer::SQL::SQLite { |
55bb45c1 |
3 | use MooseX::Types::Moose qw(HashRef); |
4 | use SQL::Translator::Constants qw(:sqlt_types :sqlt_constants); |
4e8e4c33 |
5 | use SQL::Translator::Types qw(Column Constraint Index Trigger Table View); |
a5c5cd44 |
6 | |
7 | around _build_data_type_mapping { |
8 | my $data_type_mapping = $self->$orig; |
9 | $data_type_mapping->{SQL_FLOAT()} = 'real'; |
10 | $data_type_mapping->{SQL_BIGINT()} = 'integer'; |
11 | |
12 | return $data_type_mapping; |
13 | }; |
55bb45c1 |
14 | |
4e8e4c33 |
15 | method header_comment($producer, $comment_char) { |
16 | $producer ||= caller; |
55bb45c1 |
17 | my $now = scalar localtime; |
18 | my $DEFAULT_COMMENT = '-- '; |
19 | |
20 | $comment_char = $DEFAULT_COMMENT |
21 | unless defined $comment_char; |
22 | |
23 | my $header_comment =<<"HEADER_COMMENT"; |
24 | ${comment_char} |
25 | ${comment_char}Created by $producer |
26 | ${comment_char}Created on $now |
27 | ${comment_char} |
28 | HEADER_COMMENT |
29 | |
30 | # Any additional stuff passed in |
31 | for my $additional_comment (@_) { |
32 | $header_comment .= "${comment_char}${additional_comment}\n"; |
33 | } |
34 | |
35 | return $header_comment; |
36 | } |
37 | |
38 | method produce { |
39 | my $translator = $self->translator; |
40 | # local $DEBUG = $translator->debug; |
41 | # local $WARN = $translator->show_warnings; |
42 | my $no_comments = $translator->no_comments; |
43 | my $add_drop_table = $translator->add_drop_table; |
44 | my $schema = $translator->schema; |
45 | my $producer_args = $translator->producer_args; |
46 | my $sqlite_version = $producer_args->{sqlite_version} || 0; |
47 | my $no_txn = $producer_args->{no_transaction}; |
48 | |
49 | # debug("PKG: Beginning production\n"); |
50 | |
51 | # %global_names = (); #reset |
52 | |
53 | my @create = (); |
4e8e4c33 |
54 | push @create, $self->header_comment unless ($no_comments); |
55bb45c1 |
55 | $create[0] .= "\n\nBEGIN TRANSACTION" unless $no_txn; |
56 | |
57 | for my $table ( $schema->get_tables ) { |
58 | push @create, $self->create_table($table, { no_comments => $no_comments, |
59 | sqlite_version => $sqlite_version, |
60 | add_drop_table => $add_drop_table,}); |
61 | } |
62 | |
63 | for my $view ( $schema->get_views ) { |
4e8e4c33 |
64 | push @create, $self->create_view($view, { |
55bb45c1 |
65 | add_drop_view => $add_drop_table, |
66 | no_comments => $no_comments, |
67 | }); |
68 | } |
69 | |
70 | for my $trigger ( $schema->get_triggers ) { |
4e8e4c33 |
71 | push @create, $self->create_trigger($trigger, { |
55bb45c1 |
72 | add_drop_trigger => $add_drop_table, |
73 | no_comments => $no_comments, |
74 | }); |
75 | } |
76 | |
77 | if (wantarray) { |
78 | push @create, "COMMIT" unless $no_txn; |
79 | return @create; |
80 | } else { |
81 | push @create, "COMMIT;\n" unless $no_txn; |
82 | return join(";\n\n", @create ); |
83 | } |
84 | } |
85 | |
86 | # ------------------------------------------------------------------- |
87 | sub mk_name { |
88 | my ($name, $scope, $critical) = @_; |
89 | my $max_id_length = 30; |
90 | # $scope ||= \%global_names; |
91 | if ( my $prev = $scope->{ $name } ) { |
92 | my $name_orig = $name; |
93 | $name .= sprintf( "%02d", ++$prev ); |
94 | substr($name, $max_id_length - 3) = "00" |
95 | if length( $name ) > $max_id_length; |
96 | |
97 | # warn "The name '$name_orig' has been changed to ", |
98 | # "'$name' to make it unique.\n" if $WARN; |
99 | |
100 | $scope->{ $name_orig }++; |
101 | } |
102 | |
103 | $scope->{ $name }++; |
104 | return $name; |
105 | } |
106 | |
4e8e4c33 |
107 | method create_view(View $view, $options?) { |
55bb45c1 |
108 | my $add_drop_view = $options->{add_drop_view}; |
109 | |
110 | my $view_name = $view->name; |
111 | # debug("PKG: Looking at view '${view_name}'\n"); |
112 | |
113 | # Header. Should this look like what mysqldump produces? |
114 | my $extra = $view->extra; |
115 | my $create = ''; |
116 | $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments}; |
117 | $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view; |
118 | $create .= 'CREATE'; |
119 | $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary}; |
120 | $create .= ' VIEW'; |
121 | $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists}; |
122 | $create .= " ${view_name}"; |
123 | |
124 | if( my $sql = $view->sql ){ |
125 | $create .= " AS\n ${sql}"; |
126 | } |
127 | return $create; |
128 | } |
129 | |
55bb45c1 |
130 | method create_table(Table $table, HashRef $options) { |
131 | my $table_name = $table->name; |
132 | my $no_comments = $options->{no_comments}; |
133 | my $add_drop_table = $options->{add_drop_table}; |
134 | my $sqlite_version = $options->{sqlite_version} || 0; |
135 | |
136 | # debug("PKG: Looking at table '$table_name'\n"); |
137 | |
138 | my ( @index_defs, @constraint_defs ); |
139 | my @fields = $table->get_fields or die "No fields in $table_name"; |
140 | |
141 | my $temp = $options->{temporary_table} ? 'TEMPORARY ' : ''; |
142 | # |
143 | # Header. |
144 | # |
145 | my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : ''; |
146 | my @create; |
147 | my ($comment, $create_table) = ""; |
148 | $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments; |
149 | if ($add_drop_table) { |
150 | push @create, $comment . qq[DROP TABLE$exists $table_name]; |
151 | } else { |
152 | $create_table = $comment; |
153 | } |
154 | |
155 | $create_table .= "CREATE ${temp}TABLE $table_name (\n"; |
156 | |
157 | # |
158 | # Comments |
159 | # |
160 | if ( $table->comments and !$no_comments ){ |
161 | $create_table .= "-- Comments: \n-- "; |
162 | $create_table .= join "\n-- ", $table->comments; |
163 | $create_table .= "\n--\n\n"; |
164 | } |
165 | |
166 | # |
167 | # How many fields in PK? |
168 | # |
169 | my $pk = $table->primary_key; |
170 | my @pk_fields = $pk ? $pk->fields : (); |
171 | |
172 | # |
173 | # Fields |
174 | # |
175 | my ( @field_defs, $pk_set ); |
176 | for my $field ( @fields ) { |
4e8e4c33 |
177 | push @field_defs, $self->create_field($field); |
55bb45c1 |
178 | } |
179 | |
180 | if ( |
181 | scalar @pk_fields > 1 |
182 | || |
183 | ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs ) |
184 | ) { |
185 | push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')'; |
186 | } |
187 | |
188 | # |
189 | # Indices |
190 | # |
191 | my $idx_name_default = 'A'; |
192 | for my $index ( $table->get_indices ) { |
4e8e4c33 |
193 | push @index_defs, $self->create_index($index); |
55bb45c1 |
194 | } |
195 | |
196 | # |
197 | # Constraints |
198 | # |
199 | my $c_name_default = 'A'; |
200 | for my $c ( $table->get_constraints ) { |
201 | next unless $c->type eq UNIQUE; |
4e8e4c33 |
202 | push @constraint_defs, $self->create_constraint($c); |
55bb45c1 |
203 | } |
204 | |
205 | $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)"; |
206 | |
207 | return (@create, $create_table, @index_defs, @constraint_defs ); |
208 | } |
209 | |
4e8e4c33 |
210 | method create_field(Column $field, $options?) { |
55bb45c1 |
211 | my $field_name = $field->name; |
212 | # debug("PKG: Looking at field '$field_name'\n"); |
213 | my $field_comments = $field->comments |
214 | ? "-- " . $field->comments . "\n " |
215 | : ''; |
216 | |
217 | my $field_def = $field_comments.$field_name; |
218 | |
219 | # data type and size |
220 | my $size = $field->size; |
221 | my $data_type = $field->data_type; |
222 | $data_type = 'varchar' if lc $data_type eq 'set'; |
223 | $data_type = 'blob' if lc $data_type eq 'bytea'; |
224 | |
225 | if ( lc $data_type =~ /(text|blob)/i ) { |
226 | $size = undef; |
227 | } |
228 | |
229 | # if ( $data_type =~ /timestamp/i ) { |
230 | # push @trigger_defs, |
231 | # "CREATE TRIGGER ts_${table_name} ". |
232 | # "after insert on $table_name\n". |
233 | # "begin\n". |
234 | # " update $table_name set $field_name=timestamp() ". |
235 | # "where id=new.id;\n". |
236 | # "end;\n" |
237 | # ; |
238 | # |
239 | # } |
240 | |
241 | # |
242 | # SQLite is generally typeless, but newer versions will |
243 | # make a field autoincrement if it is declared as (and |
244 | # *only* as) INTEGER PRIMARY KEY |
245 | # |
246 | my $pk = $field->table->primary_key; |
247 | my @pk_fields = $pk ? $pk->fields : (); |
248 | |
249 | if ( |
250 | $field->is_primary_key && |
251 | scalar @pk_fields == 1 && |
252 | ( |
253 | $data_type =~ /int(eger)?$/i |
254 | || |
255 | ( $data_type =~ /^number?$/i && $size !~ /,/ ) |
256 | ) |
257 | ) { |
258 | $data_type = 'INTEGER PRIMARY KEY'; |
259 | $size = undef; |
260 | # $pk_set = 1; |
261 | } |
262 | |
263 | $field_def .= sprintf " %s%s", $data_type, |
264 | ( !$field->is_auto_increment && $size ) ? "($size)" : ''; |
265 | |
266 | # Null? |
267 | $field_def .= ' NOT NULL' unless $field->is_nullable; |
268 | |
269 | # Default? XXX Need better quoting! |
270 | my $default = $field->default_value; |
271 | =cut |
272 | if (defined $default) { |
273 | SQL::Translator::Producer->_apply_default_value( |
274 | \$field_def, |
275 | $default, |
276 | [ |
277 | 'NULL' => \'NULL', |
278 | 'now()' => 'now()', |
279 | 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP', |
280 | ], |
281 | ); |
282 | } |
283 | =cut |
284 | |
285 | return $field_def; |
286 | |
287 | } |
288 | |
4e8e4c33 |
289 | method create_index(Index $index, $options?) { |
55bb45c1 |
290 | my $name = $index->name; |
291 | $name = mk_name($name); |
292 | |
293 | my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : ''; |
294 | |
295 | # strip any field size qualifiers as SQLite doesn't like these |
296 | my @fields = map { s/\(\d+\)$//; $_ } $index->fields; |
297 | (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema |
298 | # warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN; |
299 | my $index_def = |
300 | "CREATE ${type}INDEX $name ON " . $index_table_name . |
301 | ' (' . join( ', ', @fields ) . ')'; |
302 | |
303 | return $index_def; |
304 | } |
305 | |
4e8e4c33 |
306 | method create_constraint(Constraint $c, $options?) { |
55bb45c1 |
307 | my $name = $c->name; |
308 | $name = mk_name($name); |
309 | my @fields = $c->fields; |
310 | (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema |
311 | # warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN; |
312 | |
313 | my $c_def = |
314 | "CREATE UNIQUE INDEX $name ON " . $index_table_name . |
315 | ' (' . join( ', ', @fields ) . ')'; |
55bb45c1 |
316 | return $c_def; |
317 | } |
318 | |
4e8e4c33 |
319 | method create_trigger(Trigger $trigger, $options?) { |
55bb45c1 |
320 | my $add_drop = $options->{add_drop_trigger}; |
321 | |
322 | my @statements; |
323 | |
324 | my $trigger_name = $trigger->name; |
325 | my $events = $trigger->database_events; |
326 | for my $evt ( @$events ) { |
327 | |
328 | my $trig_name = $trigger_name; |
329 | if (@$events > 1) { |
330 | $trig_name .= "_$evt"; |
331 | |
332 | # warn "Multiple database events supplied for trigger '$trigger_name', ", |
333 | # "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN; |
334 | } |
335 | |
336 | push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop; |
337 | |
338 | |
339 | $DB::single = 1; |
340 | my $action = ""; |
341 | if (not ref $trigger->action) { |
342 | $action .= "BEGIN " . $trigger->action . " END"; |
343 | } |
344 | else { |
345 | $action = $trigger->action->{for_each} . " " |
346 | if $trigger->action->{for_each}; |
347 | |
348 | $action = $trigger->action->{when} . " " |
349 | if $trigger->action->{when}; |
350 | |
351 | my $steps = $trigger->action->{steps} || []; |
352 | |
353 | $action .= "BEGIN "; |
354 | $action .= $_ . "; " for (@$steps); |
355 | $action .= "END"; |
4f4fd192 |
356 | } |
55bb45c1 |
357 | |
358 | push @statements, sprintf ( |
359 | 'CREATE TRIGGER %s %s %s on %s %s', |
360 | $trig_name, |
361 | $trigger->perform_action_when, |
362 | $evt, |
363 | $trigger->on_table, |
364 | $action |
365 | ); |
366 | } |
367 | |
368 | return @statements; |
369 | } |
370 | |
4e8e4c33 |
371 | method alter_table(@) { } # Noop |
55bb45c1 |
372 | |
4e8e4c33 |
373 | method add_field(Column $field) { |
55bb45c1 |
374 | return sprintf("ALTER TABLE %s ADD COLUMN %s", |
4e8e4c33 |
375 | $field->table->name, $self->create_field($field)) |
55bb45c1 |
376 | } |
377 | |
4e8e4c33 |
378 | method alter_create_index(Index $index) { |
55bb45c1 |
379 | # This might cause name collisions |
4e8e4c33 |
380 | return $self->create_index($index); |
55bb45c1 |
381 | } |
382 | |
4e8e4c33 |
383 | method alter_create_constraint(Constraint $constraint) { |
384 | return $self->create_constraint($constraint) if $constraint->type eq 'UNIQUE'; |
55bb45c1 |
385 | } |
386 | |
4e8e4c33 |
387 | method alter_drop_constraint(@args) { $self->alter_drop_index(@args) } |
55bb45c1 |
388 | |
4e8e4c33 |
389 | method alter_drop_index(Constraint $constraint) { |
55bb45c1 |
390 | return sprintf("DROP INDEX %s", |
391 | $constraint->name); |
392 | } |
393 | |
4e8e4c33 |
394 | method batch_alter_table(Table $table, $diffs) { |
55bb45c1 |
395 | # If we have any of the following |
396 | # |
397 | # rename_field |
398 | # alter_field |
399 | # drop_field |
400 | # |
401 | # we need to do the following <http://www.sqlite.org/faq.html#q11> |
402 | # |
403 | # BEGIN TRANSACTION; |
404 | # CREATE TEMPORARY TABLE t1_backup(a,b); |
405 | # INSERT INTO t1_backup SELECT a,b FROM t1; |
406 | # DROP TABLE t1; |
407 | # CREATE TABLE t1(a,b); |
408 | # INSERT INTO t1 SELECT a,b FROM t1_backup; |
409 | # DROP TABLE t1_backup; |
410 | # COMMIT; |
411 | # |
412 | # Fun, eh? |
413 | # |
414 | # If we have rename_field we do similarly. |
415 | |
416 | my $table_name = $table->name; |
417 | my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}}; |
418 | |
419 | if ( @{$diffs->{rename_field}} == 0 && |
420 | @{$diffs->{alter_field}} == 0 && |
421 | @{$diffs->{drop_field}} == 0 |
422 | ) { |
423 | # return join("\n", map { |
424 | return map { |
425 | my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_"; |
426 | map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} } |
427 | |
428 | } grep { @{$diffs->{$_}} } |
429 | qw/rename_table |
430 | alter_drop_constraint |
431 | alter_drop_index |
432 | drop_field |
433 | add_field |
434 | alter_field |
435 | rename_field |
436 | alter_create_index |
437 | alter_create_constraint |
438 | alter_table/; |
439 | } |
440 | |
55bb45c1 |
441 | my @sql; |
442 | my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table; |
443 | |
444 | do { |
445 | local $table->{name} = $table_name . '_temp_alter'; |
446 | # We only want the table - dont care about indexes on tmp table |
4e8e4c33 |
447 | my ($table_sql) = $self->create_table($table, {no_comments => 1, temporary_table => 1}); |
55bb45c1 |
448 | push @sql,$table_sql; |
449 | }; |
450 | |
451 | push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}", |
452 | "DROP TABLE @{[$old_table]}", |
4e8e4c33 |
453 | $self->create_table($table, { no_comments => 1 }), |
55bb45c1 |
454 | "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter", |
455 | "DROP TABLE @{[$table_name]}_temp_alter"; |
456 | |
457 | return @sql; |
458 | # return join("", @sql, ""); |
459 | } |
460 | |
4e8e4c33 |
461 | method drop_table(Str $table) { |
55bb45c1 |
462 | return "DROP TABLE $table"; |
463 | } |
464 | |
4e8e4c33 |
465 | method rename_table(Str $old_table, Str $new_table, $options?) { |
55bb45c1 |
466 | my $qt = $options->{quote_table_names} || ''; |
467 | |
468 | return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt"; |
469 | |
470 | } |
471 | |
472 | # No-op. Just here to signify that we are a new style parser. |
4e8e4c33 |
473 | method preproces_schema(@) { } |
287d4603 |
474 | } |