Get enum values directly from column_info for PostgreSQL
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / Pg.pm
index 6901280..317a07d 100644 (file)
@@ -2,32 +2,19 @@ package DBIx::Class::Schema::Loader::DBI::Pg;
 
 use strict;
 use warnings;
-use base qw/
-    DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault
-    DBIx::Class::Schema::Loader::DBI
-/;
-use Carp::Clan qw/^DBIx::Class/;
+use base 'DBIx::Class::Schema::Loader::DBI::Component::QuotedDefault';
 use mro 'c3';
 
-our $VERSION = '0.07010';
+our $VERSION = '0.07048_01';
 
 =head1 NAME
 
 DBIx::Class::Schema::Loader::DBI::Pg - DBIx::Class::Schema::Loader::DBI
 PostgreSQL Implementation.
 
-=head1 SYNOPSIS
-
-  package My::Schema;
-  use base qw/DBIx::Class::Schema::Loader/;
-
-  __PACKAGE__->loader_options( debug => 1 );
-
-  1;
-
 =head1 DESCRIPTION
 
-See L<DBIx::Class::Schema::Loader::Base>.
+See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>.
 
 =cut
 
@@ -36,7 +23,7 @@ sub _setup {
 
     $self->next::method(@_);
 
-    $self->{db_schema} ||= 'public';
+    $self->{db_schema} ||= ['public'];
 
     if (not defined $self->preserve_case) {
         $self->preserve_case(0);
@@ -47,26 +34,73 @@ sub _setup {
     }
 }
 
-sub _tables_list {
-    my ($self, $opts) = @_;
+sub _system_schemas {
+    my $self = shift;
 
-    my $dbh = $self->schema->storage->dbh;
-    my @tables = $dbh->tables(undef, $self->db_schema, '%', '%');
+    return ($self->next::method(@_), 'pg_catalog');
+}
 
-    my $schema_quoted = $tables[0] =~ /^"/;
+my %pg_rules = (
+    a => 'NO ACTION',
+    r => 'RESTRICT',
+    c => 'CASCADE',
+    n => 'SET NULL',
+    d => 'SET DEFAULT',
+);
 
-    if ($schema_quoted) {
-        s/^"[^"]+"\.// for @tables;
-    }
-    else {
-        s/^[^.]+\.// for @tables;
-    }
+sub _table_fk_info {
+    my ($self, $table) = @_;
+
+    my $sth = $self->dbh->prepare_cached(<<"EOF");
+      select constr.conname, to_ns.nspname, to_class.relname, from_col.attname, to_col.attname,
+             constr.confdeltype, constr.confupdtype, constr.condeferrable
+      from pg_catalog.pg_constraint constr
+      join pg_catalog.pg_namespace from_ns on constr.connamespace = from_ns.oid
+      join pg_catalog.pg_class from_class on constr.conrelid = from_class.oid and from_class.relnamespace = from_ns.oid
+      join pg_catalog.pg_class to_class on constr.confrelid = to_class.oid
+      join pg_catalog.pg_namespace to_ns on to_class.relnamespace = to_ns.oid
+      -- can't do unnest() until 8.4, so join against a series table instead
+      join pg_catalog.generate_series(1, pg_catalog.current_setting('max_index_keys')::integer) colnum(i)
+           on colnum.i <= pg_catalog.array_upper(constr.conkey,1)
+      join pg_catalog.pg_attribute to_col
+           on to_col.attrelid = constr.confrelid
+           and to_col.attnum = constr.confkey[colnum.i]
+      join pg_catalog.pg_attribute from_col
+           on from_col.attrelid = constr.conrelid
+           and from_col.attnum = constr.conkey[colnum.i]
+      where from_ns.nspname = ?
+        and from_class.relname = ?
+        and from_class.relkind = 'r'
+        and constr.contype = 'f'
+      order by constr.conname, colnum.i
+EOF
+
+    $sth->execute($table->schema, $table->name);
+
+    my %rels;
 
-    s/^"([^"]+)"\z/$1/ for @tables;
+    while (my ($fk, $remote_schema, $remote_table, $col, $remote_col,
+               $delete_rule, $update_rule, $is_deferrable) = $sth->fetchrow_array) {
+        push @{ $rels{$fk}{local_columns}  }, $self->_lc($col);
+        push @{ $rels{$fk}{remote_columns} }, $self->_lc($remote_col);
 
-    return $self->_filter_tables(\@tables, $opts);
+        $rels{$fk}{remote_table} = DBIx::Class::Schema::Loader::Table->new(
+            loader   => $self,
+            name     => $remote_table,
+            schema   => $remote_schema,
+        ) unless exists $rels{$fk}{remote_table};
+
+        $rels{$fk}{attrs} ||= {
+            on_delete     => $pg_rules{$delete_rule},
+            on_update     => $pg_rules{$update_rule},
+            is_deferrable => $is_deferrable,
+        };
+    }
+
+    return [ map { $rels{$_} } sort keys %rels ];
 }
 
