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_maker_class('DBIx::Class::SQLMaker::Pg');
18 __PACKAGE__->sql_limit_dialect ('LimitOffset');
19 __PACKAGE__->sql_quote_char ('"');
20 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
22 sub _determine_supports_insert_returning {
23 return shift->_server_info->{normalized_dbms_version} >= 8.002
29 sub with_deferred_fk_checks {
30 my ($self, $sub) = @_;
32 my $txn_scope_guard = $self->txn_scope_guard;
34 $self->_do_query('SET CONSTRAINTS ALL DEFERRED');
36 my $sg = Scope::Guard->new(sub {
37 $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE');
40 return preserve_context { $sub->() } after => sub { $txn_scope_guard->commit };
43 # only used when INSERT ... RETURNING is disabled
45 my ($self,$source,@cols) = @_;
49 my $col_info = $source->columns_info(\@cols);
52 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
53 or $self->throw_exception( sprintf(
54 'could not determine sequence for column %s.%s, please consider adding a schema-qualified sequence to its column info',
59 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
66 my ($self, $function, $sequence) = @_;
68 $self->throw_exception('No sequence to fetch') unless $sequence;
70 my ($val) = $self->_get_dbh->selectrow_array(
71 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
77 sub _dbh_get_autoinc_seq {
78 my ($self, $dbh, $source, $col) = @_;
81 my $table = $source->name;
83 # deref table name if it needs it
85 if ref $table eq 'SCALAR';
87 # parse out schema name if present
88 if( $table =~ /^(.+)\.(.+)$/ ) {
89 ( $schema, $table ) = ( $1, $2 );
92 # get the column default using a Postgres-specific pg_catalog query
93 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
95 # if no default value is set on the column, or if we can't parse the
96 # default value as a sequence, throw.
97 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
98 $seq_expr = '' unless defined $seq_expr;
99 $schema = "$schema." if defined $schema && length $schema;
100 $self->throw_exception( sprintf (
101 'no sequence found for %s%s.%s, check the RDBMS table definition or explicitly set the '.
102 "'sequence' for this column in %s",
103 $schema ? "$schema." : '',
106 $source->source_name,
113 # custom method for fetching column default, since column_info has a
114 # bug with older versions of DBD::Pg
115 sub _dbh_get_column_default {
116 my ( $self, $dbh, $schema, $table, $col ) = @_;
118 # Build and execute a query into the pg_catalog to find the Pg
119 # expression for the default value for this column in this table.
120 # If the table name is schema-qualified, query using that specific
123 # Otherwise, find the table in the standard Postgres way, using the
124 # search path. This is done with the pg_catalog.pg_table_is_visible
125 # function, which returns true if a given table is 'visible',
126 # meaning the first table of that name to be found in the search
129 # I *think* we can be assured that this query will always find the
130 # correct column according to standard Postgres semantics.
134 my $sqlmaker = $self->sql_maker;
135 local $sqlmaker->{bindtype} = 'normal';
137 my ($where, @bind) = $sqlmaker->where ({
138 'a.attnum' => {'>', 0},
139 'c.relname' => $table,
141 -not_bool => 'a.attisdropped',
142 (defined $schema && length $schema)
143 ? ( 'n.nspname' => $schema )
144 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
147 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
150 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
151 FROM pg_catalog.pg_attrdef d
152 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
153 FROM pg_catalog.pg_class c
154 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
155 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
169 sub bind_attribute_by_data_type {
170 my ($self,$data_type) = @_;
172 # Ask for a DBD::Pg with array support
173 # pg uses (used?) version::qv()
176 if ($self->_server_info->{normalized_dbms_version} >= 9.0) {
177 if (not try { DBD::Pg->VERSION('2.17.2') }) {
178 carp_once( __PACKAGE__.': BYTEA columns are known to not work on Pg >='
179 . " 9.0 with DBD::Pg < 2.17.2\n" );
182 elsif (not try { DBD::Pg->VERSION('2.9.2') }) {
183 carp_once( __PACKAGE__.': DBD::Pg 2.9.2 or greater is strongly recommended'
184 . "for BYTEA column support.\n" );
187 # cache the result of _is_binary_lob_type
188 if (!exists $type_cache->{$data_type}) {
189 $type_cache->{$data_type} = $self->_is_binary_lob_type($data_type)
190 ? +{ pg_type => DBD::Pg::PG_BYTEA() }
194 $type_cache->{$data_type};
197 sub _exec_svp_begin {
198 my ($self, $name) = @_;
200 $self->_dbh->pg_savepoint($name);
203 sub _exec_svp_release {
204 my ($self, $name) = @_;
206 $self->_dbh->pg_release($name);
209 sub _exec_svp_rollback {
210 my ($self, $name) = @_;
212 $self->_dbh->pg_rollback_to($name);
215 sub deployment_statements {
217 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
222 ! exists $sqltargs->{producer_args}{postgres_version}
224 my $dver = $self->_server_info->{normalized_dbms_version}
226 $sqltargs->{producer_args}{postgres_version} = $dver;
229 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
238 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
242 # In your result (table) classes
243 use base 'DBIx::Class::Core';
244 __PACKAGE__->set_primary_key('id');
248 This class implements autoincrements for PostgreSQL.
250 =head1 POSTGRESQL SCHEMA SUPPORT
252 This driver supports multiple PostgreSQL schemas, with one caveat: for
253 performance reasons, data about the search path, sequence names, and
254 so forth is queried as needed and CACHED for subsequent uses.
256 For this reason, once your schema is instantiated, you should not
257 change the PostgreSQL schema search path for that schema's database
258 connection. If you do, Bad Things may happen.
260 You should do any necessary manipulation of the search path BEFORE
261 instantiating your schema object, or as part of the on_connect_do
262 option to connect(), for example:
264 my $schema = My::Schema->connect
267 [ 'SET search_path TO myschema, foo, public' ],
273 See L<DBIx::Class/CONTRIBUTORS>
277 You may distribute this code under the same terms as Perl itself.