lib/SQL/Translator/Parser/DBI/PostgreSQL.pm

   1 package SQL::Translator::Parser::DBI::PostgreSQL;
   2
   3 # -------------------------------------------------------------------
   4 # Copyright (C) 2002-2009 SQLFairy Authors
   5 #
   6 # This program is free software; you can redistribute it and/or
   7 # modify it under the terms of the GNU General Public License as
   8 # published by the Free Software Foundation; version 2.
   9 #
  10 # This program is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18 # 02111-1307  USA
  19 # -------------------------------------------------------------------
  20
  21 =head1 NAME
  22
  23 SQL::Translator::Parser::DBI::PostgreSQL - parser for DBD::Pg
  24
  25 =head1 SYNOPSIS
  26
  27 See SQL::Translator::Parser::DBI.
  28
  29 =head1 DESCRIPTION
  30
  31 Uses DBI to query PostgreSQL system tables to determine schema structure.
  32
  33 =cut
  34
  35 use strict;
  36 use DBI;
  37 use Data::Dumper;
  38 use SQL::Translator::Schema::Constants;
  39
  40 use vars qw[ $DEBUG $VERSION @EXPORT_OK ];
  41 $VERSION = '1.59';
  42 $DEBUG   = 0 unless defined $DEBUG;
  43
  44 my $actions = {c => 'cascade',
  45                r => 'restrict',
  46                a => 'no action',
  47                n => 'set null',
  48                d => 'set default',
  49            };
  50
  51 # -------------------------------------------------------------------
  52 sub parse {
  53     my ( $tr, $dbh ) = @_;
  54
  55     my $schema = $tr->schema;
  56
  57     my $column_select = $dbh->prepare(
  58       "SELECT a.attname, format_type(t.oid, a.atttypmod) as typname, a.attnum,
  59               a.atttypmod as length, a.attnotnull, a.atthasdef, ad.adsrc,
  60               d.description
  61        FROM pg_type t, pg_attribute a
  62        LEFT JOIN pg_attrdef ad ON (ad.adrelid = a.attrelid AND a.attnum = ad.adnum)
  63        LEFT JOIN pg_description d ON (a.attrelid=d.objoid AND a.attnum=d.objsubid)
  64        WHERE a.attrelid=? AND attnum>0
  65          AND a.atttypid=t.oid
  66        ORDER BY a.attnum"
  67     );
  68
  69     my $index_select  = $dbh->prepare(
  70       "SELECT oid, c.relname, i.indkey, i.indnatts, i.indisunique,
  71               ARRAY(SELECT a.attname
  72                   FROM pg_attribute a
  73                   WHERE a.attrelid=i.indrelid AND a.attnum = ANY(i.indkey)
  74               ) AS attname,
  75               i.indisprimary, pg_get_indexdef(oid) AS create_string
  76        FROM pg_class c,pg_index i
  77        WHERE c.relnamespace IN (SELECT oid FROM pg_namespace WHERE nspname='public') AND c.relkind='i'
  78          AND c.oid=i.indexrelid AND i.indrelid=?"
  79     );
  80
  81     my $table_select  = $dbh->prepare(
  82       "SELECT c.oid, c.relname, d.description
  83        FROM pg_class c
  84        LEFT JOIN pg_description d ON c.oid=d.objoid AND d.objsubid=0
  85        WHERE relnamespace IN
  86           (SELECT oid FROM pg_namespace WHERE nspname='public')
  87           AND relkind='r';"
  88     );
  89
  90     my $fk_select = $dbh->prepare(
  91         q/
  92 SELECT r.conname,
  93        c.relname,
  94        d.relname AS frelname,
  95        r.conkey,
  96        ARRAY(SELECT column_name::varchar
  97                FROM information_schema.columns
  98               WHERE ordinal_position = ANY  (r.conkey)
  99                 AND table_schema = n.nspname
 100                 AND table_name   =   c.relname ) AS fields,
 101        r.confkey,
 102        ARRAY(SELECT column_name::varchar
 103                FROM information_schema.columns
 104               WHERE ordinal_position = ANY  (r.confkey)
 105                 AND table_schema =   n.nspname
 106                 AND table_name   =   d.relname ) AS reference_fields,
 107        r.confupdtype,
 108        r.confdeltype,
 109        r.confmatchtype
 110
 111 FROM pg_catalog.pg_constraint r
 112
 113 JOIN pg_catalog.pg_class c
 114   ON c.oid = r.conrelid
 115  AND r.contype = 'f'
 116
 117 JOIN pg_catalog.pg_class d
 118   ON d.oid = r.confrelid
 119
 120 JOIN pg_catalog.pg_namespace n
 121   ON n.oid = c.relnamespace
 122
 123 WHERE pg_catalog.pg_table_is_visible(c.oid)
 124   AND n.nspname = ?
 125   AND c.relname = ?
 126 ORDER BY 1;
 127         /) or die "Can't prepare: $@";
 128
 129     $table_select->execute();
 130
 131     while ( my $tablehash = $table_select->fetchrow_hashref ) {
 132
 133         my $table_name = $$tablehash{'relname'};
 134         my $table_oid  = $$tablehash{'oid'};
 135         my $table = $schema->add_table(
 136                                        name => $table_name,
 137               #what is type?               type => $table_info->{TABLE_TYPE},
 138                                           ) || die $schema->error;
 139
 140         $table->comments($$tablehash{'description'}) if $$tablehash{'description'};
 141
 142         $column_select->execute($table_oid);
 143
 144         while (my $columnhash = $column_select->fetchrow_hashref ) {
 145
 146             #data_type seems to not be populated; perhaps there needs to
 147             #be a mapping of query output to reserved constants in sqlt?
 148
 149             my $col = $table->add_field(
 150                               name        => $$columnhash{'attname'},
 151                               default_value => $$columnhash{'adsrc'},
 152                               data_type   => $$columnhash{'typname'},
 153                               order       => $$columnhash{'attnum'},
 154                              ) || die $table->error;
 155
 156             $col->{size} = [$$columnhash{'length'}]
 157                 if $$columnhash{'length'}>0 && $$columnhash{'length'}<=0xFFFF;
 158             $col->{is_nullable} = $$columnhash{'attnotnull'} ? 0 : 1;
 159             $col->comments($$columnhash{'description'}) if $$columnhash{'description'};
 160         }
 161
 162         $index_select->execute($table_oid);
 163
 164         my @column_names = $table->field_names();
 165         while (my $indexhash = $index_select->fetchrow_hashref ) {
 166               #don't deal with function indexes at the moment
 167             next if ($$indexhash{'indkey'} eq ''
 168                      or !defined($$indexhash{'indkey'}) );
 169
 170             my $type;
 171             if      ($$indexhash{'indisprimary'}) {
 172                 $type = UNIQUE; #PRIMARY_KEY;
 173
 174                 #tell sqlt that this is the primary key:
 175                 my $col_name=$column_names[($$indexhash{'indkey'} - 1)];
 176                 $table->get_field($col_name)->{is_primary_key}=1;
 177
 178             } elsif ($$indexhash{'indisunique'}) {
 179                 $type = UNIQUE;
 180             } else {
 181                 $type = NORMAL;
 182             }
 183
 184
 185             my @column_ids = split /\s+/, $$indexhash{'indkey'};
 186             my @columns = split /\s+/, $$indexhash{'attname'};
 187
 188             $table->add_index(
 189                               name         => $$indexhash{'relname'},
 190                               type         => $type,
 191                               fields       => \@columns,
 192                              ) || die $table->error;
 193         }
 194
 195         $fk_select->execute('public',$table_name) or die "Can't execute: $@";
 196         my $fkeys = $fk_select->fetchall_arrayref({});
 197         $DEBUG and print Dumper $fkeys;
 198         for my $con (@$fkeys){
 199             my $con_name         = $con->{conname};
 200             my $fields           = $con->{fields};
 201             my $reference_fields = $con->{reference_fields};
 202             my $reference_table  = $con->{frelname};
 203             my $on_upd           = $con->{confupdtype};
 204             my $on_del           = $con->{confdeltype};
 205             $table->add_constraint(
 206                                    name   => $con_name,
 207                                    type   => 'foreign_key',
 208                                    fields =>  $fields,
 209                                    reference_fields => $reference_fields,
 210                                    reference_table => $reference_table,
 211                                    on_delete  => $actions->{$on_upd},
 212                                    on_update  => $actions->{$on_del},
 213                                );
 214         }
 215     }
 216
 217
 218     return 1;
 219 }
 220
 221 1;
 222
 223 # -------------------------------------------------------------------
 224 # Time is a waste of money.
 225 # Oscar Wilde
 226 # -------------------------------------------------------------------
 227
 228 =pod
 229
 230 =head1 AUTHOR
 231
 232 Scott Cain E<lt>cain@cshl.eduE<gt>, previous author:
 233 Paul Harrington E<lt>harringp@deshaw.comE<gt>.
 234
 235 =head1 SEE ALSO
 236
 237 SQL::Translator, DBD::Pg.
 238
 239 =cut