1 package DBIx::Class::Storage::DBI::Pg;
6 use base qw/DBIx::Class::Storage::DBI/;
9 use Context::Preserve 'preserve_context';
10 use DBIx::Class::Carp;
14 __PACKAGE__->sql_limit_dialect ('LimitOffset');
15 __PACKAGE__->sql_quote_char ('"');
16 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
17 __PACKAGE__->_use_multicolumn_in (1);
19 sub _determine_supports_insert_returning {
20 return shift->_server_info->{normalized_dbms_version} >= 8.002
26 sub with_deferred_fk_checks {
27 my ($self, $sub) = @_;
29 my $txn_scope_guard = $self->txn_scope_guard;
31 $self->_do_query('SET CONSTRAINTS ALL DEFERRED');
33 return preserve_context {
34 my $sg = Scope::Guard->new(sub {
35 $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE');
38 } after => sub { $txn_scope_guard->commit };
41 # only used when INSERT ... RETURNING is disabled
43 my ($self,$source,@cols) = @_;
47 my $col_info = $source->columns_info(\@cols);
50 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
51 or $self->throw_exception( sprintf(
52 "Could not determine sequence for column '%s.%s', please consider adding a schema-qualified sequence to its column info",
57 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
64 my ($self, $function, $sequence) = @_;
66 $self->throw_exception('No sequence to fetch') unless $sequence;
68 my ($val) = $self->_get_dbh->selectrow_array(
69 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
75 sub _dbh_get_autoinc_seq {
76 my ($self, $dbh, $source, $col) = @_;
79 my $table = $source->name;
81 # deref table name if it needs it
83 if ref $table eq 'SCALAR';
85 # parse out schema name if present
86 if( $table =~ /^(.+)\.(.+)$/ ) {
87 ( $schema, $table ) = ( $1, $2 );
90 # get the column default using a Postgres-specific pg_catalog query
91 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
93 # if no default value is set on the column, or if we can't parse the
94 # default value as a sequence, throw.
95 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
96 $seq_expr = '' unless defined $seq_expr;
97 $schema = "$schema." if defined $schema && length $schema;
98 $self->throw_exception( sprintf (
99 "No sequence found for '%s%s.%s', check the RDBMS table definition or explicitly set the ".
100 "'sequence' for this column in %s",
101 $schema ? "$schema." : '',
104 $source->source_name,
108 return $1; # exception thrown unless match is made above
111 # custom method for fetching column default, since column_info has a
112 # bug with older versions of DBD::Pg
113 sub _dbh_get_column_default {
114 my ( $self, $dbh, $schema, $table, $col ) = @_;
116 # Build and execute a query into the pg_catalog to find the Pg
117 # expression for the default value for this column in this table.
118 # If the table name is schema-qualified, query using that specific
121 # Otherwise, find the table in the standard Postgres way, using the
122 # search path. This is done with the pg_catalog.pg_table_is_visible
123 # function, which returns true if a given table is 'visible',
124 # meaning the first table of that name to be found in the search
127 # I *think* we can be assured that this query will always find the
128 # correct column according to standard Postgres semantics.
132 my $sqlmaker = $self->sql_maker;
133 local $sqlmaker->{bindtype} = 'normal';
135 my ($where, @bind) = $sqlmaker->where ({
136 'a.attnum' => {'>', 0},
137 'c.relname' => $table,
139 -not_bool => 'a.attisdropped',
140 (defined $schema && length $schema)
141 ? ( 'n.nspname' => $schema )
142 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
145 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
148 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
149 FROM pg_catalog.pg_attrdef d
150 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
151 FROM pg_catalog.pg_class c
152 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
153 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
166 sub bind_attribute_by_data_type {
167 my ($self,$data_type) = @_;
169 if ($self->_is_binary_lob_type($data_type)) {
170 # this is a hot-ish codepath, use an escape flag to minimize
171 # amount of function/method calls
172 # additionally version.pm is cock, and memleaks on multiple
174 # the flag is stored in the DBD namespace, so that Class::Unload
175 # will work (unlikely, but still)
176 unless ($DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__) {
177 if ($self->_server_info->{normalized_dbms_version} >= 9.0) {
178 try { DBD::Pg->VERSION('2.17.2'); 1 } or carp (
179 __PACKAGE__.': BYTEA columns are known to not work on Pg >= 9.0 with DBD::Pg < 2.17.2'
182 elsif (not try { DBD::Pg->VERSION('2.9.2'); 1 } ) { carp (
183 __PACKAGE__.': DBD::Pg 2.9.2 or greater is strongly recommended for BYTEA column support'
186 $DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__ = 1;
189 return { pg_type => DBD::Pg::PG_BYTEA() };
196 sub _exec_svp_begin {
197 my ($self, $name) = @_;
199 $self->_dbh->pg_savepoint($name);
202 sub _exec_svp_release {
203 my ($self, $name) = @_;
205 $self->_dbh->pg_release($name);
208 sub _exec_svp_rollback {
209 my ($self, $name) = @_;
211 $self->_dbh->pg_rollback_to($name);
214 sub deployment_statements {
216 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
221 ! exists $sqltargs->{producer_args}{postgres_version}
223 my $dver = $self->_server_info->{normalized_dbms_version}
225 $sqltargs->{producer_args}{postgres_version} = $dver;
228 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
237 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
241 # In your result (table) classes
242 use base 'DBIx::Class::Core';
243 __PACKAGE__->set_primary_key('id');
247 This class implements autoincrements for PostgreSQL.
249 =head1 POSTGRESQL SCHEMA SUPPORT
251 This driver supports multiple PostgreSQL schemas, with one caveat: for
252 performance reasons, data about the search path, sequence names, and
253 so forth is queried as needed and CACHED for subsequent uses.
255 For this reason, once your schema is instantiated, you should not
256 change the PostgreSQL schema search path for that schema's database
257 connection. If you do, Bad Things may happen.
259 You should do any necessary manipulation of the search path BEFORE
260 instantiating your schema object, or as part of the on_connect_do
261 option to connect(), for example:
263 my $schema = My::Schema->connect
266 [ 'SET search_path TO myschema, foo, public' ],
270 =head1 FURTHER QUESTIONS?
272 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
274 =head1 COPYRIGHT AND LICENSE
276 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
277 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
278 redistribute it and/or modify it under the same terms as the
279 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.