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);
25 use SQL::Translator::ProducerUtils;
26 my $util = SQL::Translator::ProducerUtils->new( quote_chars => q(') );
28 our ( $DEBUG, $WARN );
29 our $VERSION = '1.59';
30 $DEBUG = 0 unless defined $DEBUG;
31 $WARN = 0 unless defined $WARN;
33 our $max_id_length = 30;
37 my $translator = shift;
38 local $DEBUG = $translator->debug;
39 local $WARN = $translator->show_warnings;
40 my $no_comments = $translator->no_comments;
41 my $add_drop_table = $translator->add_drop_table;
42 my $schema = $translator->schema;
43 my $producer_args = $translator->producer_args;
44 my $sqlite_version = parse_dbms_version(
45 $producer_args->{sqlite_version}, 'perl'
47 my $no_txn = $producer_args->{no_transaction};
49 debug("PKG: Beginning production\n");
51 %global_names = (); #reset
54 my $head = (header_comment() . "\n") unless $no_comments;
58 push @create, "BEGIN TRANSACTION" unless $no_txn;
60 for my $table ( $schema->get_tables ) {
61 push @create, create_table($table, { no_comments => $no_comments,
62 sqlite_version => $sqlite_version,
63 add_drop_table => $add_drop_table,});
66 for my $view ( $schema->get_views ) {
67 push @create, create_view($view, {
68 add_drop_view => $add_drop_table,
69 no_comments => $no_comments,
73 for my $trigger ( $schema->get_triggers ) {
74 push @create, create_trigger($trigger, {
75 add_drop_trigger => $add_drop_table,
76 no_comments => $no_comments,
80 push @create, "COMMIT" unless $no_txn;
83 return ($head||(), @create);
87 join(";\n\n", @create ),
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 }++;
110 return $util->quote($name);
114 my ($view, $options) = @_;
115 my $add_drop_view = $options->{add_drop_view};
117 my $view_name = $util->quote($view->name);
118 $global_names{$view->name} = 1;
120 debug("PKG: Looking at view '${view_name}'\n");
122 # Header. Should this look like what mysqldump produces?
123 my $extra = $view->extra;
125 push @create, "DROP VIEW IF EXISTS $view_name" if $add_drop_view;
127 my $create_view = 'CREATE';
128 $create_view .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
129 $create_view .= ' VIEW';
130 $create_view .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
131 $create_view .= " ${view_name}";
133 if( my $sql = $view->sql ){
134 $create_view .= " AS\n ${sql}";
136 push @create, $create_view;
138 # Tack the comment onto the first statement.
139 unless ($options->{no_comments}) {
140 $create[0] = "--\n-- View: ${view_name}\n--\n" . $create[0];
149 my ($table, $options) = @_;
151 my $table_name = $util->quote($table->name);
152 $global_names{$table->name} = 1;
154 my $no_comments = $options->{no_comments};
155 my $add_drop_table = $options->{add_drop_table};
156 my $sqlite_version = $options->{sqlite_version} || 0;
158 debug("PKG: Looking at table '$table_name'\n");
160 my ( @index_defs, @constraint_defs );
161 my @fields = $table->get_fields or die "No fields in $table_name";
163 my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
167 my $exists = ($sqlite_version >= 3.003) ? ' IF EXISTS' : '';
169 my ($comment, $create_table) = "";
170 $comment = "--\n-- Table: $table_name\n--\n" unless $no_comments;
171 if ($add_drop_table) {
172 push @create, $comment . qq[DROP TABLE$exists $table_name];
174 $create_table = $comment;
177 $create_table .= "CREATE ${temp}TABLE $table_name (\n";
182 if ( $table->comments and !$no_comments ){
183 $create_table .= "-- Comments: \n-- ";
184 $create_table .= join "\n-- ", $table->comments;
185 $create_table .= "\n--\n\n";
189 # How many fields in PK?
191 my $pk = $table->primary_key;
192 my @pk_fields = $pk ? $pk->fields : ();
197 my ( @field_defs, $pk_set );
198 for my $field ( @fields ) {
199 push @field_defs, create_field($field);
203 scalar @pk_fields > 1
205 ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
207 push @field_defs, 'PRIMARY KEY (' . join(', ', map $util->quote($_), @pk_fields ) . ')';
213 my $idx_name_default = 'A';
214 for my $index ( $table->get_indices ) {
215 push @index_defs, create_index($index);
221 my $c_name_default = 'A';
222 for my $c ( $table->get_constraints ) {
223 if ($c->type eq "FOREIGN KEY") {
224 push @field_defs, create_foreignkey($c);
226 next unless $c->type eq UNIQUE;
227 push @constraint_defs, create_constraint($c);
230 $create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
232 return (@create, $create_table, @index_defs, @constraint_defs );
235 sub create_foreignkey {
238 my $field = $util->quote($c->{fields}[0]);
239 my $table = $c->{reference_table} ? $util->quote($c->{reference_table}) : '';
240 my $ref = $c->{reference_fields}[0] ? $util->quote($c->{reference_fields}[0]) : '';
241 my $fk_sql = "FOREIGN KEY($field) REFERENCES ";
242 $fk_sql .= "$table($ref)";
249 my ($field, $options) = @_;
251 my $field_name = $util->quote($field->name);
252 debug("PKG: Looking at field '$field_name'\n");
253 my $field_comments = $field->comments
254 ? "-- " . $field->comments . "\n "
257 my $field_def = $field_comments.$field_name;
260 my $size = $field->size;
261 my $data_type = $field->data_type;
262 $data_type = 'varchar' if lc $data_type eq 'set';
263 $data_type = 'blob' if lc $data_type eq 'bytea';
265 if ( lc $data_type =~ /(text|blob)/i ) {
269 # if ( $data_type =~ /timestamp/i ) {
270 # push @trigger_defs,
271 # "CREATE TRIGGER ts_${table_name} ".
272 # "after insert on $table_name\n".
274 # " update $table_name set $field_name=timestamp() ".
275 # "where id=new.id;\n".
282 # SQLite is generally typeless, but newer versions will
283 # make a field autoincrement if it is declared as (and
284 # *only* as) INTEGER PRIMARY KEY
286 my $pk = $field->table->primary_key;
287 my @pk_fields = $pk ? $pk->fields : ();
290 $field->is_primary_key &&
291 scalar @pk_fields == 1 &&
293 $data_type =~ /int(eger)?$/i
295 ( $data_type =~ /^number?$/i && $size !~ /,/ )
298 $data_type = 'INTEGER PRIMARY KEY';
303 $field_def .= sprintf " %s%s", $data_type,
304 ( !$field->is_auto_increment && $size ) ? "($size)" : '';
307 $field_def .= ' NOT NULL' unless $field->is_nullable;
310 SQL::Translator::Producer->_apply_default_value(
316 'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
326 my ($index, $options) = @_;
328 my $name = $index->name;
329 $name = mk_name($name);
331 my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
333 # strip any field size qualifiers as SQLite doesn't like these
334 my @fields = map { s/\(\d+\)$//; $util->quote($_) } $index->fields;
335 (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
336 $index_table_name = $util->quote($index_table_name);
337 warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
339 "CREATE ${type}INDEX $name ON " . $index_table_name .
340 ' (' . join( ', ', @fields ) . ')';
345 sub create_constraint
347 my ($c, $options) = @_;
350 $name = mk_name($name);
351 my @fields = map $util->quote($_), $c->fields;
352 (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
353 $index_table_name = $util->quote($index_table_name);
354 warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
357 "CREATE UNIQUE INDEX $name ON " . $index_table_name .
358 ' (' . join( ', ', @fields ) . ')';
364 my ($trigger, $options) = @_;
365 my $add_drop = $options->{add_drop_trigger};
369 my $trigger_name = $trigger->name;
370 $global_names{$trigger_name} = 1;
372 my $events = $trigger->database_events;
373 for my $evt ( @$events ) {
375 my $trig_name = $trigger_name;
377 $trig_name .= "_$evt";
379 warn "Multiple database events supplied for trigger '$trigger_name', ",
380 "creating trigger '$trig_name' for the '$evt' event.\n" if $WARN;
383 $trig_name = $util->quote($trig_name);
384 push @statements, "DROP TRIGGER IF EXISTS $trig_name" if $add_drop;
389 if (not ref $trigger->action) {
390 $action .= "BEGIN " . $trigger->action . " END";
393 $action = $trigger->action->{for_each} . " "
394 if $trigger->action->{for_each};
396 $action = $trigger->action->{when} . " "
397 if $trigger->action->{when};
399 my $steps = $trigger->action->{steps} || [];
402 $action .= $_ . "; " for (@$steps);
406 push @statements, sprintf (
407 'CREATE TRIGGER %s %s %s on %s %s',
409 $trigger->perform_action_when,
411 $util->quote($trigger->on_table),
419 sub alter_table { } # Noop
424 return sprintf("ALTER TABLE %s ADD COLUMN %s",
425 $util->quote($field->table->name), create_field($field))
428 sub alter_create_index {
431 # This might cause name collisions
432 return create_index($index);
435 sub alter_create_constraint {
436 my ($constraint) = @_;
438 return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
441 sub alter_drop_constraint { alter_drop_index(@_) }
443 sub alter_drop_index {
444 my ($constraint) = @_;
446 return sprintf("DROP INDEX %s",
447 $util->quote($constraint->name));
450 sub batch_alter_table {
451 my ($table, $diffs) = @_;
453 # If we have any of the following
459 # we need to do the following <http://www.sqlite.org/faq.html#q11>
462 # CREATE TEMPORARY TABLE t1_backup(a,b);
463 # INSERT INTO t1_backup SELECT a,b FROM t1;
465 # CREATE TABLE t1(a,b);
466 # INSERT INTO t1 SELECT a,b FROM t1_backup;
467 # DROP TABLE t1_backup;
472 # If we have rename_field we do similarly.
474 my $table_name = $table->name;
475 my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
477 if ( @{$diffs->{rename_field}} == 0 &&
478 @{$diffs->{alter_field}} == 0 &&
479 @{$diffs->{drop_field}} == 0
481 # return join("\n", map {
483 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
484 map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
486 } grep { @{$diffs->{$_}} }
488 alter_drop_constraint
495 alter_create_constraint
501 my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
504 local $table->{name} = $table_name . '_temp_alter';
505 # We only want the table - dont care about indexes on tmp table
506 my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
507 push @sql,$table_sql;
510 push @sql, "INSERT INTO @{[$util->quote($table_name.'_temp_alter')]} SELECT @{[ join(', ', map $util->quote($_), $old_table->get_fields)]} FROM @{[$util->quote($old_table)]}",
511 "DROP TABLE @{[$util->quote($old_table)]}",
512 create_table($table, { no_comments => 1 }),
513 "INSERT INTO @{[$util->quote($table_name)]} SELECT @{[ join(', ', map $util->quote($_), $old_table->get_fields)]} FROM @{[$util->quote($table_name.'_temp_alter')]}",
514 "DROP TABLE @{[$util->quote($table_name.'_temp_alter')]}";
517 # return join("", @sql, "");
522 $table = $util->quote($table);
523 return "DROP TABLE $table";
527 my ($old_table, $new_table, $options) = @_;
529 $old_table = $util->quote($old_table);
530 $new_table = $util->quote($new_table);
532 return "ALTER TABLE $old_table RENAME TO $new_table";
536 # No-op. Just here to signify that we are a new style parser.
537 sub preproces_schema { }
545 SQL::Translator, http://www.sqlite.org/.
549 Ken Youens-Clark C<< <kclark@cpan.orgE> >>.
551 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.