mysql_table_type extra data and InnoDB derivation fix.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / MySQL.pm
index d063e9e..5a5bba5 100644 (file)
@@ -1,11 +1,9 @@
 package SQL::Translator::Producer::MySQL;
 
 # -------------------------------------------------------------------
-# $Id: MySQL.pm,v 1.24 2003-08-16 15:56:58 rossta 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
@@ -22,22 +20,78 @@ package SQL::Translator::Producer::MySQL;
 # 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.24 $ =~ /(\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
@@ -47,6 +101,13 @@ my %translate  = (
     real       => 'double',
     comment    => 'text',
     bit        => 'tinyint',
+
+    #
+    # Access types
+    #
+    'long integer' => 'integer',
+    'text'         => 'text',
+    'datetime'     => 'datetime',
 );
 
 sub produce {
@@ -55,13 +116,30 @@ sub produce {
     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";
 
+    #
+    # 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');
+        }
+    }
+
+    #
+    # Generate sql
+    #
     for my $table ( $schema->get_tables ) {
         my $table_name = $table->name;
         debug("PKG: Looking at table '$table_name'\n");
@@ -87,7 +165,8 @@ sub produce {
             my @size      = $field->size;
             my %extra     = $field->extra;
             my $list      = $extra{'list'} || [];
-            my $commalist = "'" . join("','", @$list) . "'"; # \todo deal with embedded quotes
+            # \todo deal with embedded quotes
+            my $commalist = join( ', ', map { qq['$_'] } @$list );
 
             #
             # Oracle "number" type -- figure best MySQL type
@@ -97,32 +176,53 @@ sub produce {
                 if ( scalar @size > 1 ) {
                     $data_type = 'double';
                 }
-                elsif ( $size[0] >= 12 ) {
+                elsif ( $size[0] && $size[0] >= 12 ) {
                     $data_type = 'bigint';
                 }
-                elsif ( $size[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 };
+            }
+
+            @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 ) {
+                       } 
+            elsif ( defined $size[0] && $size[0] > 0 ) {
                 $field_def .= '(' . join( ', ', @size ) . ')';
             }
 
             # MySQL qualifiers
             for my $qual ( qw[ binary unsigned zerofill ] ) {
                 my $val = $extra{ $qual || uc $qual } or next;
-                $field_def .= " $val";
+                $field_def .= " $qual";
             }
 
             # Null?
@@ -147,19 +247,22 @@ sub produce {
         # Indices
         #
         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 $c ( $table->get_constraints ) {
+        my @constraints = $table->get_constraints;
+        for my $c ( @constraints ) {
             my @fields = $c->fields or next;
 
             if ( $c->type eq PRIMARY_KEY ) {
@@ -171,6 +274,14 @@ sub produce {
                     '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 
                 );
@@ -179,9 +290,26 @@ sub produce {
 
                 $def .= ' REFERENCES ' . $c->reference_table;
 
-                if ( my @rfields = $c->reference_fields ) {
+                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;
+                    }
+                }
+
+                if ( @rfields ) {
                     $def .= ' (' . join( ', ', @rfields ) . ')';
                 }
+                else {
+                    warn "FK constraint on " . $table->name . '.' .
+                        join('', @fields) . " has no reference fields\n" 
+                        if $show_warnings;
+                }
 
                 if ( $c->match_type ) {
                     $def .= ' MATCH ' . 
@@ -208,11 +336,8 @@ sub produce {
         # Footer
         #
         $create .= "\n)";
-#        while ( 
-#            my ( $key, $val ) = each %{ $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";
     }
 
@@ -220,13 +345,18 @@ sub produce {
 }
 
 1;
-__END__
 
-=head1 NAME
+# -------------------------------------------------------------------
 
-SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
+=pod
+
+=head1 SEE ALSO
+
+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