lib/SQL/Translator/Producer/SQLite.pm

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