1 package SQL::Translator::Producer::SQLite;
3 # -------------------------------------------------------------------
4 # $Id: SQLite.pm,v 1.15 2006-08-26 11:35:31 schiffbruechige Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2002-4 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.
42 use SQL::Translator::Schema::Constants;
43 use SQL::Translator::Utils qw(debug header_comment);
45 use vars qw[ $VERSION $DEBUG $WARN ];
47 $VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
48 $DEBUG = 0 unless defined $DEBUG;
49 $WARN = 0 unless defined $WARN;
51 my %used_identifiers = ();
52 my $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;
64 debug("PKG: Beginning production\n");
67 $create .= header_comment unless ($no_comments);
68 $create .= "BEGIN TRANSACTION;\n\n";
71 for my $table ( $schema->get_tables ) {
72 my @defs = create_table($table, { no_comments => $no_comments,
73 add_drop_table => $add_drop_table,});
74 my $create = shift @defs;
76 push @table_defs, $create, map( { "$_;" } @defs), "";
79 for my $view ( $schema->get_views ) {
80 push @table_defs, create_view($view, {no_comments => $no_comments,});
83 # $create .= "COMMIT;\n";
85 return wantarray ? ($create, @table_defs, "COMMIT;\n") : join("\n", ($create, @table_defs, "COMMIT;\n"));
88 # -------------------------------------------------------------------
90 my ($basename, $type, $scope, $critical) = @_;
91 my $basename_orig = $basename;
93 ? $max_id_length - (length($type) + 1)
95 $basename = substr( $basename, 0, $max_name )
96 if length( $basename ) > $max_name;
97 $basename =~ s/\./_/g;
98 my $name = $type ? "${type}_$basename" : $basename;
100 if ( $basename ne $basename_orig and $critical ) {
101 my $show_type = $type ? "+'$type'" : "";
102 warn "Truncating '$basename_orig'$show_type to $max_id_length ",
103 "character limit to make '$name'\n" if $WARN;
104 $truncated{ $basename_orig } = $name;
107 $scope ||= \%global_names;
108 if ( my $prev = $scope->{ $name } ) {
109 my $name_orig = $name;
110 $name .= sprintf( "%02d", ++$prev );
111 substr($name, $max_id_length - 3) = "00"
112 if length( $name ) > $max_id_length;
114 warn "The name '$name_orig' has been changed to ",
115 "'$name' to make it unique.\n" if $WARN;
117 $scope->{ $name_orig }++;
125 my ($view, $options) = @_;
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};
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}\n )";
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};
156 debug("PKG: Looking at table '$table_name'\n");
158 my ( @index_defs, @constraint_defs, @trigger_defs );
159 my @fields = $table->get_fields or die "No fields in $table_name";
161 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
166 $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
167 $create .= qq[DROP TABLE $table_name;\n] if $add_drop_table;
168 $create .= "CREATE ${temp}TABLE $table_name (\n";
173 if ( $table->comments and !$no_comments ){
174 $create .= "-- Comments: \n-- ";
175 $create .= join "\n-- ", $table->comments;
176 $create .= "\n--\n\n";
180 # How many fields in PK?
182 my $pk = $table->primary_key;
183 my @pk_fields = $pk ? $pk->fields : ();
188 my ( @field_defs, $pk_set );
189 for my $field ( @fields ) {
190 push @field_defs, create_field($field);
194 scalar @pk_fields > 1
196 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
198 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
204 my $idx_name_default = 'A';
205 for my $index ( $table->get_indices ) {
206 push @index_defs, create_index($index);
212 my $c_name_default = 'A';
213 for my $c ( $table->get_constraints ) {
214 next unless $c->type eq UNIQUE;
215 push @constraint_defs, create_constraint($c);
218 $create .= join(",\n", map { " $_" } @field_defs ) . "\n)";
220 return ($create, @index_defs, @constraint_defs, @trigger_defs );
225 my ($field, $options) = @_;
227 my $field_name = $field->name;
228 debug("PKG: Looking at field '$field_name'\n");
229 my $field_comments = $field->comments
230 ? "-- " . $field->comments . "\n "
233 my $field_def = $field_comments.$field_name;
236 my $size = $field->size;
237 my $data_type = $field->data_type;
238 $data_type = 'varchar' if lc $data_type eq 'set';
239 $data_type = 'blob' if lc $data_type eq 'bytea';
241 if ( lc $data_type =~ /(text|blob)/i ) {
245 # if ( $data_type =~ /timestamp/i ) {
246 # push @trigger_defs,
247 # "CREATE TRIGGER ts_${table_name} ".
248 # "after insert on $table_name\n".
250 # " update $table_name set $field_name=timestamp() ".
251 # "where id=new.id;\n".
258 # SQLite is generally typeless, but newer versions will
259 # make a field autoincrement if it is declared as (and
260 # *only* as) INTEGER PRIMARY KEY
262 my $pk = $field->table->primary_key;
263 my @pk_fields = $pk ? $pk->fields : ();
266 $field->is_primary_key &&
267 scalar @pk_fields == 1 &&
269 $data_type =~ /int(eger)?$/i
271 ( $data_type =~ /^number?$/i && $size !~ /,/ )
274 $data_type = 'INTEGER PRIMARY KEY';
279 $field_def .= sprintf " %s%s", $data_type,
280 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
283 $field_def .= ' NOT NULL' unless $field->is_nullable;
285 # Default? XXX Need better quoting!
286 my $default = $field->default_value;
287 if ( defined $default ) {
288 if ( uc $default eq 'NULL') {
289 $field_def .= ' DEFAULT NULL';
290 } elsif ( $default eq 'now()' ||
291 $default eq 'CURRENT_TIMESTAMP' ) {
292 $field_def .= ' DEFAULT CURRENT_TIMESTAMP';
293 } elsif ( $default =~ /val\(/ ) {
296 $field_def .= " DEFAULT '$default'";
306 my ($index, $options) = @_;
308 my $name = $index->name;
309 $name = mk_name($index->table->name, $name);
311 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
313 # strip any field size qualifiers as SQLite doesn't like these
314 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
315 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
316 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
318 "CREATE ${type}INDEX $name ON " . $index_table_name .
319 ' (' . join( ', ', @fields ) . ')';
324 sub create_constraint
326 my ($c, $options) = @_;
329 $name = mk_name($c->table->name, $name);
330 my @fields = $c->fields;
331 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
332 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
335 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
336 ' (' . join( ', ', @fields ) . ')';
341 sub alter_table { } # Noop
346 return sprintf("ALTER TABLE %s ADD COLUMN %s",
347 $field->table->name, create_field($field))
350 sub alter_create_index {
353 # This might cause name collisions
354 return create_index($index);
357 sub alter_create_constraint {
358 my ($constraint) = @_;
360 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
363 sub alter_drop_constraint { alter_drop_index(@_) }
365 sub alter_drop_index {
366 my ($constraint) = @_;
368 return sprintf("DROP INDEX %s",
372 sub batch_alter_table {
373 my ($table, $diffs) = @_;
375 # If we have any of the following
381 # we need to do the following <http://www.sqlite.org/faq.html#q11>
384 # CREATE TEMPORARY TABLE t1_backup(a,b);
385 # INSERT INTO t1_backup SELECT a,b FROM t1;
387 # CREATE TABLE t1(a,b);
388 # INSERT INTO t1 SELECT a,b FROM t1_backup;
389 # DROP TABLE t1_backup;
394 # If we have rename_field we do similarly.
396 my $table_name = $table->name;
397 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
399 if ( @{$diffs->{rename_field}} == 0 &&
400 @{$diffs->{alter_field}} == 0 &&
401 @{$diffs->{drop_field}} == 0
403 return join("\n", map {
404 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
405 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql;") : () } @{ $diffs->{$_} }
407 } grep { @{$diffs->{$_}} }
409 alter_drop_constraint
416 alter_create_constraint
422 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
425 local $table->{name} = $table_name . '_temp_alter';
426 # We only want the table - dont care about indexes on tmp table
427 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
428 push @sql,$table_sql;
431 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
432 "DROP TABLE @{[$old_table]}",
433 create_table($table, { no_comments => 1 }),
434 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
435 "DROP TABLE @{[$table_name]}_temp_alter";
437 return join(";\n", @sql, "");
442 return "DROP TABLE $table;";
446 my ($old_table, $new_table, $options) = @_;
448 my $qt = $options->{quote_table_names} || '';
450 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
454 # No-op. Just here to signify that we are a new style parser.
455 sub preproces_schema { }
463 SQL::Translator, http://www.sqlite.org/.
467 Ken Y. Clark C<< <kclark@cpan.orgE> >>.
469 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.