package SQL::Translator::Producer::MySQL;
-# -------------------------------------------------------------------
-# Copyright (C) 2002-2009 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
-# published by the Free Software Foundation; version 2.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
-# 02111-1307 USA
-# -------------------------------------------------------------------
-
=head1 NAME
SQL::Translator::Producer::MySQL - MySQL-specific producer for SQL::Translator
=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
+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.).
-=head1 ARGUMENTS
+=head1 ARGUMENTS
-This producer takes a single optional producer_arg C<mysql_version>, which
+This producer takes a single optional producer_arg C<mysql_version>, which
provides the desired version for the target database. By default MySQL v3 is
assumed, and statements pertaining to any features introduced in later versions
(e.g. CREATE VIEW) are not produced.
-Valid version specifiers for C<mysql_version> are listed L<here|SQL::Translator::Utils/parse_mysql_version>
+Valid version specifiers for C<mysql_version> are listed L<here|SQL::Translator::Utils/parse_mysql_version>
=head2 Table Types
=item B<table.mysql_charset>, B<table.mysql_collate>
-Set the tables default charater set and collation order.
+Set the tables default character set and collation order.
=item B<field.mysql_charset>, B<field.mysql_collate>
-Set the fields charater set and collation order.
+Set the fields character set and collation order.
=back
use strict;
use warnings;
-use vars qw[ $VERSION $DEBUG %used_names ];
-$VERSION = '1.59';
+our ( $DEBUG, %used_names );
+our $VERSION = '1.59';
$DEBUG = 0 unless defined $DEBUG;
# Maximum length for most identifiers is 64, according to:
use Data::Dumper;
use SQL::Translator::Schema::Constants;
-use SQL::Translator::Utils qw(debug header_comment
- truncate_id_uniquely parse_mysql_version);
+use SQL::Translator::Generator::DDL::MySQL;
+use SQL::Translator::Utils qw(debug header_comment
+ truncate_id_uniquely parse_mysql_version
+ batch_alter_table_statements
+ normalize_quote_options
+);
#
# Use only lowercase for the keys (e.g. "long" and not "LONG")
);
#
-# Column types that do not support lenth attribute
+# Column types that do not support length attribute
#
my @no_length_attr = qw/
date time timestamp datetime year
# 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.
+ # 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} ||= []);
+ 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;
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;
# 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' );
# 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
+ # Give the constraint a name if it doesn't have one, so it doesn'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 ($quoting_generator, $nonquoting_generator);
+ sub _generator {
+ my $options = shift;
+ return $options->{generator} if exists $options->{generator};
+
+ return normalize_quote_options($options)
+ ? $quoting_generator ||= SQL::Translator::Generator::DDL::MySQL->new()
+ : $nonquoting_generator ||= SQL::Translator::Generator::DDL::MySQL->new(
+ quote_chars => [],
+ );
+ }
+}
+
sub produce {
my $translator = shift;
local $DEBUG = $translator->debug;
my $mysql_version = parse_mysql_version ($producer_args->{mysql_version}, 'perl') || 0;
my $max_id_length = $producer_args->{mysql_max_id_length} || $DEFAULT_MAX_ID_LENGTH;
- my ($qt, $qf, $qc) = ('','', '');
- $qt = '`' if $translator->quote_table_names;
- $qf = '`' if $translator->quote_field_names;
+ my $generator = _generator({ quote_identifiers => $translator->quote_identifiers });
debug("PKG: Beginning production\n");
%used_names = ();
- my $create = '';
+ my $create = '';
$create .= header_comment unless ($no_comments);
# \todo Don't set if MySQL 3.x is set on command line
my @create = "SET foreign_key_checks=0";
# Generate sql
#
my @table_defs =();
-
+
for my $table ( $schema->get_tables ) {
# print $table->name, "\n";
- push @table_defs, create_table($table,
+ push @table_defs, create_table($table,
{ add_drop_table => $add_drop_table,
show_warnings => $show_warnings,
no_comments => $no_comments,
- quote_table_names => $qt,
- quote_field_names => $qf,
+ generator => $generator,
max_id_length => $max_id_length,
mysql_version => $mysql_version
});
{ add_replace_view => $add_drop_table,
show_warnings => $show_warnings,
no_comments => $no_comments,
- quote_table_names => $qt,
- quote_field_names => $qf,
+ generator => $generator,
max_id_length => $max_id_length,
mysql_version => $mysql_version
});
}
}
+ if ($mysql_version >= 5.000002) {
+ for my $trigger ( $schema->get_triggers ) {
+ push @table_defs, create_trigger($trigger,
+ { add_drop_trigger => $add_drop_table,
+ show_warnings => $show_warnings,
+ no_comments => $no_comments,
+ generator => $generator,
+ max_id_length => $max_id_length,
+ mysql_version => $mysql_version
+ });
+ }
+ }
+
# print "@table_defs\n";
push @table_defs, "SET foreign_key_checks=1";
return wantarray ? ($create ? $create : (), @create, @table_defs) : ($create . join('', map { $_ ? "$_;\n\n" : () } (@create, @table_defs)));
}
+sub create_trigger {
+ my ($trigger, $options) = @_;
+ my $generator = _generator($options);
+
+ my $trigger_name = $trigger->name;
+ debug("PKG: Looking at trigger '${trigger_name}'\n");
+
+ my @statements;
+
+ my $events = $trigger->database_events;
+ for my $event ( @$events ) {
+ my $name = $trigger_name;
+ if (@$events > 1) {
+ $name .= "_$event";
+
+ warn "Multiple database events supplied for trigger '${trigger_name}', ",
+ "creating trigger '${name}' for the '${event}' event\n"
+ if $options->{show_warnings};
+ }
+
+ my $action = $trigger->action;
+ $action .= ";" unless $action =~ /;\s*\z/;
+
+ push @statements, "DROP TRIGGER IF EXISTS " . $generator->quote($name) if $options->{add_drop_trigger};
+ push @statements, sprintf(
+ "CREATE TRIGGER %s %s %s ON %s\n FOR EACH ROW BEGIN %s END",
+ $generator->quote($name), $trigger->perform_action_when, $event,
+ $generator->quote($trigger->on_table), $action,
+ );
+
+ }
+ # Tack the comment onto the first statement
+ $statements[0] = "--\n-- Trigger " . $generator->quote($trigger_name) . "\n--\n" . $statements[0] unless $options->{no_comments};
+ return @statements;
+}
+
sub create_view {
my ($view, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
- my $qf = $options->{quote_field_names} || '';
+ my $generator = _generator($options);
my $view_name = $view->name;
+ my $view_name_qt = $generator->quote($view_name);
+
debug("PKG: Looking at view '${view_name}'\n");
# Header. Should this look like what mysqldump produces?
my $create = '';
- $create .= "--\n-- View: ${qt}${view_name}${qt}\n--\n" unless $options->{no_comments};
+ $create .= "--\n-- View: $view_name_qt\n--\n" unless $options->{no_comments};
$create .= 'CREATE';
$create .= ' OR REPLACE' if $options->{add_replace_view};
$create .= "\n";
}
#Header, cont.
- $create .= " VIEW ${qt}${view_name}${qt}";
+ $create .= " VIEW $view_name_qt";
if( my @fields = $view->fields ){
- my $list = join ', ', map { "${qf}${_}${qf}"} @fields;
+ my $list = join ', ', map { $generator->quote($_) } @fields;
$create .= " ( ${list} )";
}
if( my $sql = $view->sql ){
sub create_table
{
my ($table, $options) = @_;
+ my $generator = _generator($options);
- my $qt = $options->{quote_table_names} || '';
- my $qf = $options->{quote_field_names} || '';
-
- my $table_name = quote_table_name($table->name, $qt);
+ my $table_name = $generator->quote($table->name);
debug("PKG: Looking at table '$table_name'\n");
#
for my $c ( @constraints ) {
my $constr = create_constraint($c, $options);
push @constraint_defs, $constr if($constr);
-
+
unless ( $indexed_fields{ ($c->fields())[0] } || $c->type ne FOREIGN_KEY ) {
- push @index_defs, "INDEX ($qf" . ($c->fields())[0] . "$qf)";
+ push @index_defs, "INDEX (" . $generator->quote(($c->fields())[0]) . ")";
$indexed_fields{ ($c->fields())[0] } = 1;
}
}
- $create .= join(",\n", map { " $_" }
+ $create .= join(",\n", map { " $_" }
@field_defs, @index_defs, @constraint_defs
);
return $drop ? ($drop,$create) : $create;
}
-sub quote_table_name {
- my ($table_name, $qt) = @_;
-
- $table_name =~ s/\./$qt.$qt/g;
-
- return "$qt$table_name$qt";
-}
-
-sub generate_table_options
+sub generate_table_options
{
my ($table, $options) = @_;
my $create;
my $table_type_defined = 0;
- my $qf = $options->{quote_field_names} ||= '';
+ my $generator = _generator($options);
my $charset = $table->extra('mysql_charset');
my $collate = $table->extra('mysql_collate');
my $union = undef;
$collate = $value;
next;
} elsif (uc $key eq 'UNION') {
- $union = "($qf". join("$qf, $qf", @$value) ."$qf)";
+ $union = '(' . join(', ', map { $generator->quote($_) } @$value) . ')';
next;
}
$create .= " $key=$value";
{
my ($field, $options) = @_;
- my $qf = $options->{quote_field_names} ||= '';
+ my $generator = _generator($options);
my $field_name = $field->name;
debug("PKG: Looking at field '$field_name'\n");
- my $field_def = "$qf$field_name$qf";
+ my $field_def = $generator->quote($field_name);
# data type and size
my $data_type = $field->data_type;
if ( lc($data_type) eq 'enum' || lc($data_type) eq 'set') {
$field_def .= '(' . $commalist . ')';
}
- elsif (
- defined $size[0] && $size[0] > 0
- &&
- ! grep lc($data_type) eq $_, @no_length_attr
+ elsif (
+ defined $size[0] && $size[0] > 0
+ &&
+ ! grep lc($data_type) eq $_, @no_length_attr
) {
$field_def .= '(' . join( ', ', @size ) . ')';
}
}
for my $qual ( 'character set', 'collate', 'on update' ) {
my $val = $extra{ $qual } || $extra{ uc $qual } or next;
- $field_def .= " $qual $val";
+ if ( ref $val ) {
+ $field_def .= " $qual ${$val}";
+ }
+ else {
+ $field_def .= " $qual $val";
+ }
}
# Null?
- $field_def .= ' NOT NULL' unless $field->is_nullable;
-
- # Default? XXX Need better quoting!
- my $default = $field->default_value;
- if ( defined $default ) {
- SQL::Translator::Producer->_apply_default_value(
- \$field_def,
- $default,
- [
- 'NULL' => \'NULL',
- ],
- );
+ if ( $field->is_nullable ) {
+ $field_def .= ' NULL';
+ }
+ else {
+ $field_def .= ' NOT NULL';
}
+ # Default?
+ SQL::Translator::Producer->_apply_default_value(
+ $field,
+ \$field_def,
+ [
+ 'NULL' => \'NULL',
+ ],
+ );
+
if ( my $comments = $field->comments ) {
$field_def .= qq[ comment '$comments'];
}
{
my ($index, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
- my $qf = $options->{quote_field_names} || '';
-
+ my $table_name = _generator($options)->quote($index->table->name);
return join( ' ',
'ALTER TABLE',
- $qt.$index->table->name.$qt,
+ $table_name,
'ADD',
create_index(@_)
);
sub create_index
{
my ( $index, $options ) = @_;
-
- my $qf = $options->{quote_field_names} || '';
+ my $generator = _generator($options);
return join(
' ',
map { $_ || () }
lc $index->type eq 'normal' ? 'INDEX' : $index->type . ' INDEX',
$index->name
- ? $qf . truncate_id_uniquely(
+ ? $generator->quote(truncate_id_uniquely(
$index->name,
$options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH
- ) . $qf
+ ))
: '',
- '(' . $qf . join( "$qf, $qf", $index->fields ) . $qf . ')'
+ '(' . join( ', ', map { $generator->quote($_) } $index->fields ) . ')'
);
}
{
my ($index, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
- my $qf = $options->{quote_field_names} || '';
+ my $table_name = _generator($options)->quote($index->table->name);
- return join( ' ',
+ return join( ' ',
'ALTER TABLE',
- $qt.$index->table->name.$qt,
+ $table_name,
'DROP',
'INDEX',
$index->name || $index->fields
{
my ($c, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
- my $qc = $options->{quote_field_names} || '';
+ my $generator = _generator($options);
+ my $table_name = $generator->quote($c->table->name);
- 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;
+ my @out = ('ALTER','TABLE',$table_name,'DROP');
+ if($c->type eq PRIMARY_KEY) {
+ push @out, $c->type;
+ }
+ else {
+ push @out, ($c->type eq FOREIGN_KEY ? $c->type : "INDEX"),
+ $generator->quote($c->name);
+ }
+ return join(' ',@out);
}
sub alter_create_constraint
{
my ($index, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
+ my $table_name = _generator($options)->quote($index->table->name);
return join( ' ',
'ALTER TABLE',
- $qt.$index->table->name.$qt,
+ $table_name,
'ADD',
create_constraint(@_) );
}
{
my ($c, $options) = @_;
- my $qf = $options->{quote_field_names} || '';
- my $qt = $options->{quote_table_names} || '';
+ my $generator = _generator($options);
my $leave_name = $options->{leave_name} || undef;
- my @fields = $c->fields or next;
+ my $reference_table_name = $generator->quote($c->reference_table);
+
+ my @fields = $c->fields or return;
if ( $c->type eq PRIMARY_KEY ) {
- return 'PRIMARY KEY (' . $qf . join("$qf, $qf", @fields). $qf . ')';
+ return 'PRIMARY KEY (' . join(", ", map { $generator->quote($_) } @fields) . ')';
}
elsif ( $c->type eq UNIQUE ) {
- return
- 'UNIQUE '.
- (defined $c->name ? $qf.truncate_id_uniquely( $c->name, $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH ).$qf.' ' : '').
- '(' . $qf . join("$qf, $qf", @fields). $qf . ')';
+ return sprintf 'UNIQUE %s(%s)',
+ ((defined $c->name && $c->name)
+ ? $generator->quote(
+ truncate_id_uniquely( $c->name, $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH ),
+ ) . ' '
+ : ''
+ ),
+ ( join ', ', map { $generator->quote($_) } @fields ),
+ ;
}
elsif ( $c->type eq FOREIGN_KEY ) {
#
my $table = $c->table;
my $c_name = truncate_id_uniquely( $c->name, $options->{max_id_length} || $DEFAULT_MAX_ID_LENGTH );
- my $def = join(' ',
- map { $_ || () }
- 'CONSTRAINT',
- $qf . $c_name . $qf,
+ my $def = join(' ',
+ 'CONSTRAINT',
+ ($c_name ? $generator->quote($c_name) : () ),
'FOREIGN KEY'
);
- $def .= ' ('.$qf . join( "$qf, $qf", @fields ) . $qf . ')';
+ $def .= ' ('. join( ', ', map { $generator->quote($_) } @fields ) . ')';
- $def .= ' REFERENCES ' . $qt . $c->reference_table . $qt;
+ $def .= ' REFERENCES ' . $reference_table_name;
my @rfields = map { $_ || () } $c->reference_fields;
unless ( @rfields ) {
}
if ( @rfields ) {
- $def .= ' (' . $qf . join( "$qf, $qf", @rfields ) . $qf . ')';
+ $def .= ' (' . join( ', ', map { $generator->quote($_) } @rfields ) . ')';
}
else {
warn "FK constraint on " . $table->name . '.' .
- join('', @fields) . " has no reference fields\n"
+ join('', @fields) . " has no reference fields\n"
if $options->{show_warnings};
}
if ( $c->match_type ) {
- $def .= ' MATCH ' .
+ $def .= ' MATCH ' .
( $c->match_type =~ /full/i ) ? 'FULL' : 'PARTIAL';
}
if ( $c->on_delete ) {
- $def .= ' ON DELETE '.join( ' ', $c->on_delete );
+ $def .= ' ON DELETE '. $c->on_delete;
}
if ( $c->on_update ) {
- $def .= ' ON UPDATE '.join( ' ', $c->on_update );
+ $def .= ' ON UPDATE '. $c->on_update;
}
return $def;
}
{
my ($to_table, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
-
my $table_options = generate_table_options($to_table, $options) || '';
+ my $table_name = _generator($options)->quote($to_table->name);
my $out = sprintf('ALTER TABLE %s%s',
- $qt . $to_table->name . $qt,
+ $table_name,
$table_options);
return $out;
{
my ($from_field, $to_field, $options) = @_;
- my $qf = $options->{quote_field_names} || '';
- my $qt = $options->{quote_table_names} || '';
+ my $generator = _generator($options);
+ my $table_name = $generator->quote($to_field->table->name);
my $out = sprintf('ALTER TABLE %s CHANGE COLUMN %s %s',
- $qt . $to_field->table->name . $qt,
- $qf . $from_field->name . $qf,
+ $table_name,
+ $generator->quote($from_field->name),
create_field($to_field, $options));
return $out;
{
my ($new_field, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
+ my $table_name = _generator($options)->quote($new_field->table->name);
my $out = sprintf('ALTER TABLE %s ADD COLUMN %s',
- $qt . $new_field->table->name . $qt,
+ $table_name,
create_field($new_field, $options));
return $out;
}
sub drop_field
-{
+{
my ($old_field, $options) = @_;
- my $qf = $options->{quote_field_names} || '';
- my $qt = $options->{quote_table_names} || '';
-
+ my $generator = _generator($options);
+ my $table_name = $generator->quote($old_field->table->name);
+
my $out = sprintf('ALTER TABLE %s DROP COLUMN %s',
- $qt . $old_field->table->name . $qt,
- $qf . $old_field->name . $qf);
+ $table_name,
+ $generator->quote($old_field->name));
return $out;
-
+
}
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
+ # InnoDB has an issue with dropping and re-adding a FK constraint under the
+ # name in a single alter statement, 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 => $_ )
+ $_->type eq FOREIGN_KEY
+ ? ( $_->name => $_ )
: ( )
} @{$diff_hash->{alter_drop_constraint} };
}
- 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/;
+ my @stmts = batch_alter_table_statements($diff_hash, $options);
+
+ #quote
+ my $generator = _generator($options);
# rename_table makes things a bit more complex
my $renamed_from = "";
- $renamed_from = $diff_hash->{rename_table}[0][0]->name
+ $renamed_from = $generator->quote($diff_hash->{rename_table}[0][0]->name)
if $diff_hash->{rename_table} && @{$diff_hash->{rename_table}};
return unless @stmts;
# 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 $table_name = $generator->quote($table->name);
-
- my $re = $renamed_from
- ? qr/^ALTER TABLE (?:\Q$table_name\E|\Q$qt$renamed_from$qt\E) /
+ my $re = $renamed_from
+ ? qr/^ALTER TABLE (?:\Q$table_name\E|\Q$renamed_from\E) /
: qr/^ALTER TABLE \Q$table_name\E /;
my $first = shift @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 (@sql, "DROP TABLE $qt$table$qt");
-# return join("\n", @sql, "DROP TABLE $qt$table$qt");
+ my $table_name = _generator($options)->quote($table);
+ return (@sql, "DROP TABLE $table");
}
sub rename_table {
my ($old_table, $new_table, $options) = @_;
- my $qt = $options->{quote_table_names} || '';
+ my $generator = _generator($options);
+ my $old_table_name = $generator->quote($old_table);
+ my $new_table_name = $generator->quote($new_table);
- return "ALTER TABLE $qt$old_table$qt RENAME TO $qt$new_table$qt";
+ return "ALTER TABLE $old_table_name RENAME TO $new_table_name";
}
sub next_unused_name {
1;
-# -------------------------------------------------------------------
-
=pod
=head1 SEE ALSO