[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / SQLite.pm

package SQL::Translator::Producer::SQLite;

# -------------------------------------------------------------------
# $Id$
# -------------------------------------------------------------------
# Copyright (C) 2002-2009 SQLFairy Authors
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
# 02111-1307  USA
# -------------------------------------------------------------------

=head1 NAME

SQL::Translator::Producer::SQLite - SQLite producer for SQL::Translator

=head1 SYNOPSIS

  use SQL::Translator;

  my $t = SQL::Translator->new( parser => '...', producer => 'SQLite' );
  $t->translate;

=head1 DESCRIPTION

This module will produce text output of the schema suitable for SQLite.

=cut

use strict;
use warnings;
use Data::Dumper;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(debug header_comment);

use vars qw[ $DEBUG $WARN ];

$DEBUG = 0 unless defined $DEBUG;
$WARN = 0 unless defined $WARN;

our %used_identifiers = ();
our $max_id_length    = 30;
our %global_names;
our %truncated;

sub produce {
    my $translator     = shift;
    local $DEBUG       = $translator->debug;
    local $WARN        = $translator->show_warnings;
    my $no_comments    = $translator->no_comments;
    my $add_drop_table = $translator->add_drop_table;
    my $schema         = $translator->schema;
    my $producer_args  = $translator->producer_args;
    my $sqlite_version  = $producer_args->{sqlite_version} || 0;

    debug("PKG: Beginning production\n");

    my @create = ();
    push @create, header_comment unless ($no_comments);
    $create[0] .= "\n\nBEGIN TRANSACTION";

    for my $table ( $schema->get_tables ) {
        push @create, create_table($table, { no_comments => $no_comments,
                                             sqlite_version => $sqlite_version,
                                          add_drop_table => $add_drop_table,});
    }

    for my $view ( $schema->get_views ) {
      push @create, create_view($view, {
        add_drop_view => $add_drop_table,
        no_comments   => $no_comments,
      });
    }

    for my $trigger ( $schema->get_triggers ) {
      push @create, create_trigger($trigger, {
        add_drop_trigger => $add_drop_table,
        no_comments   => $no_comments,
      });
    }

    return wantarray ? (@create, "COMMIT") : join(";\n\n", (@create, "COMMIT;\n"));
}

# -------------------------------------------------------------------
sub mk_name {
    my ($basename, $type, $scope, $critical) = @_;
    my $basename_orig = $basename;
    my $max_name      = !$max_id_length 
                      ? length($type) + 1
                      : $type 
                      ? $max_id_length - (length($type) + 1) 
                      : $max_id_length;
    $basename         = substr( $basename, 0, $max_name ) 
                        if length( $basename ) > $max_name;
    $basename         =~ s/\./_/g;
    my $name          = $type ? "${type}_$basename" : $basename;

    if ( $basename ne $basename_orig and $critical ) {
        my $show_type = $type ? "+'$type'" : "";
        warn "Truncating '$basename_orig'$show_type to $max_id_length ",
            "character limit to make '$name'\n" if $WARN;
        $truncated{ $basename_orig } = $name;
    }

    $scope ||= \%global_names;
    if ( my $prev = $scope->{ $name } ) {
        my $name_orig = $name;
        $name        .= sprintf( "%02d", ++$prev );
        substr($name, $max_id_length - 3) = "00" 
            if length( $name ) > $max_id_length;

        warn "The name '$name_orig' has been changed to ",
             "'$name' to make it unique.\n" if $WARN;

        $scope->{ $name_orig }++;
    }

    $scope->{ $name }++;
    return $name;
}

sub create_view {
    my ($view, $options) = @_;
    my $add_drop_view = $options->{add_drop_view};

    my $view_name = $view->name;
    debug("PKG: Looking at view '${view_name}'\n");

    # Header.  Should this look like what mysqldump produces?
    my $extra = $view->extra;
    my $create = '';
    $create .= "--\n-- View: ${view_name}\n--\n" unless $options->{no_comments};
    $create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
    $create .= 'CREATE';
    $create .= " TEMPORARY" if exists($extra->{temporary}) && $extra->{temporary};
    $create .= ' VIEW';
    $create .= " IF NOT EXISTS" if exists($extra->{if_not_exists}) && $extra->{if_not_exists};
    $create .= " ${view_name}";

    if( my $sql = $view->sql ){
      $create .= " AS\n    ${sql}";
    }
    return $create;
}


sub create_table
{
    my ($table, $options) = @_;

    my $table_name = $table->name;
    my $no_comments = $options->{no_comments};
    my $add_drop_table = $options->{add_drop_table};
    my $sqlite_version = $options->{sqlite_version} || 0;

    debug("PKG: Looking at table '$table_name'\n");

    my ( @index_defs, @constraint_defs );
    my @fields = $table->get_fields or die "No fields in $table_name";

    my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
    #
    # Header.
    #
    my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
    my @create;
    my ($comment, $create_table) = "";
    $comment =  "--\n-- Table: $table_name\n--\n" unless $no_comments;
    if ($add_drop_table) {
      push @create, $comment . qq[DROP TABLE$exists $table_name];
    } else {
      $create_table = $comment;
    }

    $create_table .= "CREATE ${temp}TABLE $table_name (\n";

    #
    # Comments
    #
    if ( $table->comments and !$no_comments ){
        $create_table .= "-- Comments: \n-- ";
        $create_table .= join "\n-- ",  $table->comments;
        $create_table .= "\n--\n\n";
    }

    #
    # How many fields in PK?
    #
    my $pk        = $table->primary_key;
    my @pk_fields = $pk ? $pk->fields : ();

    #
    # Fields
    #
    my ( @field_defs, $pk_set );
    for my $field ( @fields ) {
        push @field_defs, create_field($field);
    }

    if ( 
         scalar @pk_fields > 1 
         || 
         ( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs ) 
         ) {
        push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
    }

    #
    # Indices
    #
    my $idx_name_default = 'A';
    for my $index ( $table->get_indices ) {
        push @index_defs, create_index($index);
    }

    #
    # Constraints
    #
    my $c_name_default = 'A';
    for my $c ( $table->get_constraints ) {
        next unless $c->type eq UNIQUE; 
        push @constraint_defs, create_constraint($c);
    }

    $create_table .= join(",\n", map { "  $_" } @field_defs ) . "\n)";

    return (@create, $create_table, @index_defs, @constraint_defs );
}

sub create_field
{
    my ($field, $options) = @_;

    my $field_name = $field->name;
    debug("PKG: Looking at field '$field_name'\n");
    my $field_comments = $field->comments 
        ? "-- " . $field->comments . "\n  " 
        : '';

    my $field_def = $field_comments.$field_name;

    # data type and size
    my $size      = $field->size;
    my $data_type = $field->data_type;
    $data_type    = 'varchar' if lc $data_type eq 'set';
    $data_type  = 'blob' if lc $data_type eq 'bytea';

    if ( lc $data_type =~ /(text|blob)/i ) {
        $size = undef;
    }

#             if ( $data_type =~ /timestamp/i ) {
#                 push @trigger_defs, 
#                     "CREATE TRIGGER ts_${table_name} ".
#                     "after insert on $table_name\n".
#                     "begin\n".
#                     "  update $table_name set $field_name=timestamp() ".
#                        "where id=new.id;\n".
#                     "end;\n"
#                 ;
#
#            }

    #
    # SQLite is generally typeless, but newer versions will
    # make a field autoincrement if it is declared as (and
    # *only* as) INTEGER PRIMARY KEY
    #
    my $pk        = $field->table->primary_key;
    my @pk_fields = $pk ? $pk->fields : ();

    if ( 
         $field->is_primary_key && 
         scalar @pk_fields == 1 &&
         (
          $data_type =~ /int(eger)?$/i
          ||
          ( $data_type =~ /^number?$/i && $size !~ /,/ )
          )
         ) {
        $data_type = 'INTEGER PRIMARY KEY';
        $size      = undef;
#        $pk_set    = 1;
    }

    $field_def .= sprintf " %s%s", $data_type, 
    ( !$field->is_auto_increment && $size ) ? "($size)" : '';

    # Null?
    $field_def .= ' NOT NULL' unless $field->is_nullable;

    # Default?  XXX Need better quoting!
    my $default = $field->default_value;
    if (defined $default) {
        SQL::Translator::Producer->_apply_default_value(
            \$field_def,
            $default, 
            [
             'NULL'              => \'NULL',
             'now()'             => 'now()',
             'CURRENT_TIMESTAMP' => 'CURRENT_TIMESTAMP',
            ],
        );
    }

    return $field_def;

}

sub create_index
{
    my ($index, $options) = @_;

    my $name   = $index->name;
    $name      = mk_name($index->table->name, $name);

    my $type   = $index->type eq 'UNIQUE' ? "UNIQUE " : ''; 

    # strip any field size qualifiers as SQLite doesn't like these
    my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
    (my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
    warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
    my $index_def =  
    "CREATE ${type}INDEX $name ON " . $index_table_name .
        ' (' . join( ', ', @fields ) . ')';

    return $index_def;
}

sub create_constraint
{
    my ($c, $options) = @_;

    my $name   = $c->name;
    $name      = mk_name($c->table->name, $name);
    my @fields = $c->fields;
    (my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
    warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;

    my $c_def =  
    "CREATE UNIQUE INDEX $name ON " . $index_table_name .
        ' (' . join( ', ', @fields ) . ')';

    return $c_def;
}

sub create_trigger {
  my ($trigger, $options) = @_;
  my $add_drop = $options->{add_drop_trigger};

  my $name = $trigger->name;
  my @create;

  push @create,  "DROP TRIGGER IF EXISTS $name" if $add_drop;

  my $events = $trigger->database_events;
  die "Can't handle multiple events in triggers" if @$events > 1;

  my $action = "";
  
  $action = $trigger->ation->{for_each} . " "
    if $trigger->action->{for_each};

  $action = $trigger->action->{when} . " "
    if $trigger->action->{when};

  my $steps = $trigger->action->{steps} || [];

  $action .= "BEGIN ";
  for (@$steps) {
    $action .= $_ . "; "
  }
  $action .= "END";

  push @create, "CREATE TRIGGER $name " .
                $trigger->perform_action_when . " " .
                $events->[0] .
                " on " . $trigger->on_table . " " .
                $action;

  return @create;
            
}

sub alter_table { } # Noop

sub add_field {
  my ($field) = @_;

  return sprintf("ALTER TABLE %s ADD COLUMN %s",
      $field->table->name, create_field($field))
}

sub alter_create_index {
  my ($index) = @_;

  # This might cause name collisions
  return create_index($index);
}

sub alter_create_constraint {
  my ($constraint) = @_;

  return create_constraint($constraint) if $constraint->type eq 'UNIQUE';
}

sub alter_drop_constraint { alter_drop_index(@_) }

sub alter_drop_index {
  my ($constraint) = @_;

  return sprintf("DROP INDEX %s",
      $constraint->name);
}

sub batch_alter_table {
  my ($table, $diffs) = @_;

  # If we have any of the following
  #
  #  rename_field
  #  alter_field
  #  drop_field
  #
  # we need to do the following <http://www.sqlite.org/faq.html#q11>
  #
  # BEGIN TRANSACTION;
  # CREATE TEMPORARY TABLE t1_backup(a,b);
  # INSERT INTO t1_backup SELECT a,b FROM t1;
  # DROP TABLE t1;
  # CREATE TABLE t1(a,b);
  # INSERT INTO t1 SELECT a,b FROM t1_backup;
  # DROP TABLE t1_backup;
  # COMMIT;
  #
  # Fun, eh?
  #
  # If we have rename_field we do similarly.

  my $table_name = $table->name;
  my $renaming = $diffs->{rename_table} && @{$diffs->{rename_table}};

  if ( @{$diffs->{rename_field}} == 0 &&
       @{$diffs->{alter_field}}  == 0 &&
       @{$diffs->{drop_field}}   == 0
       ) {
#    return join("\n", map { 
    return map { 
        my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
        map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ?  ("$sql") : () } @{ $diffs->{$_} }
        
      } grep { @{$diffs->{$_}} } 
    qw/rename_table
       alter_drop_constraint
       alter_drop_index
       drop_field
       add_field
       alter_field
       rename_field
       alter_create_index
       alter_create_constraint
       alter_table/;
  }


  my @sql;
  my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
  
  do {
    local $table->{name} = $table_name . '_temp_alter';
    # We only want the table - dont care about indexes on tmp table
    my ($table_sql) = create_table($table, {no_comments => 1, temporary_table => 1});
    push @sql,$table_sql;
  };

  push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
             "DROP TABLE @{[$old_table]}",
             create_table($table, { no_comments => 1 }),
             "INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
             "DROP TABLE @{[$table_name]}_temp_alter";

  return @sql;
#  return join("", @sql, "");
}

sub drop_table {
  my ($table) = @_;
  return "DROP TABLE $table";
}

sub rename_table {
  my ($old_table, $new_table, $options) = @_;

  my $qt = $options->{quote_table_names} || '';

  return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";

}

# No-op. Just here to signify that we are a new style parser.
sub preproces_schema { }

1;

=pod

=head1 SEE ALSO

SQL::Translator, http://www.sqlite.org/.

=head1 AUTHOR

Ken Y. Clark C<< <kclark@cpan.orgE> >>.

Diff code added by Ash Berlin C<< <ash@cpan.org> >>.

=cut
Commit	Line	Data
758ab1cd	1	package SQL::Translator::Producer::SQLite;
	2
	3	# -------------------------------------------------------------------
821a0fde	4	# $Id$
758ab1cd	5	# -------------------------------------------------------------------
478f608d	6	# Copyright (C) 2002-2009 SQLFairy Authors
758ab1cd	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
20770e44	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
758ab1cd	40	use strict;
d0fcb05d	41	use warnings;
758ab1cd	42	use Data::Dumper;
b21bf652	43	use SQL::Translator::Schema::Constants;
5ee19df8	44	use SQL::Translator::Utils qw(debug header_comment);
758ab1cd	45
478f608d	46	use vars qw[ $DEBUG $WARN ];
5ee19df8	47
5ee19df8	48	$DEBUG = 0 unless defined $DEBUG;
5ee19df8	49	$WARN = 0 unless defined $WARN;
758ab1cd	50
d0fcb05d	51	our %used_identifiers = ();
	52	our $max_id_length = 30;
	53	our %global_names;
	54	our %truncated;
758ab1cd	55
758ab1cd	56	sub produce {
a1d94525	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;
d12f72ff	63	my $producer_args = $translator->producer_args;
d12f72ff	64	my $sqlite_version = $producer_args->{sqlite_version} \|\| 0;
758ab1cd	65
1a24938d	66	debug("PKG: Beginning production\n");
758ab1cd	67
24d9fe69	68	my @create = ();
24d9fe69	69	push @create, header_comment unless ($no_comments);
d0fcb05d	70	$create[0] .= "\n\nBEGIN TRANSACTION";
758ab1cd	71
b21bf652	72	for my $table ( $schema->get_tables ) {
24d9fe69	73	push @create, create_table($table, { no_comments => $no_comments,
d12f72ff	74	sqlite_version => $sqlite_version,
4d438549	75	add_drop_table => $add_drop_table,});
a5a882f0	76	}
a5a882f0	77
ec59a597	78	for my $view ( $schema->get_views ) {
24d9fe69	79	push @create, create_view($view, {
a25ac5d2	80	add_drop_view => $add_drop_table,
	81	no_comments => $no_comments,
	82	});
ec59a597	83	}
ec59a597	84
d0fcb05d	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
24d9fe69	92	return wantarray ? (@create, "COMMIT") : join(";\n\n", (@create, "COMMIT;\n"));
758ab1cd	93	}
758ab1cd	94
758ab1cd	95	# -------------------------------------------------------------------
	96	sub mk_name {
	97	my ($basename, $type, $scope, $critical) = @_;
	98	my $basename_orig = $basename;
d0fcb05d	99	my $max_name = !$max_id_length
	100	? length($type) + 1
	101	: $type
	102	? $max_id_length - (length($type) + 1)
	103	: $max_id_length;
758ab1cd	104	$basename = substr( $basename, 0, $max_name )
758ab1cd	105	if length( $basename ) > $max_name;
cc74bccc	106	$basename =~ s/\./_/g;
758ab1cd	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
ec59a597	133	sub create_view {
ec59a597	134	my ($view, $options) = @_;
a25ac5d2	135	my $add_drop_view = $options->{add_drop_view};
ec59a597	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};
a25ac5d2	144	$create .= "DROP VIEW IF EXISTS $view_name;\n" if $add_drop_view;
ec59a597	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 ){
a25ac5d2	152	$create .= " AS\n ${sql}";
ec59a597	153	}
ec59a597	154	return $create;
	155	}
	156
	157
bfb5a568	158	sub create_table
	159	{
	160	my ($table, $options) = @_;
758ab1cd	161
bfb5a568	162	my $table_name = $table->name;
	163	my $no_comments = $options->{no_comments};
	164	my $add_drop_table = $options->{add_drop_table};
3db73ef8	165	my $sqlite_version = $options->{sqlite_version} \|\| 0;
bfb5a568	166
	167	debug("PKG: Looking at table '$table_name'\n");
	168
d0fcb05d	169	my ( @index_defs, @constraint_defs );
bfb5a568	170	my @fields = $table->get_fields or die "No fields in $table_name";
bfb5a568	171
4d438549	172	my $temp = $options->{temporary_table} ? 'TEMPORARY ' : '';
bfb5a568	173	#
	174	# Header.
	175	#
d12f72ff	176	my $exists = ($sqlite_version >= 3.3) ? ' IF EXISTS' : '';
24d9fe69	177	my @create;
d0fcb05d	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";
bfb5a568	187
	188	#
	189	# Comments
	190	#
	191	if ( $table->comments and !$no_comments ){
24d9fe69	192	$create_table .= "-- Comments: \n-- ";
	193	$create_table .= join "\n-- ", $table->comments;
	194	$create_table .= "\n--\n\n";
bfb5a568	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
24d9fe69	236	$create_table .= join(",\n", map { " $_" } @field_defs ) . "\n)";
bfb5a568	237
d0fcb05d	238	return (@create, $create_table, @index_defs, @constraint_defs );
bfb5a568	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;
bc8e2aa1	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	);
bfb5a568	315	}
	316
	317	return $field_def;
	318
	319	}
	320
	321	sub create_index
	322	{
	323	my ($index, $options) = @_;
	324
	325	my $name = $index->name;
4d438549	326	$name = mk_name($index->table->name, $name);
	327
	328	my $type = $index->type eq 'UNIQUE' ? "UNIQUE " : '';
bfb5a568	329
	330	# strip any field size qualifiers as SQLite doesn't like these
	331	my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
cc74bccc	332	(my $index_table_name = $index->table->name) =~ s/^.+?\.//; # table name may not specify schema
cc74bccc	333	warn "removing schema name from '" . $index->table->name . "' to make '$index_table_name'\n" if $WARN;
bfb5a568	334	my $index_def =
907f8cea	335	"CREATE ${type}INDEX $name ON " . $index_table_name .
907f8cea	336	' (' . join( ', ', @fields ) . ')';
bfb5a568	337
	338	return $index_def;
	339	}
	340
	341	sub create_constraint
	342	{
	343	my ($c, $options) = @_;
	344
	345	my $name = $c->name;
4d438549	346	$name = mk_name($c->table->name, $name);
bfb5a568	347	my @fields = $c->fields;
cc74bccc	348	(my $index_table_name = $c->table->name) =~ s/^.+?\.//; # table name may not specify schema
cc74bccc	349	warn "removing schema name from '" . $c->table->name . "' to make '$index_table_name'\n" if $WARN;
bfb5a568	350
bfb5a568	351	my $c_def =
907f8cea	352	"CREATE UNIQUE INDEX $name ON " . $index_table_name .
907f8cea	353	' (' . join( ', ', @fields ) . ')';
bfb5a568	354
	355	return $c_def;
	356	}
	357
