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

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

# -------------------------------------------------------------------
# $Id: SQLite.pm,v 1.15 2006-08-26 11:35:31 schiffbruechige Exp $
# -------------------------------------------------------------------
# Copyright (C) 2002-4 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 Data::Dumper;
use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(debug header_comment);

use vars qw[ $VERSION $DEBUG $WARN ];

$VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
$WARN = 0 unless defined $WARN;

my %used_identifiers = ();
my $max_id_length    = 30;
my %global_names;
my %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;

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

    my $create = '';
    $create .= header_comment unless ($no_comments);
    $create .= "BEGIN TRANSACTION;\n\n";

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

#    $create .= "COMMIT;\n";

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

# -------------------------------------------------------------------
sub mk_name {
    my ($basename, $type, $scope, $critical) = @_;
    my $basename_orig = $basename;
    my $max_name      = $type 
                        ? $max_id_length - (length($type) + 1) 
                        : $max_id_length;
    $basename         = substr( $basename, 0, $max_name ) 
                        if length( $basename ) > $max_name;
    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_table
{
    my ($table, $options) = @_;

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

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

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

    #
    # Header.
    #
    my $create = '';
    $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
    $create .= qq[DROP TABLE $table_name;\n] if $add_drop_table;
    $create .= "CREATE TABLE $table_name (\n";

    #
    # Comments
    #
    if ( $table->comments and !$no_comments ){
        $create .= "-- Comments: \n-- ";
        $create .= join "\n-- ",  $table->comments;
        $create .= "\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 .= join(",\n", map { "  $_" } @field_defs ) . "\n);\n";

    $create .= "\n";

    for my $def ( @index_defs, @constraint_defs, @trigger_defs ) {
        $create .= "$def\n";
    }
    return $create;
}

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 ) {
        if ( uc $default eq 'NULL') {
            $field_def .= ' DEFAULT NULL';
        } elsif ( $default eq 'now()' ||
                  $default eq 'CURRENT_TIMESTAMP' ) {
            $field_def .= ' DEFAULT CURRENT_TIMESTAMP';
        } elsif ( $default =~ /val\(/ ) {
            next;
        } else {
            $field_def .= " DEFAULT '$default'";
        }
    }

    return $field_def;

}

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

    my $name   = $index->name;
    $name      = mk_name($index->table->name, $name); #  || ++$idx_name_default);

    # strip any field size qualifiers as SQLite doesn't like these
    my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
    my $index_def =  
    "CREATE 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); # || ++$idx_name_default);
    my @fields = $c->fields;

    my $c_def =  
    "CREATE UNIQUE INDEX $name on " . $c->table->name .
        ' (' . join( ', ', @fields ) . ');';

    return $c_def;
}

1;

=pod

=head1 SEE ALSO

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

=head1 AUTHOR

Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.

=cut
Commit	Line	Data
758ab1cd	1	package SQL::Translator::Producer::SQLite;
	2
	3	# -------------------------------------------------------------------
8619aed2	4	# $Id: SQLite.pm,v 1.15 2006-08-26 11:35:31 schiffbruechige Exp $
758ab1cd	5	# -------------------------------------------------------------------
977651a5	6	# Copyright (C) 2002-4 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;
758ab1cd	41	use Data::Dumper;
b21bf652	42	use SQL::Translator::Schema::Constants;
5ee19df8	43	use SQL::Translator::Utils qw(debug header_comment);
758ab1cd	44
758ab1cd	45	use vars qw[ $VERSION $DEBUG $WARN ];
5ee19df8	46
8619aed2	47	$VERSION = sprintf "%d.%02d", q$Revision: 1.15 $ =~ /(\d+)\.(\d+)/;
5ee19df8	48	$DEBUG = 0 unless defined $DEBUG;
5ee19df8	49	$WARN = 0 unless defined $WARN;
758ab1cd	50
	51	my %used_identifiers = ();
	52	my $max_id_length = 30;
	53	my %global_names;
	54	my %truncated;
	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;
