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;
11 use DBIx::Class::_Util 'modver_gt_or_eq';
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 my $sg = Scope::Guard->new(sub {
34 $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE');
37 return preserve_context { $sub->() } after => sub { $txn_scope_guard->commit };
40 # only used when INSERT ... RETURNING is disabled
42 my ($self,$source,@cols) = @_;
46 my $col_info = $source->columns_info(\@cols);
49 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
50 or $self->throw_exception( sprintf(
51 "Could not determine sequence for column '%s.%s', please consider adding a schema-qualified sequence to its column info",
56 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
63 my ($self, $function, $sequence) = @_;
65 $self->throw_exception('No sequence to fetch') unless $sequence;
67 my ($val) = $self->_get_dbh->selectrow_array(
68 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
74 sub _dbh_get_autoinc_seq {
75 my ($self, $dbh, $source, $col) = @_;
78 my $table = $source->name;
80 # deref table name if it needs it
82 if ref $table eq 'SCALAR';
84 # parse out schema name if present
85 if( $table =~ /^(.+)\.(.+)$/ ) {
86 ( $schema, $table ) = ( $1, $2 );
89 # get the column default using a Postgres-specific pg_catalog query
90 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
92 # if no default value is set on the column, or if we can't parse the
93 # default value as a sequence, throw.
94 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
95 $seq_expr = '' unless defined $seq_expr;
96 $schema = "$schema." if defined $schema && length $schema;
97 $self->throw_exception( sprintf (
98 "No sequence found for '%s%s.%s', check the RDBMS table definition or explicitly set the ".
99 "'sequence' for this column in %s",
100 $schema ? "$schema." : '',
103 $source->source_name,
107 return $1; # exception thrown unless match is made above
110 # custom method for fetching column default, since column_info has a
111 # bug with older versions of DBD::Pg
112 sub _dbh_get_column_default {
113 my ( $self, $dbh, $schema, $table, $col ) = @_;
115 # Build and execute a query into the pg_catalog to find the Pg
116 # expression for the default value for this column in this table.
117 # If the table name is schema-qualified, query using that specific
120 # Otherwise, find the table in the standard Postgres way, using the
121 # search path. This is done with the pg_catalog.pg_table_is_visible
122 # function, which returns true if a given table is 'visible',
123 # meaning the first table of that name to be found in the search
126 # I *think* we can be assured that this query will always find the
127 # correct column according to standard Postgres semantics.
131 my $sqlmaker = $self->sql_maker;
132 local $sqlmaker->{bindtype} = 'normal';
134 my ($where, @bind) = $sqlmaker->where ({
135 'a.attnum' => {'>', 0},
136 'c.relname' => $table,
138 -not_bool => 'a.attisdropped',
139 (defined $schema && length $schema)
140 ? ( 'n.nspname' => $schema )
141 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
144 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
147 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
148 FROM pg_catalog.pg_attrdef d
149 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
150 FROM pg_catalog.pg_class c
151 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
152 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
160 sub _dbh_execute_for_fetch {
161 #my ($self, $source, $sth, $tuple_status, @extra) = @_;
163 # This is used for bulk insert, so make sure we use a server-side
164 # prepared statement from the start, unless it's disabled
165 local $_[2]->{pg_switch_prepared} = 1 if
166 modver_gt_or_eq( 'DBD::Pg', '3.0.0' )
168 $_[2]->FETCH('pg_switch_prepared') > 0
171 shift->next::method(@_);
178 # Pg is not able to MAX(boolean_column), sigh...
180 # Generally it would make more sense to have this in the SQLMaker hierarchy,
181 # so that eventually { -max => ... } DTRT, but plans going forward are
185 sub _minmax_operator_for_datatype {
186 #my ($self, $datatype, $want_max) = @_;
188 return ($_[2] ? 'BOOL_OR' : 'BOOL_AND')
189 if ($_[1] || '') =~ /\Abool(?:ean)?\z/i;
191 shift->next::method(@_);
194 sub bind_attribute_by_data_type {
195 my ($self,$data_type) = @_;
197 if ($self->_is_binary_lob_type($data_type)) {
198 # this is a hot-ish codepath, use an escape flag to minimize
199 # amount of function/method calls
200 # the flag is stored in the DBD namespace, so that Class::Unload
201 # will work (unlikely, but still)
203 modver_gt_or_eq( 'DBD::Pg', '2.17.2' )
205 $DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__
207 if ( $self->_server_info->{normalized_dbms_version} >= 9.0 ) {
208 $self->throw_exception(
209 'BYTEA columns are known to not work on Pg >= 9.0 with DBD::Pg < 2.17.2'
213 require DBIx::Class::Optional::Dependencies
215 my $missing = DBIx::Class::Optional::Dependencies->req_missing_for([qw( rdbms_pg binary_data )])
217 # FIXME - perhaps this needs to be an exception too...?
218 # too old to test sensibly...
220 __PACKAGE__ . ": BYTEA column support strongly recommends $missing"
224 $DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__ = 1;
227 return { pg_type => DBD::Pg::PG_BYTEA() };
234 sub _exec_svp_begin {
235 my ($self, $name) = @_;
237 $self->_dbh->pg_savepoint($name);
240 sub _exec_svp_release {
241 my ($self, $name) = @_;
243 $self->_dbh->pg_release($name);
246 sub _exec_svp_rollback {
247 my ($self, $name) = @_;
249 $self->_dbh->pg_rollback_to($name);
252 sub deployment_statements {
254 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
259 ! exists $sqltargs->{producer_args}{postgres_version}
261 my $dver = $self->_server_info->{normalized_dbms_version}
263 $sqltargs->{producer_args}{postgres_version} = $dver;
266 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
275 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
279 # In your result (table) classes
280 use base 'DBIx::Class::Core';
281 __PACKAGE__->set_primary_key('id');
285 This class implements autoincrements for PostgreSQL.
287 =head1 POSTGRESQL SCHEMA SUPPORT
289 This driver supports multiple PostgreSQL schemas, with one caveat: for
290 performance reasons, data about the search path, sequence names, and
291 so forth is queried as needed and CACHED for subsequent uses.
293 For this reason, once your schema is instantiated, you should not
294 change the PostgreSQL schema search path for that schema's database
295 connection. If you do, Bad Things may happen.
297 You should do any necessary manipulation of the search path BEFORE
298 instantiating your schema object, or as part of the on_connect_do
299 option to connect(), for example:
301 my $schema = My::Schema->connect
304 [ 'SET search_path TO myschema, foo, public' ],
308 =head1 FURTHER QUESTIONS?
310 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
312 =head1 COPYRIGHT AND LICENSE
314 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
315 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
316 redistribute it and/or modify it under the same terms as the
317 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.