1 package DBIx::Class::Storage::DBI::Pg;
6 use base qw/DBIx::Class::Storage::DBI::MultiColumnIn/;
9 use DBD::Pg qw(:pg_types);
11 # Ask for a DBD::Pg with array support
12 warn "DBD::Pg 2.9.2 or greater is strongly recommended\n"
13 if ($DBD::Pg::VERSION < 2.009002); # pg uses (used?) version::qv()
15 sub with_deferred_fk_checks {
16 my ($self, $sub) = @_;
18 $self->_get_dbh->do('SET CONSTRAINTS ALL DEFERRED');
23 my ($self,$source,$col) = @_;
24 my $seq = ( $source->column_info($col)->{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
25 or $self->throw_exception( "could not determine sequence for "
27 . ".$col, please consider adding a "
28 . "schema-qualified sequence to its column info"
31 $self->_dbh_last_insert_id ($self->_dbh, $seq);
34 # there seems to be absolutely no reason to have this as a separate method,
35 # but leaving intact in case someone is already overriding it
36 sub _dbh_last_insert_id {
37 my ($self, $dbh, $seq) = @_;
38 $dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
42 sub _dbh_get_autoinc_seq {
43 my ($self, $dbh, $source, $col) = @_;
46 my $table = $source->name;
48 # deref table name if it needs it
50 if ref $table eq 'SCALAR';
52 # parse out schema name if present
53 if( $table =~ /^(.+)\.(.+)$/ ) {
54 ( $schema, $table ) = ( $1, $2 );
57 # use DBD::Pg to fetch the column info if it is recent enough to
58 # work. otherwise, use custom SQL
59 my $seq_expr = $DBD::Pg::VERSION >= 2.015001
60 ? eval{ $dbh->column_info(undef,$schema,$table,$col)->fetchrow_hashref->{COLUMN_DEF} }
61 : $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
63 # if no default value is set on the column, or if we can't parse the
64 # default value as a sequence, throw.
65 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ){
66 $seq_expr = '' unless defined $seq_expr;
67 $schema = "$schema." if defined $schema && length $schema;
68 $self->throw_exception( "no sequence found for $schema$table.$col, check table definition, "
69 . "or explicitly set the 'sequence' for this column in the "
70 . $source->source_name
78 # custom method for fetching column default, since column_info has a
79 # bug with older versions of DBD::Pg
80 sub _dbh_get_column_default {
81 my ( $self, $dbh, $schema, $table, $col ) = @_;
83 # Build and execute a query into the pg_catalog to find the Pg
84 # expression for the default value for this column in this table.
85 # If the table name is schema-qualified, query using that specific
88 # Otherwise, find the table in the standard Postgres way, using the
89 # search path. This is done with the pg_catalog.pg_table_is_visible
90 # function, which returns true if a given table is 'visible',
91 # meaning the first table of that name to be found in the search
94 # I *think* we can be assured that this query will always find the
95 # correct column according to standard Postgres semantics.
99 my $sqlmaker = $self->sql_maker;
100 local $sqlmaker->{bindtype} = 'normal';
102 my ($where, @bind) = $sqlmaker->where ({
103 'a.attnum' => {'>', 0},
104 'c.relname' => $table,
106 -not_bool => 'a.attisdropped',
107 (defined $schema && length $schema)
108 ? ( 'n.nspname' => $schema )
109 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
112 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
115 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
116 FROM pg_catalog.pg_attrdef d
117 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
118 FROM pg_catalog.pg_class c
119 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
120 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
133 sub datetime_parser_type { return "DateTime::Format::Pg"; }
135 sub bind_attribute_by_data_type {
136 my ($self,$data_type) = @_;
138 my $bind_attributes = {
139 bytea => { pg_type => DBD::Pg::PG_BYTEA },
140 blob => { pg_type => DBD::Pg::PG_BYTEA },
143 if( defined $bind_attributes->{$data_type} ) {
144 return $bind_attributes->{$data_type};
151 sub _sequence_fetch {
152 my ( $self, $type, $seq ) = @_;
153 my ($id) = $self->_get_dbh->selectrow_array("SELECT nextval('${seq}')");
158 my ($self, $name) = @_;
160 $self->_get_dbh->pg_savepoint($name);
164 my ($self, $name) = @_;
166 $self->_get_dbh->pg_release($name);
170 my ($self, $name) = @_;
172 $self->_get_dbh->pg_rollback_to($name);
181 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
185 # In your table classes
186 __PACKAGE__->load_components(qw/PK::Auto Core/);
187 __PACKAGE__->set_primary_key('id');
188 __PACKAGE__->sequence('mysequence');
192 This class implements autoincrements for PostgreSQL.
194 =head1 POSTGRESQL SCHEMA SUPPORT
196 This driver supports multiple PostgreSQL schemas, with one caveat: for
197 performance reasons, data about the search path, sequence names, and
198 so forth is queried as needed and CACHED for subsequent uses.
200 For this reason, once your schema is instantiated, you should not
201 change the PostgreSQL schema search path for that schema's database
202 connection. If you do, Bad Things may happen.
204 You should do any necessary manipulation of the search path BEFORE
205 instantiating your schema object, or as part of the on_connect_do
206 option to connect(), for example:
208 my $schema = My::Schema->connect
211 [ 'SET search_path TO myschema, foo, public' ],
217 See L<DBIx::Class/CONTRIBUTORS>
221 You may distribute this code under the same terms as Perl itself.