package SQL::Translator::Producer::MySQL;
# -------------------------------------------------------------------
-# $Id: MySQL.pm,v 1.18 2003-05-03 15:17:23 kycl4rk Exp $
+# $Id: MySQL.pm,v 1.42 2005-01-13 11:50:23 grommit Exp $
# -------------------------------------------------------------------
-# Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>,
-# darren chamberlain <darren@cpan.org>,
-# Chris Mungall <cjm@fruitfly.org>
+# 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
# 02111-1307 USA
# -------------------------------------------------------------------
+=head1 NAME
+
+SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
+
+=head1 SYNOPSIS
+
+Use via SQL::Translator:
+
+ use SQL::Translator;
+
+ my $t = SQL::Translator->new( parser => '...', producer => 'MySQL', '...' );
+ $t->translate;
+
+=head1 DESCRIPTION
+
+This module will produce text output of the schema suitable for MySQL.
+There are still some issues to be worked out with syntax differences
+between MySQL versions 3 and 4 ("SET foreign_key_checks," character sets
+for fields, etc.).
+
+=head2 Table Types
+
+Normally the tables will be created without any explicit table type given and
+so will use the MySQL default.
+
+Any tables involved in foreign key constraints automatically get a table type
+of InnoDB, unless this is overridden by setting the C<mysql_table_type> extra
+attribute explicitly on the table.
+
+=head2 Extra attributes.
+
+The producer recognises the following extra attributes on the Schema objects.
+
+=over 4
+
+=item field.list
+
+Set the list of allowed values for Enum fields.
+
+=item field.binary field.unsigned field.zerofill
+
+Set the MySQL field options of the same name.
+
+=item mysql_table_type
+
+Set the type of the table e.g. 'InnoDB', 'MyISAM'. This will be
+automatically set for tables involved in foreign key constraints if it is
+not already set explicitly. See L<"Table Types">.
+
+=back
+
+=cut
+
use strict;
use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.42 $ =~ /(\d+)\.(\d+)/;
$DEBUG = 0 unless defined $DEBUG;
use Data::Dumper;
+use SQL::Translator::Schema::Constants;
use SQL::Translator::Utils qw(debug header_comment);
+#
+# Use only lowercase for the keys (e.g. "long" and not "LONG")
+#
my %translate = (
#
# Oracle types
#
varchar2 => 'varchar',
long => 'text',
- CLOB => 'longtext',
+ clob => 'longtext',
#
# Sybase types
real => 'double',
comment => 'text',
bit => 'tinyint',
+
+ #
+ # Access types
+ #
+ 'long integer' => 'integer',
+ 'text' => 'text',
+ 'datetime' => 'datetime',
);
sub produce {
- my ($translator, $data) = @_;
- local $DEBUG = $translator->debug;
- my $no_comments = $translator->no_comments;
- my $add_drop_table = $translator->add_drop_table;
+ my $translator = shift;
+ local $DEBUG = $translator->debug;
+ my $no_comments = $translator->no_comments;
+ my $add_drop_table = $translator->add_drop_table;
+ my $schema = $translator->schema;
+ my $show_warnings = $translator->show_warnings || 0;
debug("PKG: Beginning production\n");
my $create;
$create .= header_comment unless ($no_comments);
+ # \todo Don't set if MySQL 3.x is set on command line
+ $create .= "SET foreign_key_checks=0;\n\n";
- for my $table ( keys %{ $data } ) {
-
+ #
+ # Work out which tables need to be InnoDB to support foreign key
+ # constraints. We do this first as we need InnoDB at both ends.
+ #
+ foreach ( map { $_->get_constraints } $schema->get_tables ) {
+ foreach my $meth (qw/table reference_table/) {
+ my $table = $schema->get_table($_->$meth) || next;
+ next if $table->extra('mysql_table_type');
+ $table->extra( 'mysql_table_type' => 'InnoDB');
+ }
+ }
- debug("PKG: Looking at table '$table'\n");
- my $table_data = $data->{$table};
-#warn Dumper($table_data);
- my @fields = sort {
- $table_data->{'fields'}->{$a}->{'order'}
- <=>
- $table_data->{'fields'}->{$b}->{'order'}
- } keys %{$table_data->{'fields'}};
+ #
+ # Generate sql
+ #
+ for my $table ( $schema->get_tables ) {
+ my $table_name = $table->name;
+ debug("PKG: Looking at table '$table_name'\n");
#
# Header. Should this look like what mysqldump produces?
#
- $create .= "--\n-- Table: $table\n--\n" unless $no_comments;
- $create .= qq[DROP TABLE IF EXISTS $table;\n] if $add_drop_table;
- $create .= "CREATE TABLE $table (";
+ $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
+ $create .= qq[DROP TABLE IF EXISTS $table_name;\n] if $add_drop_table;
+ $create .= "CREATE TABLE $table_name (\n";
#
# Fields
#
- for (my $i = 0; $i <= $#fields; $i++) {
- my $field = $fields[$i];
- debug("PKG: Looking at field '$field'\n");
- my $field_data = $table_data->{'fields'}->{$field};
- my @fdata = ("", $field);
- $create .= "\n";
+ my @field_defs;
+ for my $field ( $table->get_fields ) {
+ my $field_name = $field->name;
+ debug("PKG: Looking at field '$field_name'\n");
+ my $field_def = $field_name;
# data type and size
- my $attr = uc $field_data->{'data_type'} eq 'SET'
- ? 'list' : 'size';
- my @values = @{ $field_data->{ $attr } || [] };
- my $data_type = $field_data->{'data_type'};
-
- if ( $data_type eq 'number' ) {
+ my $data_type = $field->data_type;
+ my @size = $field->size;
+ my %extra = $field->extra;
+ my $list = $extra{'list'} || [];
+ # \todo deal with embedded quotes
+ my $commalist = join( ', ', map { qq['$_'] } @$list );
+
+ #
+ # Oracle "number" type -- figure best MySQL type
+ #
+ if ( lc $data_type eq 'number' ) {
# not an integer
- if ( scalar @values > 1 ) {
+ if ( scalar @size > 1 ) {
$data_type = 'double';
}
- elsif ( $values[0] >= 12 ) {
+ elsif ( $size[0] && $size[0] >= 12 ) {
$data_type = 'bigint';
}
- elsif ( $values[0] <= 1 ) {
+ elsif ( $size[0] && $size[0] <= 1 ) {
$data_type = 'tinyint';
}
else {
$data_type = 'int';
}
}
- elsif ( exists $translate{ $data_type } ) {
- $data_type = $translate{ $data_type };
+ #
+ # Convert a large Oracle varchar to "text"
+ #
+ elsif ( $data_type =~ /char/i && $size[0] > 255 ) {
+ $data_type = 'text';
+ @size = ();
+ }
+ elsif ( $data_type =~ /char/i && ! $size[0] ) {
+ @size = (255);
+ }
+ elsif ( $data_type =~ /boolean/i ) {
+ $data_type = 'enum';
+ $commalist = "'0','1'";
+ }
+ elsif ( exists $translate{ lc $data_type } ) {
+ $data_type = $translate{ lc $data_type };
}
- push @fdata, sprintf "%s%s",
- $data_type,
- defined( $values[0] )
- ? '(' . join( ', ', @values ) . ')'
- : '';
+ @size = () if $data_type =~ /(text|blob)/i;
+
+ if ( $data_type =~ /(double|float)/ && scalar @size == 1 ) {
+ push @size, '0';
+ }
+
+ $field_def .= " $data_type";
+
+ if ( lc $data_type eq 'enum' ) {
+ $field_def .= '(' . $commalist . ')';
+ }
+ elsif ( defined $size[0] && $size[0] > 0 ) {
+ $field_def .= '(' . join( ', ', @size ) . ')';
+ }
# MySQL qualifiers
for my $qual ( qw[ binary unsigned zerofill ] ) {
- push @fdata, $qual
- if $field_data->{ $qual } ||
- $field_data->{ uc $qual };
+ my $val = $extra{ $qual || uc $qual } or next;
+ $field_def .= " $qual";
}
# Null?
- push @fdata, "NOT NULL" unless $field_data->{'null'};
+ $field_def .= ' NOT NULL' unless $field->is_nullable;
# Default? XXX Need better quoting!
- my $default = $field_data->{'default'};
+ my $default = $field->default_value;
if ( defined $default ) {
if ( uc $default eq 'NULL') {
- push @fdata, "DEFAULT NULL";
+ $field_def .= ' DEFAULT NULL';
} else {
- push @fdata, "DEFAULT '$default'";
+ $field_def .= " DEFAULT '$default'";
}
}
# auto_increment?
- push @fdata, "auto_increment" if $field_data->{'is_auto_inc'};
-
- # primary key?
- # This is taken care of in the indices, could be duplicated here
- # push @fdata, "PRIMARY KEY" if $field_data->{'is_primary_key'};
-
-
- $create .= (join " ", '', @fdata);
- $create .= "," unless ($i == $#fields);
+ $field_def .= " auto_increment" if $field->is_auto_increment;
+ push @field_defs, $field_def;
}
#
# Indices
#
- my @index_creates;
- my @indices = @{ $table_data->{'indices'} || [] };
- my @constraints = @{ $table_data->{'constraints'} || [] };
-
- for my $key ( @indices, @constraints ) {
- my ($name, $type, $fields) = @{ $key }{ qw[ name type fields ] };
- $name ||= '';
- $type ||= '';
- my $index_type =
- $type eq 'primary_key' ? 'PRIMARY KEY' :
- $type eq 'unique' ? 'UNIQUE KEY' :
- $type eq 'key' ? 'KEY' :
- $type eq 'normal' ? 'KEY' : '';
-
- next unless $index_type;
- push @index_creates,
- " $index_type $name (" . join( ', ', @$fields ) . ')';
- }
-
- if ( @index_creates ) {
- $create .= join(",\n", '', @index_creates);
+ my @index_defs;
+ my %indexed_fields;
+ for my $index ( $table->get_indices ) {
+ push @index_defs, join( ' ',
+ lc $index->type eq 'normal' ? 'INDEX' : $index->type,
+ $index->name,
+ '(' . join( ', ', $index->fields ) . ')'
+ );
+ $indexed_fields{ $_ } = 1 for $index->fields;
}
#
# Constraints -- need to handle more than just FK. -ky
#
my @constraint_defs;
- for my $constraint ( @constraints ) {
- my $name = $constraint->{'name'} || '';
- my $type = $constraint->{'type'};
- my $fields = $constraint->{'fields'};
- my $ref_table = $constraint->{'reference_table'};
- my $ref_fields = $constraint->{'reference_fields'};
- my $match_type = $constraint->{'match_type'} || '';
- my $on_delete = $constraint->{'on_delete_do'};
- my $on_update = $constraint->{'on_update_do'};
-
- if ( $type eq 'foreign_key' ) {
- my $def = join(' ', map { $_ || () } ' FOREIGN KEY', $name );
- if ( @$fields ) {
- $def .= ' (' . join( ', ', @$fields ) . ')';
+ my @constraints = $table->get_constraints;
+ for my $c ( @constraints ) {
+ my @fields = $c->fields or next;
+
+ if ( $c->type eq PRIMARY_KEY ) {
+ push @constraint_defs,
+ 'PRIMARY KEY (' . join(', ', @fields). ')';
+ }
+ elsif ( $c->type eq UNIQUE ) {
+ push @constraint_defs,
+ 'UNIQUE (' . join(', ', @fields). ')';
+ }
+ elsif ( $c->type eq FOREIGN_KEY ) {
+ #
+ # Make sure FK field is indexed or MySQL complains.
+ #
+ unless ( $indexed_fields{ $fields[0] } ) {
+ push @index_defs, "INDEX ($fields[0])";
+ $indexed_fields{ $fields[0] } = 1;
+ }
+
+ my $def = join(' ',
+ map { $_ || () } 'FOREIGN KEY', $c->name
+ );
+
+ $def .= ' (' . join( ', ', @fields ) . ')';
+
+ $def .= ' REFERENCES ' . $c->reference_table;
+
+ my @rfields = map { $_ || () } $c->reference_fields;
+ unless ( @rfields ) {
+ my $rtable_name = $c->reference_table;
+ if ( my $ref_table = $schema->get_table( $rtable_name ) ) {
+ push @rfields, $ref_table->primary_key;
+ }
+ else {
+ warn "Can't find reference table '$rtable_name' " .
+ "in schema\n" if $show_warnings;
+ }
}
- $def .= " REFERENCES $ref_table";
- if ( @{ $ref_fields || [] } ) {
- $def .= ' (' . join( ', ', @$ref_fields ) . ')';
+ if ( @rfields ) {
+ $def .= ' (' . join( ', ', @rfields ) . ')';
+ }
+ else {
+ warn "FK constraint on " . $table->name . '.' .
+ join('', @fields) . " has no reference fields\n"
+ if $show_warnings;
}
- if ( $match_type ) {
+ if ( $c->match_type ) {
$def .= ' MATCH ' .
- ( $match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
+ ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
}
- if ( @{ $on_delete || [] } ) {
- $def .= ' ON DELETE '.join(' ', @$on_delete);
+ if ( $c->on_delete ) {
+ $def .= ' ON DELETE '.join( ' ', $c->on_delete );
}
- if ( @{ $on_update || [] } ) {
- $def .= ' ON UPDATE '.join(' ', @$on_update);
+ if ( $c->on_update ) {
+ $def .= ' ON UPDATE '.join( ' ', $c->on_update );
}
push @constraint_defs, $def;
}
}
- $create .= join(",\n", '', @constraint_defs) if @constraint_defs;
+ $create .= join(",\n", map { " $_" }
+ @field_defs, @index_defs, @constraint_defs
+ );
#
# Footer
#
$create .= "\n)";
- while (
- my ( $key, $val ) = each %{ $table_data->{'table_options'} ||= {} }
- ) {
- $create .= " $key=$val"
- }
+ my $mysql_table_type = $table->extra('mysql_table_type');
+ $create .= " Type=$mysql_table_type" if $mysql_table_type;
$create .= ";\n\n";
}
}
1;
-__END__
-=head1 NAME
+# -------------------------------------------------------------------
-SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
+=pod
+
+=head1 SEE ALSO
-=head1 AUTHOR
+SQL::Translator, http://www.mysql.com/.
+
+=head1 AUTHORS
darren chamberlain E<lt>darren@cpan.orgE<gt>,
-Ken Y. Clark E<lt>kclark@cpan.orgE<gt>
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
+
+=cut
projects / dbsrgits/SQL-Translator.git / blobdiff