Release 0.07047
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / mysql.pm
index 79515a7..2af0178 100644 (file)
@@ -3,71 +3,157 @@ package DBIx::Class::Schema::Loader::DBI::mysql;
 use strict;
 use warnings;
 use base 'DBIx::Class::Schema::Loader::DBI';
+use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
-use Class::C3;
+use List::Util qw/any first/;
+use Try::Tiny;
+use Scalar::Util 'blessed';
+use DBIx::Class::Schema::Loader::Utils qw/sigwarn_silencer/;
+use namespace::clean;
+use DBIx::Class::Schema::Loader::Table ();
 
-our $VERSION = '0.06001';
+our $VERSION = '0.07047';
 
 =head1 NAME
 
 DBIx::Class::Schema::Loader::DBI::mysql - DBIx::Class::Schema::Loader::DBI mysql Implementation.
 
-=head1 SYNOPSIS
+=head1 DESCRIPTION
 
-  package My::Schema;
-  use base qw/DBIx::Class::Schema::Loader/;
+See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
 
-  __PACKAGE__->loader_options( debug => 1 );
+=cut
 
-  1;
+sub _setup {
+    my $self = shift;
 
-=head1 DESCRIPTION
+    $self->schema->storage->sql_maker->quote_char("`");
+    $self->schema->storage->sql_maker->name_sep(".");
 
-See L<DBIx::Class::Schema::Loader::Base>.
+    $self->next::method(@_);
 
-=cut
+    if (not defined $self->preserve_case) {
+        $self->preserve_case(0);
+    }
+
+    if ($self->db_schema && $self->db_schema->[0] eq '%') {
+        my @schemas = try {
+            $self->_show_databases;
+        }
+        catch {
+            croak "no SHOW DATABASES privileges: $_";
+        };
 
-sub _tables_list { 
-    my ($self, $opts) = @_;
+        @schemas = grep {
+            my $schema = $_;
+            not any { lc($schema) eq lc($_) } $self->_system_schemas
+        } @schemas;
 
-    return $self->next::method($opts, undef, undef);
+        $self->db_schema(\@schemas);
+    }
 }
 
-sub _table_fk_info {
-    my ($self, $table) = @_;
+sub _show_databases {
+    my $self = shift;
 
-    my $dbh = $self->schema->storage->dbh;
+    return map $_->[0], @{ $self->dbh->selectall_arrayref('SHOW DATABASES') };
+}
 
-    local $dbh->{RaiseError} = 0;
-    local $dbh->{PrintError} = 0;
+sub _system_schemas {
+    my $self = shift;
 
-    my $table_def_ref = eval { $dbh->selectrow_arrayref("SHOW CREATE TABLE `$table`") };
+    return ($self->next::method(@_), 'mysql');
+}
+
+sub _table_fk_info {
+    my ($self, $table) = @_;
+
+    my $table_def_ref = eval { $self->dbh->selectrow_arrayref("SHOW CREATE TABLE ".$table->sql_name) };
     my $table_def = $table_def_ref->[1];
 
     return [] if not $table_def;
 
-    my $qt = qr/["`]/;
+    my $qt  = qr/["`]/;
+    my $nqt = qr/[^"`]/;
 
     my (@reldata) = ($table_def =~
-        /CONSTRAINT $qt.*$qt FOREIGN KEY \($qt(.*)$qt\) REFERENCES $qt(.*)$qt \($qt(.*)$qt\)/ig
+        /CONSTRAINT ${qt}${nqt}+${qt} FOREIGN KEY \($qt(.*)$qt\) REFERENCES (?:$qt($nqt+)$qt\.)?$qt($nqt+)$qt \($qt(.+)$qt\)\s*(.*)/ig
     );
 
     my @rels;
     while (scalar @reldata > 0) {
-        my $cols = shift @reldata;
-        my $f_table = shift @reldata;
-        my $f_cols = shift @reldata;
+        my ($cols, $f_schema, $f_table, $f_cols, $rest) = splice @reldata, 0, 5;
+
+        my @cols   = map { s/$qt//g; $self->_lc($_) }
+            split(/$qt?\s*$qt?,$qt?\s*$qt?/, $cols);
+
+        my @f_cols = map { s/$qt//g; $self->_lc($_) }
+            split(/$qt?\s*$qt?,$qt?\s*$qt?/, $f_cols);
+
+        # Match case of remote schema to that in SHOW DATABASES, if it's there
+        # and we have permissions to run SHOW DATABASES.
+        if ($f_schema) {
+            my $matched = first {
+                lc($_) eq lc($f_schema)
+            } try { $self->_show_databases };
+
+            $f_schema = $matched if $matched;
+        }
+
+        my $remote_table = do {
+            # Get ->tables_list to return tables from the remote schema, in case it is not in the db_schema list.
+            local $self->{db_schema} = [ $f_schema ] if $f_schema;
+
+            first {
+                lc($_->name) eq lc($f_table)
+                && ((not $f_schema) || lc($_->schema) eq lc($f_schema))
+            } $self->_tables_list;
+        };
+
+        # The table may not be in any database, or it may not have been found by the previous code block for whatever reason.
+        if (not $remote_table) {
+            my $remote_schema = $f_schema || $self->db_schema && @{ $self->db_schema } == 1 && $self->db_schema->[0];
+
+            $remote_table = DBIx::Class::Schema::Loader::Table->new(
+                loader => $self,
+                name   => $f_table,
+                ($remote_schema ? (
+                    schema => $remote_schema,
+                ) : ()),
+            );
+        }
 
-        my @cols   = map { s/(?: \Q$self->{_quoter}\E | $qt )//x; lc $_ }
-            split(/\s*,\s*/, $cols);
+        my %attrs;
 
-        my @f_cols = map { s/(?: \Q$self->{_quoter}\E | $qt )//x; lc $_ }
-            split(/\s*,\s*/, $f_cols);
+        if ($rest) {
+            my @on_clauses = $rest =~ /(ON DELETE|ON UPDATE) (RESTRICT|CASCADE|SET NULL|NO ACTION) ?/ig;
+
+            while (my ($clause, $value) = splice @on_clauses, 0, 2) {
+                $clause = lc $clause;
+                $clause =~ s/ /_/;
+
+                $value = uc $value;
+
+                $attrs{$clause} = $value;
+            }
+        }
+
+# The default behavior is RESTRICT. Specifying RESTRICT explicitly just removes
+# that ON clause from the SHOW CREATE TABLE output. For this reason, even
+# though the default for these clauses everywhere else in Schema::Loader is
+# CASCADE, we change the default here to RESTRICT in order to reproduce the
+# schema faithfully.
+        $attrs{on_delete}     ||= 'RESTRICT';
+        $attrs{on_update}     ||= 'RESTRICT';
+
+# MySQL does not have a DEFERRABLE attribute, but there is a way to defer FKs.
+        $attrs{is_deferrable}   = 1;
 
         push(@rels, {
             local_columns => \@cols,
             remote_columns => \@f_cols,
-            remote_table => $f_table
+            remote_table => $remote_table,
+            attrs => \%attrs,
         });
     }
 
@@ -79,15 +165,14 @@ sub _table_fk_info {
 sub _mysql_table_get_keys {
     my ($self, $table) = @_;
 
-    if(!exists($self->{_cache}->{_mysql_keys}->{$table})) {
+    if(!exists($self->{_cache}->{_mysql_keys}->{$table->sql_name})) {
         my %keydata;
-        my $dbh = $self->schema->storage->dbh;
-        my $sth = $dbh->prepare('SHOW INDEX FROM '.$self->_table_as_sql($table));
+        my $sth = $self->dbh->prepare('SHOW INDEX FROM '.$table->sql_name);
         $sth->execute;
         while(my $row = $sth->fetchrow_hashref) {
             next if $row->{Non_unique};
             push(@{$keydata{$row->{Key_name}}},
-                [ $row->{Seq_in_index}, lc $row->{Column_name} ]
+                [ $row->{Seq_in_index}, $self->_lc($row->{Column_name}) ]
             );
         }
         foreach my $keyname (keys %keydata) {
@@ -95,10 +180,10 @@ sub _mysql_table_get_keys {
                 @{$keydata{$keyname}};
             $keydata{$keyname} = \@ordered_cols;
         }
-        $self->{_cache}->{_mysql_keys}->{$table} = \%keydata;
+        $self->{_cache}->{_mysql_keys}->{$table->sql_name} = \%keydata;
     }
 
-    return $self->{_cache}->{_mysql_keys}->{$table};
+    return $self->{_cache}->{_mysql_keys}->{$table->sql_name};
 }
 
 sub _table_pk_info {
@@ -112,7 +197,7 @@ sub _table_uniq_info {
 
     my @uniqs;
     my $keydata = $self->_mysql_table_get_keys($table);
-    foreach my $keyname (keys %$keydata) {
+    foreach my $keyname (sort keys %$keydata) {
         next if $keyname eq 'PRIMARY';
         push(@uniqs, [ $keyname => $keydata->{$keyname} ]);
     }
@@ -126,30 +211,31 @@ sub _columns_info_for {
 
     my $result = $self->next::method(@_);
 
-    my $dbh = $self->schema->storage->dbh;
-
     while (my ($col, $info) = each %$result) {
-        delete $info->{size}
-            unless $info->{data_type} =~ /^(?: (?:var)?(?:char(?:acter)?|binary) | bit | year)\z/ix;
-
         if ($info->{data_type} eq 'int') {
             $info->{data_type} = 'integer';
         }
         elsif ($info->{data_type} eq 'double') {
             $info->{data_type} = 'double precision';
         }
+        my $data_type = $info->{data_type};
+
+        delete $info->{size} if $data_type !~ /^(?: (?:var)?(?:char(?:acter)?|binary) | bit | year)\z/ix;
 
-        my ($precision, $scale, $column_type) = eval { $dbh->selectrow_array(<<'EOF', {}, lc $table, lc $col) };
-SELECT numeric_precision, numeric_scale, column_type
+        # information_schema is available in 5.0+
+        my ($precision, $scale, $column_type, $default) = eval { $self->dbh->selectrow_array(<<'EOF', {}, $table->name, lc($col)) };
+SELECT numeric_precision, numeric_scale, column_type, column_default
 FROM information_schema.columns
-WHERE lower(table_name) = ? AND lower(column_name) = ?
+WHERE table_schema = schema() AND table_name = ? AND lower(column_name) = ?
 EOF
+        my $has_information_schema = not $@;
+
         $column_type = '' if not defined $column_type;
 
-        if ($info->{data_type} eq 'bit' && (not exists $info->{size})) {
+        if ($data_type eq 'bit' && (not exists $info->{size})) {
             $info->{size} = $precision if defined $precision;
         }
-        elsif ($info->{data_type} =~ /^(?:float|double precision|decimal)\z/) {
+        elsif ($data_type =~ /^(?:float|double precision|decimal)\z/i) {
             if (defined $precision && defined $scale) {
                 if ($precision == 10 && $scale == 0) {
                     delete $info->{size};
@@ -159,7 +245,7 @@ EOF
                 }
             }
         }
-        elsif ($info->{data_type} eq 'year') {
+        elsif ($data_type eq 'year') {
             if ($column_type =~ /\(2\)/) {
                 $info->{size} = 2;
             }
@@ -167,6 +253,35 @@ EOF
                 delete $info->{size};
             }
         }
+        elsif ($data_type =~ /^(?:date(?:time)?|timestamp)\z/) {
+            if (not (defined $self->datetime_undef_if_invalid && $self->datetime_undef_if_invalid == 0)) {
+                $info->{datetime_undef_if_invalid} = 1;
+            }
+        }
+        elsif ($data_type =~ /^(?:enum|set)\z/ && $has_information_schema
+               && $column_type =~ /^(?:enum|set)\(/) {
+
+            delete $info->{extra}{list};
+
+            while ($column_type =~ /'((?:[^']* (?:''|\\')* [^']*)* [^\\']?)',?/xg) {
+                my $el = $1;
+                $el =~ s/''/'/g;
+                push @{ $info->{extra}{list} }, $el;
+            }
+        }
+
+        # Sometimes apparently there's a bug where default_value gets set to ''
+        # for things that don't actually have or support that default (like ints.)
+        if (exists $info->{default_value} && $info->{default_value} eq '') {
+            if ($has_information_schema) {
+                if (not defined $default) {
+                    delete $info->{default_value};
+                }
+            }
+            else { # just check if it's a char/text type, otherwise remove
+                delete $info->{default_value} unless $data_type =~ /char|text/i;
+            }
+        }
     }
 
     return $result;
@@ -186,23 +301,88 @@ sub _extra_column_info {
     if ($dbi_info->{mysql_values}) {
         $extra_info{extra}{list} = $dbi_info->{mysql_values};
     }
-    if (   $dbi_info->{COLUMN_DEF}      =~ /^CURRENT_TIMESTAMP\z/i
-        && $dbi_info->{mysql_type_name} =~ /^TIMESTAMP\z/i) {
+    if ((not blessed $dbi_info) # isa $sth
+        && lc($dbi_info->{COLUMN_DEF})      eq 'current_timestamp'
+        && lc($dbi_info->{mysql_type_name}) eq 'timestamp') {
 
-        $extra_info{default_value} = \'CURRENT_TIMESTAMP';
+        my $current_timestamp = 'current_timestamp';
+        $extra_info{default_value} = \$current_timestamp;
     }
 
     return \%extra_info;
 }
 
+sub _dbh_column_info {
+    my $self = shift;
+
+    local $SIG{__WARN__} = sigwarn_silencer(
+        qr/^column_info: unrecognized column type/
+    );
+
+    $self->next::method(@_);
+}
+
+sub _table_comment {
+    my ( $self, $table ) = @_;
+    my $comment = $self->next::method($table);
+    if (not $comment) {
+        ($comment) = try { $self->schema->storage->dbh->selectrow_array(
+            qq{SELECT table_comment
+                FROM information_schema.tables
+                WHERE table_schema = schema()
+                  AND table_name = ?
+            }, undef, $table->name);
+        };
+        # InnoDB likes to auto-append crap.
+        if (not $comment) {
+            # Do nothing.
+        }
+        elsif ($comment =~ /^InnoDB free:/) {
+            $comment = undef;
+        }
+        else {
+            $comment =~ s/; InnoDB.*//;
+        }
+    }
+    return $comment;
+}
+
+sub _column_comment {
+    my ( $self, $table, $column_number, $column_name ) = @_;
+    my $comment = $self->next::method($table, $column_number, $column_name);
+    if (not $comment) {
+        ($comment) = try { $self->schema->storage->dbh->selectrow_array(
+            qq{SELECT column_comment
+                FROM information_schema.columns
+                WHERE table_schema = schema()
+                  AND table_name = ?
+                  AND lower(column_name) = ?
+            }, undef, $table->name, lc($column_name));
+        };
+    }
+    return $comment;
+}
+
+sub _view_definition {
+    my ($self, $view) = @_;
+
+    return scalar $self->schema->storage->dbh->selectrow_array(
+        q{SELECT view_definition
+            FROM information_schema.views
+           WHERE table_schema = schema()
+             AND table_name = ?
+        }, undef, $view->name,
+    );
+}
+
 =head1 SEE ALSO
 
 L<DBIx::Class::Schema::Loader>, L<DBIx::Class::Schema::Loader::Base>,
 L<DBIx::Class::Schema::Loader::DBI>
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+See L<DBIx::Class::Schema::Loader/AUTHORS>.
 
 =head1 LICENSE