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[ $VERSION $DEBUG $WARN ];
49 $DEBUG = 0 unless defined $DEBUG;
50 $WARN = 0 unless defined $WARN;
52 our %used_identifiers = ();
53 our $max_id_length = 30;
58 my $translator = shift;
59 local $DEBUG = $translator->debug;
60 local $WARN = $translator->show_warnings;
61 my $no_comments = $translator->no_comments;
62 my $add_drop_table = $translator->add_drop_table;
63 my $schema = $translator->schema;
64 my $producer_args = $translator->producer_args;
65 my $sqlite_version = $producer_args->{sqlite_version} || 0;
66 my $no_txn = $producer_args->{no_transaction};
68 debug("PKG: Beginning production\n");
71 push @create, header_comment unless ($no_comments);
72 $create[0] .= "\n\nBEGIN TRANSACTION" unless $no_txn;
74 for my $table ( $schema->get_tables ) {
75 push @create, create_table($table, { no_comments => $no_comments,
76 sqlite_version => $sqlite_version,
77 add_drop_table => $add_drop_table,});
80 for my $view ( $schema->get_views ) {
81 push @create, create_view($view, {
82 add_drop_view => $add_drop_table,
83 no_comments => $no_comments,
87 for my $trigger ( $schema->get_triggers ) {
88 push @create, create_trigger($trigger, {
89 add_drop_trigger => $add_drop_table,
90 no_comments => $no_comments,
95 push @create, "COMMIT" unless $no_txn;
98 push @create, "COMMIT;\n" unless $no_txn;
99 return join(";\n\n", @create );
103 # -------------------------------------------------------------------
105 my ($basename, $type, $scope, $critical) = @_;
106 my $basename_orig = $basename;
107 my $max_name = !$max_id_length
110 ? $max_id_length - (length($type) + 1)
112 $basename = substr( $basename, 0, $max_name )
113 if length( $basename ) > $max_name;
114 $basename =~ s/\./_/g;
115 my $name = $type ? "${type}_$basename" : $basename;
117 if ( $basename ne $basename_orig and $critical ) {
118 my $show_type = $type ? "+'$type'" : "";
119 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
120 "character limit to make '$name'\n" if $WARN;
121 $truncated{ $basename_orig } = $name;
124 $scope ||= \%global_names;
125 if ( my $prev = $scope->{ $name } ) {
126 my $name_orig = $name;
127 $name .= sprintf( "%02d", ++$prev );
128 substr($name, $max_id_length - 3) = "00"
129 if length( $name ) > $max_id_length;
131 warn "The name '$name_orig' has been changed to ",
132 "'$name' to make it unique.\n" if $WARN;
134 $scope->{ $name_orig }++;
142 my ($view, $options) = @_;
143 my $add_drop_view = $options->{add_drop_view};
145 my $view_name = $view->name;
146 debug("PKG: Looking at view '${view_name}'\n");
148 # Header. Should this look like what mysqldump produces?
149 my $extra = $view->extra;
151 $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
152 $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
154 $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
156 $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
157 $create .= " ${view_name}";
159 if( my $sql = $view->sql ){
160 $create .= " AS\n ${sql}";
168 my ($table, $options) = @_;
170 my $table_name = $table->name;
171 my $no_comments = $options->{no_comments};
172 my $add_drop_table = $options->{add_drop_table};
173 my $sqlite_version = $options->{sqlite_version} || 0;
175 debug("PKG: Looking at table '$table_name'\n");
177 my ( @index_defs, @constraint_defs );
178 my @fields = $table->get_fields or die "No fields in $table_name";
180 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
184 my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
186 my ($comment, $create_table) = "";
187 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
188 if ($add_drop_table) {
189 push @create, $comment . qq[DROP TABLE$exists $table_name];
191 $create_table = $comment;
194 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
199 if ( $table->comments and !$no_comments ){
200 $create_table .= "-- Comments: \n-- ";
201 $create_table .= join "\n-- ", $table->comments;
202 $create_table .= "\n--\n\n";
206 # How many fields in PK?
208 my $pk = $table->primary_key;
209 my @pk_fields = $pk ? $pk->fields : ();
214 my ( @field_defs, $pk_set );
215 for my $field ( @fields ) {
216 push @field_defs, create_field($field);
220 scalar @pk_fields > 1
222 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
224 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
230 my $idx_name_default = 'A';
231 for my $index ( $table->get_indices ) {
232 push @index_defs, create_index($index);
238 my $c_name_default = 'A';
239 for my $c ( $table->get_constraints ) {
240 next unless $c->type eq UNIQUE;
241 push @constraint_defs, create_constraint($c);
244 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
246 return (@create, $create_table, @index_defs, @constraint_defs );
251 my ($field, $options) = @_;
253 my $field_name = $field->name;
254 debug("PKG: Looking at field '$field_name'\n");
255 my $field_comments = $field->comments
256 ? "-- " . $field->comments . "\n "
259 my $field_def = $field_comments.$field_name;
262 my $size = $field->size;
263 my $data_type = $field->data_type;
264 $data_type = 'varchar' if lc $data_type eq 'set';
265 $data_type = 'blob' if lc $data_type eq 'bytea';
267 if ( lc $data_type =~ /(text|blob)/i ) {
271 # if ( $data_type =~ /timestamp/i ) {
272 # push @trigger_defs,
273 # "CREATE TRIGGER ts_${table_name} ".
274 # "after insert on $table_name\n".
276 # " update $table_name set $field_name=timestamp() ".
277 # "where id=new.id;\n".
284 # SQLite is generally typeless, but newer versions will
285 # make a field autoincrement if it is declared as (and
286 # *only* as) INTEGER PRIMARY KEY
288 my $pk = $field->table->primary_key;
289 my @pk_fields = $pk ? $pk->fields : ();
292 $field->is_primary_key &&
293 scalar @pk_fields == 1 &&
295 $data_type =~ /int(eger)?$/i
297 ( $data_type =~ /^number?$/i && $size !~ /,/ )
300 $data_type = 'INTEGER PRIMARY KEY';
305 $field_def .= sprintf " %s%s", $data_type,
306 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
309 $field_def .= ' NOT NULL' unless $field->is_nullable;
311 # Default? XXX Need better quoting!
312 my $default = $field->default_value;
313 if (defined $default) {
314 SQL::Translator::Producer->_apply_default_value(
320 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
331 my ($index, $options) = @_;
333 my $name = $index->name;
334 $name = mk_name($index->table->name, $name);
336 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
338 # strip any field size qualifiers as SQLite doesn't like these
339 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
340 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
341 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
343 "CREATE ${type}INDEX $name ON " . $index_table_name .
344 ' (' . join( ', ', @fields ) . ')';
349 sub create_constraint
351 my ($c, $options) = @_;
354 $name = mk_name($c->table->name, $name);
355 my @fields = $c->fields;
356 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
357 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
360 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
361 ' (' . join( ', ', @fields ) . ')';
367 my ($trigger, $options) = @_;
368 my $add_drop = $options->{add_drop_trigger};
370 my $name = $trigger->name;
373 push @create, "DROP TRIGGER IF EXISTS $name" if $add_drop;
375 my $events = $trigger->database_events;
376 die "Can't handle multiple events in triggers" if @$events > 1;
381 unless (ref $trigger->action) {
382 $action .= "BEGIN " . $trigger->action . " END";
384 $action = $trigger->action->{for_each} . " "
385 if $trigger->action->{for_each};
387 $action = $trigger->action->{when} . " "
388 if $trigger->action->{when};
390 my $steps = $trigger->action->{steps} || [];
399 push @create, "CREATE TRIGGER $name " .
400 $trigger->perform_action_when . " " .
402 " on " . $trigger->on_table . " " .
409 sub alter_table { } # Noop
414 return sprintf("ALTER TABLE %s ADD COLUMN %s",
415 $field->table->name, create_field($field))
418 sub alter_create_index {
421 # This might cause name collisions
422 return create_index($index);
425 sub alter_create_constraint {
426 my ($constraint) = @_;
428 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
431 sub alter_drop_constraint { alter_drop_index(@_) }
433 sub alter_drop_index {
434 my ($constraint) = @_;
436 return sprintf("DROP INDEX %s",
440 sub batch_alter_table {
441 my ($table, $diffs) = @_;
443 # If we have any of the following
449 # we need to do the following <http://www.sqlite.org/faq.html#q11>
452 # CREATE TEMPORARY TABLE t1_backup(a,b);
453 # INSERT INTO t1_backup SELECT a,b FROM t1;
455 # CREATE TABLE t1(a,b);
456 # INSERT INTO t1 SELECT a,b FROM t1_backup;
457 # DROP TABLE t1_backup;
462 # If we have rename_field we do similarly.
464 my $table_name = $table->name;
465 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
467 if ( @{$diffs->{rename_field}} == 0 &&
468 @{$diffs->{alter_field}} == 0 &&
469 @{$diffs->{drop_field}} == 0
471 # return join("\n", map {
473 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
474 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
476 } grep { @{$diffs->{$_}} }
478 alter_drop_constraint
485 alter_create_constraint
491 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
494 local $table->{name} = $table_name . '_temp_alter';
495 # We only want the table - dont care about indexes on tmp table
496 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
497 push @sql,$table_sql;
500 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
501 "DROP TABLE @{[$old_table]}",
502 create_table($table, { no_comments => 1 }),
503 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
504 "DROP TABLE @{[$table_name]}_temp_alter";
507 # return join("", @sql, "");
512 return "DROP TABLE $table";
516 my ($old_table, $new_table, $options) = @_;
518 my $qt = $options->{quote_table_names} || '';
520 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
524 # No-op. Just here to signify that we are a new style parser.
525 sub preproces_schema { }
533 SQL::Translator, http://www.sqlite.org/.
537 Ken Y. Clark C<< <kclark@cpan.orgE> >>.
539 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.