758ab1cd	63
1a24938d	64	debug("PKG: Beginning production\n");
758ab1cd	65
a5a882f0	66	my $create = '';
5ee19df8	67	$create .= header_comment unless ($no_comments);
a5a882f0	68	$create .= "BEGIN TRANSACTION;\n\n";
758ab1cd	69
bfb5a568	70	my @table_defs = ();
b21bf652	71	for my $table ( $schema->get_tables ) {
8619aed2	72	push @table_defs, create_table($table, { no_comments => $no_comments,
bfb5a568	73	add_drop_table => $add_drop_table,});
a5a882f0	74	}
a5a882f0	75
bfb5a568	76	# $create .= "COMMIT;\n";
a5a882f0	77
bfb5a568	78	return wantarray ? ($create, @table_defs, "COMMIT;\n") : join("\n", ($create, @table_defs, "COMMIT;\n"));
758ab1cd	79	}
758ab1cd	80
758ab1cd	81	# -------------------------------------------------------------------
	82	sub mk_name {
	83	my ($basename, $type, $scope, $critical) = @_;
	84	my $basename_orig = $basename;
	85	my $max_name = $type
	86	? $max_id_length - (length($type) + 1)
	87	: $max_id_length;
	88	$basename = substr( $basename, 0, $max_name )
	89	if length( $basename ) > $max_name;
	90	my $name = $type ? "${type}_$basename" : $basename;
	91
	92	if ( $basename ne $basename_orig and $critical ) {
	93	my $show_type = $type ? "+'$type'" : "";
	94	warn "Truncating '$basename_orig'$show_type to $max_id_length ",
	95	"character limit to make '$name'\n" if $WARN;
	96	$truncated{ $basename_orig } = $name;
	97	}
	98
	99	$scope \|\|= \%global_names;
	100	if ( my $prev = $scope->{ $name } ) {
	101	my $name_orig = $name;
	102	$name .= sprintf( "%02d", ++$prev );
	103	substr($name, $max_id_length - 3) = "00"
	104	if length( $name ) > $max_id_length;
	105
	106	warn "The name '$name_orig' has been changed to ",
	107	"'$name' to make it unique.\n" if $WARN;
	108
	109	$scope->{ $name_orig }++;
	110	}
	111
	112	$scope->{ $name }++;
	113	return $name;
	114	}
	115
