# -*-cperl-*- # $Id: Pg.pm,v 1.202 2006/05/05 15:20:15 turnstep Exp $ # # Copyright (c) 2002-2006 PostgreSQL Global Development Group # Portions Copyright (c) 2002 Jeffrey W. Baker # Portions Copyright (c) 1997-2001 Edmund Mergl # Portions Copyright (c) 1994-1997 Tim Bunce # # You may distribute under the terms of either the GNU General Public # License or the Artistic License, as specified in the Perl README file. use 5.006001; { package DBD::Pg; our $VERSION = '1.49'; use DBI (); use DynaLoader (); use Exporter (); use vars qw(@ISA %EXPORT_TAGS $err $errstr $sqlstate $drh $dbh $DBDPG_DEFAULT); @ISA = qw(DynaLoader Exporter); %EXPORT_TAGS = ( pg_types => [qw( PG_BOOL PG_BYTEA PG_CHAR PG_INT8 PG_INT2 PG_INT4 PG_TEXT PG_OID PG_TID PG_FLOAT4 PG_FLOAT8 PG_ABSTIME PG_RELTIME PG_TINTERVAL PG_BPCHAR PG_VARCHAR PG_DATE PG_TIME PG_DATETIME PG_TIMESPAN PG_TIMESTAMP PG_POINT PG_LINE PG_LSEG PG_BOX PG_PATH PG_POLYGON PG_CIRCLE )] ); { package DBD::Pg::DefaultValue; sub new { my $self = {}; return bless $self, shift; } } $DBDPG_DEFAULT = DBD::Pg::DefaultValue->new(); Exporter::export_ok_tags('pg_types'); @EXPORT = qw($DBDPG_DEFAULT); require_version DBI 1.45; bootstrap DBD::Pg $VERSION; $err = 0; # holds error code for DBI::err $errstr = ""; # holds error string for DBI::errstr $sqlstate = ""; # holds five character SQLSTATE code $drh = undef; # holds driver handle once initialized sub CLONE { $drh = undef; } sub driver { return $drh if defined $drh; my($class, $attr) = @_; $class .= "::dr"; # not a 'my' since we use it above to prevent multiple drivers $drh = DBI::_new_drh($class, { 'Name' => 'Pg', 'Version' => $VERSION, 'Err' => \$DBD::Pg::err, 'Errstr' => \$DBD::Pg::errstr, 'State' => \$DBD::Pg::sqlstate, 'Attribution' => "DBD::Pg $VERSION by Greg Sabino Mullane and others", }); DBD::Pg::db->install_method("pg_endcopy"); DBD::Pg::db->install_method("pg_getline"); DBD::Pg::db->install_method("pg_ping"); DBD::Pg::db->install_method("pg_putline"); DBD::Pg::db->install_method("pg_release"); DBD::Pg::db->install_method("pg_rollback_to"); DBD::Pg::db->install_method("pg_savepoint"); DBD::Pg::db->install_method("pg_server_trace"); DBD::Pg::db->install_method("pg_server_untrace"); DBD::Pg::db->install_method("pg_type_info"); $drh; } ## Deprecated: use $dbh->{pg_server_version} if possible instead sub _pg_use_catalog { my $dbh = shift; return $dbh->{private_dbdpg}{pg_use_catalog} if defined $dbh->{private_dbdpg}{pg_use_catalog}; $dbh->{private_dbdpg}{pg_use_catalog} = $dbh->{private_dbdpg}{version} >= 70300 ? 'pg_catalog.' : ''; } 1; } { package DBD::Pg::dr; use strict; our $CATALOG = 123; ## Set later on, this is to catch seriously misplaced code ## Returns an array of formatted database names from the pg_database table sub data_sources { my $drh = shift; ## Connect to "postgres" when the minimum version we support is 8.0 my $dbh = DBD::Pg::dr::connect($drh, 'dbname=template1') or return undef; $dbh->{AutoCommit}=1; my $SQL = "SELECT ${CATALOG}quote_ident(datname) FROM ${CATALOG}pg_database ORDER BY 1"; my $sth = $dbh->prepare($SQL); $sth->execute() or die $DBI::errstr; my @sources = map { "dbi:Pg:dbname=$_->[0]" } @{$sth->fetchall_arrayref()}; $dbh->disconnect; return @sources; } sub connect { my($drh, $dbname, $user, $pass)= @_; ## Allow "db" and "database" as synonyms for "dbname" $dbname =~ s/\b(?:db|database)\s*=/dbname=/; my $Name = $dbname; if ($dbname =~ m#dbname\s*=\s*[\"\']([^\"\']+)#) { $Name = "'$1'"; $dbname =~ s/"/'/g; } elsif ($dbname =~ m#dbname\s*=\s*([^;]+)#) { $Name = $1; } $user = "" unless defined($user); $pass = "" unless defined($pass); $user = $ENV{DBI_USER} if $user eq ""; $pass = $ENV{DBI_PASS} if $pass eq ""; $user = "" unless defined($user); $pass = "" unless defined($pass); my ($dbh) = DBI::_new_dbh($drh, { 'Name' => $Name, 'User' => $user, 'CURRENT_USER' => $user, }); # Connect to the database.. DBD::Pg::db::_login($dbh, $dbname, $user, $pass) or return undef; my $version = $dbh->{pg_server_version}; $dbh->{private_dbdpg}{version} = $version; ## If the version is 7.3 or later, fully qualify the system relations $CATALOG = $version >= 70300 ? 'pg_catalog.' : ''; $dbh; } } { package DBD::Pg::db; use DBI qw(:sql_types); use strict; sub prepare { my($dbh, $statement, @attribs) = @_; return undef if ! defined $statement; # Create a 'blank' statement handle: my $sth = DBI::_new_sth($dbh, { 'Statement' => $statement, }); my $ph = DBD::Pg::st::_prepare($sth, $statement, @attribs) || 0; if ($ph < 0) { return undef; } if (@attribs and ref $attribs[0] and ref $attribs[0] eq 'HASH') { # Feel ambitious? Move all this to dbdimp.c! :) if (exists $attribs[0]->{bind_types}) { my $bind = $attribs[0]->{bind_types}; ## Until we are allowed to set just the type, we use a null $sth->bind_param("$1",undef,"foo"); } } $sth; } sub last_insert_id { my ($dbh, $catalog, $schema, $table, $col, $attr) = @_; ## Our ultimate goal is to get a sequence my ($sth, $count, $SQL, $sequence); ## Cache all of our table lookups? Default is yes my $cache = 1; ## Catalog and col are not used $schema = '' if ! defined $schema; $table = '' if ! defined $table; my $cachename = "lii$table$schema"; if (defined $attr and length $attr) { ## If not a hash, assume it is a sequence name if (! ref $attr) { $attr = {sequence => $attr}; } elsif (ref $attr ne 'HASH') { return $dbh->set_err(1, "last_insert_id must be passed a hashref as the final argument"); } ## Named sequence overrides any table or schema settings if (exists $attr->{sequence} and length $attr->{sequence}) { $sequence = $attr->{sequence}; } if (exists $attr->{pg_cache}) { $cache = $attr->{pg_cache}; } } if (! defined $sequence and exists $dbh->{private_dbdpg}{$cachename} and $cache) { $sequence = $dbh->{private_dbdpg}{$cachename}; } elsif (! defined $sequence) { ## At this point, we must have a valid table name if (! length $table) { return $dbh->set_err(1, "last_insert_id needs at least a sequence or table name"); } my @args = ($table); ## Only 7.3 and up can use schemas $schema = '' if $dbh->{private_dbdpg}{version} < 70300; ## Make sure the table in question exists and grab its oid my ($schemajoin,$schemawhere) = ('',''); if (length $schema) { $schemajoin = "\n JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)"; $schemawhere = "\n AND n.nspname = ?"; push @args, $schema; } $SQL = "SELECT c.oid FROM ${DBD::Pg::dr::CATALOG}pg_class c $schemajoin\n WHERE relname = ?$schemawhere"; $sth = $dbh->prepare($SQL); $count = $sth->execute(@args); if (!defined $count or $count eq '0E0') { $sth->finish(); my $message = qq{Could not find the table "$table"}; length $schema and $message .= qq{ in the schema "$schema"}; return $dbh->set_err(1, $message); } my $oid = $sth->fetchall_arrayref()->[0][0]; ## This table has a primary key. Is there a sequence associated with it via a unique, indexed column? $SQL = "SELECT a.attname, i.indisprimary, substring(d.adsrc for 128) AS def\n". "FROM ${DBD::Pg::dr::CATALOG}pg_index i, ${DBD::Pg::dr::CATALOG}pg_attribute a, ${DBD::Pg::dr::CATALOG}pg_attrdef d\n ". "WHERE i.indrelid = $oid AND d.adrelid=a.attrelid AND d.adnum=a.attnum\n". " AND a.attrelid=$oid AND i.indisunique IS TRUE\n". " AND a.atthasdef IS TRUE AND i.indkey[0]=a.attnum\n". " AND d.adsrc ~ '^nextval'"; $sth = $dbh->prepare($SQL); $count = $sth->execute(); if (!defined $count or $count eq '0E0') { $sth->finish(); $dbh->set_err(1, qq{No suitable column found for last_insert_id of table "$table"}); } my $info = $sth->fetchall_arrayref(); ## We have at least one with a default value. See if we can determine sequences my @def; for (@$info) { next unless $_->[2] =~ /^nextval\('([^']+)'::/o; push @$_, $1; push @def, $_; } if (!@def) { $dbh->set_err(1, qq{No suitable column found for last_insert_id of table "$table"\n}); } ## Tiebreaker goes to the primary keys if (@def > 1) { my @pri = grep { $_->[1] } @def; if (1 != @pri) { $dbh->set_err(1, qq{No suitable column found for last_insert_id of table "$table"\n}); } @def = @pri; } $sequence = $def[0]->[3]; ## Cache this information for subsequent calls $dbh->{private_dbdpg}{$cachename} = $sequence; } $sth = $dbh->prepare("SELECT currval(?)"); $sth->execute($sequence); return $sth->fetchall_arrayref()->[0][0]; } ## end of last_insert_id sub ping { my $dbh = shift; local $SIG{__WARN__} = sub { } if $dbh->{PrintError}; local $dbh->{RaiseError} = 0 if $dbh->{RaiseError}; my $ret = DBD::Pg::db::_ping($dbh); return $ret < 1 ? 0 : $ret; } sub pg_ping { my $dbh = shift; local $SIG{__WARN__} = sub { } if $dbh->{PrintError}; local $dbh->{RaiseError} = 0 if $dbh->{RaiseError}; return DBD::Pg::db::_ping($dbh); } sub pg_type_info { my($dbh,$pg_type) = @_; local $SIG{__WARN__} = sub { } if $dbh->{PrintError}; local $dbh->{RaiseError} = 0 if $dbh->{RaiseError}; my $ret = DBD::Pg::db::_pg_type_info($pg_type); return $ret; } # Column expected in statement handle returned. # table_cat, table_schem, table_name, column_name, data_type, type_name, # column_size, buffer_length, DECIMAL_DIGITS, NUM_PREC_RADIX, NULLABLE, # REMARKS, COLUMN_DEF, SQL_DATA_TYPE, SQL_DATETIME_SUB, CHAR_OCTET_LENGTH, # ORDINAL_POSITION, IS_NULLABLE # The result set is ordered by TABLE_SCHEM, TABLE_NAME and ORDINAL_POSITION. sub column_info { my $dbh = shift; my ($catalog, $schema, $table, $column) = @_; my $version = $dbh->{private_dbdpg}{version}; my @search; ## If the schema or table has an underscore or a %, use a LIKE comparison if (defined $schema and length $schema and $version >= 70300) { push @search, "n.nspname " . ($schema =~ /[_%]/ ? "LIKE " : "= ") . $dbh->quote($schema); } if (defined $table and length $table) { push @search, "c.relname " . ($table =~ /[_%]/ ? "LIKE " : "= ") . $dbh->quote($table); } if (defined $column and length $column) { push @search, "a.attname " . ($column =~ /[_%]/ ? "LIKE " : "= ") . $dbh->quote($column); } my $whereclause = join "\n\t\t\t\tAND ", "", @search; my $showschema = $version >= 70300 ? "quote_ident(n.nspname)" : "NULL::text"; my $schemajoin = $version >= 70300 ? "JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)" : ""; # col_description is not available for Pg < 7.2 my $remarks = $version > 70200 ? "${DBD::Pg::dr::CATALOG}col_description(a.attrelid, a.attnum)" : "NULL::text"; my $col_info_sql = qq! SELECT NULL::text AS "TABLE_CAT" , $showschema AS "TABLE_SCHEM" , quote_ident(c.relname) AS "TABLE_NAME" , quote_ident(a.attname) AS "COLUMN_NAME" , a.atttypid AS "DATA_TYPE" , ${DBD::Pg::dr::CATALOG}format_type(a.atttypid, NULL) AS "TYPE_NAME" , a.attlen AS "COLUMN_SIZE" , NULL::text AS "BUFFER_LENGTH" , NULL::text AS "DECIMAL_DIGITS" , NULL::text AS "NUM_PREC_RADIX" , CASE a.attnotnull WHEN 't' THEN 0 ELSE 1 END AS "NULLABLE" , $remarks AS "REMARKS" , af.adsrc AS "COLUMN_DEF" , NULL::text AS "SQL_DATA_TYPE" , NULL::text AS "SQL_DATETIME_SUB" , NULL::text AS "CHAR_OCTET_LENGTH" , a.attnum AS "ORDINAL_POSITION" , CASE a.attnotnull WHEN 't' THEN 'NO' ELSE 'YES' END AS "IS_NULLABLE" , ${DBD::Pg::dr::CATALOG}format_type(a.atttypid, a.atttypmod) AS "pg_type" , a.attrelid AS "pg_attrelid" , a.attnum AS "pg_attnum" , a.atttypmod AS "pg_atttypmod" FROM ${DBD::Pg::dr::CATALOG}pg_type t JOIN ${DBD::Pg::dr::CATALOG}pg_attribute a ON (t.oid = a.atttypid) JOIN ${DBD::Pg::dr::CATALOG}pg_class c ON (a.attrelid = c.oid) LEFT JOIN ${DBD::Pg::dr::CATALOG}pg_attrdef af ON (a.attnum = af.adnum AND a.attrelid = af.adrelid) $schemajoin WHERE a.attnum >= 0 AND c.relkind IN ('r','v') $whereclause ORDER BY "TABLE_SCHEM", "TABLE_NAME", "ORDINAL_POSITION" !; my $data = $dbh->selectall_arrayref($col_info_sql) or return undef; # To turn the data back into a statement handle, we need # to fetch the data as an array of arrays, and also have a # a matching array of all the column names my %col_map = (qw/ TABLE_CAT 0 TABLE_SCHEM 1 TABLE_NAME 2 COLUMN_NAME 3 DATA_TYPE 4 TYPE_NAME 5 COLUMN_SIZE 6 BUFFER_LENGTH 7 DECIMAL_DIGITS 8 NUM_PREC_RADIX 9 NULLABLE 10 REMARKS 11 COLUMN_DEF 12 SQL_DATA_TYPE 13 SQL_DATETIME_SUB 14 CHAR_OCTET_LENGTH 15 ORDINAL_POSITION 16 IS_NULLABLE 17 pg_type 18 pg_constraint 19 /); my $oldconstraint_sth; if ($version < 70300) { my $constraint_query = "SELECT rcsrc FROM pg_relcheck WHERE rcname = ?"; $oldconstraint_sth = $dbh->prepare($constraint_query); } for my $row (@$data) { my $typmod = pop @$row; my $attnum = pop @$row; my $aid = pop @$row; $row->[$col_map{COLUMN_SIZE}] = _calc_col_size($typmod,$row->[$col_map{COLUMN_SIZE}]); # Replace the Pg type with the SQL_ type my $w = $row->[$col_map{DATA_TYPE}]; $row->[$col_map{DATA_TYPE}] = DBD::Pg::db::pg_type_info($dbh,$row->[$col_map{DATA_TYPE}]); $w = $row->[$col_map{DATA_TYPE}]; # Add pg_constraint if ($version >= 70300) { my $SQL = "SELECT consrc FROM pg_catalog.pg_constraint WHERE contype = 'c' AND ". "conrelid = $aid AND conkey = '{$attnum}'"; my $info = $dbh->selectall_arrayref($SQL); if (@$info) { $row->[19] = $info->[0][0]; } else { $row->[19] = undef; } } else { $oldconstraint_sth->execute("$row->[$col_map{TABLE_NAME}]_$row->[$col_map{COLUMN_NAME}]"); ($row->[19]) = $oldconstraint_sth->fetchrow_array; } $col_map{pg_constraint} = 19; } # get rid of atttypmod that we no longer need delete $col_map{pg_atttypmod}; # Since we've processed the data in Perl, we have to jump through a hoop # To turn it back into a statement handle # my $sth = _prepare_from_data( 'column_info', $data, [ sort { $col_map{$a} <=> $col_map{$b} } keys %col_map]); } sub _prepare_from_data { my ($statement, $data, $names, %attr) = @_; my $sponge = DBI->connect("dbi:Sponge:","","",{ RaiseError => 1 }); my $sth = $sponge->prepare($statement, { rows=>$data, NAME=>$names, %attr }); return $sth; } sub primary_key_info { my $dbh = shift; my ($catalog, $schema, $table, $attr) = @_; ## Catalog is ignored, but table is mandatory return undef unless defined $table and length $table; my $version = $dbh->{private_dbdpg}{version}; my $whereclause = "AND c.relname = " . $dbh->quote($table); my $gotschema = $version >= 70300 ? 1 : 0; if (defined $schema and length $schema and $gotschema) { $whereclause .= "\n\t\t\tAND n.nspname = " . $dbh->quote($schema); } my $showschema = $gotschema ? "quote_ident(n.nspname)" : "NULL::text"; my $schemajoin = $gotschema ? "LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)" : ""; my $showtablespace = ''; my $tablespacejoin = ''; if ($version >= 70500) { $tablespacejoin = 'LEFT JOIN pg_catalog.pg_tablespace t ON (t.oid = c.reltablespace)'; $showtablespace = ', quote_ident(t.spcname), quote_ident(t.spclocation)'; } my $pri_key_sql = qq{ SELECT c.oid , $showschema , quote_ident(c.relname) , quote_ident(c2.relname) , i.indkey $showtablespace FROM ${DBD::Pg::dr::CATALOG}pg_class c JOIN ${DBD::Pg::dr::CATALOG}pg_index i ON (i.indrelid = c.oid) JOIN ${DBD::Pg::dr::CATALOG}pg_class c2 ON (c2.oid = i.indexrelid) $schemajoin $tablespacejoin WHERE i.indisprimary IS TRUE $whereclause }; my $sth = $dbh->prepare($pri_key_sql) or return undef; $sth->execute(); my $info = $sth->fetchall_arrayref()->[0]; return undef if ! defined $info; # Get the attribute information my $indkey = join ',', split /\s+/, $info->[4]; my $sql = qq{ SELECT a.attnum, ${DBD::Pg::dr::CATALOG}quote_ident(a.attname) AS colname, ${DBD::Pg::dr::CATALOG}quote_ident(t.typname) AS typename FROM ${DBD::Pg::dr::CATALOG}pg_attribute a, ${DBD::Pg::dr::CATALOG}pg_type t WHERE a.attrelid = '$info->[0]' AND a.atttypid = t.oid AND attnum IN ($indkey); }; $sth = $dbh->prepare($sql) or return undef; $sth->execute(); my $attribs = $sth->fetchall_hashref('attnum'); my $pkinfo = []; ## Normal way: complete "row" per column in the primary key if (!exists $attr->{'pg_onerow'}) { my $x=0; my @key_seq = split/\s+/, $info->[4]; for (@key_seq) { # TABLE_CAT $pkinfo->[$x][0] = undef; # SCHEMA_NAME $pkinfo->[$x][1] = $info->[1]; # TABLE_NAME $pkinfo->[$x][2] = $info->[2]; # COLUMN_NAME $pkinfo->[$x][3] = $attribs->{$_}{colname}; # KEY_SEQ $pkinfo->[$x][4] = $_; # PK_NAME $pkinfo->[$x][5] = $info->[3]; # DATA_TYPE $pkinfo->[$x][6] = $attribs->{$_}{typename}; if ($tablespacejoin) { $pkinfo->[$x][7] = $info->[5]; $pkinfo->[$x][8] = $info->[6]; } $x++; } } else { ## Nicer way: return only one row # TABLE_CAT $info->[0] = undef; # TABLESPACES if ($tablespacejoin) { $info->[7] = $info->[5]; $info->[8] = $info->[6]; } # PK_NAME $info->[5] = $info->[3]; # COLUMN_NAME $info->[3] = 2==$attr->{'pg_onerow'} ? [ map { $attribs->{$_}{colname} } split /\s+/, $info->[4] ] : join ', ', map { $attribs->{$_}{colname} } split /\s+/, $info->[4]; # DATA_TYPE $info->[6] = 2==$attr->{'pg_onerow'} ? [ map { $attribs->{$_}{typename} } split /\s+/, $info->[4] ] : join ', ', map { $attribs->{$_}{typename} } split /\s+/, $info->[4]; # KEY_SEQ $info->[4] = 2==$attr->{'pg_onerow'} ? [ split /\s+/, $info->[4] ] : join ', ', split /\s+/, $info->[4]; $pkinfo = [$info]; } my @cols = (qw(TABLE_CAT TABLE_SCHEM TABLE_NAME COLUMN_NAME KEY_SEQ PK_NAME DATA_TYPE)); push @cols, 'pg_tablespace_name', 'pg_tablespace_location' if $tablespacejoin; return _prepare_from_data('primary_key_info', $pkinfo, \@cols); } sub primary_key { my $sth = primary_key_info(@_[0..3], {pg_onerow => 2}); return defined $sth ? @{$sth->fetchall_arrayref()->[0][3]} : (); } sub foreign_key_info { my $dbh = shift; ## PK: catalog, schema, table, FK: catalog, schema, table, attr ## Each of these may be undef or empty my $pschema = $_[1] || ''; my $ptable = $_[2] || ''; my $fschema = $_[4] || ''; my $ftable = $_[5] || ''; my $args = $_[6]; ## No way to currently specify it, but we are ready when there is my $odbc = 0; ## Must have at least one named table return undef if !$ptable and !$ftable; ## Versions 7.2 or less have no pg_constraint table, so we cannot support my $version = $dbh->{private_dbdpg}{version}; return undef unless $version >= 70300; my $C = 'pg_catalog.'; ## If only the primary table is given, we return only those columns ## that are used as foreign keys, even if that means that we return ## unique keys but not primary one. We also return all the foreign ## tables/columns that are referencing them, of course. ## The first step is to find the oid of each specific table in the args: ## Return undef if no matching relation found my %oid; for ([$ptable, $pschema, 'P'], [$ftable, $fschema, 'F']) { if (length $_->[0]) { my $SQL = "SELECT c.oid AS schema FROM ${C}pg_class c, ${C}pg_namespace n\n". "WHERE c.relnamespace = n.oid AND c.relname = " . $dbh->quote($_->[0]); if (length $_->[1]) { $SQL .= " AND n.nspname = " . $dbh->quote($_->[1]); } my $info = $dbh->selectall_arrayref($SQL); return undef if ! @$info; $oid{$_->[2]} = $info->[0][0]; } } ## We now need information about each constraint we care about. ## Foreign table: only 'f' / Primary table: only 'p' or 'u' my $WHERE = $odbc ? "((contype = 'p'" : "((contype IN ('p','u')"; if (length $ptable) { $WHERE .= " AND conrelid=$oid{'P'}::oid"; } else { $WHERE .= " AND conrelid IN (SELECT DISTINCT confrelid FROM ${C}pg_constraint WHERE conrelid=$oid{'F'}::oid)"; if (length $pschema) { $WHERE .= " AND n2.nspname = " . $dbh->quote($pschema); } } $WHERE .= ")\n \t\t\t\tOR \n \t\t\t\t(contype = 'f'"; if (length $ftable) { $WHERE .= " AND conrelid=$oid{'F'}::oid"; if (length $ptable) { $WHERE .= " AND confrelid=$oid{'P'}::oid"; } } else { $WHERE .= " AND confrelid = $oid{'P'}::oid"; if (length $fschema) { $WHERE .= " AND n2.nspname = " . $dbh->quote($fschema); } } $WHERE .= "))"; ## Grab everything except specific column names: my $fk_sql = qq{ SELECT conrelid, confrelid, contype, conkey, confkey, ${C}quote_ident(c.relname) AS t_name, ${C}quote_ident(n2.nspname) AS t_schema, ${C}quote_ident(n.nspname) AS c_schema, ${C}quote_ident(conname) AS c_name, CASE WHEN confupdtype = 'c' THEN 0 WHEN confupdtype = 'r' THEN 1 WHEN confupdtype = 'n' THEN 2 WHEN confupdtype = 'a' THEN 3 WHEN confupdtype = 'd' THEN 4 ELSE -1 END AS update, CASE WHEN confdeltype = 'c' THEN 0 WHEN confdeltype = 'r' THEN 1 WHEN confdeltype = 'n' THEN 2 WHEN confdeltype = 'a' THEN 3 WHEN confdeltype = 'd' THEN 4 ELSE -1 END AS delete, CASE WHEN condeferrable = 'f' THEN 7 WHEN condeferred = 't' THEN 6 WHEN condeferred = 'f' THEN 5 ELSE -1 END AS defer FROM ${C}pg_constraint k, ${C}pg_class c, ${C}pg_namespace n, ${C}pg_namespace n2 WHERE $WHERE AND k.connamespace = n.oid AND k.conrelid = c.oid AND c.relnamespace = n2.oid ORDER BY conrelid ASC }; my $sth = $dbh->prepare($fk_sql); $sth->execute(); my $info = $sth->fetchall_arrayref({}); return undef if ! defined $info or ! @$info; ## Return undef if just ptable given but no fk found return undef if ! length $ftable and ! grep { $_->{'contype'} eq 'f'} @$info; ## Figure out which columns we need information about my %colnum; for (@$info) { $colnum{$_->{'conrelid'}}{$1}++ while $_->{'conkey'} =~ /(\d+)/go; if ($_->{'contype'} eq 'f') { $colnum{$_->{'confrelid'}}{$1}++ while $_->{'confkey'} =~ /(\d+)/go; } } ## Get the information about the columns computed above my $SQL = qq{ SELECT a.attrelid, a.attnum, ${C}quote_ident(a.attname) AS colname, ${C}quote_ident(t.typname) AS typename FROM ${C}pg_attribute a, ${C}pg_type t WHERE a.atttypid = t.oid AND (\n}; $SQL .= join "\n\t\t\t\tOR\n" => map { my $cols = join ',' => keys %{$colnum{$_}}; "\t\t\t\t( a.attrelid = '$_' AND a.attnum IN ($cols) )" } sort keys %colnum; $sth = $dbh->prepare(qq{$SQL \)}); $sth->execute(); my $attribs = $sth->fetchall_arrayref({}); ## Make a lookup hash my %attinfo; for (@$attribs) { $attinfo{"$_->{'attrelid'}"}{"$_->{'attnum'}"} = $_; } ## This is an array in case we have identical oid/column combos. Lowest oid wins my %ukey; for my $c (grep { $_->{'contype'} ne 'f' } @$info) { ## Munge multi-column keys into sequential order my $multi = join ' ' => sort split/\s*/, $c->{'conkey'}; push @{$ukey{$c->{'conrelid'}}{$multi}}, $c; } ## Finally, return as a SQL/CLI structure: my $fkinfo = []; my $x=0; for my $t (sort { $a->{'c_name'} cmp $b->{'c_name'} } grep { $_->{'contype'} eq 'f' } @$info) { ## We need to find which constraint row (if any) matches our confrelid-confkey combo ## by checking out ukey hash. We sort for proper matching of { 1 2 } vs. { 2 1 } ## No match means we have a pure index constraint my $u; my $multi = join ' ' => sort split/\s*/, $t->{'confkey'}; if (exists $ukey{$t->{'confrelid'}}{$multi}) { $u = $ukey{$t->{'confrelid'}}{$multi}->[0]; } else { ## Mark this as an index so we can fudge things later on $multi = "index"; ## Grab the first one found, modify later on as needed $u = (values %{$ukey{$t->{'confrelid'}}})[0]->[0]; } ## ODBC is primary keys only next if $odbc and ($u->{'contype'} ne 'p' or $multi eq 'index'); my (@conkey, @confkey); push (@conkey, $1) while $t->{'conkey'} =~ /(\d+)/go; push (@confkey, $1) while $t->{'confkey'} =~ /(\d+)/go; for (my $y=0; $conkey[$y]; $y++) { # UK_TABLE_CAT $fkinfo->[$x][0] = undef; # UK_TABLE_SCHEM $fkinfo->[$x][1] = $u->{'t_schema'}; # UK_TABLE_NAME $fkinfo->[$x][2] = $u->{'t_name'}; # UK_COLUMN_NAME $fkinfo->[$x][3] = $attinfo{$t->{'confrelid'}}{$confkey[$y]}{'colname'}; # FK_TABLE_CAT $fkinfo->[$x][4] = undef; # FK_TABLE_SCHEM $fkinfo->[$x][5] = $t->{'t_schema'}; # FK_TABLE_NAME $fkinfo->[$x][6] = $t->{'t_name'}; # FK_COLUMN_NAME $fkinfo->[$x][7] = $attinfo{$t->{'conrelid'}}{$conkey[$y]}{'colname'}; # ORDINAL_POSITION $fkinfo->[$x][8] = $conkey[$y]; # UPDATE_RULE $fkinfo->[$x][9] = "$t->{'update'}"; # DELETE_RULE $fkinfo->[$x][10] = "$t->{'delete'}"; # FK_NAME $fkinfo->[$x][11] = $t->{'c_name'}; # UK_NAME (may be undef if an index with no named constraint) $fkinfo->[$x][12] = $multi eq 'index' ? undef : $u->{'c_name'}; # DEFERRABILITY $fkinfo->[$x][13] = "$t->{'defer'}"; # UNIQUE_OR_PRIMARY $fkinfo->[$x][14] = ($u->{'contype'} eq 'p' and $multi ne 'index') ? 'PRIMARY' : 'UNIQUE'; # UK_DATA_TYPE $fkinfo->[$x][15] = $attinfo{$t->{'confrelid'}}{$confkey[$y]}{'typename'}; # FK_DATA_TYPE $fkinfo->[$x][16] = $attinfo{$t->{'conrelid'}}{$conkey[$y]}{'typename'}; $x++; } ## End each column in this foreign key } ## End each foreign key my @CLI_cols = (qw( UK_TABLE_CAT UK_TABLE_SCHEM UK_TABLE_NAME UK_COLUMN_NAME FK_TABLE_CAT FK_TABLE_SCHEM FK_TABLE_NAME FK_COLUMN_NAME ORDINAL_POSITION UPDATE_RULE DELETE_RULE FK_NAME UK_NAME DEFERABILITY UNIQUE_OR_PRIMARY UK_DATA_TYPE FK_DATA_TYPE )); my @ODBC_cols = (qw( PKTABLE_CAT PKTABLE_SCHEM PKTABLE_NAME PKCOLUMN_NAME FKTABLE_CAT FKTABLE_SCHEM FKTABLE_NAME FKCOLUMN_NAME KEY_SEQ UPDATE_RULE DELETE_RULE FK_NAME PK_NAME DEFERABILITY UNIQUE_OR_PRIMARY PK_DATA_TYPE FKDATA_TYPE )); return _prepare_from_data('foreign_key_info', $fkinfo, $odbc ? \@ODBC_cols : \@CLI_cols); } sub table_info { my $dbh = shift; my ($catalog, $schema, $table, $type) = @_; my $tbl_sql = (); my $version = $dbh->{private_dbdpg}{version}; if ( # Rule 19a (defined $catalog and $catalog eq '%') and (defined $schema and $schema eq '') and (defined $table and $table eq '') ) { $tbl_sql = q{ SELECT NULL::text AS "TABLE_CAT" , NULL::text AS "TABLE_SCHEM" , NULL::text AS "TABLE_NAME" , NULL::text AS "TABLE_TYPE" , NULL::text AS "REMARKS" }; } elsif (# Rule 19b (defined $catalog and $catalog eq '') and (defined $schema and $schema eq '%') and (defined $table and $table eq '') ) { $tbl_sql = $version >= 70300 ? q{SELECT NULL::text AS "TABLE_CAT" , quote_ident(n.nspname) AS "TABLE_SCHEM" , NULL::text AS "TABLE_NAME" , NULL::text AS "TABLE_TYPE" , CASE WHEN n.nspname ~ '^pg_' THEN 'system schema' ELSE 'owned by ' || pg_get_userbyid(n.nspowner) END AS "REMARKS" FROM pg_catalog.pg_namespace n ORDER BY "TABLE_SCHEM" } : q{SELECT NULL::text AS "TABLE_CAT" , NULL::text AS "TABLE_SCHEM" , NULL::text AS "TABLE_NAME" , NULL::text AS "TABLE_TYPE" , NULL::text AS "REMARKS" }; } elsif (# Rule 19c (defined $catalog and $catalog eq '') and (defined $schema and $schema eq '') and (defined $table and $table eq '') and (defined $type and $type eq '%') ) { $tbl_sql = q{ SELECT NULL::text AS "TABLE_CAT" , NULL::text AS "TABLE_SCHEM" , NULL::text AS "TABLE_NAME" , 'TABLE' AS "TABLE_TYPE" , 'relkind: r' AS "REMARKS" UNION SELECT NULL::text AS "TABLE_CAT" , NULL::text AS "TABLE_SCHEM" , NULL::text AS "TABLE_NAME" , 'VIEW' AS "TABLE_TYPE" , 'relkind: v' AS "REMARKS" }; } else { # Default SQL my $showschema = "NULL::text"; my $schemajoin = ''; my $has_objsubid = ''; my $tablespacejoin = ''; my $showtablespace = ''; my @search; if ($version >= 70300) { $showschema = "quote_ident(n.nspname)"; $schemajoin = "LEFT JOIN pg_catalog.pg_namespace n ON (n.oid = c.relnamespace)"; $has_objsubid = "AND d.objsubid = 0"; } if ($version >= 70500) { $tablespacejoin = 'LEFT JOIN pg_catalog.pg_tablespace t ON (t.oid = c.reltablespace)'; $showtablespace = ', quote_ident(t.spcname) AS "pg_tablespace_name", quote_ident(t.spclocation) AS "pg_tablespace_location"'; } ## If the schema or table has an underscore or a %, use a LIKE comparison if (defined $schema and length $schema and $version >= 70300) { push @search, "n.nspname " . ($schema =~ /[_%]/ ? "LIKE " : "= ") . $dbh->quote($schema); } if (defined $table and length $table) { push @search, "c.relname " . ($table =~ /[_%]/ ? "LIKE " : "= ") . $dbh->quote($table); } ## All we can see is "table" or "view". Default is both my $typesearch = "IN ('r','v')"; if (defined $type and length $type) { if ($type =~ /\btable\b/i and $type !~ /\bview\b/i) { $typesearch = "= 'r'"; } elsif ($type =~ /\bview\b/i and $type !~ /\btable\b/i) { $typesearch = "= 'v'"; } } push @search, "c.relkind $typesearch"; my $whereclause = join "\n\t\t\t\t\t AND " => @search; my $schemacase = $version >= 70300 ? "quote_ident(n.nspname)" : "quote_ident(c.relname)"; $tbl_sql = qq{ SELECT NULL::text AS "TABLE_CAT" , $showschema AS "TABLE_SCHEM" , quote_ident(c.relname) AS "TABLE_NAME" , CASE WHEN c.relkind = 'v' THEN CASE WHEN $schemacase ~ '^pg_' THEN 'SYSTEM VIEW' ELSE 'VIEW' END ELSE CASE WHEN $schemacase ~ '^pg_' THEN 'SYSTEM TABLE' ELSE 'TABLE' END END AS "TABLE_TYPE" , d.description AS "REMARKS" $showtablespace FROM ${DBD::Pg::dr::CATALOG}pg_class AS c LEFT JOIN ${DBD::Pg::dr::CATALOG}pg_description AS d ON (c.relfilenode = d.objoid $has_objsubid) $schemajoin $tablespacejoin WHERE $whereclause ORDER BY "TABLE_TYPE", "TABLE_CAT", "TABLE_SCHEM", "TABLE_NAME" }; } my $sth = $dbh->prepare( $tbl_sql ) or return undef; $sth->execute(); return $sth; } sub tables { my ($dbh, @args) = @_; my $attr = $args[4]; my $sth = $dbh->table_info(@args) or return; my $tables = $sth->fetchall_arrayref() or return; my $version = $dbh->{private_dbdpg}{version}; my @tables = map { ($version >= 70300 and (! (ref $attr eq "HASH" and $attr->{pg_noprefix}))) ? "$_->[1].$_->[2]" : $_->[2] } @$tables; return @tables; } sub table_attributes { my ($dbh, $table) = @_; my $sth = $dbh->column_info(undef,undef,$table,undef); my %convert = ( COLUMN_NAME => 'NAME', DATA_TYPE => 'TYPE', COLUMN_SIZE => 'SIZE', NULLABLE => 'NOTNULL', REMARKS => 'REMARKS', COLUMN_DEF => 'DEFAULT', pg_constraint => 'CONSTRAINT', ); my $attrs = $sth->fetchall_arrayref(\%convert); for my $row (@$attrs) { # switch the column names for my $name (keys %$row) { $row->{ $convert{$name} } = $row->{$name}; ## Keep some original columns delete $row->{$name} unless ($name eq 'REMARKS' or $name eq 'NULLABLE'); } # Moved check outside of loop as it was inverting the NOTNULL value for # attribute. # NOTNULL inverts the sense of NULLABLE $row->{NOTNULL} = ($row->{NOTNULL} ? 0 : 1); my @pri_keys = (); @pri_keys = $dbh->primary_key( undef, undef, $table ); $row->{PRIMARY_KEY} = scalar(grep { /^$row->{NAME}$/i } @pri_keys) ? 1 : 0; } return $attrs; } sub _calc_col_size { my $mod = shift; my $size = shift; if ((defined $size) and ($size > 0)) { return $size; } elsif ($mod > 0xffff) { my $prec = ($mod & 0xffff) - 4; $mod >>= 16; my $dig = $mod; return "$prec,$dig"; } elsif ($mod >= 4) { return $mod - 4; } # else { # $rtn = $mod; # $rtn = undef; # } return; } sub type_info_all { my ($dbh) = @_; my $names = { TYPE_NAME => 0, DATA_TYPE => 1, COLUMN_SIZE => 2, LITERAL_PREFIX => 3, LITERAL_SUFFIX => 4, CREATE_PARAMS => 5, NULLABLE => 6, CASE_SENSITIVE => 7, SEARCHABLE => 8, UNSIGNED_ATTRIBUTE => 9, FIXED_PREC_SCALE => 10, AUTO_UNIQUE_VALUE => 11, LOCAL_TYPE_NAME => 12, MINIMUM_SCALE => 13, MAXIMUM_SCALE => 14, SQL_DATA_TYPE => 15, SQL_DATETIME_SUB => 16, NUM_PREC_RADIX => 17, INTERVAL_PRECISION => 18, }; ## This list is derived from dbi_sql.h in DBI, from types.c and types.h, and from the PG docs ## Aids to make the list more readable: my $GIG = 1073741824; my $PS = 'precision/scale'; my $LEN = 'length'; my $UN = undef; my $ti = [ $names, # name sql_type size pfx/sfx crt n/c/s +-/P/I local min max sub rdx itvl ['unknown', SQL_UNKNOWN_TYPE, 0, $UN,$UN, $UN, 1,0,0, $UN,0,0, 'UNKNOWN', $UN,$UN, SQL_UNKNOWN_TYPE, $UN, $UN, $UN ], ['bytea', SQL_VARBINARY, $GIG, "'","'", $UN, 1,0,3, $UN,0,0, 'BYTEA', $UN,$UN, SQL_VARBINARY, $UN, $UN, $UN ], ['bpchar', SQL_CHAR, $GIG, "'","'", $LEN, 1,1,3, $UN,0,0, 'CHARACTER', $UN,$UN, SQL_CHAR, $UN, $UN, $UN ], ['numeric', SQL_DECIMAL, 1000, $UN,$UN, $PS, 1,0,2, 0,0,0, ' FLOAT', 0,1000, SQL_DECIMAL, $UN, $UN, $UN ], ['numeric', SQL_NUMERIC, 1000, $UN,$UN, $PS, 1,0,2, 0,0,0, 'FLOAT', 0,1000, SQL_NUMERIC, $UN, $UN, $UN ], ['int4', SQL_INTEGER, 10, $UN,$UN, $UN, 1,0,2, 0,0,0, 'INTEGER', 0,0, SQL_INTEGER, $UN, $UN, $UN ], ['int2', SQL_SMALLINT, 5, $UN,$UN, $UN, 1,0,2, 0,0,0, 'SMALLINT', 0,0, SQL_SMALLINT, $UN, $UN, $UN ], ['float4', SQL_FLOAT, 6, $UN,$UN, $PS, 1,0,2, 0,0,0, 'FLOAT', 0,6, SQL_FLOAT, $UN, $UN, $UN ], ['float8', SQL_REAL, 15, $UN,$UN, $PS, 1,0,2, 0,0,0, 'REAL', 0,15, SQL_REAL, $UN, $UN, $UN ], ['int8', SQL_DOUBLE, 20, $UN,$UN, $UN, 1,0,2, 0,0,0, 'LONGINT', 0,0, SQL_DOUBLE, $UN, $UN, $UN ], ['date', SQL_DATE, 10, "'","'", $UN, 1,0,2, $UN,0,0, 'DATE', 0,0, SQL_DATE, $UN, $UN, $UN ], ['tinterval',SQL_TIME, 18, "'","'", $UN, 1,0,2, $UN,0,0, 'TINTERVAL', 0,6, SQL_TIME, $UN, $UN, $UN ], ['timestamp',SQL_TIMESTAMP, 29, "'","'", $UN, 1,0,2, $UN,0,0, 'TIMESTAMP', 0,6, SQL_TIMESTAMP, $UN, $UN, $UN ], ['text', SQL_VARCHAR, $GIG, "'","'", $LEN, 1,1,3, $UN,0,0, 'TEXT', $UN,$UN, SQL_VARCHAR, $UN, $UN, $UN ], ['bool', SQL_BOOLEAN, 1, "'","'", $UN, 1,0,2, $UN,0,0, 'BOOLEAN', $UN,$UN, SQL_BOOLEAN, $UN, $UN, $UN ], ['array', SQL_ARRAY, 1, "'","'", $UN, 1,0,2, $UN,0,0, 'ARRAY', $UN,$UN, SQL_ARRAY, $UN, $UN, $UN ], ['date', SQL_TYPE_DATE, 10, "'","'", $UN, 1,0,2, $UN,0,0, 'DATE', 0,0, SQL_TYPE_DATE, $UN, $UN, $UN ], ['time', SQL_TYPE_TIME, 18, "'","'", $UN, 1,0,2, $UN,0,0, 'TIME', 0,6, SQL_TYPE_TIME, $UN, $UN, $UN ], ['timestamp',SQL_TYPE_TIMESTAMP,29, "'","'", $UN, 1,0,2, $UN,0,0, 'TIMESTAMP', 0,6, SQL_TYPE_TIMESTAMP, $UN, $UN, $UN ], ['timetz', SQL_TYPE_TIME_WITH_TIMEZONE, 29, "'","'", $UN, 1,0,2, $UN,0,0, 'TIMETZ', 0,6, SQL_TYPE_TIME_WITH_TIMEZONE, $UN, $UN, $UN ], ['timestamptz',SQL_TYPE_TIMESTAMP_WITH_TIMEZONE, 29, "'","'", $UN, 1,0,2, $UN,0,0, 'TIMESTAMPTZ',0,6, SQL_TYPE_TIMESTAMP_WITH_TIMEZONE, $UN, $UN, $UN ], # # intentionally omitted: char, all geometric types, internal types ]; return $ti; } # Characters that need to be escaped by quote(). my %esc = ( "'" => '\\047', # '\\' . sprintf("%03o", ord("'")), # ISO SQL 2 '\\' => '\\134', # '\\' . sprintf("%03o", ord("\\")), ); # Set up lookup for SQL types we don't want to escape. my %no_escape = map { $_ => 1 } DBI::SQL_INTEGER, DBI::SQL_SMALLINT, DBI::SQL_DECIMAL, DBI::SQL_FLOAT, DBI::SQL_REAL, DBI::SQL_DOUBLE, DBI::SQL_NUMERIC; sub get_info { my ($dbh,$type) = @_; return undef unless defined $type and length $type; my $version = $dbh->{private_dbdpg}{version}; my %type = ( ## Driver information: 116 => ["SQL_ACTIVE_ENVIRONMENTS", 0 ], 10021 => ["SQL_ASYNC_MODE", 0 ], 120 => ["SQL_BATCH_ROW_COUNT", 2 ], 121 => ["SQL_BATCH_SUPPORT", 3 ], ## ?? 2 => ["SQL_DATA_SOURCE_NAME", 'dbi:Pg:db='.$dbh->{Name} ], ## TODO: support port and other args 3 => ["SQL_DRIVER_HDBC", 0 ], ## ?? 135 => ["SQL_DRIVER_HDESC", 0 ], 4 => ["SQL_DRIVER_HENV", 0 ], 76 => ["SQL_DRIVER_HLIB", 0 ], 5 => ["SQL_DRIVER_HSTMT", 0 ], 6 => ["SQL_DRIVER_NAME", 'DBD/Pg.pm' ], 77 => ["SQL_DRIVER_ODBC_VERSION", '03.00' ], ## ?? 7 => ["SQL_DRIVER_VER", 'DBDVERSION' ], 144 => ["SQL_DYNAMIC_CURSOR_ATTRIBUTES1", 0 ], ## ?? 519 145 => ["SQL_DYNAMIC_CURSOR_ATTRIBUTES2", 0 ], ## ?? 5209 84 => ["SQL_FILE_USAGE", 0 ], 146 => ["SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES1", 519 ], ## ?? 147 => ["SQL_FORWARD_ONLY_CURSOR_ATTRIBUTES2", 5209 ], ## ?? 81 => ["SQL_GETDATA_EXTENSIONS", 15 ], 149 => ["SQL_INFO_SCHEMA_VIEWS", $version<70400? 0:3932149 ], # not: assert, charset, collat, trans 150 => ["SQL_KEYSET_CURSOR_ATTRIBUTES1", 0 ], 151 => ["SQL_KEYSET_CURSOR_ATTRIBUTES2", 0 ], 10022 => ["SQL_MAX_ASYNC_CONCURRENT_STATEMENTS", 0 ], 0 => ["SQL_MAX_DRIVER_CONNECTIONS", 'MAXCONNECTIONS' ], 152 => ["SQL_ODBC_INTERFACE_CONFORMANCE", 1 ], ## ?? 10 => ["SQL_ODBC_VER", '03.00.0000' ], ## ?? 153 => ["SQL_PARAM_ARRAY_ROW_COUNTS", 2 ], 154 => ["SQL_PARAM_ARRAY_SELECTS", 3 ], 11 => ["SQL_ROW_UPDATES", 'N' ], 14 => ["SQL_SEARCH_PATTERN_ESCAPE", '\\' ], 13 => ["SQL_SERVER_NAME", $dbh->{Name} ], 166 => ["SQL_STANDARD_CLI_CONFORMANCE", 2 ], ## ?? 167 => ["SQL_STATIC_CURSOR_ATTRIBUTES1", 519 ], ## ?? 168 => ["SQL_STATIC_CURSOR_ATTRIBUTES2", 5209 ], ## ?? ## DBMS Information 16 => ["SQL_DATABASE_NAME", $dbh->{Name} ], 17 => ["SQL_DBMS_NAME", 'PostgreSQL' ], 18 => ["SQL_DBMS_VERSION", 'ODBCVERSION' ], ## Data source information 20 => ["SQL_ACCESSIBLE_PROCEDURES", "Y" ], 19 => ["SQL_ACCESSIBLE_TABLES", "Y" ], 82 => ["SQL_BOOKMARK_PERSISTENCE", 0 ], 42 => ["SQL_CATALOG_TERM", '' ], 10004 => ["SQL_COLLATION_SEQ", 'ENCODING' ], ## ?? 22 => ["SQL_CONCAT_NULL_BEHAVIOR", 0 ], 23 => ["SQL_CURSOR_COMMIT_BEHAVIOR", 1 ], 24 => ["SQL_CURSOR_ROLLBACK_BEHAVIOR", 1 ], 10001 => ["SQL_CURSOR_SENSITIVITY", 1 ], 25 => ["SQL_DATA_SOURCE_READ_ONLY", "N" ], 26 => ["SQL_DEFAULT_TXN_ISOLATION", 8 ], 10002 => ["SQL_DESCRIBE_PARAMETER", "Y" ], 36 => ["SQL_MULT_RESULT_SETS", "Y" ], 37 => ["SQL_MULTIPLE_ACTIVE_TXN", "Y" ], 111 => ["SQL_NEED_LONG_DATA_LEN", "N" ], 85 => ["SQL_NULL_COLLATION", 0 ], 40 => ["SQL_PROCEDURE_TERM", "function" ], ## for now 39 => ["SQL_SCHEMA_TERM", "schema" ], 44 => ["SQL_SCROLL_OPTIONS", 8 ], ## ?? 45 => ["SQL_TABLE_TERM", "table" ], 46 => ["SQL_TXN_CAPABLE", 2 ], 72 => ["SQL_TXN_ISOLATION_OPTION", 15 ], 47 => ["SQL_USER_NAME", $dbh->{CURRENT_USER} ], ## Supported SQL 169 => ["SQL_AGGREGATE_FUNCTIONS", 127 ], 117 => ["SQL_ALTER_DOMAIN", 31 ], 86 => ["SQL_ALTER_TABLE", 32639 ], ## no collate 114 => ["SQL_CATALOG_LOCATION", 0 ], 10003 => ["SQL_CATALOG_NAME", "N" ], 41 => ["SQL_CATALOG_NAME_SEPARATOR", "" ], 92 => ["SQL_CATALOG_USAGE", 0 ], 87 => ["SQL_COLUMN_ALIAS", "Y" ], 74 => ["SQL_CORRELATION_NAME", 2 ], 127 => ["SQL_CREATE_ASSERTION", 0 ], 128 => ["SQL_CREATE_CHARACTER_SET", 0 ], 129 => ["SQL_CREATE_COLLATION", 0 ], 130 => ["SQL_CREATE_DOMAIN", 23 ], 131 => ["SQL_CREATE_SCHEMA", $version<70300 ? 0 : 3 ], 132 => ["SQL_CREATE_TABLE", 13845 ], 133 => ["SQL_CREATE_TRANSLATION", 0 ], 134 => ["SQL_CREATE_VIEW", 9 ], 119 => ["SQL_DATETIME_LITERALS", 65535 ], 170 => ["SQL_DDL_INDEX", 3 ], 136 => ["SQL_DROP_ASSERTION", 0 ], 137 => ["SQL_DROP_CHARACTER_SET", 0 ], 138 => ["SQL_DROP_COLLATION", 0 ], 139 => ["SQL_DROP_DOMAIN", 7 ], 140 => ["SQL_DROP_SCHEMA", $version<70300 ? 0 : 7 ], 141 => ["SQL_DROP_TABLE", 7 ], 142 => ["SQL_DROP_TRANSLATION", 0 ], 143 => ["SQL_DROP_VIEW", 7 ], 27 => ["SQL_EXPRESSIONS_IN_ORDERBY", "Y" ], 88 => ["SQL_GROUP_BY", 2 ], 28 => ["SQL_IDENTIFIER_CASE", 2 ], ## kinda 29 => ["SQL_IDENTIFIER_QUOTE_CHAR", '"' ], 148 => ["SQL_INDEX_KEYWORDS", 0 ], 172 => ["SQL_INSERT_STATEMENT", 7 ], 73 => ["SQL_INTEGERITY", "Y" ], ## e.g. ON DELETE CASCADE? 89 => ["SQL_KEYWORDS", 'KEYWORDS' ], 113 => ["SQL_LIKE_ESCAPE_CLAUSE", "Y" ], 75 => ["SQL_NON_NULLABLE_COLUMNS", 1 ], 115 => ["SQL_OJ_CAPABILITIES", 127 ], 90 => ["SQL_ORDER_BY_COLUMNS_IN_SELECT", "N" ], 38 => ["SQL_OUTER_JOINS", "Y" ], 21 => ["SQL_PROCEDURES", "Y" ], 93 => ["SQL_QUOTED_IDENTIFIER_CASE", 3 ], 91 => ["SQL_SCHEMA_USAGE", $version<70300 ? 0 : 31 ], 94 => ["SQL_SPECIAL_CHARACTERS", '$' ], 118 => ["SQL_SQL_CONFORMANCE", 4 ], ## ?? 95 => ["SQL_SUBQUERIES", 31 ], 96 => ["SQL_UNION", 3 ], ## SQL limits 112 => ["SQL_MAX_BINARY_LITERAL_LEN", 0 ], 34 => ["SQL_MAX_CATALOG_NAME_LEN", 0 ], 108 => ["SQL_MAX_CHAR_LITERAL_LEN", 0 ], 30 => ["SQL_MAX_COLUMN_NAME_LEN", 'NAMEDATALEN' ], 97 => ["SQL_MAX_COLUMNS_IN_GROUP_BY", 0 ], 98 => ["SQL_MAX_COLUMNS_IN_INDEX", 0 ], 99 => ["SQL_MAX_COLUMNS_IN_ORDER_BY", 0 ], 100 => ["SQL_MAX_COLUMNS_IN_SELECT", 0 ], 101 => ["SQL_MAX_COLUMNS_IN_TABLE", 1600 ], ## depends on column types 31 => ["SQL_MAX_CURSOR_NAME_LEN", 'NAMEDATALEN' ], 10005 => ["SQL_MAX_IDENTIFIER_LEN", 'NAMEDATALEN' ], 102 => ["SQL_MAX_INDEX_SIZE", 0 ], 102 => ["SQL_MAX_PROCEDURE_NAME_LEN", 'NAMEDATALEN' ], 104 => ["SQL_MAX_ROW_SIZE", 0 ], ## actually 1.6 TB, but too big to represent here 103 => ["SQL_MAX_ROW_SIZE_INCLUDES_LONG", "Y" ], 32 => ["SQL_MAX_SCHEMA_NAME_LEN", 'NAMEDATALEN' ], 105 => ["SQL_MAX_STATEMENT_LEN", 0 ], 35 => ["SQL_MAX_TABLE_NAME_LEN", 'NAMEDATALEN' ], 106 => ["SQL_MAX_TABLES_IN_SELECT", 0 ], 107 => ["SQL_MAX_USER_NAME_LEN", 'NAMEDATALEN' ], ## Scalar function information 48 => ["SQL_CONVERT_FUNCTIONS", 2 ], ## ?? 49 => ["SQL_NUMERIC_FUNCTIONS", 16777215 ], ## ?? all but some naming clashes: rand(om), trunc(ate), log10=ln, etc. 50 => ["SQL_STRING_FUNCTIONS", 16280984 ], ## ?? 51 => ["SQL_SYSTEM_FUNCTIONS", 0 ], ## ?? 109 => ["SQL_TIMEDATE_ADD_INTERVALS", 0 ], ## ?? no explicit timestampadd? 110 => ["SQL_TIMEDATE_DIFF_INTERVALS", 0 ], ## ?? 52 => ["SQL_TIMEDATE_FUNCTIONS", 1966083 ], ## Conversion information - all but BIT, LONGVARBINARY, and LONGVARCHAR 53 => ["SQL_CONVERT_BIGINT", 1830399 ], 54 => ["SQL_CONVERT_BINARY", 1830399 ], 55 => ["SQL_CONVERT_BIT", 0 ], 56 => ["SQL_CONVERT_CHAR", 1830399 ], 57 => ["SQL_CONVERT_DATE", 1830399 ], 58 => ["SQL_CONVERT_DECIMAL", 1830399 ], 59 => ["SQL_CONVERT_DOUBLE", 1830399 ], 60 => ["SQL_CONVERT_FLOAT", 1830399 ], 61 => ["SQL_CONVERT_INTEGER", 1830399 ], 123 => ["SQL_CONVERT_INTERVAL_DAY_TIME", 1830399 ], 124 => ["SQL_CONVERT_INTERVAL_YEAR_MONTH", 1830399 ], 71 => ["SQL_CONVERT_LONGVARBINARY", 0 ], 62 => ["SQL_CONVERT_LONGVARCHAR", 0 ], 63 => ["SQL_CONVERT_NUMERIC", 1830399 ], 64 => ["SQL_CONVERT_REAL", 1830399 ], 65 => ["SQL_CONVERT_SMALLINT", 1830399 ], 66 => ["SQL_CONVERT_TIME", 1830399 ], 67 => ["SQL_CONVERT_TIMESTAMP", 1830399 ], 68 => ["SQL_CONVERT_TINYINT", 1830399 ], 69 => ["SQL_CONVERT_VARBINARY", 0 ], 70 => ["SQL_CONVERT_VARCHAR", 1830399 ], 122 => ["SQL_CONVERT_WCHAR", 0 ], 125 => ["SQL_CONVERT_WLONGVARCHAR", 0 ], 126 => ["SQL_CONVERT_WVARCHAR", 0 ], ); ## end of %type ## Put both numbers and names into a hash my %t; for (keys %type) { $t{$_} = $type{$_}->[1]; $t{$type{$_}->[0]} = $type{$_}->[1]; } return undef unless exists $t{$type}; my $ans = $t{$type}; if ($ans eq 'NAMEDATALEN') { return $version >= 70300 ? 63 : 31; ## Could technically be more } elsif ($ans eq 'ODBCVERSION') { return "00.00.0000" unless $version =~ /^(\d\d?)(\d\d)(\d\d)$/o; return sprintf "%02d.%02d.%.2d00", $1,$2,$3; } elsif ($ans eq 'DBDVERSION') { my $simpleversion = $DBD::Pg::VERSION; $simpleversion =~ s/_/./g; return sprintf "%02d.%02d.%1d%1d%1d%1d", split (/\./, "$simpleversion.0.0.0.0.0.0"); } elsif ($ans eq 'MAXCONNECTIONS') { return $dbh->selectall_arrayref("show max_connections")->[0][0]; } elsif ($ans eq 'ENCODING') { return $dbh->selectall_arrayref("show server_encoding")->[0][0]; } elsif ($ans eq 'KEYWORDS') { ## http://www.postgresql.org/docs/current/static/sql-keywords-appendix.html ## Basically, we want ones that are 'reserved' for PostgreSQL but not 'reserved' in SQL:2003 return join "," => (qw(ANALYSE ANALYZE ASC DEFERRABLE DESC DO ILIKE INITIALLY ISNULL LIMIT NOTNULL OFF OFFSET PLACING VERBOSE)); } return $ans; } # end of get_info } { package DBD::Pg::st; sub bind_param_array { ## The DBI version is broken, so we implement a near-copy here my $sth = shift; my ($p_id, $value_array, $attr) = @_; return $sth->set_err(1, "Value for parameter $p_id must be a scalar or an arrayref, not a ".ref($value_array)) if defined $value_array and ref $value_array and ref $value_array ne 'ARRAY'; return $sth->set_err(1, "Can't use named placeholders for non-driver supported bind_param_array") unless DBI::looks_like_number($p_id); # because we rely on execute(@ary) here # get/create arrayref to hold params my $hash_of_arrays = $sth->{ParamArrays} ||= { }; if (ref $value_array eq 'ARRAY') { # check that input has same length as existing # find first arrayref entry (if any) for (keys %$hash_of_arrays) { my $v = $$hash_of_arrays{$_}; next unless ref $v eq 'ARRAY'; return $sth->set_err (1,"Arrayref for parameter $p_id has ".@$value_array." elements" ." but parameter $_ has ".@$v) if @$value_array != @$v; } } $$hash_of_arrays{$p_id} = $value_array; return $sth->bind_param($p_id, '', $attr) if $attr; ## This is the big change so -w does not complain 1; } } ## end st section 1; __END__ =head1 NAME DBD::Pg - PostgreSQL database driver for the DBI module =head1 VERSION This documents version 1.49 of the DBD::Pg module =head1 SYNOPSIS use DBI; $dbh = DBI->connect("dbi:Pg:dbname=$dbname", "", "", {AutoCommit => 0}); # For some advanced uses you may need PostgreSQL type values: use DBD::Pg qw(:pg_types); # See the DBI module documentation for full details =head1 DESCRIPTION DBD::Pg is a Perl module that works with the DBI module to provide access to PostgreSQL databases. =head1 MODULE DOCUMENTATION This documentation describes driver specific behavior and restrictions. It is not supposed to be used as the only reference for the user. In any case consult the L documentation first! =head1 THE DBI CLASS =head2 DBI Class Methods =over 4 =item B To connect to a database with a minimum of parameters, use the following syntax: $dbh = DBI->connect("dbi:Pg:dbname=$dbname", "", ""); This connects to the database $dbname on the default port (usually 5432) without any user authentication. The following connect statement shows almost all possible parameters: $dbh = DBI->connect("dbi:Pg:dbname=$dbname;host=$host;port=$port;" . "options=$options", "$username", "$password", {AutoCommit => 0}); If a parameter is not given, the PostgreSQL server will first look for specific environment variables, and then use hard-coded defaults: parameter environment variable hard coded default -------------------------------------------------- host PGHOST local domain socket hostaddr* PGHOSTADDR local domain socket port PGPORT 5432 dbname** PGDATABASE current userid username PGUSER current userid password PGPASSWORD (none) options PGOPTIONS (none) service* PGSERVICE (none) sslmode* PGSSLMODE (none) * Only for servers running version 7.4 or greater ** Can also use "db" or "database" The options parameter specifies runtime options for the Postgres backend. Common usage is to increase the number of buffers with the C<-B> option. Also important is the C<-F> option, which disables automatic fsync() call after each transaction. For further details please refer to the PostgreSQL documentation at L. For authentication with username and password, appropriate entries have to be made in F. Please refer to the comments in the F and the F files for the different types of authentication. Note that for these two parameters DBI distinguishes between empty and undefined. If these parameters are undefined DBI substitutes the values of the environment variables C and C if present. You can also conenct by using a service connection file, which is named "pg_service.conf." The location of this file can be controlled by setting the C environment variable. To use one of the named services within the file, set the name by using either the "service" parameter or the environment variable C. Note that when connecting this way, only the minimum parameters should be used. For example, to connect to a service named "zephyr", you could use: $dbh = DBI->connect("dbi:Pg:service=zephyr", "", ""); You could also set $ENV{PGSERVICE} to "zephyr" and connect like this: $dbh = DBI->connect("dbi:Pg:", "", ""); The format of the pg_service.conf file is simply a bracketed service name, followed by one parameter per line in the format name=value. For example: [zephyr] dbname=winds user=wisp password=W$2Hc00YSgP port=6543 There are four valid arguments to the "sslmode" parameter, which controls whether to use SSL to connect to the database: =over 4 =item disable - SSL connections are never used =item allow - try non-SSL, then SSL =item prefer - try SSL, then non-SSL =item require - connect only with SSL =back =item B Implemented by DBI, no driver-specific impact. =item B Implemented by DBI, no driver-specific impact. =item B Implemented by DBI, no driver-specific impact. =item B @driver_names = DBI->available_drivers; Implemented by DBI, no driver-specific impact. =item B @data_sources = DBI->data_sources('Pg'); This driver supports this method. Note that the necessary database connection to the database "template1" will be made on the localhost without any user authentication. Other preferences can only be set with the environment variables C, C, C, C, and C. =back =head1 METHODS COMMON TO ALL HANDLES =over 4 =item B $rv = $h->err; Supported by this driver as proposed by DBI. For the connect method it returns C. In all other cases it returns C of the current handle. =item B $str = $h->errstr; Supported by this driver as proposed by DBI. It returns the C related to the current handle. =item B $str = $h->state; Supported by this driver. Returns a five-character "SQLSTATE" code. Success is indicated by a "00000" code, which gets mapped to an empty string by DBI. A code of S8006 indicates a connection failure, usually because the connection to the PostgreSQL server has been lost. Note that state can be called as either $sth->state or $dbh->state. PostgreSQL servers version less than 7.4 will return a small subset of the available codes, and should not be relied upon. The list of codes used by PostgreSQL can be found at: L =item B $h->trace($trace_level); $h->trace($trace_level, $trace_filename); Implemented by DBI, no driver-specific impact. =item B $h->trace_msg($message_text); $h->trace_msg($message_text, $min_level); Implemented by DBI, no driver-specific impact. =item B This driver supports a variety of driver specific functions accessible via the C method. Note that the name of the function comes last, after the arguments. =over =item table_attributes $attrs = $dbh->func($table, 'table_attributes'); The C function is no longer recommended. Instead, you can use the more portable C and C methods to access the same information. The C method returns, for the given table argument, a reference to an array of hashes, each of which contains the following keys: NAME attribute name TYPE attribute type SIZE attribute size (-1 for variable size) NULLABLE flag nullable DEFAULT default value CONSTRAINT constraint PRIMARY_KEY flag is_primary_key REMARKS attribute description The REMARKS field will be returned as C for Postgres versions 7.1.x and older. =item lo_creat $lobjId = $dbh->func($mode, 'lo_creat'); Creates a new large object and returns the object-id. $mode is a bitmask describing different attributes of the new object. Use the following constants: $dbh->{pg_INV_WRITE} $dbh->{pg_INV_READ} Upon failure it returns C. =item lo_open $lobj_fd = $dbh->func($lobjId, $mode, 'lo_open'); Opens an existing large object and returns an object-descriptor for use in subsequent C calls. For the mode bits see C. Returns C upon failure. Note that 0 is a perfectly correct object descriptor! =item lo_write $nbytes = $dbh->func($lobj_fd, $buf, $len, 'lo_write'); Writes $len bytes of $buf into the large object $lobj_fd. Returns the number of bytes written and C upon failure. =item lo_read $nbytes = $dbh->func($lobj_fd, $buf, $len, 'lo_read'); Reads $len bytes into $buf from large object $lobj_fd. Returns the number of bytes read and C upon failure. =item lo_lseek $loc = $dbh->func($lobj_fd, $offset, $whence, 'lo_lseek'); Changes the current read or write location on the large object $obj_id. Currently $whence can only be 0 (C). Returns the current location and C upon failure. =item lo_tell $loc = $dbh->func($lobj_fd, 'lo_tell'); Returns the current read or write location on the large object $lobj_fd and C upon failure. =item lo_close $lobj_fd = $dbh->func($lobj_fd, 'lo_close'); Closes an existing large object. Returns true upon success and false upon failure. =item lo_unlink $ret = $dbh->func($lobjId, 'lo_unlink'); Deletes an existing large object. Returns true upon success and false upon failure. =item lo_import $lobjId = $dbh->func($filename, 'lo_import'); Imports a Unix file as large object and returns the object id of the new object or C upon failure. =item lo_export $ret = $dbh->func($lobjId, $filename, 'lo_export'); Exports a large object into a Unix file. Returns false upon failure, true otherwise. =item pg_notifies $ret = $dbh->func('pg_notifies'); Returns either C or a reference to two-element array [ $table, $backend_pid ] of asynchronous notifications received. =item getfd $fd = $dbh->func('getfd'); Returns fd of the actual connection to server. Can be used with select() and func('pg_notifies'). Deprecated in favor of C<< $dbh->{pg_socket} >>. =back =back =head1 ATTRIBUTES COMMON TO ALL HANDLES =over 4 =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, read-only) Supported by this driver as proposed by DBI. A database handle is active while it is connected and statement handle is active until it is finished. =item B (boolean, read-only) Implemented by DBI, no driver-specific impact. Requires DBI 1.41 or greater. =item B (integer, read-only) Implemented by DBI, no driver-specific impact. =item B (integer, read-only) Implemented by DBI, no driver-specific impact. =item B (hash ref) Implemented by DBI, no driver-specific impact. =item B (scalar) Implemented by DBI, no driver-specific impact. =item B (array ref) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Not used by this driver. =item B (boolean) Implemented by DBI, no driver-specific impact. If set to true, then the disconnect() method will not be automatically called when the database handle goes out of scope (e.g. when exiting after a fork). =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (code ref, inherited) Implemented by DBI, no driver-specific impact. =item B (unsigned integer) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (integer, inherited) Implemented by DBI, no driver-specific impact. =item B (string, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Supported by this driver as proposed by DBI. This method is similar to the SQL function C. =item B (integer, inherited) Not used by this driver. =item B (boolean, inherited) Not used by this driver. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (boolean, inherited) Implemented by DBI, no driver-specific impact. =item B (inherited) Implemented by DBI, no driver-specific impact. =back =head1 DBI DATABASE HANDLE OBJECTS =head2 Database Handle Methods =over 4 =item B @row_ary = $dbh->selectrow_array($statement, \%attr, @bind_values); Implemented by DBI, no driver-specific impact. =item B $ary_ref = $dbh->selectrow_arrayref($statement, \%attr, @bind_values); Implemented by DBI, no driver-specific impact. =item B $hash_ref = $dbh->selectrow_hashref($statement, \%attr, @bind_values); Implemented by DBI, no driver-specific impact. =item B $ary_ref = $dbh->selectall_arrayref($statement, \%attr, @bind_values); Implemented by DBI, no driver-specific impact. =item B $hash_ref = $dbh->selectall_hashref($statement, $key_field); Implemented by DBI, no driver-specific impact. =item B $ary_ref = $dbh->selectcol_arrayref($statement, \%attr, @bind_values); Implemented by DBI, no driver-specific impact. =item B $sth = $dbh->prepare($statement, \%attr); WARNING: DBD::Pg now uses true prepared statements by sending them to the backend to be prepared by the PostgreSQL server. Statements that were legal before may no longer work. See below for details. Prepares a statement for later execution. PostgreSQL supports prepared statements, which enables DBD::Pg to only send the query once, and simply send the arguments for every subsequent call to execute(). DBD::Pg can use these server-side prepared statements, or it can just send the entire query to the server each time. The best way is automatically chosen for each query. This will be sufficient for most users: keep reading for a more detailed explanation and some optional flags. Statements that do not begin with the word "SELECT", "INSERT", "UPDATE", or "DELETE" will not be sent to be server-side prepared. Deciding whether or not to use prepared statements depends on many factors, but you can force them to be used or not used by passing the C attribute to prepare(). A "0" means to never use prepared statements. This is the default when connected to servers earlier than version 7.4, which is when prepared statements were introduced. Setting C to "1" means that prepared statements should be used whenever possible. This is the default for servers version 8.0 or higher. Servers that are version 7.4 get a special default value of "2", because server-side statements were only partially supported in that version. In this case, it only uses server-side prepares if all parameters are specifically bound. The pg_server_prepare attribute can also be set at connection time like so: $dbh = DBI->connect($DBNAME, $DBUSER, $DBPASS, { AutoCommit => 0, RaiseError => 1, pg_server_prepare => 0 }); or you may set it after your database handle is created: $dbh->{pg_server_prepare} = 1; To enable it for just one particular statement: $sth = $dbh->prepare("SELECT id FROM mytable WHERE val = ?", { pg_server_prepare => 1 }); You can even toggle between the two as you go: $sth->{pg_server_prepare} = 1; $sth->execute(22); $sth->{pg_server_prepare} = 0; $sth->execute(44); $sth->{pg_server_prepare} = 1; $sth->execute(66); In the above example, the first execute will use the previously prepared statement. The second execute will not, but will build the query into a single string and send it to the server. The third one will act like the first and only send the arguments. Even if you toggle back and forth, a statement is only prepared once. Using prepared statements is in theory quite a bit faster: not only does the PostgreSQL backend only have to prepare the query only once, but DBD::Pg no longer has to worry about quoting each value before sending it to the server. However, there are some drawbacks. The server cannot always choose the ideal parse plan because it will not know the arguments before hand. But for most situations in which you will be executing similar data many times, the default plan will probably work out well. Further discussion on this subject is beyond the scope of this documentation: please consult the pgsql-performance mailing list, L Only certain commands will be sent to a server-side prepare: currently these include C statements. The "prepare/bind/execute" process has changed significantly for PostgreSQL servers 7.4 and later: please see the C and C entries for much more information. Setting one of the bind_values to "undef" is the equivalent of setting the value to NULL in the database. Setting the bind_value to $DBDPG_DEFAULT is equivalent to sending the literal string 'DEFAULT' to the backend. Note that using this option will force server-side prepares off until such time as PostgreSQL supports using DEFAULT in prepared statements. =item B Supported by this driver as proposed by DBI. =item B Supported by this driver as proposed by DBI. =item B $ary_ref = $sth->fetchrow_arrayref; Supported by this driver as proposed by DBI. =item B @ary = $sth->fetchrow_array; Supported by this driver as proposed by DBI. =item B $hash_ref = $sth->fetchrow_hashref; Supported by this driver as proposed by DBI. =item B $tbl_ary_ref = $sth->fetchall_arrayref; Implemented by DBI, no driver-specific impact. =item B $rc = $sth->finish; Supported by this driver as proposed by DBI. =item B $rv = $sth->rows; Supported by this driver as proposed by DBI. In contrast to many other drivers the number of rows is available immediately after executing the statement. =item B $rc = $sth->bind_col($column_number, \$var_to_bind, \%attr); Supported by this driver as proposed by DBI. =item B $rc = $sth->bind_columns(\%attr, @list_of_refs_to_vars_to_bind); Supported by this driver as proposed by DBI. =item B $rows = $sth->dump_results($maxlen, $lsep, $fsep, $fh); Implemented by DBI, no driver-specific impact. =item B $blob = $sth->blob_read($id, $offset, $len); Supported by this driver as proposed by DBI. Implemented by DBI but not documented, so this method might change. This method seems to be heavily influenced by the current implementation of blobs in Oracle. Nevertheless we try to be as compatible as possible. Whereas Oracle suffers from the limitation that blobs are related to tables and every table can have only one blob (datatype LONG), PostgreSQL handles its blobs independent of any table by using so-called object identifiers. This explains why the C method is blessed into the STATEMENT package and not part of the DATABASE package. Here the field parameter has been used to handle this object identifier. The offset and len parameters may be set to zero, in which case the driver fetches the whole blob at once. Starting with PostgreSQL 6.5, every access to a blob has to be put into a transaction. This holds even for a read-only access. See also the PostgreSQL-specific functions concerning blobs, which are available via the C interface. For further information and examples about blobs, please read the chapter about Large Objects in the PostgreSQL Programmer's Guide at L. =back =head2 Statement Handle Attributes =over 4 =item B (integer, read-only) Implemented by DBI, no driver-specific impact. =item B (integer, read-only) Implemented by DBI, no driver-specific impact. =item B (array-ref, read-only) Supported by this driver as proposed by DBI. =item B (array-ref, read-only) Implemented by DBI, no driver-specific impact. =item B (array-ref, read-only) Implemented by DBI, no driver-specific impact. =item B (hash-ref, read-only) Implemented by DBI, no driver-specific impact. =item B (hash-ref, read-only) Implemented by DBI, no driver-specific impact. =item B (hash-ref, read-only) Implemented by DBI, no driver-specific impact. =item B (array-ref, read-only) Supported by this driver as proposed by DBI =item B (array-ref, read-only) Supported by this driver. C types will return the precision. Types of C and C will return their size (number of characters). Other types will return the number of I. =item B (array-ref, read-only) Supported by this driver as proposed by DBI. The only type that will return a value currently is C. =item B (array-ref, read-only) Supported by this driver as proposed by DBI. This is only available for servers version 7.3 and later. Others will return "2" for all columns. =item B (string, read-only) Not supported by this driver. See the note about B elsewhere in this document. =item C (dbh, read-only) Implemented by DBI, no driver-specific impact. =item C (hash ref, read-only) Supported by this driver as proposed by DBI. If called before C, the literal values passed in are returned. If called after C, then the quoted versions of the values are shown. =item C (hash ref, read-only) Returns a hash of all current placeholders. The keys are the names of the placeholders, and the values are the types that have been bound to each one. Placeholders that have not yet been bound will return undef as the value. =item B (string, read-only) Supported by this driver as proposed by DBI. =item B (integer, read-only) Not supported by this driver. =item B (array-ref, read-only) PostgreSQL specific attribute. It returns a reference to an array of integer values for each column. The integer shows the size of the column in bytes. Variable length columns are indicated by -1. =item B (array-ref, read-only) PostgreSQL specific attribute. It returns a reference to an array of strings for each column. The string shows the name of the data_type. =item B (integer, read-only) PostgreSQL specific attribute. It returns the OID of the last INSERT command. =item B (integer, read-only) PostgreSQL specific attribute. It returns the type of the last command. Possible types are: "INSERT", "DELETE", "UPDATE", "SELECT". =back =head1 FURTHER INFORMATION =head2 Transactions Transaction behavior is controlled via the C attribute. For a complete definition of C please refer to the DBI documentation. According to the DBI specification the default for C is a true value. In this mode, any change to the database becomes valid immediately. Any C, C or C statements will be rejected. DBD::Pg implements C by issuing a C statement immediately before executing a statement, and a C afterwards. =head2 Savepoints PostgreSQL version 8.0 introduced the concept of savepoints, which allows transactions to be rolled back to a certain point without affecting the rest of the transaction. DBD::Pg encourages using the following methods to control savepoints: =over 4 =item B Creates a savepoint. This will fail unless you are inside of a transaction. The only argument is the name of the savepoint. Note that PostgreSQL DOES allow multiple savepoints with the same name to exist. $dbh->pg_savepoint("mysavepoint"); =item B Rolls the database back to a named savepoint, discarding any work performed after that point. If more than one savepoint with that name exists, rolls back to the most recently created one. $dbh->pg_rollback_to("mysavepoint"); =item B Releases (or removes) a named savepoint. If more than one savepoint with that name exists, it will only destroy the most recently created one. Note that all savepoints created after the one being released are also destroyed. $dbh->pg_release("mysavepoint"); =back =head2 COPY support DBD::Pg supports the COPY command through three functions: pg_putline, pg_getline, and pg_endcopy. The COPY command allows data to be quickly loaded or read from a table. The basic process is to issue a COPY command via $dbh->do(), do either $dbh->pg_putline or $dbh->pg_getline, and then issue a $dbh->pg_endcopy (for pg_putline only). The first step is to put the server into "COPY" mode. This is done by sending a complete COPY command to the server, by using the do() method. For example: $dbh->do("COPY foobar FROM STDIN"); This would tell the server to enter a COPY IN state. It is now ready to receive information via the pg_putline method. The complete syntax of the COPY command is more complex and not documented here: the canonical PostgreSQL documentation for COPY be found at: http://www.postgresql.org/docs/current/static/sql-copy.html Note that 7.2 servers can only accept a small subset of later features in the COPY command: most notably they do not accept column specifications. Once the COPY command has been issued, no other SQL commands are allowed until after pg_endcopy has been successfully called. If in a COPY IN state, you cannot use pg_getline, and if in COPY OUT state, you cannot use pg_putline. =over 4 =item B Used to put data into a table after the server has been put into COPY IN mode by calling "COPY tablename FROM STDIN". The only argument is the data you want inserted. The default delimiter is a tab character, but this can be changed in the COPY statement. Returns a 1 on sucessful input. Examples: $dbh->do("COPY mytable FROM STDIN"); $dbh->pg_putline("123\tPepperoni\t3\n"); $dbh->pg_putline("314\tMushroom\t8\n"); $dbh->pg_putline("6\tAnchovies\t100\n"); $dbh->pg_endcopy; ## This example uses explicit columns and a custom delimiter $dbh->do("COPY mytable(flavor, slices) FROM STDIN WITH DELIMITER '~'"); $dbh->pg_putline("Pepperoni~123\n"); $dbh->pg_putline("Mushroom~314\n"); $dbh->pg_putline("Anchovies~6\n"); $dbh->pg_endcopy; =item B Used to retrieve data from a table after the server has been put into COPY OUT mode by calling "COPY tablename TO STDOUT". The first argument to pg_getline is the variable into which the data will be stored. The second argument is the size of the variable: this should be greater than the expected size of the row. Returns a 1 on success, and an empty string when the last row has been fetched. Example: $dbh->do("COPY mytable TO STDOUT"); my @data; my $x=0; 1 while($dbh->pg_getline($data[$x++], 100)); pop @data; ## Remove final "\\.\n" line If DBD::Pg is compiled with pre-7.4 libraries, this function will not work: you will have to use the old $dbh->func($data, 100, 'getline') command, and call pg_getline manually. Users are highly encouraged to upgrade to a newer version of PostgreSQL if this is the case. =item B When done with pg_putline, call pg_endcopy to put the server back in a normal state. Returns a 1 on success. This method will fail if called when not in a COPY IN or COPY OUT state. Note that you no longer need to send "\\.\n" when in COPY IN mode: pg_endcopy will do this for you automatically as needed. pg_endcopy is only needed after getline if you are using the old-style method, $dbh->func($data, 100, 'getline'). =back =head2 Large Objects This driver supports all largeobject functions provided by libpq via the C method. Please note that, starting with PostgreSQL 6.5, any access to a large object -- even read-only large objects -- must be put into a transaction! =head2 Cursors Although PostgreSQL has a cursor concept, it has not been used in the current implementation. Cursors in PostgreSQL can only be used inside a transaction block. Because only one transaction block at a time is allowed, this would have implied the restriction not to use any nested C