1 package SQL::Translator::Producer::MySQL;
3 # -------------------------------------------------------------------
4 # Copyright (C) 2002-2009 SQLFairy Authors
6 # This program is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU General Public License as
8 # published by the Free Software Foundation; version 2.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 # -------------------------------------------------------------------
23 SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
27 Use via SQL::Translator:
31 my $t = SQL::Translator->new( parser => '...', producer => 'MySQL', '...' );
36 This module will produce text output of the schema suitable for MySQL.
37 There are still some issues to be worked out with syntax differences
38 between MySQL versions 3 and 4 ("SET foreign_key_checks," character sets
43 This producer takes a single optional producer_arg C<mysql_version>, which
44 provides the desired version for the target database. By default MySQL v3 is
45 assumed, and statements pertaining to any features introduced in later versions
46 (e.g. CREATE VIEW) are not produced.
48 Valid version specifiers for C<mysql_version> are listed L<here|SQL::Translator::Utils/parse_mysql_version>
52 Normally the tables will be created without any explicit table type given and
53 so will use the MySQL default.
55 Any tables involved in foreign key constraints automatically get a table type
56 of InnoDB, unless this is overridden by setting the C<mysql_table_type> extra
57 attribute explicitly on the table.
59 =head2 Extra attributes.
61 The producer recognises the following extra attributes on the Schema objects.
67 Set the list of allowed values for Enum fields.
69 =item B<field.binary>, B<field.unsigned>, B<field.zerofill>
71 Set the MySQL field options of the same name.
73 =item B<field.renamed_from>, B<table.renamed_from>
75 Use when producing diffs to indicate that the current table/field has been
76 renamed from the old name as given in the attribute value.
78 =item B<table.mysql_table_type>
80 Set the type of the table e.g. 'InnoDB', 'MyISAM'. This will be
81 automatically set for tables involved in foreign key constraints if it is
82 not already set explicitly. See L<"Table Types">.
84 Please note that the C<ENGINE> option is the preferred method of specifying
85 the MySQL storage engine to use, but this method still works for backwards
88 =item B<table.mysql_charset>, B<table.mysql_collate>
90 Set the tables default charater set and collation order.
92 =item B<field.mysql_charset>, B<field.mysql_collate>
94 Set the fields charater set and collation order.
102 use vars qw[ $VERSION $DEBUG %used_names ];
104 $DEBUG = 0 unless defined $DEBUG;
106 # Maximum length for most identifiers is 64, according to:
107 # http://dev.mysql.com/doc/refman/4.1/en/identifiers.html
108 # http://dev.mysql.com/doc/refman/5.0/en/identifiers.html
109 my $DEFAULT_MAX_ID_LENGTH = 64;
112 use SQL::Translator::Schema::Constants;
113 use SQL::Translator::Utils qw(debug header_comment
114 truncate_id_uniquely parse_mysql_version);
117 # Use only lowercase for the keys (e.g. "long" and not "LONG")
123 varchar2 => 'varchar',
139 'long integer' => 'integer',
141 'datetime' => 'datetime',
150 # Column types that do not support lenth attribute
152 my @no_length_attr = qw/
153 date time timestamp datetime year
157 sub preprocess_schema {
160 # extra->{mysql_table_type} used to be the type. It belongs in options, so
161 # move it if we find it. Return Engine type if found in extra or options
162 # Similarly for mysql_charset and mysql_collate
163 my $extra_to_options = sub {
164 my ($table, $extra_name, $opt_name) = @_;
166 my $extra = $table->extra;
168 my $extra_type = delete $extra->{$extra_name};
170 # Now just to find if there is already an Engine or Type option...
171 # and lets normalize it to ENGINE since:
173 # The ENGINE table option specifies the storage engine for the table.
174 # TYPE is a synonym, but ENGINE is the preferred option name.
177 # We have to use the hash directly here since otherwise there is no way
179 my $options = ( $table->{options} ||= []);
181 # If multiple option names, normalize to the first one
183 OPT_NAME: for ( @$opt_name[1..$#$opt_name] ) {
184 for my $idx ( 0..$#{$options} ) {
185 my ($key, $value) = %{ $options->[$idx] };
188 $options->[$idx] = { $opt_name->[0] => $value };
193 $opt_name = $opt_name->[0];
198 # This assumes that there isn't both a Type and an Engine option.
200 for my $idx ( 0..$#{$options} ) {
201 my ($key, $value) = %{ $options->[$idx] };
203 next unless uc $key eq $opt_name;
205 # make sure case is right on option name
206 delete $options->[$idx]{$key};
207 return $options->[$idx]{$opt_name} = $value || $extra_type;
212 push @$options, { $opt_name => $extra_type };
218 # Names are only specific to a given schema
219 local %used_names = ();
222 # Work out which tables need to be InnoDB to support foreign key
223 # constraints. We do this first as we need InnoDB at both ends.
225 foreach my $table ( $schema->get_tables ) {
227 $extra_to_options->($table, 'mysql_table_type', ['ENGINE', 'TYPE'] );
228 $extra_to_options->($table, 'mysql_charset', 'CHARACTER SET' );
229 $extra_to_options->($table, 'mysql_collate', 'COLLATE' );
231 foreach my $c ( $table->get_constraints ) {
232 next unless $c->type eq FOREIGN_KEY;
234 # Normalize constraint names here.
235 my $c_name = $c->name;
236 # Give the constraint a name if it doesn't have one, so it doens't feel
238 $c_name = $table->name . '_fk' unless length $c_name;
240 $c->name( next_unused_name($c_name) );
242 for my $meth (qw/table reference_table/) {
243 my $table = $schema->get_table($c->$meth) || next;
244 # This normalizes the types to ENGINE and returns the value if its there
245 next if $extra_to_options->($table, 'mysql_table_type', ['ENGINE', 'TYPE']);
246 $table->options( { 'ENGINE' => 'InnoDB' } );
248 } # foreach constraints
250 my %map = ( mysql_collate => 'collate', mysql_charset => 'character set');
251 foreach my $f ( $table->get_fields ) {
252 my $extra = $f->extra;
254 $extra->{$map{$_}} = delete $extra->{$_} if exists $extra->{$_};
258 if ( !$size[0] && $f->data_type =~ /char$/ ) {
267 my $translator = shift;
268 local $DEBUG = $translator->debug;
270 my $no_comments = $translator->no_comments;
271 my $add_drop_table = $translator->add_drop_table;
272 my $schema = $translator->schema;
273 my $show_warnings = $translator->show_warnings || 0;
274 my $producer_args = $translator->producer_args;
275 my $mysql_version = parse_mysql_version ($producer_args->{mysql_version}, 'perl') || 0;
276 my $max_id_length = $producer_args->{mysql_max_id_length} || $DEFAULT_MAX_ID_LENGTH;
278 my ($qt, $qf, $qc) = ('','', '');
279 $qt = '`' if $translator->quote_table_names;
280 $qf = '`' if $translator->quote_field_names;
282 debug("PKG: Beginning production\n");
285 $create .= header_comment unless ($no_comments);
286 # \todo Don't set if MySQL 3.x is set on command line
287 my @create = "SET foreign_key_checks=0";
289 preprocess_schema($schema);
296 for my $table ( $schema->get_tables ) {
297 # print $table->name, "\n";
298 push @table_defs, create_table($table,
299 { add_drop_table => $add_drop_table,
300 show_warnings => $show_warnings,
301 no_comments => $no_comments,
302 quote_table_names => $qt,
303 quote_field_names => $qf,
304 max_id_length => $max_id_length,
305 mysql_version => $mysql_version
309 if ($mysql_version >= 5.000001) {
310 for my $view ( $schema->get_views ) {
311 push @table_defs, create_view($view,
312 { add_replace_view => $add_drop_table,
313 show_warnings => $show_warnings,
314 no_comments => $no_comments,
315 quote_table_names => $qt,
316 quote_field_names => $qf,
317 max_id_length => $max_id_length,
318 mysql_version => $mysql_version
324 # print "@table_defs\n";
325 push @table_defs, "SET foreign_key_checks=1";
327 return wantarray ? ($create ? $create : (), @create, @table_defs) : ($create . join('', map { $_ ? "$_;\n\n" : () } (@create, @table_defs)));
331 my ($view, $options) = @_;
332 my $qt = $options->{quote_table_names} || '';
333 my $qf = $options->{quote_field_names} || '';
335 my $view_name = $view->name;
336 debug("PKG: Looking at view '${view_name}'\n");
338 # Header. Should this look like what mysqldump produces?
340 $create .= "--\n-- View: ${qt}${view_name}${qt}\n--\n" unless $options->{no_comments};
342 $create .= ' OR REPLACE' if $options->{add_replace_view};
345 my $extra = $view->extra;
347 if( exists($extra->{mysql_algorithm}) && defined(my $algorithm = $extra->{mysql_algorithm}) ){
348 $create .= " ALGORITHM = ${algorithm}\n" if $algorithm =~ /(?:UNDEFINED|MERGE|TEMPTABLE)/i;
351 if( exists($extra->{mysql_definer}) && defined(my $user = $extra->{mysql_definer}) ){
352 $create .= " DEFINER = ${user}\n";
355 if( exists($extra->{mysql_security}) && defined(my $security = $extra->{mysql_security}) ){
356 $create .= " SQL SECURITY ${security}\n" if $security =~ /(?:DEFINER|INVOKER)/i;
360 $create .= " VIEW ${qt}${view_name}${qt}";
362 if( my @fields = $view->fields ){
363 my $list = join ', ', map { "${qf}${_}${qf}"} @fields;
364 $create .= " ( ${list} )";
366 if( my $sql = $view->sql ){
367 # do not wrap parenthesis around the selector, mysql doesn't like this
368 # http://bugs.mysql.com/bug.php?id=9198
369 $create .= " AS\n ${sql}\n";
377 my ($table, $options) = @_;
379 my $qt = $options->{quote_table_names} || '';
380 my $qf = $options->{quote_field_names} || '';
382 my $table_name = quote_table_name($table->name, $qt);
383 debug("PKG: Looking at table '$table_name'\n");
386 # Header. Should this look like what mysqldump produces?
390 $create .= "--\n-- Table: $table_name\n--\n" unless $options->{no_comments};
391 $drop = qq[DROP TABLE IF EXISTS $table_name] if $options->{add_drop_table};
392 $create .= "CREATE TABLE $table_name (\n";
398 for my $field ( $table->get_fields ) {
399 push @field_defs, create_field($field, $options);
407 for my $index ( $table->get_indices ) {
408 push @index_defs, create_index($index, $options);
409 $indexed_fields{ $_ } = 1 for $index->fields;
413 # Constraints -- need to handle more than just FK. -ky
416 my @constraints = $table->get_constraints;
417 for my $c ( @constraints ) {
418 my $constr = create_constraint($c, $options);
419 push @constraint_defs, $constr if($constr);
421 unless ( $indexed_fields{ ($c->fields())[0] } || $c->type ne FOREIGN_KEY ) {
422 push @index_defs, "INDEX ($qf" . ($c->fields())[0] . "$qf)";
423 $indexed_fields{ ($c->fields())[0] } = 1;
427 $create .= join(",\n", map { " $_" }
428 @field_defs, @index_defs, @constraint_defs
435 $create .= generate_table_options($table, $options) || '';
436 # $create .= ";\n\n";
438 return $drop ? ($drop,$create) : $create;
441 sub quote_table_name {
442 my ($table_name, $qt) = @_;
444 $table_name =~ s/\./$qt.$qt/g;
446 return "$qt$table_name$qt";
449 sub generate_table_options
451 my ($table, $options) = @_;
454 my $table_type_defined = 0;
455 my $qf = $options->{quote_field_names} ||= '';
456 my $charset = $table->extra('mysql_charset');
457 my $collate = $table->extra('mysql_collate');
459 for my $t1_option_ref ( $table->options ) {
460 my($key, $value) = %{$t1_option_ref};
461 $table_type_defined = 1
462 if uc $key eq 'ENGINE' or uc $key eq 'TYPE';
463 if (uc $key eq 'CHARACTER SET') {
466 } elsif (uc $key eq 'COLLATE') {
469 } elsif (uc $key eq 'UNION') {
470 $union = "($qf". join("$qf, $qf", @$value) ."$qf)";
473 $create .= " $key=$value";
476 my $mysql_table_type = $table->extra('mysql_table_type');
477 $create .= " ENGINE=$mysql_table_type"
478 if $mysql_table_type && !$table_type_defined;
479 my $comments = $table->comments;
481 $create .= " DEFAULT CHARACTER SET $charset" if $charset;
482 $create .= " COLLATE $collate" if $collate;
483 $create .= " UNION=$union" if $union;
484 $create .= qq[ comment='$comments'] if $comments;
490 my ($field, $options) = @_;
492 my $qf = $options->{quote_field_names} ||= '';
494 my $field_name = $field->name;
495 debug("PKG: Looking at field '$field_name'\n");
496 my $field_def = "$qf$field_name$qf";
499 my $data_type = $field->data_type;
500 my @size = $field->size;
501 my %extra = $field->extra;
502 my $list = $extra{'list'} || [];
503 # \todo deal with embedded quotes
504 my $commalist = join( ', ', map { qq['$_'] } @$list );
505 my $charset = $extra{'mysql_charset'};
506 my $collate = $extra{'mysql_collate'};
508 my $mysql_version = $options->{mysql_version} || 0;
510 # Oracle "number" type -- figure best MySQL type
512 if ( lc $data_type eq 'number' ) {
514 if ( scalar @size > 1 ) {
515 $data_type = 'double';
517 elsif ( $size[0] && $size[0] >= 12 ) {
518 $data_type = 'bigint';
520 elsif ( $size[0] && $size[0] <= 1 ) {
521 $data_type = 'tinyint';
528 # Convert a large Oracle varchar to "text"
529 # (not necessary as of 5.0.3 http://dev.mysql.com/doc/refman/5.0/en/char.html)
531 elsif ( $data_type =~ /char/i && $size[0] > 255 ) {
532 unless ($size[0] <= 65535 && $mysql_version >= 5.000003 ) {
537 elsif ( $data_type =~ /boolean/i ) {
538 if ($mysql_version >= 4) {
539 $data_type = 'boolean';
542 $commalist = "'0','1'";
545 elsif ( exists $translate{ lc $data_type } ) {
546 $data_type = $translate{ lc $data_type };
549 @size = () if $data_type =~ /(text|blob)/i;
551 if ( $data_type =~ /(double|float)/ && scalar @size == 1 ) {
555 $field_def .= " $data_type";
557 if ( lc($data_type) eq 'enum' || lc($data_type) eq 'set') {
558 $field_def .= '(' . $commalist . ')';
561 defined $size[0] && $size[0] > 0
563 ! grep lc($data_type) eq $_, @no_length_attr
565 $field_def .= '(' . join( ', ', @size ) . ')';
569 $field_def .= " CHARACTER SET $charset" if $charset;
570 $field_def .= " COLLATE $collate" if $collate;
573 for my $qual ( qw[ binary unsigned zerofill ] ) {
574 my $val = $extra{ $qual } || $extra{ uc $qual } or next;
575 $field_def .= " $qual";
577 for my $qual ( 'character set', 'collate', 'on update' ) {
578 my $val = $extra{ $qual } || $extra{ uc $qual } or next;
579 $field_def .= " $qual $val";
583 $field_def .= ' NOT NULL' unless $field->is_nullable;
585 # Default? XXX Need better quoting!
586 my $default = $field->default_value;
587 if ( defined $default ) {
588 SQL::Translator::Producer->_apply_default_value(
597 if ( my $comments = $field->comments ) {
598 $field_def .= qq[ comment '$comments'];
602 $field_def .= " auto_increment" if $field->is_auto_increment;
607 sub alter_create_index
609 my ($index, $options) = @_;
611 my $qt = $options->{quote_table_names} || '';
612 my $qf = $options->{quote_field_names} || '';
616 $qt.$index->table->name.$qt,
624 my ( $index, $options ) = @_;
626 my $qf = $options->{quote_field_names} || '';
631 lc $index->type eq 'normal' ? 'INDEX' : $index->type . ' INDEX',
633 ? $qf . truncate_id_uniquely(
635 $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH
638 '(' . $qf . join( "$qf, $qf", $index->fields ) . $qf . ')'
644 my ($index, $options) = @_;
646 my $qt = $options->{quote_table_names} || '';
647 my $qf = $options->{quote_field_names} || '';
651 $qt.$index->table->name.$qt,
654 $index->name || $index->fields
659 sub alter_drop_constraint
661 my ($c, $options) = @_;
663 my $qt = $options->{quote_table_names} || '';
664 my $qc = $options->{quote_field_names} || '';
666 my $out = sprintf('ALTER TABLE %s DROP %s %s',
667 $qt . $c->table->name . $qt,
668 $c->type eq FOREIGN_KEY ? $c->type : "INDEX",
669 $qc . $c->name . $qc );
674 sub alter_create_constraint
676 my ($index, $options) = @_;
678 my $qt = $options->{quote_table_names} || '';
681 $qt.$index->table->name.$qt,
683 create_constraint(@_) );
686 sub create_constraint
688 my ($c, $options) = @_;
690 my $qf = $options->{quote_field_names} || '';
691 my $qt = $options->{quote_table_names} || '';
692 my $leave_name = $options->{leave_name} || undef;
694 my @fields = $c->fields or next;
696 if ( $c->type eq PRIMARY_KEY ) {
697 return 'PRIMARY KEY (' . $qf . join("$qf, $qf", @fields). $qf . ')';
699 elsif ( $c->type eq UNIQUE ) {
702 (defined $c->name ? $qf.truncate_id_uniquely( $c->name, $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH ).$qf.' ' : '').
703 '(' . $qf . join("$qf, $qf", @fields). $qf . ')';
705 elsif ( $c->type eq FOREIGN_KEY ) {
707 # Make sure FK field is indexed or MySQL complains.
710 my $table = $c->table;
711 my $c_name = truncate_id_uniquely( $c->name, $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH );
721 $def .= ' ('.$qf . join( "$qf, $qf", @fields ) . $qf . ')';
723 $def .= ' REFERENCES ' . $qt . $c->reference_table . $qt;
725 my @rfields = map { $_ || () } $c->reference_fields;
726 unless ( @rfields ) {
727 my $rtable_name = $c->reference_table;
728 if ( my $ref_table = $table->schema->get_table( $rtable_name ) ) {
729 push @rfields, $ref_table->primary_key;
732 warn "Can't find reference table '$rtable_name' " .
733 "in schema\n" if $options->{show_warnings};
738 $def .= ' (' . $qf . join( "$qf, $qf", @rfields ) . $qf . ')';
741 warn "FK constraint on " . $table->name . '.' .
742 join('', @fields) . " has no reference fields\n"
743 if $options->{show_warnings};
746 if ( $c->match_type ) {
748 ( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
751 if ( $c->on_delete ) {
752 $def .= ' ON DELETE '.join( ' ', $c->on_delete );
755 if ( $c->on_update ) {
756 $def .= ' ON UPDATE '.join( ' ', $c->on_update );
766 my ($to_table, $options) = @_;
768 my $qt = $options->{quote_table_names} || '';
770 my $table_options = generate_table_options($to_table, $options) || '';
771 my $out = sprintf('ALTER TABLE %s%s',
772 $qt . $to_table->name . $qt,
778 sub rename_field { alter_field(@_) }
781 my ($from_field, $to_field, $options) = @_;
783 my $qf = $options->{quote_field_names} || '';
784 my $qt = $options->{quote_table_names} || '';
786 my $out = sprintf('ALTER TABLE %s CHANGE COLUMN %s %s',
787 $qt . $to_field->table->name . $qt,
788 $qf . $from_field->name . $qf,
789 create_field($to_field, $options));
796 my ($new_field, $options) = @_;
798 my $qt = $options->{quote_table_names} || '';
800 my $out = sprintf('ALTER TABLE %s ADD COLUMN %s',
801 $qt . $new_field->table->name . $qt,
802 create_field($new_field, $options));
810 my ($old_field, $options) = @_;
812 my $qf = $options->{quote_field_names} || '';
813 my $qt = $options->{quote_table_names} || '';
815 my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
816 $qt . $old_field->table->name . $qt,
817 $qf . $old_field->name . $qf);
823 sub batch_alter_table {
824 my ($table, $diff_hash, $options) = @_;
826 # InnoDB has an issue with dropping and re-adding a FK constraint under the
827 # name in a single alter statment, see: http://bugs.mysql.com/bug.php?id=13741
829 # We have to work round this.
832 my %fks_to_drop = map {
833 $_->type eq FOREIGN_KEY
836 } @{$diff_hash->{alter_drop_constraint} };
838 my %fks_to_create = map {
839 if ( $_->type eq FOREIGN_KEY) {
840 $fks_to_alter{$_->name} = $fks_to_drop{$_->name} if $fks_to_drop{$_->name};
843 } @{$diff_hash->{alter_create_constraint} };
846 if (scalar keys %fks_to_alter) {
847 $diff_hash->{alter_drop_constraint} = [
848 grep { !$fks_to_alter{$_->name} } @{ $diff_hash->{alter_drop_constraint} }
851 @drop_stmt = batch_alter_table($table, { alter_drop_constraint => [ values %fks_to_alter ] }, $options);
856 if (@{ $diff_hash->{$_} || [] }) {
857 my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
858 map { $meth->( (ref $_ eq 'ARRAY' ? @$_ : $_), $options ) } @{ $diff_hash->{$_} }
861 alter_drop_constraint
868 alter_create_constraint
871 # rename_table makes things a bit more complex
872 my $renamed_from = "";
873 $renamed_from = $diff_hash->{rename_table}[0][0]->name
874 if $diff_hash->{rename_table} && @{$diff_hash->{rename_table}};
876 return unless @stmts;
877 # Just zero or one stmts. return now
878 return (@drop_stmt,@stmts) unless @stmts > 1;
880 # Now strip off the 'ALTER TABLE xyz' of all but the first one
882 my $qt = $options->{quote_table_names} || '';
883 my $table_name = $qt . $table->name . $qt;
886 my $re = $renamed_from
887 ? qr/^ALTER TABLE (?:\Q$table_name\E|\Q$qt$renamed_from$qt\E) /
888 : qr/^ALTER TABLE \Q$table_name\E /;
890 my $first = shift @stmts;
891 my ($alter_table) = $first =~ /($re)/;
893 my $padd = " " x length($alter_table);
895 return @drop_stmt, join( ",\n", $first, map { s/$re//; $padd . $_ } @stmts);
900 my ($table, $options) = @_;
902 my $qt = $options->{quote_table_names} || '';
904 # Drop (foreign key) constraints so table drops cleanly
905 my @sql = batch_alter_table($table, { alter_drop_constraint => [ grep { $_->type eq 'FOREIGN KEY' } $table->get_constraints ] }, $options);
907 return (@sql, "DROP TABLE $qt$table$qt");
908 # return join("\n", @sql, "DROP TABLE $qt$table$qt");
913 my ($old_table, $new_table, $options) = @_;
915 my $qt = $options->{quote_table_names} || '';
917 return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
920 sub next_unused_name {
921 my $name = shift || '';
922 if ( !defined($used_names{$name}) ) {
923 $used_names{$name} = $name;
928 while ( defined($used_names{$name . '_' . $i}) ) {
932 $used_names{$name} = $name;
938 # -------------------------------------------------------------------
944 SQL::Translator, http://www.mysql.com/.
948 darren chamberlain E<lt>darren@cpan.orgE<gt>,
949 Ken Youens-Clark E<lt>kclark@cpan.orgE<gt>.