package SQL::Translator::Producer::MySQL;
# -------------------------------------------------------------------
-# $Id: MySQL.pm,v 1.52 2006-11-27 19:28:04 schiffbruechige Exp $
+# $Id: MySQL.pm,v 1.54 2007-11-10 03:36:43 mwz444 Exp $
# -------------------------------------------------------------------
# Copyright (C) 2002-4 SQLFairy Authors
#
=over 4
-=item field.list
+=item B<field.list>
Set the list of allowed values for Enum fields.
-=item field.binary, field.unsigned, field.zerofill
+=item B<field.binary>, B<field.unsigned>, B<field.zerofill>
Set the MySQL field options of the same name.
-=item table.mysql_table_type
+=item B<field.renamed_from>, B<table.renamed_from>
+
+Use when producing diffs to indicate that the current table/field has been
+renamed from the old name as given in the attribute value.
+
+=item B<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
+Please note that the C<ENGINE> option is the prefered method of specifying
+the MySQL storage engine to use, but this method still works for backwards
+compatability.
-MySql-4.1+. Set the tables colation order.
-
-=item table.mysql_charset, table.mysql_collate
+=item B<table.mysql_charset>, B<table.mysql_collate>
Set the tables default charater set and collation order.
-=item field.mysql_charset, field.mysql_collate
+=item B<field.mysql_charset>, B<field.mysql_collate>
Set the fields charater set and collation order.
use strict;
use warnings;
-use vars qw[ $VERSION $DEBUG ];
-$VERSION = sprintf "%d.%02d", q$Revision: 1.52 $ =~ /(\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;
'datetime' => 'datetime',
);
+
+sub preprocess_schema {
+ my ($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
+ # Similarly for mysql_charset and mysql_collate
+ my $extra_to_options = sub {
+ my ($table, $extra_name, $opt_name) = @_;
+
+ my $extra = $table->extra;
+
+ my $extra_type = delete $extra->{$extra_name};
+
+ # 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} ||= []);
+
+ # If multiple option names, normalize to the first one
+ if (ref $opt_name) {
+ OPT_NAME: for ( @$opt_name[1..$#$opt_name] ) {
+ for my $idx ( 0..$#{$options} ) {
+ my ($key, $value) = %{ $options->[$idx] };
+
+ if (uc $key eq $_) {
+ $options->[$idx] = { $opt_name->[0] => $value };
+ last OPT_NAME;
+ }
+ }
+ }
+ $opt_name = $opt_name->[0];
+
+ }
+
+
+ # This assumes that there isn't both a Type and an Engine option.
+ OPTION:
+ for my $idx ( 0..$#{$options} ) {
+ my ($key, $value) = %{ $options->[$idx] };
+
+ next unless uc $key eq $opt_name;
+
+ # make sure case is right on option name
+ delete $options->[$idx]{$key};
+ return $options->[$idx]{$opt_name} = $value || $extra_type;
+
+ }
+
+ if ($extra_type) {
+ push @$options, { $opt_name => $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 ) {
+
+ $extra_to_options->($table, 'mysql_table_type', ['ENGINE', 'TYPE'] );
+ $extra_to_options->($table, 'mysql_charset', 'CHARACTER SET' );
+ $extra_to_options->($table, 'mysql_collate', 'COLLATE' );
+
+ 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;
+ # This normalizes the types to ENGINE and returns the value if its there
+ next if $extra_to_options->($table, 'mysql_table_type', ['ENGINE', 'TYPE']);
+ $table->options( { 'ENGINE' => 'InnoDB' } );
+ }
+ } # foreach constraints
+
+ foreach my $f ( $table->get_fields ) {
+ my @size = $f->size;
+ if ( !$size[0] && $f->data_type =~ /char$/ ) {
+ $f->size( (255) );
+ }
+ }
+
+ }
+}
+
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;
my $show_warnings = $translator->show_warnings || 0;
- my ($qt, $qf) = ('','');
+ my ($qt, $qf, $qc) = ('','', '');
$qt = '`' if $translator->quote_table_names;
$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');
- }
- }
+ preprocess_schema($schema);
#
# Generate sql
#
my @table_defs =();
+
for my $table ( $schema->get_tables ) {
# print $table->name, "\n";
push @table_defs, create_table($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 { " $_" }
# 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;
+ my $charset = $table->extra('mysql_charset');
+ my $collate = $table->extra('mysql_collate');
+ 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';
+ if (uc $key eq 'CHARACTER SET') {
+ $charset = $value;
+ next;
+ } elsif (uc $key eq 'COLLATE') {
+ $collate = $value;
+ next;
+ }
+ $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 $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) = @_;
$data_type = 'text';
@size = ();
}
- elsif ( $data_type =~ /char/i && ! $size[0] ) {
- @size = (255);
- }
elsif ( $data_type =~ /boolean/i ) {
$data_type = 'enum';
$commalist = "'0','1'";
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) = @_;
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 alter_drop_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,
+ 'DROP',
+ 'INDEX',
+ $index->name || $index->fields
+ );
+
+}
+
+sub alter_drop_constraint
+{
+ my ($c, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+ my $qc = $options->{quote_field_names} || '';
+
+ my $out = sprintf('ALTER TABLE %s DROP %s %s',
+ $qt . $c->table->name . $qt,
+ $c->type eq FOREIGN_KEY ? $c->type : "INDEX",
+ $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 $counter = ($options->{fk_name_counter} ||= {});
+ my $leave_name = $options->{leave_name} || undef;
my @fields = $c->fields or next;
# Make sure FK field is indexed or MySQL complains.
#
- $counter->{$c->table} ||= {};
+ my $table = $c->table;
+ my $c_name = $c->name;
+
my $def = join(' ',
map { $_ || () }
'CONSTRAINT',
- $qt . join('_', $c->table,
- $c->name,
- ($counter->{$c->table}{$c->name}++ || ())
- ) . $qt,
+ $qf . $c_name . $qf,
'FOREIGN KEY'
);
+
$def .= ' ('.$qf . join( "$qf, $qf", @fields ) . $qf . ')';
$def .= ' REFERENCES ' . $qt . $c->reference_table . $qt;
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 {
$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};
}
return undef;
}
+sub alter_table
+{
+ my ($to_table, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+
+ 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) = @_;
- my $qf = $options->{quote_field_name} || '';
- my $qt = $options->{quote_table_name} || '';
+ my $qf = $options->{quote_field_names} || '';
+ my $qt = $options->{quote_table_names} || '';
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;
{
my ($new_field, $options) = @_;
- my $qt = $options->{quote_table_name} || '';
+ my $qt = $options->{quote_table_names} || '';
my $out = sprintf('ALTER TABLE %s ADD COLUMN %s',
$qt . $new_field->table->name . $qt,
{
my ($old_field, $options) = @_;
- my $qf = $options->{quote_field_name} || '';
- my $qt = $options->{quote_table_name} || '';
+ my $qf = $options->{quote_field_names} || '';
+ my $qt = $options->{quote_table_names} || '';
my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
$qt . $old_field->table->name . $qt,
}
+sub batch_alter_table {
+ my ($table, $diff_hash, $options) = @_;
+
+ # InnoDB has an issue with dropping and re-adding a FK constraint under the
+ # name in a single alter statment, see: http://bugs.mysql.com/bug.php?id=13741
+ #
+ # We have to work round this.
+
+ my %fks_to_alter;
+ my %fks_to_drop = map {
+ $_->type eq FOREIGN_KEY
+ ? ( $_->name => $_ )
+ : ( )
+ } @{$diff_hash->{alter_drop_constraint} };
+
+ my %fks_to_create = map {
+ if ( $_->type eq FOREIGN_KEY) {
+ $fks_to_alter{$_->name} = $fks_to_drop{$_->name} if $fks_to_drop{$_->name};
+ ( $_->name => $_ );
+ } else { ( ) }
+ } @{$diff_hash->{alter_create_constraint} };
+
+ my $drop_stmt = '';
+ if (scalar keys %fks_to_alter) {
+ $diff_hash->{alter_drop_constraint} = [
+ grep { !$fks_to_alter{$_->name} } @{ $diff_hash->{alter_drop_constraint} }
+ ];
+
+ $drop_stmt = batch_alter_table($table, { alter_drop_constraint => [ values %fks_to_alter ] }, $options)
+ . "\n";
+
+ }
+
+ my @stmts = map {
+ if (@{ $diff_hash->{$_} || [] }) {
+ my $meth = __PACKAGE__->can($_) or die __PACKAGE__ . " cant $_";
+ map { $meth->( (ref $_ eq 'ARRAY' ? @$_ : $_), $options ) } @{ $diff_hash->{$_} }
+ } else { () }
+ } qw/rename_table
+ alter_drop_constraint
+ alter_drop_index
+ drop_field
+ add_field
+ alter_field
+ rename_field
+ alter_create_index
+ alter_create_constraint
+ alter_table/;
+
+ # rename_table makes things a bit more complex
+ my $renamed_from = "";
+ $renamed_from = $diff_hash->{rename_table}[0][0]->name
+ if $diff_hash->{rename_table} && @{$diff_hash->{rename_table}};
+
+ return unless @stmts;
+ # Just zero or one stmts. return now
+ return "$drop_stmt@stmts;" unless @stmts > 1;
+
+ # Now strip off the 'ALTER TABLE xyz' of all but the first one
+
+ my $qt = $options->{quote_table_names} || '';
+ my $table_name = $qt . $table->name . $qt;
+
+
+ my $re = $renamed_from
+ ? qr/^ALTER TABLE (?:\Q$table_name\E|\Q$qt$renamed_from$qt\E) /
+ : qr/^ALTER TABLE \Q$table_name\E /;
+
+ my $first = shift @stmts;
+ my ($alter_table) = $first =~ /($re)/;
+
+ my $padd = " " x length($alter_table);
+
+ return $drop_stmt . join( ",\n", $first, map { s/$re//; $padd . $_ } @stmts) . ';';
+
+}
+
+sub drop_table {
+ my ($table, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+
+ # 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 ] }, $options);
+
+ return join("\n", @sql, "DROP TABLE $qt$table$qt;");
+
+}
+
+sub rename_table {
+ my ($old_table, $new_table, $options) = @_;
+
+ my $qt = $options->{quote_table_names} || '';
+
+ return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
+}
+
+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;
# -------------------------------------------------------------------
projects / dbsrgits/SQL-Translator.git / blobdiff