1 package SQL::Translator::Producer::SQLite;
3 # -------------------------------------------------------------------
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-2009 SQLFairy Authors
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator
31 my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
36 This module will produce text output of the schema suitable for SQLite.
43 use SQL::Translator::Schema::Constants;
44 use SQL::Translator::Utils qw(debug header_comment);
46 use vars qw[ $DEBUG $WARN ];
48 $DEBUG = 0 unless defined $DEBUG;
49 $WARN = 0 unless defined $WARN;
51 our %used_identifiers = ();
52 our $max_id_length = 30;
57 my $translator = shift;
58 local $DEBUG = $translator->debug;
59 local $WARN = $translator->show_warnings;
60 my $no_comments = $translator->no_comments;
61 my $add_drop_table = $translator->add_drop_table;
62 my $schema = $translator->schema;
63 my $producer_args = $translator->producer_args;
64 my $sqlite_version = $producer_args->{sqlite_version} || 0;
65 my $no_txn = $producer_args->{no_transaction};
67 debug("PKG: Beginning production\n");
70 push @create, header_comment unless ($no_comments);
71 $create[0] .= "\n\nBEGIN TRANSACTION" unless $no_txn;
73 for my $table ( $schema->get_tables ) {
74 push @create, create_table($table, { no_comments => $no_comments,
75 sqlite_version => $sqlite_version,
76 add_drop_table => $add_drop_table,});
79 for my $view ( $schema->get_views ) {
80 push @create, create_view($view, {
81 add_drop_view => $add_drop_table,
82 no_comments => $no_comments,
86 for my $trigger ( $schema->get_triggers ) {
87 push @create, create_trigger($trigger, {
88 add_drop_trigger => $add_drop_table,
89 no_comments => $no_comments,
94 push @create, "COMMIT" unless $no_txn;
97 push @create, "COMMIT;\n" unless $no_txn;
98 return join(";\n\n", @create );
102 # -------------------------------------------------------------------
104 my ($basename, $type, $scope, $critical) = @_;
105 my $basename_orig = $basename;
106 my $max_name = !$max_id_length
109 ? $max_id_length - (length($type) + 1)
111 $basename = substr( $basename, 0, $max_name )
112 if length( $basename ) > $max_name;
113 $basename =~ s/\./_/g;
114 my $name = $type ? "${type}_$basename" : $basename;
116 if ( $basename ne $basename_orig and $critical ) {
117 my $show_type = $type ? "+'$type'" : "";
118 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
119 "character limit to make '$name'\n" if $WARN;
120 $truncated{ $basename_orig } = $name;
123 $scope ||= \%global_names;
124 if ( my $prev = $scope->{ $name } ) {
125 my $name_orig = $name;
126 $name .= sprintf( "%02d", ++$prev );
127 substr($name, $max_id_length - 3) = "00"
128 if length( $name ) > $max_id_length;
130 warn "The name '$name_orig' has been changed to ",
131 "'$name' to make it unique.\n" if $WARN;
133 $scope->{ $name_orig }++;
141 my ($view, $options) = @_;
142 my $add_drop_view = $options->{add_drop_view};
144 my $view_name = $view->name;
145 debug("PKG: Looking at view '${view_name}'\n");
147 # Header. Should this look like what mysqldump produces?
148 my $extra = $view->extra;
150 $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
151 $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
153 $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
155 $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
156 $create .= " ${view_name}";
158 if( my $sql = $view->sql ){
159 $create .= " AS\n ${sql}";
167 my ($table, $options) = @_;
169 my $table_name = $table->name;
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.3) ? ' 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(', ', @pk_fields ) . ')';
229 my $idx_name_default = 'A';
230 for my $index ( $table->get_indices ) {
231 push @index_defs, create_index($index);
237 my $c_name_default = 'A';
238 for my $c ( $table->get_constraints ) {
239 next unless $c->type eq UNIQUE;
240 push @constraint_defs, create_constraint($c);
243 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
245 return (@create, $create_table, @index_defs, @constraint_defs );
250 my ($field, $options) = @_;
252 my $field_name = $field->name;
253 debug("PKG: Looking at field '$field_name'\n");
254 my $field_comments = $field->comments
255 ? "-- " . $field->comments . "\n "
258 my $field_def = $field_comments.$field_name;
261 my $size = $field->size;
262 my $data_type = $field->data_type;
263 $data_type = 'varchar' if lc $data_type eq 'set';
264 $data_type = 'blob' if lc $data_type eq 'bytea';
266 if ( lc $data_type =~ /(text|blob)/i ) {
270 # if ( $data_type =~ /timestamp/i ) {
271 # push @trigger_defs,
272 # "CREATE TRIGGER ts_${table_name} ".
273 # "after insert on $table_name\n".
275 # " update $table_name set $field_name=timestamp() ".
276 # "where id=new.id;\n".
283 # SQLite is generally typeless, but newer versions will
284 # make a field autoincrement if it is declared as (and
285 # *only* as) INTEGER PRIMARY KEY
287 my $pk = $field->table->primary_key;
288 my @pk_fields = $pk ? $pk->fields : ();
291 $field->is_primary_key &&
292 scalar @pk_fields == 1 &&
294 $data_type =~ /int(eger)?$/i
296 ( $data_type =~ /^number?$/i && $size !~ /,/ )
299 $data_type = 'INTEGER PRIMARY KEY';
304 $field_def .= sprintf " %s%s", $data_type,
305 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
308 $field_def .= ' NOT NULL' unless $field->is_nullable;
310 # Default? XXX Need better quoting!
311 my $default = $field->default_value;
312 if (defined $default) {
313 SQL::Translator::Producer->_apply_default_value(
319 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
330 my ($index, $options) = @_;
332 my $name = $index->name;
333 $name = mk_name($index->table->name, $name);
335 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
337 # strip any field size qualifiers as SQLite doesn't like these
338 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
339 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
340 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
342 "CREATE ${type}INDEX $name ON " . $index_table_name .
343 ' (' . join( ', ', @fields ) . ')';
348 sub create_constraint
350 my ($c, $options) = @_;
353 $name = mk_name($c->table->name, $name);
354 my @fields = $c->fields;
355 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
356 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
359 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
360 ' (' . join( ', ', @fields ) . ')';
366 my ($trigger, $options) = @_;
367 my $add_drop = $options->{add_drop_trigger};
369 my $name = $trigger->name;
372 push @create, "DROP TRIGGER IF EXISTS $name" if $add_drop;
374 my $events = $trigger->database_events;
375 die "Can't handle multiple events in triggers" if @$events > 1;
380 unless (ref $trigger->action) {
381 $action .= "BEGIN " . $trigger->action . " END";
383 $action = $trigger->action->{for_each} . " "
384 if $trigger->action->{for_each};
386 $action = $trigger->action->{when} . " "
387 if $trigger->action->{when};
389 my $steps = $trigger->action->{steps} || [];
398 push @create, "CREATE TRIGGER $name " .
399 $trigger->perform_action_when . " " .
401 " on " . $trigger->on_table . " " .
408 sub alter_table { } # Noop
413 return sprintf("ALTER TABLE %s ADD COLUMN %s",
414 $field->table->name, create_field($field))
417 sub alter_create_index {
420 # This might cause name collisions
421 return create_index($index);
424 sub alter_create_constraint {
425 my ($constraint) = @_;
427 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
430 sub alter_drop_constraint { alter_drop_index(@_) }
432 sub alter_drop_index {
433 my ($constraint) = @_;
435 return sprintf("DROP INDEX %s",
439 sub batch_alter_table {
440 my ($table, $diffs) = @_;
442 # If we have any of the following
448 # we need to do the following <http://www.sqlite.org/faq.html#q11>
451 # CREATE TEMPORARY TABLE t1_backup(a,b);
452 # INSERT INTO t1_backup SELECT a,b FROM t1;
454 # CREATE TABLE t1(a,b);
455 # INSERT INTO t1 SELECT a,b FROM t1_backup;
456 # DROP TABLE t1_backup;
461 # If we have rename_field we do similarly.
463 my $table_name = $table->name;
464 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
466 if ( @{$diffs->{rename_field}} == 0 &&
467 @{$diffs->{alter_field}} == 0 &&
468 @{$diffs->{drop_field}} == 0
470 # return join("\n", map {
472 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
473 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
475 } grep { @{$diffs->{$_}} }
477 alter_drop_constraint
484 alter_create_constraint
490 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
493 local $table->{name} = $table_name . '_temp_alter';
494 # We only want the table - dont care about indexes on tmp table
495 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
496 push @sql,$table_sql;
499 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
500 "DROP TABLE @{[$old_table]}",
501 create_table($table, { no_comments => 1 }),
502 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
503 "DROP TABLE @{[$table_name]}_temp_alter";
506 # return join("", @sql, "");
511 return "DROP TABLE $table";
515 my ($old_table, $new_table, $options) = @_;
517 my $qt = $options->{quote_table_names} || '';
519 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
523 # No-op. Just here to signify that we are a new style parser.
524 sub preproces_schema { }
532 SQL::Translator, http://www.sqlite.org/.
536 Ken Y. Clark C<< <kclark@cpan.orgE> >>.
538 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.