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 parse_dbms_version);
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 = parse_dbms_version(
62 $producer_args->{sqlite_version}, 'perl'
64 my $no_txn = $producer_args->{no_transaction};
66 debug("PKG: Beginning production\n");
68 %global_names = (); #reset
71 my $head = (header_comment() . "\n") unless $no_comments;
75 push @create, "BEGIN TRANSACTION" unless $no_txn;
77 for my $table ( $schema->get_tables ) {
78 push @create, create_table($table, { no_comments => $no_comments,
79 sqlite_version => $sqlite_version,
80 add_drop_table => $add_drop_table,});
83 for my $view ( $schema->get_views ) {
84 push @create, create_view($view, {
85 add_drop_view => $add_drop_table,
86 no_comments => $no_comments,
90 for my $trigger ( $schema->get_triggers ) {
91 push @create, create_trigger($trigger, {
92 add_drop_trigger => $add_drop_table,
93 no_comments => $no_comments,
97 push @create, "COMMIT" unless $no_txn;
100 return ($head||(), @create);
104 join(";\n\n", @create ),
110 # -------------------------------------------------------------------
112 my ($name, $scope, $critical) = @_;
114 $scope ||= \%global_names;
115 if ( my $prev = $scope->{ $name } ) {
116 my $name_orig = $name;
117 $name .= sprintf( "%02d", ++$prev );
118 substr($name, $max_id_length - 3) = "00"
119 if length( $name ) > $max_id_length;
121 warn "The name '$name_orig' has been changed to ",
122 "'$name' to make it unique.\n" if $WARN;
124 $scope->{ $name_orig }++;
132 my ($view, $options) = @_;
133 my $add_drop_view = $options->{add_drop_view};
135 my $view_name = $view->name;
136 $global_names{$view_name} = 1;
138 debug("PKG: Looking at view '${view_name}'\n");
140 # Header. Should this look like what mysqldump produces?
141 my $extra = $view->extra;
143 push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view;
145 my $create_view = 'CREATE';
146 $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
147 $create_view .= ' VIEW';
148 $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
149 $create_view .= " ${view_name}";
151 if( my $sql = $view->sql ){
152 $create_view .= " AS\n ${sql}";
154 push @create, $create_view;
156 # Tack the comment onto the first statement.
157 unless ($options->{no_comments}) {
158 $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0];
167 my ($table, $options) = @_;
169 my $table_name = $table->name;
170 $global_names{$table_name} = 1;
172 my $no_comments = $options->{no_comments};
173 my $add_drop_table = $options->{add_drop_table};
174 my $sqlite_version = $options->{sqlite_version} || 0;
176 debug("PKG: Looking at table '$table_name'\n");
178 my ( @index_defs, @constraint_defs );
179 my @fields = $table->get_fields or die "No fields in $table_name";
181 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
185 my $exists = ($sqlite_version >= 3.003) ? ' IF EXISTS' : '';
187 my ($comment, $create_table) = "";
188 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
189 if ($add_drop_table) {
190 push @create, $comment . qq[DROP TABLE$exists $table_name];
192 $create_table = $comment;
195 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
200 if ( $table->comments and !$no_comments ){
201 $create_table .= "-- Comments: \n-- ";
202 $create_table .= join "\n-- ", $table->comments;
203 $create_table .= "\n--\n\n";
207 # How many fields in PK?
209 my $pk = $table->primary_key;
210 my @pk_fields = $pk ? $pk->fields : ();
215 my ( @field_defs, $pk_set );
216 for my $field ( @fields ) {
217 push @field_defs, create_field($field);
221 scalar @pk_fields > 1
223 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
225 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
231 my $idx_name_default = 'A';
232 for my $index ( $table->get_indices ) {
233 push @index_defs, create_index($index);
239 my $c_name_default = 'A';
240 for my $c ( $table->get_constraints ) {
241 if ($c->type eq "FOREIGN KEY") {
242 push @field_defs, create_foreignkey($c);
244 next unless $c->type eq UNIQUE;
245 push @constraint_defs, create_constraint($c);
248 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
250 return (@create, $create_table, @index_defs, @constraint_defs );
253 sub create_foreignkey {
256 my $fk_sql = "FOREIGN KEY($c->{fields}[0]) REFERENCES ";
257 $fk_sql .= ( $c->{reference_table} || '' )."(".( $c->{reference_fields}[0] || '' ).")";
264 my ($field, $options) = @_;
266 my $field_name = $field->name;
267 debug("PKG: Looking at field '$field_name'\n");
268 my $field_comments = $field->comments
269 ? "-- " . $field->comments . "\n "
272 my $field_def = $field_comments.$field_name;
275 my $size = $field->size;
276 my $data_type = $field->data_type;
277 $data_type = 'varchar' if lc $data_type eq 'set';
278 $data_type = 'blob' if lc $data_type eq 'bytea';
280 if ( lc $data_type =~ /(text|blob)/i ) {
284 # if ( $data_type =~ /timestamp/i ) {
285 # push @trigger_defs,
286 # "CREATE TRIGGER ts_${table_name} ".
287 # "after insert on $table_name\n".
289 # " update $table_name set $field_name=timestamp() ".
290 # "where id=new.id;\n".
297 # SQLite is generally typeless, but newer versions will
298 # make a field autoincrement if it is declared as (and
299 # *only* as) INTEGER PRIMARY KEY
301 my $pk = $field->table->primary_key;
302 my @pk_fields = $pk ? $pk->fields : ();
305 $field->is_primary_key &&
306 scalar @pk_fields == 1 &&
308 $data_type =~ /int(eger)?$/i
310 ( $data_type =~ /^number?$/i && $size !~ /,/ )
313 $data_type = 'INTEGER PRIMARY KEY';
318 $field_def .= sprintf " %s%s", $data_type,
319 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
322 $field_def .= ' NOT NULL' unless $field->is_nullable;
325 SQL::Translator::Producer->_apply_default_value(
331 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
341 my ($index, $options) = @_;
343 my $name = $index->name;
344 $name = mk_name($name);
346 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
348 # strip any field size qualifiers as SQLite doesn't like these
349 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
350 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
351 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
353 "CREATE ${type}INDEX $name ON " . $index_table_name .
354 ' (' . join( ', ', @fields ) . ')';
359 sub create_constraint
361 my ($c, $options) = @_;
364 $name = mk_name($name);
365 my @fields = $c->fields;
366 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
367 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
370 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
371 ' (' . join( ', ', @fields ) . ')';
377 my ($trigger, $options) = @_;
378 my $add_drop = $options->{add_drop_trigger};
382 my $trigger_name = $trigger->name;
383 $global_names{$trigger_name} = 1;
385 my $events = $trigger->database_events;
386 for my $evt ( @$events ) {
388 my $trig_name = $trigger_name;
390 $trig_name .= "_$evt";
392 warn "Multiple database events supplied for trigger '$trigger_name', ",
393 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
396 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
401 if (not ref $trigger->action) {
402 $action .= "BEGIN " . $trigger->action . " END";
405 $action = $trigger->action->{for_each} . " "
406 if $trigger->action->{for_each};
408 $action = $trigger->action->{when} . " "
409 if $trigger->action->{when};
411 my $steps = $trigger->action->{steps} || [];
414 $action .= $_ . "; " for (@$steps);
418 push @statements, sprintf (
419 'CREATE TRIGGER %s %s %s on %s %s',
421 $trigger->perform_action_when,
431 sub alter_table { } # Noop
436 return sprintf("ALTER TABLE %s ADD COLUMN %s",
437 $field->table->name, create_field($field))
440 sub alter_create_index {
443 # This might cause name collisions
444 return create_index($index);
447 sub alter_create_constraint {
448 my ($constraint) = @_;
450 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
453 sub alter_drop_constraint { alter_drop_index(@_) }
455 sub alter_drop_index {
456 my ($constraint) = @_;
458 return sprintf("DROP INDEX %s",
462 sub batch_alter_table {
463 my ($table, $diffs) = @_;
465 # If we have any of the following
471 # we need to do the following <http://www.sqlite.org/faq.html#q11>
474 # CREATE TEMPORARY TABLE t1_backup(a,b);
475 # INSERT INTO t1_backup SELECT a,b FROM t1;
477 # CREATE TABLE t1(a,b);
478 # INSERT INTO t1 SELECT a,b FROM t1_backup;
479 # DROP TABLE t1_backup;
484 # If we have rename_field we do similarly.
486 my $table_name = $table->name;
487 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
489 if ( @{$diffs->{rename_field}} == 0 &&
490 @{$diffs->{alter_field}} == 0 &&
491 @{$diffs->{drop_field}} == 0
493 # return join("\n", map {
495 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
496 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
498 } grep { @{$diffs->{$_}} }
500 alter_drop_constraint
507 alter_create_constraint
513 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
516 local $table->{name} = $table_name . '_temp_alter';
517 # We only want the table - dont care about indexes on tmp table
518 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
519 push @sql,$table_sql;
522 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
523 "DROP TABLE @{[$old_table]}",
524 create_table($table, { no_comments => 1 }),
525 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
526 "DROP TABLE @{[$table_name]}_temp_alter";
529 # return join("", @sql, "");
534 return "DROP TABLE $table";
538 my ($old_table, $new_table, $options) = @_;
540 my $qt = $options->{quote_table_names} || '';
542 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
546 # No-op. Just here to signify that we are a new style parser.
547 sub preproces_schema { }
555 SQL::Translator, http://www.sqlite.org/.
559 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
561 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.