1 package SQL::Translator::Producer::SQLite;
5 SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator
11 my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
16 This module will produce text output of the schema suitable for SQLite.
23 use SQL::Translator::Schema::Constants;
24 use SQL::Translator::Utils qw(debug header_comment parse_dbms_version);
26 our ( $DEBUG, $WARN );
28 our $VERSION = '1.59';
29 $DEBUG = 0 unless defined $DEBUG;
30 $WARN = 0 unless defined $WARN;
32 our $max_id_length = 30;
36 my $translator = shift;
37 local $DEBUG = $translator->debug;
38 local $WARN = $translator->show_warnings;
39 my $no_comments = $translator->no_comments;
40 my $add_drop_table = $translator->add_drop_table;
41 my $schema = $translator->schema;
42 my $producer_args = $translator->producer_args;
43 my $sqlite_version = parse_dbms_version(
44 $producer_args->{sqlite_version}, 'perl'
46 my $no_txn = $producer_args->{no_transaction};
48 debug("PKG: Beginning production\n");
50 %global_names = (); #reset
53 my $head = (header_comment() . "\n") unless $no_comments;
57 push @create, "BEGIN TRANSACTION" unless $no_txn;
59 for my $table ( $schema->get_tables ) {
60 push @create, create_table($table, { no_comments => $no_comments,
61 sqlite_version => $sqlite_version,
62 add_drop_table => $add_drop_table,});
65 for my $view ( $schema->get_views ) {
66 push @create, create_view($view, {
67 add_drop_view => $add_drop_table,
68 no_comments => $no_comments,
72 for my $trigger ( $schema->get_triggers ) {
73 push @create, create_trigger($trigger, {
74 add_drop_trigger => $add_drop_table,
75 no_comments => $no_comments,
79 push @create, "COMMIT" unless $no_txn;
82 return ($head||(), @create);
86 join(";\n\n", @create ),
93 my ($name, $scope, $critical) = @_;
95 $scope ||= \%global_names;
96 if ( my $prev = $scope->{ $name } ) {
97 my $name_orig = $name;
98 $name .= sprintf( "%02d", ++$prev );
99 substr($name, $max_id_length - 3) = "00"
100 if length( $name ) > $max_id_length;
102 warn "The name '$name_orig' has been changed to ",
103 "'$name' to make it unique.\n" if $WARN;
105 $scope->{ $name_orig }++;
113 my ($view, $options) = @_;
114 my $add_drop_view = $options->{add_drop_view};
116 my $view_name = $view->name;
117 $global_names{$view_name} = 1;
119 debug("PKG: Looking at view '${view_name}'\n");
121 # Header. Should this look like what mysqldump produces?
122 my $extra = $view->extra;
124 push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view;
126 my $create_view = 'CREATE';
127 $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
128 $create_view .= ' VIEW';
129 $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
130 $create_view .= " ${view_name}";
132 if( my $sql = $view->sql ){
133 $create_view .= " AS\n ${sql}";
135 push @create, $create_view;
137 # Tack the comment onto the first statement.
138 unless ($options->{no_comments}) {
139 $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0];
148 my ($table, $options) = @_;
150 my $table_name = $table->name;
151 $global_names{$table_name} = 1;
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.003) ? ' 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 if ($c->type eq "FOREIGN KEY") {
223 push @field_defs, create_foreignkey($c);
225 next unless $c->type eq UNIQUE;
226 push @constraint_defs, create_constraint($c);
229 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
231 return (@create, $create_table, @index_defs, @constraint_defs );
234 sub create_foreignkey {
237 my $fk_sql = "FOREIGN KEY($c->{fields}[0]) REFERENCES ";
238 $fk_sql .= ( $c->{reference_table} || '' )."(".( $c->{reference_fields}[0] || '' ).")";
245 my ($field, $options) = @_;
247 my $field_name = $field->name;
248 debug("PKG: Looking at field '$field_name'\n");
249 my $field_comments = $field->comments
250 ? "-- " . $field->comments . "\n "
253 my $field_def = $field_comments.$field_name;
256 my $size = $field->size;
257 my $data_type = $field->data_type;
258 $data_type = 'varchar' if lc $data_type eq 'set';
259 $data_type = 'blob' if lc $data_type eq 'bytea';
261 if ( lc $data_type =~ /(text|blob)/i ) {
265 # if ( $data_type =~ /timestamp/i ) {
266 # push @trigger_defs,
267 # "CREATE TRIGGER ts_${table_name} ".
268 # "after insert on $table_name\n".
270 # " update $table_name set $field_name=timestamp() ".
271 # "where id=new.id;\n".
278 # SQLite is generally typeless, but newer versions will
279 # make a field autoincrement if it is declared as (and
280 # *only* as) INTEGER PRIMARY KEY
282 my $pk = $field->table->primary_key;
283 my @pk_fields = $pk ? $pk->fields : ();
286 $field->is_primary_key &&
287 scalar @pk_fields == 1 &&
289 $data_type =~ /int(eger)?$/i
291 ( $data_type =~ /^number?$/i && $size !~ /,/ )
294 $data_type = 'INTEGER PRIMARY KEY';
299 $field_def .= sprintf " %s%s", $data_type,
300 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
303 $field_def .= ' NOT NULL' unless $field->is_nullable;
306 SQL::Translator::Producer->_apply_default_value(
312 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
322 my ($index, $options) = @_;
324 my $name = $index->name;
325 $name = mk_name($name);
327 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
329 # strip any field size qualifiers as SQLite doesn't like these
330 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
331 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
332 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
334 "CREATE ${type}INDEX $name ON " . $index_table_name .
335 ' (' . join( ', ', @fields ) . ')';
340 sub create_constraint
342 my ($c, $options) = @_;
345 $name = mk_name($name);
346 my @fields = $c->fields;
347 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
348 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
351 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
352 ' (' . join( ', ', @fields ) . ')';
358 my ($trigger, $options) = @_;
359 my $add_drop = $options->{add_drop_trigger};
363 my $trigger_name = $trigger->name;
364 $global_names{$trigger_name} = 1;
366 my $events = $trigger->database_events;
367 for my $evt ( @$events ) {
369 my $trig_name = $trigger_name;
371 $trig_name .= "_$evt";
373 warn "Multiple database events supplied for trigger '$trigger_name', ",
374 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
377 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
382 if (not ref $trigger->action) {
383 $action .= "BEGIN " . $trigger->action . " END";
386 $action = $trigger->action->{for_each} . " "
387 if $trigger->action->{for_each};
389 $action = $trigger->action->{when} . " "
390 if $trigger->action->{when};
392 my $steps = $trigger->action->{steps} || [];
395 $action .= $_ . "; " for (@$steps);
399 push @statements, sprintf (
400 'CREATE TRIGGER %s %s %s on %s %s',
402 $trigger->perform_action_when,
412 sub alter_table { } # Noop
417 return sprintf("ALTER TABLE %s ADD COLUMN %s",
418 $field->table->name, create_field($field))
421 sub alter_create_index {
424 # This might cause name collisions
425 return create_index($index);
428 sub alter_create_constraint {
429 my ($constraint) = @_;
431 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
434 sub alter_drop_constraint { alter_drop_index(@_) }
436 sub alter_drop_index {
437 my ($constraint) = @_;
439 return sprintf("DROP INDEX %s",
443 sub batch_alter_table {
444 my ($table, $diffs) = @_;
446 # If we have any of the following
452 # we need to do the following <http://www.sqlite.org/faq.html#q11>
455 # CREATE TEMPORARY TABLE t1_backup(a,b);
456 # INSERT INTO t1_backup SELECT a,b FROM t1;
458 # CREATE TABLE t1(a,b);
459 # INSERT INTO t1 SELECT a,b FROM t1_backup;
460 # DROP TABLE t1_backup;
465 # If we have rename_field we do similarly.
467 my $table_name = $table->name;
468 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
470 if ( @{$diffs->{rename_field}} == 0 &&
471 @{$diffs->{alter_field}} == 0 &&
472 @{$diffs->{drop_field}} == 0
474 # return join("\n", map {
476 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
477 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
479 } grep { @{$diffs->{$_}} }
481 alter_drop_constraint
488 alter_create_constraint
494 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
497 local $table->{name} = $table_name . '_temp_alter';
498 # We only want the table - dont care about indexes on tmp table
499 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
500 push @sql,$table_sql;
503 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
504 "DROP TABLE @{[$old_table]}",
505 create_table($table, { no_comments => 1 }),
506 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
507 "DROP TABLE @{[$table_name]}_temp_alter";
510 # return join("", @sql, "");
515 return "DROP TABLE $table";
519 my ($old_table, $new_table, $options) = @_;
521 my $qt = $options->{quote_table_names} || '';
523 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
527 # No-op. Just here to signify that we are a new style parser.
528 sub preproces_schema { }
536 SQL::Translator, http://www.sqlite.org/.
540 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
542 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.