bfb5a568	116	sub create_table
	117	{
	118	my ($table, $options) = @_;
758ab1cd	119
bfb5a568	120	my $table_name = $table->name;
	121	my $no_comments = $options->{no_comments};
	122	my $add_drop_table = $options->{add_drop_table};
	123
	124	debug("PKG: Looking at table '$table_name'\n");
	125
	126	my ( @index_defs, @constraint_defs, @trigger_defs );
	127	my @fields = $table->get_fields or die "No fields in $table_name";
	128
	129	#
	130	# Header.
	131	#
	132	my $create = '';
	133	$create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
	134	$create .= qq[DROP TABLE $table_name;\n] if $add_drop_table;
	135	$create .= "CREATE TABLE $table_name (\n";
	136
	137	#
	138	# Comments
	139	#
	140	if ( $table->comments and !$no_comments ){
	141	$create .= "-- Comments: \n-- ";
	142	$create .= join "\n-- ", $table->comments;
	143	$create .= "\n--\n\n";
	144	}
	145
	146	#
	147	# How many fields in PK?
	148	#
	149	my $pk = $table->primary_key;
	150	my @pk_fields = $pk ? $pk->fields : ();
	151
	152	#
	153	# Fields
	154	#
	155	my ( @field_defs, $pk_set );
	156	for my $field ( @fields ) {
	157	push @field_defs, create_field($field);
	158	}
	159
	160	if (
	161	scalar @pk_fields > 1
	162	\|\|
	163	( @pk_fields && !grep /INTEGER PRIMARY KEY/, @field_defs )
	164	) {
	165	push @field_defs, 'PRIMARY KEY (' . join(', ', @pk_fields ) . ')';
	166	}
	167
	168	#
	169	# Indices
	170	#
	171	my $idx_name_default = 'A';
	172	for my $index ( $table->get_indices ) {
	173	push @index_defs, create_index($index);
	174	}
	175
	176	#
	177	# Constraints
	178	#
	179	my $c_name_default = 'A';
	180	for my $c ( $table->get_constraints ) {
	181	next unless $c->type eq UNIQUE;
	182	push @constraint_defs, create_constraint($c);
	183	}
184
185	$create .= join(",\n", map { " $_" } @field_defs ) . "\n);\n";
186
187	$create .= "\n";
188
189	for my $def ( @index_defs, @constraint_defs, @trigger_defs ) {
190	$create .= "$def\n";
191	}
192	return $create;
193	}
194
195	sub create_field
196	{
197	my ($field, $options) = @_;
198
199	my $field_name = $field->name;
200	debug("PKG: Looking at field '$field_name'\n");
201	my $field_comments = $field->comments
202	? "-- " . $field->comments . "\n "
203	: '';
204
205	my $field_def = $field_comments.$field_name;
206
207	# data type and size
208	my $size = $field->size;
209	my $data_type = $field->data_type;
210	$data_type = 'varchar' if lc $data_type eq 'set';
211	$data_type = 'blob' if lc $data_type eq 'bytea';
212
213	if ( lc $data_type =~ /(text\|blob)/i ) {
214	$size = undef;
215	}
216
217	# if ( $data_type =~ /timestamp/i ) {
218	# push @trigger_defs,
219	# "CREATE TRIGGER ts_${table_name} ".
220	# "after insert on $table_name\n".
221	# "begin\n".
222	# " update $table_name set $field_name=timestamp() ".
223	# "where id=new.id;\n".
224	# "end;\n"
225	# ;
226	#
227	# }
228
229	#
230	# SQLite is generally typeless, but newer versions will
231	# make a field autoincrement if it is declared as (and
232	# only as) INTEGER PRIMARY KEY
233	#
234	my $pk = $field->table->primary_key;
235	my @pk_fields = $pk ? $pk->fields : ();
236
237	if (
238	$field->is_primary_key &&
239	scalar @pk_fields == 1 &&
240	(
241	$data_type =~ /int(eger)?$/i
242	\|\|
243	( $data_type =~ /^number?$/i && $size !~ /,/ )
244	)
245	) {
246	$data_type = 'INTEGER PRIMARY KEY';
247	$size = undef;
248	# $pk_set = 1;
249	}
250
251	$field_def .= sprintf " %s%s", $data_type,
252	( !$field->is_auto_increment && $size ) ? "($size)" : '';
253
254	# Null?
255	$field_def .= ' NOT NULL' unless $field->is_nullable;
256
257	# Default? XXX Need better quoting!
258	my $default = $field->default_value;
259	if ( defined $default ) {
260	if ( uc $default eq 'NULL') {
261	$field_def .= ' DEFAULT NULL';
262	} elsif ( $default eq 'now()' \|\|
263	$default eq 'CURRENT_TIMESTAMP' ) {
264	$field_def .= ' DEFAULT CURRENT_TIMESTAMP';
265	} elsif ( $default =~ /val\(/ ) {
266	next;
267	} else {
268	$field_def .= " DEFAULT '$default'";
269	}
270	}
271
272	return $field_def;
273
274	}
275
276	sub create_index
277	{
278	my ($index, $options) = @_;
279
280	my $name = $index->name;
281	$name = mk_name($index->table->name, $name); # \|\| ++$idx_name_default);
282
283	# strip any field size qualifiers as SQLite doesn't like these
284	my @fields = map { s/\(\d+\)$//; $_ } $index->fields;
285	my $index_def =
286	"CREATE INDEX $name on " . $index->table->name .
287	' (' . join( ', ', @fields ) . ');';
288
289	return $index_def;
290	}
291
292	sub create_constraint
293	{
294	my ($c, $options) = @_;
295
296	my $name = $c->name;
297	$name = mk_name($c->table->name, $name); # \|\| ++$idx_name_default);
298	my @fields = $c->fields;
299
300	my $c_def =
301	"CREATE UNIQUE INDEX $name on " . $c->table->name .
302	' (' . join( ', ', @fields ) . ');';
303
304	return $c_def;
305	}
306
307	1;
758ab1cd	308
20770e44	309	=pod
	310
	311	=head1 SEE ALSO
	312
	313	SQL::Translator, http://www.sqlite.org/.
758ab1cd	314
	315	=head1 AUTHOR
	316
20770e44	317	Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
	318
	319	=cut