Just a couple tweaks.
[dbsrgits/SQL-Translator.git] / lib / SQL / Translator / Producer / MySQL.pm
CommitLineData
9398955f 1package SQL::Translator::Producer::MySQL;
2
49e1eb70 3# -------------------------------------------------------------------
977651a5 4# $Id: MySQL.pm,v 1.31 2004-02-09 23:02:15 kycl4rk Exp $
49e1eb70 5# -------------------------------------------------------------------
977651a5 6# Copyright (C) 2002-4 SQLFairy Authors
9398955f 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
c855a748 23=head1 NAME
24
25SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
26
27=head1 SYNOPSIS
28
29Use via SQL::Translator:
30
31 use SQL::Translator;
32
33 my $t = SQL::Translator->new( parser => '...', producer => 'MySQL', '...' );
34 $t->translate;
35
36=head1 DESCRIPTION
37
38This module will produce text output of the schema suitable for MySQL.
39There are still some issues to be worked out with syntax differences
40between MySQL versions 3 and 4 ("SET foreign_key_checks," character sets
41for fields, etc.).
42
43=cut
44
9398955f 45use strict;
d529894e 46use vars qw[ $VERSION $DEBUG ];
977651a5 47$VERSION = sprintf "%d.%02d", q$Revision: 1.31 $ =~ /(\d+)\.(\d+)/;
5636ed00 48$DEBUG = 0 unless defined $DEBUG;
9398955f 49
50use Data::Dumper;
1c14e9f1 51use SQL::Translator::Schema::Constants;
5ee19df8 52use SQL::Translator::Utils qw(debug header_comment);
9398955f 53
d2344c83 54#
55# Use only lowercase for the keys (e.g. "long" and not "LONG")
56#
2620fc1c 57my %translate = (
58 #
59 # Oracle types
60 #
61 varchar2 => 'varchar',
62 long => 'text',
d2344c83 63 clob => 'longtext',
2620fc1c 64
65 #
66 # Sybase types
67 #
68 int => 'integer',
69 money => 'float',
70 real => 'double',
71 comment => 'text',
72 bit => 'tinyint',
73);
74
9398955f 75sub produce {
a1d94525 76 my $translator = shift;
77 local $DEBUG = $translator->debug;
78 my $no_comments = $translator->no_comments;
79 my $add_drop_table = $translator->add_drop_table;
80 my $schema = $translator->schema;
d529894e 81
1a24938d 82 debug("PKG: Beginning production\n");
d529894e 83
84 my $create;
5ee19df8 85 $create .= header_comment unless ($no_comments);
0823773d 86 # \todo Don't set if MySQL 3.x is set on command line
da147d03 87 $create .= "SET foreign_key_checks=0;\n\n";
9398955f 88
1c14e9f1 89 for my $table ( $schema->get_tables ) {
90 my $table_name = $table->name;
91 debug("PKG: Looking at table '$table_name'\n");
9398955f 92
d529894e 93 #
9398955f 94 # Header. Should this look like what mysqldump produces?
d529894e 95 #
1c14e9f1 96 $create .= "--\n-- Table: $table_name\n--\n" unless $no_comments;
97 $create .= qq[DROP TABLE IF EXISTS $table_name;\n] if $add_drop_table;
98 $create .= "CREATE TABLE $table_name (\n";
9398955f 99
d529894e 100 #
9398955f 101 # Fields
d529894e 102 #
1c14e9f1 103 my @field_defs;
104 for my $field ( $table->get_fields ) {
105 my $field_name = $field->name;
106 debug("PKG: Looking at field '$field_name'\n");
107 my $field_def = $field_name;
9398955f 108
109 # data type and size
1c14e9f1 110 my $data_type = $field->data_type;
111 my @size = $field->size;
35ed60b5 112 my %extra = $field->extra;
113 my $list = $extra{'list'} || [];
0823773d 114 # \todo deal with embedded quotes
4524cf01 115 my $commalist = join( ', ', map { qq['$_'] } @$list );
2620fc1c 116
1c14e9f1 117 #
118 # Oracle "number" type -- figure best MySQL type
119 #
120 if ( lc $data_type eq 'number' ) {
2620fc1c 121 # not an integer
1c14e9f1 122 if ( scalar @size > 1 ) {
2620fc1c 123 $data_type = 'double';
124 }
1c14e9f1 125 elsif ( $size[0] >= 12 ) {
2620fc1c 126 $data_type = 'bigint';
127 }
1c14e9f1 128 elsif ( $size[0] <= 1 ) {
2620fc1c 129 $data_type = 'tinyint';
130 }
131 else {
132 $data_type = 'int';
133 }
134 }
d2344c83 135 elsif ( exists $translate{ lc $data_type } ) {
136 $data_type = $translate{ lc $data_type };
2620fc1c 137 }
138
472b787e 139 @size = () if $data_type =~ /(text|blob)/i;
6d3f6379 140
1c14e9f1 141 $field_def .= " $data_type";
35ed60b5 142
143 if ( lc $data_type eq 'enum' ) {
144 $field_def .= '(' . $commalist . ')';
6d3f6379 145 }
146 elsif ( defined $size[0] && $size[0] > 0 ) {
1c14e9f1 147 $field_def .= '(' . join( ', ', @size ) . ')';
148 }
d529894e 149
150 # MySQL qualifiers
151 for my $qual ( qw[ binary unsigned zerofill ] ) {
1c14e9f1 152 my $val = $extra{ $qual || uc $qual } or next;
0823773d 153 $field_def .= " $qual";
d529894e 154 }
9398955f 155
156 # Null?
1c14e9f1 157 $field_def .= ' NOT NULL' unless $field->is_nullable;
9398955f 158
159 # Default? XXX Need better quoting!
1c14e9f1 160 my $default = $field->default_value;
d529894e 161 if ( defined $default ) {
162 if ( uc $default eq 'NULL') {
1c14e9f1 163 $field_def .= ' DEFAULT NULL';
9398955f 164 } else {
1c14e9f1 165 $field_def .= " DEFAULT '$default'";
9398955f 166 }
167 }
168
169 # auto_increment?
1c14e9f1 170 $field_def .= " auto_increment" if $field->is_auto_increment;
171 push @field_defs, $field_def;
56120730 172 }
9398955f 173
d529894e 174 #
175 # Indices
176 #
1c14e9f1 177 my @index_defs;
178 for my $index ( $table->get_indices ) {
179 push @index_defs, join( ' ',
35ed60b5 180 lc $index->type eq 'normal' ? 'INDEX' : $index->type,
1c14e9f1 181 $index->name,
182 '(' . join( ', ', $index->fields ) . ')'
183 );
d529894e 184 }
185
186 #
5e56da9a 187 # Constraints -- need to handle more than just FK. -ky
188 #
2620fc1c 189 my @constraint_defs;
1c14e9f1 190 for my $c ( $table->get_constraints ) {
191 my @fields = $c->fields or next;
5e56da9a 192
1c14e9f1 193 if ( $c->type eq PRIMARY_KEY ) {
194 push @constraint_defs,
195 'PRIMARY KEY (' . join(', ', @fields). ')';
196 }
197 elsif ( $c->type eq UNIQUE ) {
198 push @constraint_defs,
199 'UNIQUE (' . join(', ', @fields). ')';
200 }
201 elsif ( $c->type eq FOREIGN_KEY ) {
202 my $def = join(' ',
203 map { $_ || () } 'FOREIGN KEY', $c->name
204 );
205
206 $def .= ' (' . join( ', ', @fields ) . ')';
207
208 $def .= ' REFERENCES ' . $c->reference_table;
209
210 if ( my @rfields = $c->reference_fields ) {
211 $def .= ' (' . join( ', ', @rfields ) . ')';
5e56da9a 212 }
213
1c14e9f1 214 if ( $c->match_type ) {
5e56da9a 215 $def .= ' MATCH ' .
1c14e9f1 216 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
5e56da9a 217 }
218
1c14e9f1 219 if ( $c->on_delete ) {
220 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
586809da 221 }
222
1c14e9f1 223 if ( $c->on_update ) {
224 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
586809da 225 }
5e56da9a 226
2620fc1c 227 push @constraint_defs, $def;
5e56da9a 228 }
229 }
230
1c14e9f1 231 $create .= join(",\n", map { " $_" }
232 @field_defs, @index_defs, @constraint_defs
233 );
5e56da9a 234
235 #
9398955f 236 # Footer
d529894e 237 #
c45c546e 238 $create .= "\n)";
1c14e9f1 239# while (
240# my ( $key, $val ) = each %{ $table->options }
241# ) {
242# $create .= " $key=$val"
243# }
9398955f 244 $create .= ";\n\n";
245 }
246
9398955f 247 return $create;
248}
249
9398955f 2501;
9398955f 251
c855a748 252# -------------------------------------------------------------------
9398955f 253
c855a748 254=pod
255
256=head1 SEE ALSO
257
258SQL::Translator, http://www.mysql.com/.
9398955f 259
2d6979da 260=head1 AUTHORS
9398955f 261
758ab1cd 262darren chamberlain E<lt>darren@cpan.orgE<gt>,
c855a748 263Ken Y. Clark E<lt>kclark@cpan.orgE<gt>.
264
265=cut