1 package SQL::Translator::Producer::SQLite;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
23 SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator
29 my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
34 This module will produce text output of the schema suitable for SQLite.
41 use SQL::Translator::Schema::Constants;
42 use SQL::Translator::Utils qw(debug header_comment);
45 use vars qw[ $VERSION $DEBUG $WARN ];
48 $DEBUG = 0 if !defined $DEBUG;
49 $WARN = 0 if !defined $WARN;
51 Readonly my $MAX_ID_LENGTH => 30;
55 my $translator = shift;
56 local $DEBUG = $translator->debug;
57 local $WARN = $translator->show_warnings;
58 my $no_comments = $translator->no_comments;
59 my $add_drop_table = $translator->add_drop_table;
60 my $schema = $translator->schema;
61 my $producer_args = $translator->producer_args;
62 my $sqlite_version = $producer_args->{sqlite_version} || 0;
63 my $no_txn = $producer_args->{no_transaction};
65 debug("PKG: Beginning production\n");
67 %global_names = (); #reset
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 ($name, $scope, $critical) = @_;
106 $scope ||= \%global_names;
107 if ( my $prev = $scope->{ $name } ) {
108 my $name_orig = $name;
109 $name .= sprintf( "%02d", ++$prev );
110 substr($name, $MAX_ID_LENGTH - 3) = "00"
111 if length( $name ) > $MAX_ID_LENGTH;
113 warn "The name '$name_orig' has been changed to ",
114 "'$name' to make it unique.\n" if $WARN;
116 $scope->{ $name_orig }++;
124 my ($view, $options) = @_;
125 my $add_drop_view = $options->{add_drop_view};
127 my $view_name = $view->name;
128 debug("PKG: Looking at view '${view_name}'\n");
130 # Header. Should this look like what mysqldump produces?
131 my $extra = $view->extra;
133 $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
134 $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
136 $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
138 $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
139 $create .= " ${view_name}";
141 if( my $sql = $view->sql ){
142 $create .= " AS\n ${sql}";
150 my ($table, $options) = @_;
152 my $table_name = $table->name;
153 my $no_comments = $options->{no_comments};
154 my $add_drop_table = $options->{add_drop_table};
155 my $sqlite_version = $options->{sqlite_version} || 0;
157 debug("PKG: Looking at table '$table_name'\n");
159 my ( @index_defs, @constraint_defs );
160 my @fields = $table->get_fields or die "No fields in $table_name";
162 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
166 my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
168 my ($comment, $create_table) = "";
169 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
170 if ($add_drop_table) {
171 push @create, $comment . qq[DROP TABLE$exists $table_name];
173 $create_table = $comment;
176 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
181 if ( $table->comments and !$no_comments ){
182 $create_table .= "-- Comments: \n-- ";
183 $create_table .= join "\n-- ", $table->comments;
184 $create_table .= "\n--\n\n";
188 # How many fields in PK?
190 my $pk = $table->primary_key;
191 my @pk_fields = $pk ? $pk->fields : ();
196 my ( @field_defs, $pk_set );
197 for my $field ( @fields ) {
198 push @field_defs, create_field($field);
202 scalar @pk_fields > 1
204 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
206 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
212 my $idx_name_default = 'A';
213 for my $index ( $table->get_indices ) {
214 push @index_defs, create_index($index);
220 my $c_name_default = 'A';
221 for my $c ( $table->get_constraints ) {
222 next unless $c->type eq UNIQUE;
223 push @constraint_defs, create_constraint($c);
226 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
228 return (@create, $create_table, @index_defs, @constraint_defs );
233 my ($field, $options) = @_;
235 my $field_name = $field->name;
236 debug("PKG: Looking at field '$field_name'\n");
237 my $field_comments = $field->comments
238 ? "-- " . $field->comments . "\n "
241 my $field_def = $field_comments.$field_name;
244 my $size = $field->size;
245 my $data_type = $field->data_type;
246 $data_type = 'varchar' if lc $data_type eq 'set';
247 $data_type = 'blob' if lc $data_type eq 'bytea';
249 if ( lc $data_type =~ /(text|blob)/i ) {
253 # if ( $data_type =~ /timestamp/i ) {
254 # push @trigger_defs,
255 # "CREATE TRIGGER ts_${table_name} ".
256 # "after insert on $table_name\n".
258 # " update $table_name set $field_name=timestamp() ".
259 # "where id=new.id;\n".
266 # SQLite is generally typeless, but newer versions will
267 # make a field autoincrement if it is declared as (and
268 # *only* as) INTEGER PRIMARY KEY
270 my $pk = $field->table->primary_key;
271 my @pk_fields = $pk ? $pk->fields : ();
274 $field->is_primary_key &&
275 scalar @pk_fields == 1 &&
277 $data_type =~ /int(eger)?$/i
279 ( $data_type =~ /^number?$/i && $size !~ /,/ )
282 $data_type = 'INTEGER PRIMARY KEY';
287 $field_def .= sprintf " %s%s", $data_type,
288 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
291 $field_def .= ' NOT NULL' unless $field->is_nullable;
293 # Default? XXX Need better quoting!
294 my $default = $field->default_value;
295 if (defined $default) {
296 SQL::Translator::Producer->_apply_default_value(
302 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
313 my ($index, $options) = @_;
315 my $name = $index->name;
316 $name = mk_name($name);
318 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
320 # strip any field size qualifiers as SQLite doesn't like these
321 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
322 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
323 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
325 "CREATE ${type}INDEX $name ON " . $index_table_name .
326 ' (' . join( ', ', @fields ) . ')';
331 sub create_constraint
333 my ($c, $options) = @_;
336 $name = mk_name($name);
337 my @fields = $c->fields;
338 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
339 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
342 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
343 ' (' . join( ', ', @fields ) . ')';
349 my ($trigger, $options) = @_;
350 my $add_drop = $options->{add_drop_trigger};
354 my $trigger_name = $trigger->name;
355 my $events = $trigger->database_events;
356 for my $evt ( @$events ) {
358 my $trig_name = $trigger_name;
360 $trig_name .= "_$evt";
362 warn "Multiple database events supplied for trigger '$trigger_name', ",
363 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
366 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
371 if (not ref $trigger->action) {
372 $action .= "BEGIN " . $trigger->action . " END";
375 $action = $trigger->action->{for_each} . " "
376 if $trigger->action->{for_each};
378 $action = $trigger->action->{when} . " "
379 if $trigger->action->{when};
381 my $steps = $trigger->action->{steps} || [];
384 $action .= $_ . "; " for (@$steps);
388 push @statements, sprintf (
389 'CREATE TRIGGER %s %s %s on %s %s',
391 $trigger->perform_action_when,
401 sub alter_table { } # Noop
406 return sprintf("ALTER TABLE %s ADD COLUMN %s",
407 $field->table->name, create_field($field))
410 sub alter_create_index {
413 # This might cause name collisions
414 return create_index($index);
417 sub alter_create_constraint {
418 my ($constraint) = @_;
420 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
423 sub alter_drop_constraint { alter_drop_index(@_) }
425 sub alter_drop_index {
426 my ($constraint) = @_;
428 return sprintf("DROP INDEX %s",
432 sub batch_alter_table {
433 my ($table, $diffs) = @_;
435 # If we have any of the following
441 # we need to do the following <http://www.sqlite.org/faq.html#q11>
444 # CREATE TEMPORARY TABLE t1_backup(a,b);
445 # INSERT INTO t1_backup SELECT a,b FROM t1;
447 # CREATE TABLE t1(a,b);
448 # INSERT INTO t1 SELECT a,b FROM t1_backup;
449 # DROP TABLE t1_backup;
454 # If we have rename_field we do similarly.
456 my $table_name = $table->name;
457 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
459 if ( @{$diffs->{rename_field}} == 0 &&
460 @{$diffs->{alter_field}} == 0 &&
461 @{$diffs->{drop_field}} == 0
463 # return join("\n", map {
465 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
466 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
468 } grep { @{$diffs->{$_}} }
470 alter_drop_constraint
477 alter_create_constraint
483 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
486 local $table->{name} = $table_name . '_temp_alter';
487 # We only want the table - dont care about indexes on tmp table
488 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
489 push @sql,$table_sql;
492 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
493 "DROP TABLE @{[$old_table]}",
494 create_table($table, { no_comments => 1 }),
495 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
496 "DROP TABLE @{[$table_name]}_temp_alter";
499 # return join("", @sql, "");
504 return "DROP TABLE $table";
508 my ($old_table, $new_table, $options) = @_;
510 my $qt = $options->{quote_table_names} || '';
512 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
516 # No-op. Just here to signify that we are a new style parser.
517 sub preproces_schema { }
525 SQL::Translator, http://www.sqlite.org/.
529 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.
531 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.