d0fcb05d	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
4d438549	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
ecf7f25d	423	return sprintf("DROP INDEX %s",
ecf7f25d	424	$constraint->name);
4d438549	425	}
	426
	427	sub batch_alter_table {
	428	my ($table, $diffs) = @_;
	429
4d438549	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?
46bf5655	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}};
4d438549	453
	454	if ( @{$diffs->{rename_field}} == 0 &&
	455	@{$diffs->{alter_field}} == 0 &&
46bf5655	456	@{$diffs->{drop_field}} == 0
46bf5655	457	) {
24d9fe69	458	# return join("\n", map {
24d9fe69	459	return map {
4d438549	460	my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
24d9fe69	461	map { my $sql = $meth->(ref $_ eq 'ARRAY' ? @$_ : $_); $sql ? ("$sql") : () } @{ $diffs->{$_} }
4d438549	462
46bf5655	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
24d9fe69	473	alter_table/;
4d438549	474	}
	475
	476
	477	my @sql;
46bf5655	478	my $old_table = $renaming ? $diffs->{rename_table}[0][0] : $table;
4d438549	479
4d438549	480	do {
46bf5655	481	local $table->{name} = $table_name . '_temp_alter';
4d438549	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
46bf5655	487	push @sql, "INSERT INTO @{[$table_name]}_temp_alter SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$old_table]}",
46bf5655	488	"DROP TABLE @{[$old_table]}",
4d438549	489	create_table($table, { no_comments => 1 }),
46bf5655	490	"INSERT INTO @{[$table_name]} SELECT @{[ join(', ', $old_table->get_fields)]} FROM @{[$table_name]}_temp_alter",
46bf5655	491	"DROP TABLE @{[$table_name]}_temp_alter";
4d438549	492
24d9fe69	493	return @sql;
24d9fe69	494	# return join("", @sql, "");
4d438549	495	}
	496
	497	sub drop_table {
	498	my ($table) = @_;
24d9fe69	499	return "DROP TABLE $table";
4d438549	500	}
4d438549	501
46bf5655	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
934e1b39	511	# No-op. Just here to signify that we are a new style parser.
	512	sub preproces_schema { }
	513
bfb5a568	514	1;
758ab1cd	515
20770e44	516	=pod
	517
	518	=head1 SEE ALSO
	519
	520	SQL::Translator, http://www.sqlite.org/.
758ab1cd	521
	522	=head1 AUTHOR
	523
4d438549	524	Ken Y. Clark C<< <kclark@cpan.orgE> >>.
	525
	526	Diff code added by Ash Berlin C<< <ash@cpan.org> >>.
20770e44	527
20770e44	528	=cut