X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FTranslator%2FProducer%2FMySQL.pm;h=6c20e566cf2acca05f098c57bd35aff7d33721bd;hb=1c680eb9aac43c469260f89be06027951722402e;hp=77e05d55e3afbad3839b7349b4e204467752f0fb;hpb=fa94b25f9fc0bb94cf13bf5d196230a6b9c36754;p=dbsrgits%2FSQL-Translator.git diff --git a/lib/SQL/Translator/Producer/MySQL.pm b/lib/SQL/Translator/Producer/MySQL.pm index 77e05d5..6c20e56 100644 --- a/lib/SQL/Translator/Producer/MySQL.pm +++ b/lib/SQL/Translator/Producer/MySQL.pm @@ -1,7 +1,7 @@ package SQL::Translator::Producer::MySQL; # ------------------------------------------------------------------- -# $Id: MySQL.pm,v 1.51 2006-11-09 18:19:05 schiffbruechige Exp $ +# $Id: MySQL.pm,v 1.54 2007-11-10 03:36:43 mwz444 Exp $ # ------------------------------------------------------------------- # Copyright (C) 2002-4 SQLFairy Authors # @@ -63,21 +63,17 @@ Set the list of allowed values for Enum fields. Set the MySQL field options of the same name. +=item field.renamed_from + +Used when producing diffs to say this column is the new name fo the specified +old column. + =item table.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">. -=item mysql_character_set - -MySql-4.1+. Set the tables character set. -Run SHOW CHARACTER SET to see list. - -=item mysql_collate - -MySql-4.1+. Set the tables colation order. - =item table.mysql_charset, table.mysql_collate Set the tables default charater set and collation order. @@ -92,8 +88,8 @@ Set the fields charater set and collation order. use strict; use warnings; -use vars qw[ $VERSION $DEBUG ]; -$VERSION = sprintf "%d.%02d", q$Revision: 1.51 $ =~ /(\d+)\.(\d+)/; +use vars qw[ $VERSION $DEBUG %used_names ]; +$VERSION = sprintf "%d.%02d", q$Revision: 1.54 $ =~ /(\d+)\.(\d+)/; $DEBUG = 0 unless defined $DEBUG; use Data::Dumper; @@ -128,9 +124,84 @@ my %translate = ( 'datetime' => 'datetime', ); + +sub preprocess_schema { + my ($class, $schema) = @_; + + # extra->{mysql_table_type} used to be the type. It belongs in options, so + # move it if we find it. Return Engine type if found in extra or options + my $mysql_table_type_to_options = sub { + my ($table) = @_; + + my $extra = $table->extra; + + my $extra_type = delete $extra->{mysql_table_type}; + + # Now just to find if there is already an Engine or Type option... + # and lets normalize it to ENGINE since: + # + # The ENGINE table option specifies the storage engine for the table. + # TYPE is a synonym, but ENGINE is the preferred option name. + # + + # We have to use the hash directly here since otherwise there is no way + # to remove options. + my $options = ( $table->{options} ||= []); + + # This assumes that there isn't both a Type and an Engine option. + for my $idx ( 0..$#{$options} ) { + my ($key, $value) = %{ $options->[$idx] }; + + next unless uc $key eq 'ENGINE' || uc $key eq 'TYPE'; + + # if the extra.mysql_table_type is given, use that + delete $options->[$idx]{$key}; + return $options->[$idx]{ENGINE} = $value || $extra_type; + + } + + if ($extra_type) { + push @$options, { ENGINE => $extra_type }; + return $extra_type; + } + + }; + + # Names are only specific to a given schema + local %used_names = (); + + # + # 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 my $table ( $schema->get_tables ) { + + $mysql_table_type_to_options->($table); + + foreach my $c( $table->get_constraints ) { + next unless $c->type eq FOREIGN_KEY; + + # Normalize constraint names here. + my $c_name = $c->name; + # Give the constraint a name if it doesn't have one, so it doens't feel + # left out + $c_name = $table->name . '_fk' unless length $c_name; + + $c->name( next_unused_name($c_name) ); + + for my $meth (qw/table reference_table/) { + my $table = $schema->get_table($c->$meth) || next; + next if $mysql_table_type_to_options->($table); + $table->options( { 'ENGINE' => 'InnoDB' } ); + } + } + } +} + sub produce { my $translator = shift; local $DEBUG = $translator->debug; + local %used_names; my $no_comments = $translator->no_comments; my $add_drop_table = $translator->add_drop_table; my $schema = $translator->schema; @@ -141,29 +212,19 @@ sub produce { $qf = '`' if $translator->quote_field_names; debug("PKG: Beginning production\n"); - + %used_names = (); 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 ) { - next unless $_->type eq FOREIGN_KEY; - 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'); - } - } + __PACKAGE__->preprocess_schema($schema); # # Generate sql # my @table_defs =(); + for my $table ( $schema->get_tables ) { # print $table->name, "\n"; push @table_defs, create_table($table, @@ -227,10 +288,10 @@ sub create_table my $constr = create_constraint($c, $options); push @constraint_defs, $constr if($constr); - unless ( $indexed_fields{ ($c->fields())[0] } ) { - push @index_defs, "INDEX ($qf" . ($c->fields())[0] . "$qf)"; - $indexed_fields{ ($c->fields())[0] } = 1; - } + unless ( $indexed_fields{ ($c->fields())[0] } || $c->type ne FOREIGN_KEY ) { + push @index_defs, "INDEX ($qf" . ($c->fields())[0] . "$qf)"; + $indexed_fields{ ($c->fields())[0] } = 1; + } } $create .= join(",\n", map { " $_" } @@ -241,33 +302,38 @@ sub create_table # Footer # $create .= "\n)"; - my $table_type_defined = 0; - for my $t1_option_ref ( $table->options ) { - my($key, $value) = %{$t1_option_ref}; - $table_type_defined = 1 - if uc $key eq 'ENGINE' or uc $key eq 'TYPE'; - $create .= " $key=$value"; - } - my $mysql_table_type = $table->extra('mysql_table_type'); - #my $charset = $table->extra('mysql_character_set'); - #my $collate = $table->extra('mysql_collate'); - #$create .= " Type=$mysql_table_type" if $mysql_table_type; - #$create .= " DEFAULT CHARACTER SET $charset" if $charset; - #$create .= " COLLATE $collate" if $collate; - $create .= " Type=$mysql_table_type" - if $mysql_table_type && !$table_type_defined; - my $charset = $table->extra('mysql_charset'); - my $collate = $table->extra('mysql_collate'); - my $comments = $table->comments; - - $create .= " DEFAULT CHARACTER SET $charset" if $charset; - $create .= " COLLATE $collate" if $collate; - $create .= qq[ comment='$comments'] if $comments; + $create .= generate_table_options($table) || ''; $create .= ";\n\n"; return $drop ? ($drop,$create) : $create; } +sub generate_table_options +{ + my ($table) = @_; + my $create; + + my $table_type_defined = 0; + for my $t1_option_ref ( $table->options ) { + my($key, $value) = %{$t1_option_ref}; + $table_type_defined = 1 + if uc $key eq 'ENGINE' or uc $key eq 'TYPE'; + $create .= " $key=$value"; + } + + my $mysql_table_type = $table->extra('mysql_table_type'); + $create .= " ENGINE=$mysql_table_type" + if $mysql_table_type && !$table_type_defined; + my $charset = $table->extra('mysql_charset'); + my $collate = $table->extra('mysql_collate'); + my $comments = $table->comments; + + $create .= " DEFAULT CHARACTER SET $charset" if $charset; + $create .= " COLLATE $collate" if $collate; + $create .= qq[ comment='$comments'] if $comments; + return $create; +} + sub create_field { my ($field, $options) = @_; @@ -376,6 +442,21 @@ sub create_field return $field_def; } +sub alter_create_index +{ + my ($index, $options) = @_; + + my $qt = $options->{quote_table_names} || ''; + my $qf = $options->{quote_field_names} || ''; + + return join( ' ', + 'ALTER TABLE', + $qt.$index->table->name.$qt, + 'ADD', + create_index(@_) + ); +} + sub create_index { my ($index, $options) = @_; @@ -383,19 +464,64 @@ sub create_index my $qf = $options->{quote_field_names} || ''; return join( ' ', - lc $index->type eq 'normal' ? 'INDEX' : $index->type, + lc $index->type eq 'normal' ? 'INDEX' : $index->type . ' INDEX', $index->name, '(' . $qf . join( "$qf, $qf", $index->fields ) . $qf . ')' ); } -sub create_constraint +sub alter_drop_index { - my ($c, $options) = @_; + my ($index, $options) = @_; + my $qt = $options->{quote_table_names} || ''; my $qf = $options->{quote_field_names} || ''; + + return join( ' ', + 'ALTER TABLE', + $qt.$index->table->name.$qt, + 'DROP', + 'INDEX', + $index->name || $index->fields + ); + +} + +sub alter_drop_constraint +{ + my ($c, $options) = @_; + + my $qt = $options->{quote_table_names} || ''; + my $qc = $options->{quote_constraint_names} || ''; + + my $out = sprintf('ALTER TABLE %s DROP %s %s', + $c->table->name, + $c->type, + $qc . $c->name . $qc ); + + return $out; +} + +sub alter_create_constraint +{ + my ($index, $options) = @_; + my $qt = $options->{quote_table_names} || ''; + return join( ' ', + 'ALTER TABLE', + $qt.$index->table->name.$qt, + 'ADD', + create_constraint(@_) ); +} + +sub create_constraint +{ + my ($c, $options) = @_; + + my $qf = $options->{quote_field_names} || ''; + my $qt = $options->{quote_table_names} || ''; + my $leave_name = $options->{leave_name} || undef; my @fields = $c->fields or next; @@ -413,9 +539,16 @@ sub create_constraint # Make sure FK field is indexed or MySQL complains. # + my $table = $c->table; + my $c_name = $c->name; + my $def = join(' ', - map { $_ || () } 'CONSTRAINT', $qt . $c->table . '_' . $c->name . $qt, 'FOREIGN KEY' - ); + map { $_ || () } + 'CONSTRAINT', + $qt . $c_name . $qt, + 'FOREIGN KEY' + ); + $def .= ' ('.$qf . join( "$qf, $qf", @fields ) . $qf . ')'; @@ -424,7 +557,7 @@ sub create_constraint my @rfields = map { $_ || () } $c->reference_fields; unless ( @rfields ) { my $rtable_name = $c->reference_table; - if ( my $ref_table = $c->table->schema->get_table( $rtable_name ) ) { + if ( my $ref_table = $table->schema->get_table( $rtable_name ) ) { push @rfields, $ref_table->primary_key; } else { @@ -437,7 +570,7 @@ sub create_constraint $def .= ' (' . $qf . join( "$qf, $qf", @rfields ) . $qf . ')'; } else { - warn "FK constraint on " . $c->table->name . '.' . + warn "FK constraint on " . $table->name . '.' . join('', @fields) . " has no reference fields\n" if $options->{show_warnings}; } @@ -460,6 +593,21 @@ sub create_constraint return undef; } +sub alter_table +{ + my ($to_table, $options) = @_; + + my $qt = $options->{quote_table_name} || ''; + + my $table_options = generate_table_options($to_table) || ''; + my $out = sprintf('ALTER TABLE %s%s', + $qt . $to_table->name . $qt, + $table_options); + + return $out; +} + +sub rename_field { alter_field(@_) } sub alter_field { my ($from_field, $to_field, $options) = @_; @@ -469,7 +617,7 @@ sub alter_field my $out = sprintf('ALTER TABLE %s CHANGE COLUMN %s %s', $qt . $to_field->table->name . $qt, - $qf . $to_field->name . $qf, + $qf . $from_field->name . $qf, create_field($to_field, $options)); return $out; @@ -504,6 +652,67 @@ sub drop_field } +sub batch_alter_table { + my ($table, $diff_hash, $options) = @_; + + my @stmts = map { + if (@{ $diff_hash->{$_} || [] }) { + my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_"; + map { $meth->(ref $_ eq 'ARRAY' ? @$_ : $_) } @{ $diff_hash->{$_} } + } else { () } + } qw/alter_drop_constraint + alter_drop_index + drop_field + add_field + alter_field + rename_field + alter_create_index + alter_create_constraint + alter_table/; + + return unless @stmts; + # Just zero or one stmts. return now + return "@stmts;" unless @stmts > 1; + + # Now strip off the 'ALTER TABLE xyz' of all but the first one + + my $qt = $options->{quote_table_name} || ''; + my $table_name = $qt . $table->name . $qt; + + my $first = shift @stmts; + my ($alter_table) = $first =~ /^(ALTER TABLE \Q$table_name\E )/; + my $re = qr/^$alter_table/; + my $padd = " " x length($alter_table); + + return join( ",\n", $first, map { s/$re//; $padd . $_ } @stmts) . ';'; +} + +sub drop_table { + my ($table) = @_; + + # Drop (foreign key) constraints so table drops cleanly + my @sql = batch_alter_table($table, { alter_drop_constraint => [ grep { $_->type eq 'FOREIGN KEY' } $table->get_constraints ] }); + + return join("\n", @sql, "DROP TABLE $table;"); + +} + +sub next_unused_name { + my $name = shift || ''; + if ( !defined($used_names{$name}) ) { + $used_names{$name} = $name; + return $name; + } + + my $i = 1; + while ( defined($used_names{$name . '_' . $i}) ) { + ++$i; + } + $name .= '_' . $i; + $used_names{$name} = $name; + return $name; +} + 1; # -------------------------------------------------------------------