lib/SQL/Translator/Producer/SQLite.pm

   1 package SQL::Translator::Producer::SQLite;
   2
   3 # -------------------------------------------------------------------
   4 # $Id$
   5 # -------------------------------------------------------------------
   6 # Copyright (C) 2002-2009 SQLFairy Authors
   7 #
   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.
  11 #
  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.
  16 #
  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
  20 # 02111-1307  USA
  21 # -------------------------------------------------------------------
  22
  23 =head1 NAME
  24
  25 SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator
  26
  27 =head1 SYNOPSIS
  28
  29   use SQL::Translator;
  30
  31   my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
  32   $t->translate;
  33
  34 =head1 DESCRIPTION
  35
  36 This module will produce text output of the schema suitable for SQLite.
  37
  38 =cut
  39
  40 use strict;
  41 use warnings;
  42 use Data::Dumper;
  43 use SQL::Translator::Schema::Constants;
  44 use SQL::Translator::Utils qw(debug header_comment);
  45
  46 use vars qw[ $DEBUG $WARN ];
  47
  48 $DEBUG = 0 unless defined $DEBUG;
  49 $WARN = 0 unless defined $WARN;
  50
  51 our %used_identifiers = ();
  52 our $max_id_length    = 30;
  53 our %global_names;
  54 our %truncated;
  55
  56 sub produce {
  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;
  63     my $producer_args  = $translator->producer_args;
  64     my $sqlite_version  = $producer_args->{sqlite_version} || 0;
  65
  66     debug("PKG: Beginning production\n");
  67
  68     my @create = ();
  69     push @create, header_comment unless ($no_comments);
  70     $create[0] .= "\n\nBEGIN TRANSACTION";
  71
  72     for my $table ( $schema->get_tables ) {
  73         push @create, create_table($table, { no_comments => $no_comments,
  74                                              sqlite_version => $sqlite_version,
  75                                           add_drop_table => $add_drop_table,});
  76     }
  77
  78     for my $view ( $schema->get_views ) {
  79       push @create, create_view($view, {
  80         add_drop_view => $add_drop_table,
  81         no_comments   => $no_comments,
  82       });
  83     }
  84
  85     for my $trigger ( $schema->get_triggers ) {
  86       push @create, create_trigger($trigger, {
  87         add_drop_trigger => $add_drop_table,
  88         no_comments   => $no_comments,
  89       });
  90     }
  91
  92     return wantarray ? (@create, "COMMIT") : join(";\n\n", (@create, "COMMIT;\n"));
  93 }
  94
  95 # -------------------------------------------------------------------
  96 sub mk_name {
  97     my ($basename, $type, $scope, $critical) = @_;
  98     my $basename_orig = $basename;
  99     my $max_name      = !$max_id_length
 100                       ? length($type) + 1
 101                       : $type
 102                       ? $max_id_length - (length($type) + 1)
 103                       : $max_id_length;
 104     $basename         = substr( $basename, 0, $max_name )
 105                         if length( $basename ) > $max_name;
 106     $basename         =~ s/\./_/g;
 107     my $name          = $type ? "${type}_$basename" : $basename;
 108
 109     if ( $basename ne $basename_orig and $critical ) {
 110         my $show_type = $type ? "+'$type'" : "";
 111         warn "Truncating '$basename_orig'$show_type to $max_id_length ",
 112             "character limit to make '$name'\n" if $WARN;
 113         $truncated{ $basename_orig } = $name;
 114     }
 115
 116     $scope ||= \%global_names;
 117     if ( my $prev = $scope->{ $name } ) {
 118         my $name_orig = $name;
 119         $name        .= sprintf( "%02d", ++$prev );
 120         substr($name, $max_id_length - 3) = "00"
 121             if length( $name ) > $max_id_length;
 122
 123         warn "The name '$name_orig' has been changed to ",
 124              "'$name' to make it unique.\n" if $WARN;
 125
 126         $scope->{ $name_orig }++;
 127     }
 128
 129     $scope->{ $name }++;
 130     return $name;
 131 }
 132
 133 sub create_view {
 134     my ($view, $options) = @_;
 135     my $add_drop_view = $options->{add_drop_view};
 136
 137     my $view_name = $view->name;
 138     debug("PKG: Looking at view '${view_name}'\n");
 139
 140     # Header.  Should this look like what mysqldump produces?
 141     my $extra = $view->extra;
 142     my $create = '';
 143     $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
 144     $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
 145     $create .= 'CREATE';
 146     $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
 147     $create .= ' VIEW';
 148     $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
 149     $create .= " ${view_name}";
 150
 151     if( my $sql = $view->sql ){
 152       $create .= " AS\n    ${sql}";
 153     }
 154     return $create;
 155 }
 156
 157
 158 sub create_table
 159 {
 160     my ($table, $options) = @_;
 161
 162     my $table_name = $table->name;
 163     my $no_comments = $options->{no_comments};
 164     my $add_drop_table = $options->{add_drop_table};
 165     my $sqlite_version = $options->{sqlite_version} || 0;
 166
 167     debug("PKG: Looking at table '$table_name'\n");
 168
 169     my ( @index_defs, @constraint_defs );
 170     my @fields = $table->get_fields or die "No fields in $table_name";
 171
 172     my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
 173     #
 174     # Header.
 175     #
 176     my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
 177     my @create;
 178     my ($comment, $create_table) = "";
 179     $comment =  "--\n-- Table: $table_name\n--\n" unless $no_comments;
 180     if ($add_drop_table) {
 181       push @create, $comment . qq[DROP TABLE$exists $table_name];
 182     } else {
 183       $create_table = $comment;
 184     }
 185
 186     $create_table .= "CREATE ${temp}TABLE $table_name (\n";
 187
 188     #
 189     # Comments
 190     #
 191     if ( $table->comments and !$no_comments ){
 192         $create_table .= "-- Comments: \n-- ";
 193         $create_table .= join "\n-- ",  $table->comments;
 194         $create_table .= "\n--\n\n";
 195     }
 196
 197     #
 198     # How many fields in PK?
 199     #
 200     my $pk        = $table->primary_key;
 201     my @pk_fields = $pk ? $pk->fields : ();
 202
 203     #
 204     # Fields
 205     #
 206     my ( @field_defs, $pk_set );
 207     for my $field ( @fields ) {
 208         push @field_defs, create_field($field);
 209     }
 210
 211     if (
 212          scalar @pk_fields > 1
 213          ||
 214          ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
 215          ) {
 216         push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
 217     }
 218
 219     #
 220     # Indices
 221     #
 222     my $idx_name_default = 'A';
 223     for my $index ( $table->get_indices ) {
 224         push @index_defs, create_index($index);
 225     }
 226
 227     #
 228     # Constraints
 229     #
 230     my $c_name_default = 'A';
 231     for my $c ( $table->get_constraints ) {
 232         next unless $c->type eq UNIQUE;
 233         push @constraint_defs, create_constraint($c);
 234     }
 235
 236     $create_table .= join(",\n", map { "  $_" } @field_defs ) . "\n)";
 237
 238     return (@create, $create_table, @index_defs, @constraint_defs );
 239 }
 240
 241 sub create_field
 242 {
 243     my ($field, $options) = @_;
 244
 245     my $field_name = $field->name;
 246     debug("PKG: Looking at field '$field_name'\n");
 247     my $field_comments = $field->comments
 248         ? "-- " . $field->comments . "\n  "
 249         : '';
 250
 251     my $field_def = $field_comments.$field_name;
 252
 253     # data type and size
 254     my $size      = $field->size;
 255     my $data_type = $field->data_type;
 256     $data_type    = 'varchar' if lc $data_type eq 'set';
 257     $data_type  = 'blob' if lc $data_type eq 'bytea';
 258
 259     if ( lc $data_type =~ /(text|blob)/i ) {
 260         $size = undef;
 261     }
 262
 263 #             if ( $data_type =~ /timestamp/i ) {
 264 #                 push @trigger_defs,
 265 #                     "CREATE TRIGGER ts_${table_name} ".
 266 #                     "after insert on $table_name\n".
 267 #                     "begin\n".
 268 #                     "  update $table_name set $field_name=timestamp() ".
 269 #                        "where id=new.id;\n".
 270 #                     "end;\n"
 271 #                 ;
 272 #
 273 #            }
 274
 275     #
 276     # SQLite is generally typeless, but newer versions will
 277     # make a field autoincrement if it is declared as (and
 278     # *only* as) INTEGER PRIMARY KEY
 279     #
 280     my $pk        = $field->table->primary_key;
 281     my @pk_fields = $pk ? $pk->fields : ();
 282
 283     if (
 284          $field->is_primary_key &&
 285          scalar @pk_fields == 1 &&
 286          (
 287           $data_type =~ /int(eger)?$/i
 288           ||
 289           ( $data_type =~ /^number?$/i && $size !~ /,/ )
 290           )
 291          ) {
 292         $data_type = 'INTEGER PRIMARY KEY';
 293         $size      = undef;
 294 #        $pk_set    = 1;
 295     }
 296
 297     $field_def .= sprintf " %s%s", $data_type,
 298     ( !$field->is_auto_increment && $size ) ? "($size)" : '';
 299
 300     # Null?
 301     $field_def .= ' NOT NULL' unless $field->is_nullable;
 302
 303     # Default?  XXX Need better quoting!
 304     my $default = $field->default_value;
 305     if (defined $default) {
 306         SQL::Translator::Producer->_apply_default_value(
 307             \$field_def,
 308             $default,
 309             [
 310              'NULL'              => \'NULL',
 311              'now()'             => 'now()',
 312              'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
 313             ],
 314         );
 315     }
 316
 317     return $field_def;
 318
 319 }
 320
 321 sub create_index
 322 {
 323     my ($index, $options) = @_;
 324
 325     my $name   = $index->name;
 326     $name      = mk_name($index->table->name, $name);
 327
 328     my $type   = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
 329
 330     # strip any field size qualifiers as SQLite doesn't like these
 331     my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
 332     (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
 333     warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
 334     my $index_def =
 335     "CREATE ${type}INDEX $name ON " . $index_table_name .
 336         ' (' . join( ', ', @fields ) . ')';
 337
 338     return $index_def;
 339 }
 340
 341 sub create_constraint
 342 {
 343     my ($c, $options) = @_;
 344
 345     my $name   = $c->name;
 346     $name      = mk_name($c->table->name, $name);
 347     my @fields = $c->fields;
 348     (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
 349     warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
 350
 351     my $c_def =
 352     "CREATE UNIQUE INDEX $name ON " . $index_table_name .
 353         ' (' . join( ', ', @fields ) . ')';
 354
 355     return $c_def;
 356 }
 357
 358 sub create_trigger {
 359   my ($trigger, $options) = @_;
 360   my $add_drop = $options->{add_drop_trigger};
 361
 362   my $name = $trigger->name;
 363   my @create;
 364
 365   push @create,  "DROP TRIGGER IF EXISTS $name" if $add_drop;
 366
 367   my $events = $trigger->database_events;
 368   die "Can't handle multiple events in triggers" if @$events > 1;
 369
 370   my $action = "";
 371
 372   $action = $trigger->ation->{for_each} . " "
 373     if $trigger->action->{for_each};
 374
 375   $action = $trigger->action->{when} . " "
 376     if $trigger->action->{when};
 377
 378   my $steps = $trigger->action->{steps} || [];
 379
 380   $action .= "BEGIN ";
 381   for (@$steps) {
 382     $action .= $_ . "; "
 383   }
 384   $action .= "END";
 385
 386   push @create, "CREATE TRIGGER $name " .
 387                 $trigger->perform_action_when . " " .
 388                 $events->[0] .
 389                 " on " . $trigger->on_table . " " .
 390                 $action;
 391
 392   return @create;
 393
 394 }
 395
 396 sub alter_table { } # Noop
 397
 398 sub add_field {
 399   my ($field) = @_;
 400
 401   return sprintf("ALTER TABLE %s ADD COLUMN %s",
 402       $field->table->name, create_field($field))
 403 }
 404
 405 sub alter_create_index {
 406   my ($index) = @_;
 407
 408   # This might cause name collisions
 409   return create_index($index);
 410 }
 411
 412 sub alter_create_constraint {
 413   my ($constraint) = @_;
 414
 415   return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
 416 }
 417
 418 sub alter_drop_constraint { alter_drop_index(@_) }
 419
 420 sub alter_drop_index {
 421   my ($constraint) = @_;
 422
 423   return sprintf("DROP INDEX %s",
 424       $constraint->name);
 425 }
 426
 427 sub batch_alter_table {
 428   my ($table, $diffs) = @_;
 429
 430   # If we have any of the following
 431   #
 432   #  rename_field
 433   #  alter_field
 434   #  drop_field
 435   #
 436   # we need to do the following <http://www.sqlite.org/faq.html#q11>
 437   #
 438   # BEGIN TRANSACTION;
 439   # CREATE TEMPORARY TABLE t1_backup(a,b);
 440   # INSERT INTO t1_backup SELECT a,b FROM t1;
 441   # DROP TABLE t1;
 442   # CREATE TABLE t1(a,b);
 443   # INSERT INTO t1 SELECT a,b FROM t1_backup;
 444   # DROP TABLE t1_backup;
 445   # COMMIT;
 446   #
 447   # Fun, eh?
 448   #
 449   # If we have rename_field we do similarly.
 450
 451   my $table_name = $table->name;
 452   my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};
 453
 454   if ( @{$diffs->{rename_field}} == 0 &&
 455        @{$diffs->{alter_field}}  == 0 &&
 456        @{$diffs->{drop_field}}   == 0
 457        ) {
 458 #    return join("\n", map {
 459     return map {
 460         my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
 461         map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ?  ("$sql") : () } @{ $diffs->{$_} }
 462
 463       } grep { @{$diffs->{$_}} }
 464     qw/rename_table
 465        alter_drop_constraint
 466        alter_drop_index
 467        drop_field
 468        add_field
 469        alter_field
 470        rename_field
 471        alter_create_index
 472        alter_create_constraint
 473        alter_table/;
 474   }
 475
 476
 477   my @sql;
 478   my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
 479
 480   do {
 481     local $table->{name} = $table_name . '_temp_alter';
 482     # We only want the table - dont care about indexes on tmp table
 483     my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
 484     push @sql,$table_sql;
 485   };
 486
 487   push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
 488              "DROP TABLE @{[$old_table]}",
 489              create_table($table, { no_comments => 1 }),
 490              "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
 491              "DROP TABLE @{[$table_name]}_temp_alter";
 492
 493   return @sql;
 494 #  return join("", @sql, "");
 495 }
 496
 497 sub drop_table {
 498   my ($table) = @_;
 499   return "DROP TABLE $table";
 500 }
 501
 502 sub rename_table {
 503   my ($old_table, $new_table, $options) = @_;
 504
 505   my $qt = $options->{quote_table_names} || '';
 506
 507   return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
 508
 509 }
 510
 511 # No-op. Just here to signify that we are a new style parser.
 512 sub preproces_schema { }
 513
 514 1;
 515
 516 =pod
 517
 518 =head1 SEE ALSO
 519
 520 SQL::Translator, http://www.sqlite.org/.
 521
 522 =head1 AUTHOR
 523
 524 Ken Y. Clark C<< <kclark@cpan.orgE> >>.
 525
 526 Diff code added by Ash Berlin C<< <ash@cpan.org> >>.
 527
 528 =cut