+
 sub _table_uniq_info {
     my ($self, $table) = @_;
 
@@ -75,35 +109,34 @@ sub _table_uniq_info {
         if $DBD::Pg::VERSION >= 1.50;
 
     my @uniqs;
-    my $dbh = $self->schema->storage->dbh;
 
     # Most of the SQL here is mostly based on
     #   Rose::DB::Object::Metadata::Auto::Pg, after some prodding from
     #   John Siracusa to use his superior SQL code :)
 
-    my $attr_sth = $self->{_cache}->{pg_attr_sth} ||= $dbh->prepare(
+    my $attr_sth = $self->{_cache}->{pg_attr_sth} ||= $self->dbh->prepare(
         q{SELECT attname FROM pg_catalog.pg_attribute
         WHERE attrelid = ? AND attnum = ?}
     );
 
-    my $uniq_sth = $self->{_cache}->{pg_uniq_sth} ||= $dbh->prepare(
+    my $uniq_sth = $self->{_cache}->{pg_uniq_sth} ||= $self->dbh->prepare(
         q{SELECT x.indrelid, i.relname, x.indkey
         FROM
           pg_catalog.pg_index x
           JOIN pg_catalog.pg_class c ON c.oid = x.indrelid
           JOIN pg_catalog.pg_class i ON i.oid = x.indexrelid
-          JOIN pg_catalog.pg_constraint con ON con.conname = i.relname
-          LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+          JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
         WHERE
           x.indisunique = 't' AND
+          x.indpred     IS NULL AND
           c.relkind     = 'r' AND
           i.relkind     = 'i' AND
-          con.contype   = 'u' AND
           n.nspname     = ? AND
-          c.relname     = ?}
+          c.relname     = ?
+        ORDER BY i.relname}
     );
 
-    $uniq_sth->execute($self->db_schema, $table);
+    $uniq_sth->execute($table->schema, $table->name);
     while(my $row = $uniq_sth->fetchrow_arrayref) {
         my ($tableid, $indexname, $col_nums) = @$row;
         $col_nums =~ s/^\s+//;
@@ -113,13 +146,11 @@ sub _table_uniq_info {
         foreach (@col_nums) {
             $attr_sth->execute($tableid, $_);
             my $name_aref = $attr_sth->fetchrow_arrayref;
-            push(@col_names, $name_aref->[0]) if $name_aref;
+            push(@col_names, $self->_lc($name_aref->[0])) if $name_aref;
         }
 
-        if(!@col_names) {
-            warn "Failed to parse UNIQUE constraint $indexname on $table";
-        }
-        else {
+        # skip indexes with missing column names (e.g. expression indexes)
+        if(@col_names == @col_nums) {
             push(@uniqs, [ $indexname => \@col_names ]);
         }
     }
@@ -128,37 +159,36 @@ sub _table_uniq_info {
 }
 
 sub _table_comment {
-    my ( $self, $table ) = @_;
-    my ($table_comment) = $self->next::method($table);
-    if (not $table_comment) {
-        ($table_comment) = $self->schema->storage->dbh->selectrow_array(
-            q{SELECT obj_description(oid) 
-                FROM pg_class 
-                WHERE relname=? AND relnamespace=(
-                    SELECT oid FROM pg_namespace WHERE nspname=?)
-            }, undef, $table, $self->db_schema
-            );   
-    }
+    my $self = shift;
+    my ($table) = @_;
+
+    my $table_comment = $self->next::method(@_);
+
+    return $table_comment if $table_comment;
+
+    ($table_comment) = $self->dbh->selectrow_array(<<'EOF', {}, $table->name, $table->schema);
+SELECT pg_catalog.obj_description(oid)
+FROM pg_catalog.pg_class
+WHERE relname=? AND relnamespace=(SELECT oid FROM pg_catalog.pg_namespace WHERE nspname=?)
+EOF
+
     return $table_comment
 }
 
 
 sub _column_comment {
-    my ( $self, $table, $column_number, $column_name ) = @_;
-    my ($column_comment) = $self->next::method(
-        $table, $column_number, $column_name);
-    if (not $column_comment) {
-        my ($table_oid) = $self->schema->storage->dbh->selectrow_array(
-            q{SELECT oid
-                FROM pg_class 
-                WHERE relname=? AND relnamespace=(
-                    SELECT oid FROM pg_namespace WHERE nspname=?)
-            }, undef, $table, $self->db_schema
-            );   
-        $column_comment = $self->schema->storage->dbh->selectrow_array(
-            'SELECT col_description(?,?)', undef, $table_oid, $column_number );
-    }
-    return $column_comment;
+    my $self = shift;
+    my ($table, $column_number, $column_name) = @_;
+
+    my $column_comment = $self->next::method(@_);
+
+    return $column_comment if $column_comment;
+
+    return $self->dbh->selectrow_array(<<'EOF', {}, $column_number, $table->name, $table->schema);
+SELECT pg_catalog.col_description(oid, ?)
+FROM pg_catalog.pg_class
+WHERE relname=? AND relnamespace=(SELECT oid FROM pg_catalog.pg_namespace WHERE nspname=?)
+EOF
 }
 
 # Make sure data_type's that don't need it don't have a 'size' column_info, and
@@ -167,7 +197,7 @@ sub _columns_info_for {
     my $self = shift;
     my ($table) = @_;
 
-    my $result = $self->next::method(@_);
+    my ($result, $raw) = $self->next::method(@_);
 
     while (my ($col, $info) = each %$result) {
         my $data_type = $info->{data_type};
@@ -175,7 +205,7 @@ sub _columns_info_for {
         # these types are fixed size
         # XXX should this be a negative match?
         if ($data_type =~
-/^(?:bigint|int8|bigserial|serial8|boolean|bool|box|bytea|cidr|circle|date|double precision|float8|inet|integer|int|int4|line|lseg|macaddr|money|path|point|polygon|real|float4|smallint|int2|serial|serial4|text)\z/i) {
+/^(?:bigint|int8|bigserial|serial8|bool(?:ean)?|box|bytea|cidr|circle|date|double precision|float8|inet|integer|int|int4|line|lseg|macaddr|money|path|point|polygon|real|float4|smallint|int2|serial|serial4|text)\z/i) {
             delete $info->{size};
         }
 # for datetime types, check if it has a precision or not
@@ -188,18 +218,18 @@ sub _columns_info_for {
             }
 
             my ($precision) = $self->schema->storage->dbh
-                ->selectrow_array(<<EOF, {}, $table, $col);
+                ->selectrow_array(<<EOF, {}, $table->name, $col);
 SELECT datetime_precision
 FROM information_schema.columns
 WHERE table_name = ? and column_name = ?
 EOF
 
             if ($data_type =~ /^time\b/i) {
-                if ((not $precision) || $precision !~ /^\d/) {
+                if ((not defined $precision) || $precision !~ /^\d/) {
                     delete $info->{size};
                 }
                 else {
-                    my ($integer_datetimes) = $self->schema->storage->dbh
+                    my ($integer_datetimes) = $self->dbh
                         ->selectrow_array('show integer_datetimes');
 
                     my $max_precision =
@@ -213,7 +243,7 @@ EOF
                     }
                 }
             }
-            elsif ((not $precision) || $precision !~ /^\d/ || $precision == 6) {
+            elsif ((not defined $precision) || $precision !~ /^\d/ || $precision == 6) {
                 delete $info->{size};
             }
             else {
@@ -223,8 +253,7 @@ EOF
         elsif ($data_type =~ /^(?:bit(?: varying)?|varbit)\z/i) {
             $info->{data_type} = 'varbit' if $data_type =~ /var/i;
 
-            my ($precision) = $self->schema->storage->dbh
-                ->selectrow_array(<<EOF, {}, $table, $col);
+            my ($precision) = $self->dbh->selectrow_array(<<EOF, {}, $table->name, $col);
 SELECT character_maximum_length
 FROM information_schema.columns
 WHERE table_name = ? and column_name = ?
@@ -252,64 +281,109 @@ EOF
         elsif (lc($data_type) eq 'character') {
             $info->{data_type} = 'char';
         }
-        else {
+        # DBD::Pg < 3.5.2 can get the order wrong on Pg >= 9.1.0
+        elsif (
+            ($DBD::Pg::VERSION >= 3.005002 or $self->dbh->{pg_server_version} < 90100)
+                and
+            my $values = $raw->{$col}->{pg_enum_values}
+        ) {
+            $info->{extra}{list} = $values;
+
+            # Store its original name in extra for SQLT to pick up.
+            $info->{extra}{custom_type_name} = $info->{data_type};
+
+            $info->{data_type} = 'enum';
+
+            delete $info->{size};
+        }
+        else  {
             my ($typetype) = $self->schema->storage->dbh
                 ->selectrow_array(<<EOF, {}, $data_type);
 SELECT typtype
 FROM pg_catalog.pg_type
-WHERE typname = ?
+WHERE oid = ?::regtype
 EOF
-            if ($typetype eq 'e') {
-                # The following will extract a list of allowed values for the
-                # enum.
-                my $typevalues = $self->schema->storage->dbh
-                    ->selectall_arrayref(<<EOF, {}, $info->{data_type});
+            if ($typetype && $typetype eq 'e') {
+                # The following will extract a list of allowed values for the enum.
+                my $order_column = $self->dbh->{pg_server_version} >= 90100 ? 'enumsortorder' : 'oid';
+                $info->{extra}{list} = $self->dbh
+                    ->selectcol_arrayref(<<EOF, {}, $data_type);
 SELECT e.enumlabel
 FROM pg_catalog.pg_enum e
-JOIN pg_catalog.pg_type t ON t.oid = e.enumtypid
-WHERE t.typname = ?
+WHERE e.enumtypid = ?::regtype
+ORDER BY e.$order_column
 EOF
 
-                $info->{extra}{list} = [ map { $_->[0] } @$typevalues ];
-
                 # Store its original name in extra for SQLT to pick up.
-                $info->{extra}{custom_type_name} = $info->{data_type};
+                $info->{extra}{custom_type_name} = $data_type;
 
                 $info->{data_type} = 'enum';
-                
+
                 delete $info->{size};
             }
         }
 
-# process SERIAL columns
-        if (ref($info->{default_value}) eq 'SCALAR'
-                && ${ $info->{default_value} } =~ /\bnextval\('([^:]+)'/i) {
-            $info->{is_auto_increment} = 1;
-            $info->{sequence}          = $1;
-            delete $info->{default_value};
-        }
+        if (ref($info->{default_value}) eq 'SCALAR') {
+            # process SERIAL columns
+            if (${ $info->{default_value} } =~ /\bnextval\('([^:]+)'/i) {
+                $info->{is_auto_increment} = 1;
+                $info->{sequence}          = $1;
+                delete $info->{default_value};
+            }
+            # alias now() to current_timestamp for deploying to other DBs
+            elsif (lc ${ $info->{default_value} } eq 'now()') {
+                # do not use a ref to a constant, that breaks Data::Dump output
+                ${$info->{default_value}} = 'current_timestamp';
 
-# alias now() to current_timestamp for deploying to other DBs
-        if ((eval { lc ${ $info->{default_value} } }||'') eq 'now()') {
-            # do not use a ref to a constant, that breaks Data::Dump output
-            ${$info->{default_value}} = 'current_timestamp';
+                my $now = 'now()';
+                $info->{original}{default_value} = \$now;
+            }
+            elsif (${ $info->{default_value} } =~ /\bCURRENT_TIMESTAMP\b/) {
+                # PostgreSQL v10 upcases current_timestamp in default values
+                ${ $info->{default_value} } =~ s/\b(CURRENT_TIMESTAMP)\b/lc $1/ge;
+            }
+        }
 
-            my $now = 'now()';
-            $info->{original}{default_value} = \$now;
+        # detect 0/1 for booleans and rewrite
+        if ($data_type =~ /^bool/i && exists $info->{default_value}) {
+            if ($info->{default_value} eq '0') {
+                my $false = 'false';
+                $info->{default_value} = \$false;
+            }
+            elsif ($info->{default_value} eq '1') {
+                my $true = 'true';
+                $info->{default_value} = \$true;
+            }
         }
     }
 
     return $result;
 }
 
+sub _view_definition {
+    my ($self, $view) = @_;
+
+    my $def =  $self->schema->storage->dbh->selectrow_array(<<'EOF', {}, $view->schema, $view->name);
+SELECT pg_catalog.pg_get_viewdef(oid)
+FROM pg_catalog.pg_class
+WHERE relnamespace = (SELECT OID FROM pg_catalog.pg_namespace WHERE nspname = ?)
+AND relname = ?
+EOF
+    # The definition is returned as a complete statement including the
+    # trailing semicolon, but that's not allowed in CREATE VIEW, so
+    # strip it out
+    $def =~ s/\s*;\s*\z//;
+    return $def;
+}
+
 =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