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