1 package DBIx::Class::Storage::DBI::Pg;
7 DBIx::Class::Storage::DBI::MultiColumnIn
12 use Context::Preserve 'preserve_context';
13 use DBIx::Class::Carp;
17 __PACKAGE__->sql_limit_dialect ('LimitOffset');
18 __PACKAGE__->sql_quote_char ('"');
19 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
21 sub _determine_supports_insert_returning {
22 return shift->_server_info->{normalized_dbms_version} >= 8.002
28 sub with_deferred_fk_checks {
29 my ($self, $sub) = @_;
31 my $txn_scope_guard = $self->txn_scope_guard;
33 $self->_do_query('SET CONSTRAINTS ALL DEFERRED');
35 my $sg = Scope::Guard->new(sub {
36 $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE');
39 return preserve_context { $sub->() } after => sub { $txn_scope_guard->commit };
42 # only used when INSERT ... RETURNING is disabled
44 my ($self,$source,@cols) = @_;
48 my $col_info = $source->columns_info(\@cols);
51 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
52 or $self->throw_exception( sprintf(
53 'could not determine sequence for column %s.%s, please consider adding a schema-qualified sequence to its column info',
58 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
65 my ($self, $function, $sequence) = @_;
67 $self->throw_exception('No sequence to fetch') unless $sequence;
69 my ($val) = $self->_get_dbh->selectrow_array(
70 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
76 sub _dbh_get_autoinc_seq {
77 my ($self, $dbh, $source, $col) = @_;
80 my $table = $source->name;
82 # deref table name if it needs it
84 if ref $table eq 'SCALAR';
86 # parse out schema name if present
87 if( $table =~ /^(.+)\.(.+)$/ ) {
88 ( $schema, $table ) = ( $1, $2 );
91 # get the column default using a Postgres-specific pg_catalog query
92 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
94 # if no default value is set on the column, or if we can't parse the
95 # default value as a sequence, throw.
96 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
97 $seq_expr = '' unless defined $seq_expr;
98 $schema = "$schema." if defined $schema && length $schema;
99 $self->throw_exception( sprintf (
100 'no sequence found for %s%s.%s, check the RDBMS table definition or explicitly set the '.
101 "'sequence' for this column in %s",
102 $schema ? "$schema." : '',
105 $source->source_name,
112 # custom method for fetching column default, since column_info has a
113 # bug with older versions of DBD::Pg
114 sub _dbh_get_column_default {
115 my ( $self, $dbh, $schema, $table, $col ) = @_;
117 # Build and execute a query into the pg_catalog to find the Pg
118 # expression for the default value for this column in this table.
119 # If the table name is schema-qualified, query using that specific
122 # Otherwise, find the table in the standard Postgres way, using the
123 # search path. This is done with the pg_catalog.pg_table_is_visible
124 # function, which returns true if a given table is 'visible',
125 # meaning the first table of that name to be found in the search
128 # I *think* we can be assured that this query will always find the
129 # correct column according to standard Postgres semantics.
133 my $sqlmaker = $self->sql_maker;
134 local $sqlmaker->{bindtype} = 'normal';
136 my ($where, @bind) = $sqlmaker->where ({
137 'a.attnum' => {'>', 0},
138 'c.relname' => $table,
140 -not_bool => 'a.attisdropped',
141 (defined $schema && length $schema)
142 ? ( 'n.nspname' => $schema )
143 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
146 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
149 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
150 FROM pg_catalog.pg_attrdef d
151 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
152 FROM pg_catalog.pg_class c
153 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
154 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
168 sub bind_attribute_by_data_type {
169 my ($self,$data_type) = @_;
171 # Ask for a DBD::Pg with array support
172 # pg uses (used?) version::qv()
175 if ($self->_server_info->{normalized_dbms_version} >= 9.0) {
176 if (not try { DBD::Pg->VERSION('2.17.2') }) {
177 carp_once( __PACKAGE__.': BYTEA columns are known to not work on Pg >='
178 . " 9.0 with DBD::Pg < 2.17.2\n" );
181 elsif (not try { DBD::Pg->VERSION('2.9.2') }) {
182 carp_once( __PACKAGE__.': DBD::Pg 2.9.2 or greater is strongly recommended'
183 . "for BYTEA column support.\n" );
186 # cache the result of _is_binary_lob_type
187 if (!exists $type_cache->{$data_type}) {
188 $type_cache->{$data_type} = $self->_is_binary_lob_type($data_type)
189 ? +{ pg_type => DBD::Pg::PG_BYTEA() }
193 $type_cache->{$data_type};
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' ],
272 See L<DBIx::Class/CONTRIBUTORS>
276 You may distribute this code under the same terms as Perl itself.