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);
44 use vars qw[ $VERSION $DEBUG $WARN ];
47 $DEBUG = 0 unless defined $DEBUG;
48 $WARN = 0 unless defined $WARN;
50 our $max_id_length = 30;
54 my $translator = shift;
55 local $DEBUG = $translator->debug;
56 local $WARN = $translator->show_warnings;
57 my $no_comments = $translator->no_comments;
58 my $add_drop_table = $translator->add_drop_table;
59 my $schema = $translator->schema;
60 my $producer_args = $translator->producer_args;
61 my $sqlite_version = $producer_args->{sqlite_version} || 0;
62 my $no_txn = $producer_args->{no_transaction};
64 debug("PKG: Beginning production\n");
66 %global_names = (); #reset
69 push @create, header_comment unless ($no_comments);
70 $create[0] .= "\n\nBEGIN TRANSACTION" unless $no_txn;
72 for my $table ( $schema->get_tables ) {
73 push @create, create_table($table, { no_comments => $no_comments,
74 sqlite_version => $sqlite_version,
75 add_drop_table => $add_drop_table,});
78 for my $view ( $schema->get_views ) {
79 push @create, create_view($view, {
80 add_drop_view => $add_drop_table,
81 no_comments => $no_comments,
85 for my $trigger ( $schema->get_triggers ) {
86 push @create, create_trigger($trigger, {
87 add_drop_trigger => $add_drop_table,
88 no_comments => $no_comments,
93 push @create, "COMMIT" unless $no_txn;
96 push @create, "COMMIT;\n" unless $no_txn;
97 return join(";\n\n", @create );
101 # -------------------------------------------------------------------
103 my ($name, $scope, $critical) = @_;
105 $scope ||= \%global_names;
106 if ( my $prev = $scope->{ $name } ) {
107 my $name_orig = $name;
108 $name .= sprintf( "%02d", ++$prev );
109 substr($name, $max_id_length - 3) = "00"
110 if length( $name ) > $max_id_length;
112 warn "The name '$name_orig' has been changed to ",
113 "'$name' to make it unique.\n" if $WARN;
115 $scope->{ $name_orig }++;
123 my ($view, $options) = @_;
124 my $add_drop_view = $options->{add_drop_view};
126 my $view_name = $view->name;
127 debug("PKG: Looking at view '${view_name}'\n");
129 # Header. Should this look like what mysqldump produces?
130 my $extra = $view->extra;
132 $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
133 $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
135 $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
137 $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
138 $create .= " ${view_name}";
140 if( my $sql = $view->sql ){
141 $create .= " AS\n ${sql}";
149 my ($table, $options) = @_;
151 my $table_name = $table->name;
152 my $no_comments = $options->{no_comments};
153 my $add_drop_table = $options->{add_drop_table};
154 my $sqlite_version = $options->{sqlite_version} || 0;
156 debug("PKG: Looking at table '$table_name'\n");
158 my ( @index_defs, @constraint_defs );
159 my @fields = $table->get_fields or die "No fields in $table_name";
161 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
165 my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
167 my ($comment, $create_table) = "";
168 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
169 if ($add_drop_table) {
170 push @create, $comment . qq[DROP TABLE$exists $table_name];
172 $create_table = $comment;
175 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
180 if ( $table->comments and !$no_comments ){
181 $create_table .= "-- Comments: \n-- ";
182 $create_table .= join "\n-- ", $table->comments;
183 $create_table .= "\n--\n\n";
187 # How many fields in PK?
189 my $pk = $table->primary_key;
190 my @pk_fields = $pk ? $pk->fields : ();
195 my ( @field_defs, $pk_set );
196 for my $field ( @fields ) {
197 push @field_defs, create_field($field);
201 scalar @pk_fields > 1
203 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
205 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
211 my $idx_name_default = 'A';
212 for my $index ( $table->get_indices ) {
213 push @index_defs, create_index($index);
219 my $c_name_default = 'A';
220 for my $c ( $table->get_constraints ) {
221 next unless $c->type eq UNIQUE;
222 push @constraint_defs, create_constraint($c);
225 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
227 return (@create, $create_table, @index_defs, @constraint_defs );
232 my ($field, $options) = @_;
234 my $field_name = $field->name;
235 debug("PKG: Looking at field '$field_name'\n");
236 my $field_comments = $field->comments
237 ? "-- " . $field->comments . "\n "
240 my $field_def = $field_comments.$field_name;
243 my $size = $field->size;
244 my $data_type = $field->data_type;
245 $data_type = 'varchar' if lc $data_type eq 'set';
246 $data_type = 'blob' if lc $data_type eq 'bytea';
248 if ( lc $data_type =~ /(text|blob)/i ) {
252 # if ( $data_type =~ /timestamp/i ) {
253 # push @trigger_defs,
254 # "CREATE TRIGGER ts_${table_name} ".
255 # "after insert on $table_name\n".
257 # " update $table_name set $field_name=timestamp() ".
258 # "where id=new.id;\n".
265 # SQLite is generally typeless, but newer versions will
266 # make a field autoincrement if it is declared as (and
267 # *only* as) INTEGER PRIMARY KEY
269 my $pk = $field->table->primary_key;
270 my @pk_fields = $pk ? $pk->fields : ();
273 $field->is_primary_key &&
274 scalar @pk_fields == 1 &&
276 $data_type =~ /int(eger)?$/i
278 ( $data_type =~ /^number?$/i && $size !~ /,/ )
281 $data_type = 'INTEGER PRIMARY KEY';
286 $field_def .= sprintf " %s%s", $data_type,
287 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
290 $field_def .= ' NOT NULL' unless $field->is_nullable;
292 # Default? XXX Need better quoting!
293 my $default = $field->default_value;
294 if (defined $default) {
295 SQL::Translator::Producer->_apply_default_value(
301 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
312 my ($index, $options) = @_;
314 my $name = $index->name;
315 $name = mk_name($name);
317 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
319 # strip any field size qualifiers as SQLite doesn't like these
320 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
321 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
322 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
324 "CREATE ${type}INDEX $name ON " . $index_table_name .
325 ' (' . join( ', ', @fields ) . ')';
330 sub create_constraint
332 my ($c, $options) = @_;
335 $name = mk_name($name);
336 my @fields = $c->fields;
337 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
338 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
341 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
342 ' (' . join( ', ', @fields ) . ')';
348 my ($trigger, $options) = @_;
349 my $add_drop = $options->{add_drop_trigger};
353 my $trigger_name = $trigger->name;
354 my $events = $trigger->database_events;
355 for my $evt ( @$events ) {
357 my $trig_name = $trigger_name;
359 $trig_name .= "_$evt";
361 warn "Multiple database events supplied for trigger '$trigger_name', ",
362 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
365 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
370 if (not ref $trigger->action) {
371 $action .= "BEGIN " . $trigger->action . " END";
374 $action = $trigger->action->{for_each} . " "
375 if $trigger->action->{for_each};
377 $action = $trigger->action->{when} . " "
378 if $trigger->action->{when};
380 my $steps = $trigger->action->{steps} || [];
383 $action .= $_ . "; " for (@$steps);
387 push @statements, sprintf (
388 'CREATE TRIGGER %s %s %s on %s %s',
390 $trigger->perform_action_when,
400 sub alter_table { } # Noop
405 return sprintf("ALTER TABLE %s ADD COLUMN %s",
406 $field->table->name, create_field($field))
409 sub alter_create_index {
412 # This might cause name collisions
413 return create_index($index);
416 sub alter_create_constraint {
417 my ($constraint) = @_;
419 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
422 sub alter_drop_constraint { alter_drop_index(@_) }
424 sub alter_drop_index {
425 my ($constraint) = @_;
427 return sprintf("DROP INDEX %s",
431 sub batch_alter_table {
432 my ($table, $diffs) = @_;
434 # If we have any of the following
440 # we need to do the following <http://www.sqlite.org/faq.html#q11>
443 # CREATE TEMPORARY TABLE t1_backup(a,b);
444 # INSERT INTO t1_backup SELECT a,b FROM t1;
446 # CREATE TABLE t1(a,b);
447 # INSERT INTO t1 SELECT a,b FROM t1_backup;
448 # DROP TABLE t1_backup;
453 # If we have rename_field we do similarly.
455 my $table_name = $table->name;
456 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
458 if ( @{$diffs->{rename_field}} == 0 &&
459 @{$diffs->{alter_field}} == 0 &&
460 @{$diffs->{drop_field}} == 0
462 # return join("\n", map {
464 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
465 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
467 } grep { @{$diffs->{$_}} }
469 alter_drop_constraint
476 alter_create_constraint
482 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
485 local $table->{name} = $table_name . '_temp_alter';
486 # We only want the table - dont care about indexes on tmp table
487 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
488 push @sql,$table_sql;
491 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
492 "DROP TABLE @{[$old_table]}",
493 create_table($table, { no_comments => 1 }),
494 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
495 "DROP TABLE @{[$table_name]}_temp_alter";
498 # return join("", @sql, "");
503 return "DROP TABLE $table";
507 my ($old_table, $new_table, $options) = @_;
509 my $qt = $options->{quote_table_names} || '';
511 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
515 # No-op. Just here to signify that we are a new style parser.
516 sub preproces_schema { }
524 SQL::Translator, http://www.sqlite.org/.
528 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
530 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.