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 use vars qw[ $VERSION $DEBUG $WARN ];
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 ),
92 # -------------------------------------------------------------------
94 my ($name, $scope, $critical) = @_;
96 $scope ||= \%global_names;
97 if ( my $prev = $scope->{ $name } ) {
98 my $name_orig = $name;
99 $name .= sprintf( "%02d", ++$prev );
100 substr($name, $max_id_length - 3) = "00"
101 if length( $name ) > $max_id_length;
103 warn "The name '$name_orig' has been changed to ",
104 "'$name' to make it unique.\n" if $WARN;
106 $scope->{ $name_orig }++;
114 my ($view, $options) = @_;
115 my $add_drop_view = $options->{add_drop_view};
117 my $view_name = $view->name;
118 debug("PKG: Looking at view '${view_name}'\n");
120 # Header. Should this look like what mysqldump produces?
121 my $extra = $view->extra;
123 push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view;
125 my $create_view = 'CREATE';
126 $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
127 $create_view .= ' VIEW';
128 $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
129 $create_view .= " ${view_name}";
131 if( my $sql = $view->sql ){
132 $create_view .= " AS\n ${sql}";
134 push @create, $create_view;
136 # Tack the comment onto the first statement.
137 unless ($options->{no_comments}) {
138 $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0];
147 my ($table, $options) = @_;
149 my $table_name = $table->name;
150 my $no_comments = $options->{no_comments};
151 my $add_drop_table = $options->{add_drop_table};
152 my $sqlite_version = $options->{sqlite_version} || 0;
154 debug("PKG: Looking at table '$table_name'\n");
156 my ( @index_defs, @constraint_defs );
157 my @fields = $table->get_fields or die "No fields in $table_name";
159 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
163 my $exists = ($sqlite_version >= 3.003) ? ' IF EXISTS' : '';
165 my ($comment, $create_table) = "";
166 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
167 if ($add_drop_table) {
168 push @create, $comment . qq[DROP TABLE$exists $table_name];
170 $create_table = $comment;
173 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
178 if ( $table->comments and !$no_comments ){
179 $create_table .= "-- Comments: \n-- ";
180 $create_table .= join "\n-- ", $table->comments;
181 $create_table .= "\n--\n\n";
185 # How many fields in PK?
187 my $pk = $table->primary_key;
188 my @pk_fields = $pk ? $pk->fields : ();
193 my ( @field_defs, $pk_set );
194 for my $field ( @fields ) {
195 push @field_defs, create_field($field);
199 scalar @pk_fields > 1
201 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
203 push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
209 my $idx_name_default = 'A';
210 for my $index ( $table->get_indices ) {
211 push @index_defs, create_index($index);
217 my $c_name_default = 'A';
218 for my $c ( $table->get_constraints ) {
219 next unless $c->type eq UNIQUE;
220 push @constraint_defs, create_constraint($c);
223 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
225 return (@create, $create_table, @index_defs, @constraint_defs );
230 my ($field, $options) = @_;
232 my $field_name = $field->name;
233 debug("PKG: Looking at field '$field_name'\n");
234 my $field_comments = $field->comments
235 ? "-- " . $field->comments . "\n "
238 my $field_def = $field_comments.$field_name;
241 my $size = $field->size;
242 my $data_type = $field->data_type;
243 $data_type = 'varchar' if lc $data_type eq 'set';
244 $data_type = 'blob' if lc $data_type eq 'bytea';
246 if ( lc $data_type =~ /(text|blob)/i ) {
250 # if ( $data_type =~ /timestamp/i ) {
251 # push @trigger_defs,
252 # "CREATE TRIGGER ts_${table_name} ".
253 # "after insert on $table_name\n".
255 # " update $table_name set $field_name=timestamp() ".
256 # "where id=new.id;\n".
263 # SQLite is generally typeless, but newer versions will
264 # make a field autoincrement if it is declared as (and
265 # *only* as) INTEGER PRIMARY KEY
267 my $pk = $field->table->primary_key;
268 my @pk_fields = $pk ? $pk->fields : ();
271 $field->is_primary_key &&
272 scalar @pk_fields == 1 &&
274 $data_type =~ /int(eger)?$/i
276 ( $data_type =~ /^number?$/i && $size !~ /,/ )
279 $data_type = 'INTEGER PRIMARY KEY';
284 $field_def .= sprintf " %s%s", $data_type,
285 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
288 $field_def .= ' NOT NULL' unless $field->is_nullable;
291 SQL::Translator::Producer->_apply_default_value(
297 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
307 my ($index, $options) = @_;
309 my $name = $index->name;
310 $name = mk_name($name);
312 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
314 # strip any field size qualifiers as SQLite doesn't like these
315 my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
316 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
317 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
319 "CREATE ${type}INDEX $name ON " . $index_table_name .
320 ' (' . join( ', ', @fields ) . ')';
325 sub create_constraint
327 my ($c, $options) = @_;
330 $name = mk_name($name);
331 my @fields = $c->fields;
332 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
333 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
336 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
337 ' (' . join( ', ', @fields ) . ')';
343 my ($trigger, $options) = @_;
344 my $add_drop = $options->{add_drop_trigger};
348 my $trigger_name = $trigger->name;
349 my $events = $trigger->database_events;
350 for my $evt ( @$events ) {
352 my $trig_name = $trigger_name;
354 $trig_name .= "_$evt";
356 warn "Multiple database events supplied for trigger '$trigger_name', ",
357 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
360 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
365 if (not ref $trigger->action) {
366 $action .= "BEGIN " . $trigger->action . " END";
369 $action = $trigger->action->{for_each} . " "
370 if $trigger->action->{for_each};
372 $action = $trigger->action->{when} . " "
373 if $trigger->action->{when};
375 my $steps = $trigger->action->{steps} || [];
378 $action .= $_ . "; " for (@$steps);
382 push @statements, sprintf (
383 'CREATE TRIGGER %s %s %s on %s %s',
385 $trigger->perform_action_when,
395 sub alter_table { } # Noop
400 return sprintf("ALTER TABLE %s ADD COLUMN %s",
401 $field->table->name, create_field($field))
404 sub alter_create_index {
407 # This might cause name collisions
408 return create_index($index);
411 sub alter_create_constraint {
412 my ($constraint) = @_;
414 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
417 sub alter_drop_constraint { alter_drop_index(@_) }
419 sub alter_drop_index {
420 my ($constraint) = @_;
422 return sprintf("DROP INDEX %s",
426 sub batch_alter_table {
427 my ($table, $diffs) = @_;
429 # If we have any of the following
435 # we need to do the following <http://www.sqlite.org/faq.html#q11>
438 # CREATE TEMPORARY TABLE t1_backup(a,b);
439 # INSERT INTO t1_backup SELECT a,b FROM t1;
441 # CREATE TABLE t1(a,b);
442 # INSERT INTO t1 SELECT a,b FROM t1_backup;
443 # DROP TABLE t1_backup;
448 # If we have rename_field we do similarly.
450 my $table_name = $table->name;
451 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
453 if ( @{$diffs->{rename_field}} == 0 &&
454 @{$diffs->{alter_field}} == 0 &&
455 @{$diffs->{drop_field}} == 0
457 # return join("\n", map {
459 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
460 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
462 } grep { @{$diffs->{$_}} }
464 alter_drop_constraint
471 alter_create_constraint
477 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
480 local $table->{name} = $table_name . '_temp_alter';
481 # We only want the table - dont care about indexes on tmp table
482 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
483 push @sql,$table_sql;
486 push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
487 "DROP TABLE @{[$old_table]}",
488 create_table($table, { no_comments => 1 }),
489 "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
490 "DROP TABLE @{[$table_name]}_temp_alter";
493 # return join("", @sql, "");
498 return "DROP TABLE $table";
502 my ($old_table, $new_table, $options) = @_;
504 my $qt = $options->{quote_table_names} || '';
506 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
510 # No-op. Just here to signify that we are a new style parser.
511 sub preproces_schema { }
519 SQL::Translator, http://www.sqlite.org/.
523 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
525 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.