1 package SQL::Translator::Producer::SQLite;
5 SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator
11 my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
16 This module will produce text output of the schema suitable for SQLite.
23 use SQL::Translator::Schema::Constants;
24 use SQL::Translator::Utils qw(debug header_comment parse_dbms_version batch_alter_table_statements);
25 use SQL::Translator::Generator::DDL::SQLite;
27 our ( $DEBUG, $WARN );
28 our $VERSION = '1.60';
29 $DEBUG = 0 unless defined $DEBUG;
30 $WARN = 0 unless defined $WARN;
32 our $max_id_length = 30;
35 # HIDEOUS TEMPORARY DEFAULT WITHOUT QUOTING!
39 my ($quoting_generator, $nonquoting_generator);
42 ? $nonquoting_generator ||= SQL::Translator::Generator::DDL::SQLite->new(quote_chars => [])
43 : $quoting_generator ||= SQL::Translator::Generator::DDL::SQLite->new
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;
54 my $producer_args = $translator->producer_args;
55 my $sqlite_version = parse_dbms_version(
56 $producer_args->{sqlite_version}, 'perl'
58 my $no_txn = $producer_args->{no_transaction};
60 debug("PKG: Beginning production\n");
62 %global_names = (); #reset
64 # only quote if quotes were requested for real
65 # 0E0 indicates "the default of true" was assumed
67 if $translator->quote_identifiers and $translator->quote_identifiers ne '0E0';
70 $head = (header_comment() . "\n") unless $no_comments;
74 push @create, "BEGIN TRANSACTION" unless $no_txn;
76 for my $table ( $schema->get_tables ) {
77 push @create, create_table($table, { no_comments => $no_comments,
78 sqlite_version => $sqlite_version,
79 add_drop_table => $add_drop_table,});
82 for my $view ( $schema->get_views ) {
83 push @create, create_view($view, {
84 add_drop_view => $add_drop_table,
85 no_comments => $no_comments,
89 for my $trigger ( $schema->get_triggers ) {
90 push @create, create_trigger($trigger, {
91 add_drop_trigger => $add_drop_table,
92 no_comments => $no_comments,
96 push @create, "COMMIT" unless $no_txn;
99 return ($head||(), @create);
103 join(";\n\n", @create ),
110 my ($name, $scope, $critical) = @_;
112 $scope ||= \%global_names;
113 if ( my $prev = $scope->{ $name } ) {
114 my $name_orig = $name;
115 $name .= sprintf( "%02d", ++$prev );
116 substr($name, $max_id_length - 3) = "00"
117 if length( $name ) > $max_id_length;
119 warn "The name '$name_orig' has been changed to ",
120 "'$name' to make it unique.\n" if $WARN;
122 $scope->{ $name_orig }++;
126 return _generator()->quote($name);
130 my ($view, $options) = @_;
131 my $add_drop_view = $options->{add_drop_view};
133 my $view_name = _generator()->quote($view->name);
134 $global_names{$view->name} = 1;
136 debug("PKG: Looking at view '${view_name}'\n");
138 # Header. Should this look like what mysqldump produces?
139 my $extra = $view->extra;
141 push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view;
143 my $create_view = 'CREATE';
144 $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
145 $create_view .= ' VIEW';
146 $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
147 $create_view .= " ${view_name}";
149 if( my $sql = $view->sql ){
150 $create_view .= " AS\n ${sql}";
152 push @create, $create_view;
154 # Tack the comment onto the first statement.
155 unless ($options->{no_comments}) {
156 $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0];
165 my ($table, $options) = @_;
167 my $table_name = _generator()->quote($table->name);
168 $global_names{$table->name} = 1;
170 my $no_comments = $options->{no_comments};
171 my $add_drop_table = $options->{add_drop_table};
172 my $sqlite_version = $options->{sqlite_version} || 0;
174 debug("PKG: Looking at table '$table_name'\n");
176 my ( @index_defs, @constraint_defs );
177 my @fields = $table->get_fields or die "No fields in $table_name";
179 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
183 my $exists = ($sqlite_version >= 3.003) ? ' IF EXISTS' : '';
185 my ($comment, $create_table) = "";
186 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
187 if ($add_drop_table) {
188 push @create, $comment . qq[DROP TABLE$exists $table_name];
190 $create_table = $comment;
193 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
198 if ( $table->comments and !$no_comments ){
199 $create_table .= "-- Comments: \n-- ";
200 $create_table .= join "\n-- ", $table->comments;
201 $create_table .= "\n--\n\n";
205 # How many fields in PK?
207 my $pk = $table->primary_key;
208 my @pk_fields = $pk ? $pk->fields : ();
213 my ( @field_defs, $pk_set );
214 for my $field ( @fields ) {
215 push @field_defs, create_field($field);
219 scalar @pk_fields > 1
221 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
223 push @field_defs, 'PRIMARY KEY (' . join(', ', map _generator()->quote($_), @pk_fields ) . ')';
229 for my $index ( $table->get_indices ) {
230 push @index_defs, create_index($index);
236 for my $c ( $table->get_constraints ) {
237 if ($c->type eq "FOREIGN KEY") {
238 push @field_defs, create_foreignkey($c);
240 elsif ($c->type eq "CHECK") {
241 push @field_defs, create_check_constraint($c);
243 next unless $c->type eq UNIQUE;
244 push @constraint_defs, create_constraint($c);
247 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
249 return (@create, $create_table, @index_defs, @constraint_defs );
252 sub create_check_constraint {
255 $check .= 'CONSTRAINT ' . _generator->quote( $c->name ) . ' ' if $c->name;
256 $check .= 'CHECK(' . $c->expression . ')';
260 sub create_foreignkey {
263 my @fields = $c->fields;
264 my @rfields = map { $_ || () } $c->reference_fields;
265 unless ( @rfields ) {
266 my $rtable_name = $c->reference_table;
267 if ( my $ref_table = $c->schema->get_table( $rtable_name ) ) {
268 push @rfields, $ref_table->primary_key;
270 die "FK constraint on " . $rtable_name . '.' . join('', @fields) . " has no reference fields\n"
274 die "Can't find reference table '$rtable_name' in schema\n";
278 my $fk_sql = sprintf 'FOREIGN KEY (%s) REFERENCES %s(%s)',
279 join (', ', map { _generator()->quote($_) } @fields ),
280 _generator()->quote($c->reference_table),
281 join (', ', map { _generator()->quote($_) } @rfields )
284 $fk_sql .= " ON DELETE " . $c->{on_delete} if $c->{on_delete};
285 $fk_sql .= " ON UPDATE " . $c->{on_update} if $c->{on_update};
290 sub create_field { return _generator()->field($_[0]) }
294 my ($index, $options) = @_;
296 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
297 my $name = mk_name($index->name || "${index_table_name}_idx");
299 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
301 # strip any field size qualifiers as SQLite doesn't like these
302 my @fields = map { s/\(\d+\)$//; _generator()->quote($_) } $index->fields;
303 $index_table_name = _generator()->quote($index_table_name);
304 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
306 "CREATE ${type}INDEX $name ON " . $index_table_name .
307 ' (' . join( ', ', @fields ) . ')';
312 sub create_constraint
314 my ($c, $options) = @_;
316 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
317 my $name = mk_name($c->name || "${index_table_name}_idx");
318 my @fields = map _generator()->quote($_), $c->fields;
319 $index_table_name = _generator()->quote($index_table_name);
320 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
323 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
324 ' (' . join( ', ', @fields ) . ')';
330 my ($trigger, $options) = @_;
331 my $add_drop = $options->{add_drop_trigger};
335 my $trigger_name = $trigger->name;
336 $global_names{$trigger_name} = 1;
338 my $events = $trigger->database_events;
339 for my $evt ( @$events ) {
341 my $trig_name = $trigger_name;
343 $trig_name .= "_$evt";
345 warn "Multiple database events supplied for trigger '$trigger_name', ",
346 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
349 $trig_name = _generator()->quote($trig_name);
350 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
355 if (not ref $trigger->action) {
356 $action = $trigger->action;
357 $action = "BEGIN " . $action . " END"
358 unless $action =~ /^ \s* BEGIN [\s\;] .*? [\s\;] END [\s\;]* $/six;
361 $action = $trigger->action->{for_each} . " "
362 if $trigger->action->{for_each};
364 $action = $trigger->action->{when} . " "
365 if $trigger->action->{when};
367 my $steps = $trigger->action->{steps} || [];
370 $action .= $_ . "; " for (@$steps);
374 push @statements, sprintf (
375 'CREATE TRIGGER %s %s %s on %s %s',
377 $trigger->perform_action_when,
379 _generator()->quote($trigger->on_table),
387 sub alter_table { () } # Noop
392 return sprintf("ALTER TABLE %s ADD COLUMN %s",
393 _generator()->quote($field->table->name), create_field($field))
396 sub alter_create_index {
399 # This might cause name collisions
400 return create_index($index);
403 sub alter_create_constraint {
404 my ($constraint) = @_;
406 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
409 sub alter_drop_constraint { alter_drop_index(@_) }
411 sub alter_drop_index {
412 my ($constraint) = @_;
414 return sprintf("DROP INDEX %s",
415 _generator()->quote($constraint->name));
418 sub batch_alter_table {
419 my ($table, $diffs, $options) = @_;
421 # If we have any of the following
427 # we need to do the following <http://www.sqlite.org/faq.html#q11>
430 # CREATE TEMPORARY TABLE t1_backup(a,b);
431 # INSERT INTO t1_backup SELECT a,b FROM t1;
433 # CREATE TABLE t1(a,b);
434 # INSERT INTO t1 SELECT a,b FROM t1_backup;
435 # DROP TABLE t1_backup;
440 # If we have rename_field we do similarly.
442 # We create the temporary table as a copy of the new table, copy all data
443 # to temp table, create new table and then copy as appropriate taking note
446 my $table_name = $table->name;
448 if ( @{$diffs->{rename_field}} == 0 &&
449 @{$diffs->{alter_field}} == 0 &&
450 @{$diffs->{drop_field}} == 0
452 return batch_alter_table_statements($diffs, $options);
457 # $table is the new table but we may need an old one
458 # TODO: this is NOT very well tested at the moment so add more tests
460 my $old_table = $table;
462 if ( $diffs->{rename_table} && @{$diffs->{rename_table}} ) {
463 $old_table = $diffs->{rename_table}[0][0];
466 my $temp_table_name = $table_name . '_temp_alter';
468 # CREATE TEMPORARY TABLE t1_backup(a,b);
470 my %temp_table_fields;
472 local $table->{name} = $temp_table_name;
473 # We only want the table - don't care about indexes on tmp table
474 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
475 push @sql,$table_sql;
477 %temp_table_fields = map { $_ => 1} $table->get_fields;
480 # record renamed fields for later
481 my %rename_field = map { $_->[1]->name => $_->[0]->name } @{$diffs->{rename_field}};
483 # drop added fields from %temp_table_fields
484 delete @temp_table_fields{@{$diffs->{add_field}}};
486 # INSERT INTO t1_backup SELECT a,b FROM t1;
488 push @sql, sprintf( 'INSERT INTO %s( %s) SELECT %s FROM %s',
490 _generator()->quote( $temp_table_name ),
493 map _generator()->quote($_),
494 grep { $temp_table_fields{$_} } $table->get_fields ),
497 map _generator()->quote($_),
498 map { $rename_field{$_} ? $rename_field{$_} : $_ }
499 grep { $temp_table_fields{$_} } $table->get_fields ),
501 _generator()->quote( $old_table->name )
506 push @sql, sprintf('DROP TABLE %s', _generator()->quote($old_table->name));
508 # CREATE TABLE t1(a,b);
510 push @sql, create_table($table, { no_comments => 1 });
512 # INSERT INTO t1 SELECT a,b FROM t1_backup;
514 push @sql, sprintf('INSERT INTO %s SELECT %s FROM %s',
515 _generator()->quote($table_name),
516 join(', ', map _generator()->quote($_), $table->get_fields),
517 _generator()->quote($temp_table_name)
520 # DROP TABLE t1_backup;
522 push @sql, sprintf('DROP TABLE %s', _generator()->quote($temp_table_name));
524 return wantarray ? @sql : join(";\n", @sql);
529 $table = _generator()->quote($table);
530 return "DROP TABLE $table";
534 my ($old_table, $new_table, $options) = @_;
536 $old_table = _generator()->quote($old_table);
537 $new_table = _generator()->quote($new_table);
539 return "ALTER TABLE $old_table RENAME TO $new_table";
543 # No-op. Just here to signify that we are a new style parser.
544 sub preproces_schema { }
552 SQL::Translator, http://www.sqlite.org/.
556 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
558 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.