Removed some old code, make table type "InnoDB" if there's a FK constraint.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / MySQL.pm
index c97b433..8b2c45d 100644 (file)
@@ -1,11 +1,9 @@
 package SQL::Translator::Producer::MySQL;
 
 # -------------------------------------------------------------------
-# $Id: MySQL.pm,v 1.5 2003-01-27 17:04:46 dlc Exp $
+# $Id: MySQL.pm,v 1.34 2004-08-05 15:41:46 kycl4rk 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,122 +20,240 @@ 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.).
+
+=cut
+
 use strict;
 use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.5 $ =~ /(\d+)\.(\d+)/;
-$DEBUG   = 1 unless defined $DEBUG;
+$VERSION = sprintf "%d.%02d", q$Revision: 1.34 $ =~ /(\d+)\.(\d+)/;
+$DEBUG   = 0 unless defined $DEBUG;
 
 use Data::Dumper;
+use SQL::Translator::Schema::Constants;
+use SQL::Translator::Utils qw(debug header_comment);
 
-sub import {
-    warn "loading " . __PACKAGE__ . "...\n";
-}
+#
+# Use only lowercase for the keys (e.g. "long" and not "LONG")
+#
+my %translate  = (
+    #
+    # Oracle types
+    #
+    varchar2   => 'varchar',
+    long       => 'text',
+    clob       => 'longtext',
+
+    #
+    # Sybase types
+    #
+    int        => 'integer',
+    money      => 'float',
+    real       => 'double',
+    comment    => 'text',
+    bit        => 'tinyint',
+
+    #
+    # Access types
+    #
+    'long integer' => 'integer',
+    'text'         => 'text',
+    'datetime'     => 'datetime',
+);
 
 sub produce {
-    my ($translator, $data) = @_;
-    $DEBUG                  = $translator->debug;
-    my $no_comments         = $translator->no_comments;
+    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;
 
-    debug("Beginning production\n");
+    debug("PKG: Beginning production\n");
 
     my $create; 
-    unless ( $no_comments ) {
-        $create .= sprintf "--\n-- Created by %s\n-- Created on %s\n--\n\n",
-            __PACKAGE__, scalar localtime;
-    }
+    $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}) {
-        debug("Looking at table '$table'\n");
-        my $table_data = $data->{$table};
-        my @fields = sort { 
-            $table_data->{'fields'}->{$a}->{'order'} 
-            <=>
-            $table_data->{'fields'}->{$b}->{'order'}
-        } keys %{$table_data->{'fields'}};
+    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 .= "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("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 } || [] };
-            push @fdata, sprintf "%s%s", 
-                $field_data->{'data_type'},
-                ( @values )
-                    ? '('.join(', ', @values).')'
-                    : '';
+            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 @size > 1 ) {
+                    $data_type = 'double';
+                }
+                elsif ( $size[0] >= 12 ) {
+                    $data_type = 'bigint';
+                }
+                elsif ( $size[0] <= 1 ) {
+                    $data_type = 'tinyint';
+                }
+                else {
+                    $data_type = 'int';
+                }
+            }
+            #
+            # Convert a large Oracle varchar to "text"
+            #
+            elsif ( lc $data_type eq 'varchar2' && $size[0] > 255 ) {
+                $data_type = 'text';
+                @size      = ();
+            }
+            elsif ( exists $translate{ lc $data_type } ) {
+                $data_type = $translate{ lc $data_type };
+            }
+
+            @size = () if $data_type =~ /(text|blob)/i;
+
+            $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'} || [] };
-        for (my $i = 0; $i <= $#indices; $i++) {
-            my $key  = $indices[$i];
-            my ($name, $type, $fields) = @{ $key }{ qw[ name type fields ] };
-            $name ||= '';
-            my $index_type = 
-                $type eq 'primary_key' ? 'PRIMARY KEY' :
-                $type eq 'unique'      ? 'UNIQUE KEY'  : 'KEY';
-            push @index_creates, 
-                "  $index_type $name (" . join( ', ', @$fields ) . ')';
+        my @index_defs;
+        for my $index ( $table->get_indices ) {
+            push @index_defs, join( ' ', 
+                lc $index->type eq 'normal' ? 'INDEX' : $index->type,
+                $index->name,
+                '(' . join( ', ', $index->fields ) . ')'
+            );
         }
 
-        if ( @index_creates ) {
-            $create .= join(",\n", '', @index_creates);
+        #
+        # Constraints -- need to handle more than just FK. -ky
+        #
+        my @constraint_defs;
+        my $has_fk;
+        for my $c ( $table->get_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 ) {
+                $has_fk = 1;
+                my $def = join(' ', 
+                    map { $_ || () } 'FOREIGN KEY', $c->name 
+                );
+
+                $def .= ' (' . join( ', ', @fields ) . ')';
+
+                $def .= ' REFERENCES ' . $c->reference_table;
+
+                if ( my @rfields = $c->reference_fields ) {
+                    $def .= ' (' . join( ', ', @rfields ) . ')';
+                }
+
+                if ( $c->match_type ) {
+                    $def .= ' MATCH ' . 
+                        ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
+                }
+
+                if ( $c->on_delete ) {
+                    $def .= ' ON DELETE '.join( ' ', $c->on_delete );
+                }
+
+                if ( $c->on_update ) {
+                    $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+                }
+
+                push @constraint_defs, $def;
+            }
         }
 
+        $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" 
+        if ( $has_fk ) {
+            $create .= " Type=InnoDB";
         }
         $create .= ";\n\n";
     }
@@ -145,19 +261,19 @@ sub produce {
     return $create;
 }
 
-sub debug {
-    if ($DEBUG) {
-        map { warn "[" . __PACKAGE__ . "] $_" } @_;
-    }
-}
-
 1;
-__END__
 
-=head1 NAME
+# -------------------------------------------------------------------
+
+=pod
+
+=head1 SEE ALSO
+
+SQL::Translator, http://www.mysql.com/.
 
-SQL::Translator::Producer::MySQL - mysql-specific producer for SQL::Translator
+=head1 AUTHORS
 
-=head1 AUTHOR
+darren chamberlain E<lt>darren@cpan.orgE<gt>,
+Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
 
-darren chamberlain E<lt>darren@cpan.orgE<gt>
+=cut