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,@cols) = @_;
28 my $seq = ( $source->column_info($col)->{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
29 or $self->throw_exception( "could not determine sequence for "
31 . ".$col, please consider adding a "
32 . "schema-qualified sequence to its column info"
35 push @values, $self->_dbh_last_insert_id ($self->_dbh, $seq);
41 # there seems to be absolutely no reason to have this as a separate method,
42 # but leaving intact in case someone is already overriding it
43 sub _dbh_last_insert_id {
44 my ($self, $dbh, $seq) = @_;
45 $dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
49 sub _dbh_get_autoinc_seq {
50 my ($self, $dbh, $source, $col) = @_;
53 my $table = $source->name;
55 # deref table name if it needs it
57 if ref $table eq 'SCALAR';
59 # parse out schema name if present
60 if( $table =~ /^(.+)\.(.+)$/ ) {
61 ( $schema, $table ) = ( $1, $2 );
64 # get the column default using a Postgres-specific pg_catalog query
65 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
67 # if no default value is set on the column, or if we can't parse the
68 # default value as a sequence, throw.
69 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ){
70 $seq_expr = '' unless defined $seq_expr;
71 $schema = "$schema." if defined $schema && length $schema;
72 $self->throw_exception( "no sequence found for $schema$table.$col, check table definition, "
73 . "or explicitly set the 'sequence' for this column in the "
74 . $source->source_name
82 # custom method for fetching column default, since column_info has a
83 # bug with older versions of DBD::Pg
84 sub _dbh_get_column_default {
85 my ( $self, $dbh, $schema, $table, $col ) = @_;
87 # Build and execute a query into the pg_catalog to find the Pg
88 # expression for the default value for this column in this table.
89 # If the table name is schema-qualified, query using that specific
92 # Otherwise, find the table in the standard Postgres way, using the
93 # search path. This is done with the pg_catalog.pg_table_is_visible
94 # function, which returns true if a given table is 'visible',
95 # meaning the first table of that name to be found in the search
98 # I *think* we can be assured that this query will always find the
99 # correct column according to standard Postgres semantics.
103 my $sqlmaker = $self->sql_maker;
104 local $sqlmaker->{bindtype} = 'normal';
106 my ($where, @bind) = $sqlmaker->where ({
107 'a.attnum' => {'>', 0},
108 'c.relname' => $table,
110 -not_bool => 'a.attisdropped',
111 (defined $schema && length $schema)
112 ? ( 'n.nspname' => $schema )
113 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
116 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
119 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
120 FROM pg_catalog.pg_attrdef d
121 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
122 FROM pg_catalog.pg_class c
123 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
124 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
137 sub datetime_parser_type { return "DateTime::Format::Pg"; }
139 sub bind_attribute_by_data_type {
140 my ($self,$data_type) = @_;
142 my $bind_attributes = {
143 bytea => { pg_type => DBD::Pg::PG_BYTEA },
144 blob => { pg_type => DBD::Pg::PG_BYTEA },
147 if( defined $bind_attributes->{$data_type} ) {
148 return $bind_attributes->{$data_type};
155 sub _sequence_fetch {
156 my ( $self, $type, $seq ) = @_;
157 my ($id) = $self->_get_dbh->selectrow_array("SELECT nextval('${seq}')");
162 my ($self, $name) = @_;
164 $self->_get_dbh->pg_savepoint($name);
168 my ($self, $name) = @_;
170 $self->_get_dbh->pg_release($name);
174 my ($self, $name) = @_;
176 $self->_get_dbh->pg_rollback_to($name);
185 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
189 # In your table classes
190 __PACKAGE__->load_components(qw/PK::Auto Core/);
191 __PACKAGE__->set_primary_key('id');
192 __PACKAGE__->sequence('mysequence');
196 This class implements autoincrements for PostgreSQL.
198 =head1 POSTGRESQL SCHEMA SUPPORT
200 This driver supports multiple PostgreSQL schemas, with one caveat: for
201 performance reasons, data about the search path, sequence names, and
202 so forth is queried as needed and CACHED for subsequent uses.
204 For this reason, once your schema is instantiated, you should not
205 change the PostgreSQL schema search path for that schema's database
206 connection. If you do, Bad Things may happen.
208 You should do any necessary manipulation of the search path BEFORE
209 instantiating your schema object, or as part of the on_connect_do
210 option to connect(), for example:
212 my $schema = My::Schema->connect
215 [ 'SET search_path TO myschema, foo, public' ],
221 See L<DBIx::Class/CONTRIBUTORS>
225 You may distribute this code under the same terms as Perl itself.