1 package DBIx::Class::Storage::DBI::Pg;
7 DBIx::Class::Storage::DBI::MultiColumnIn
11 use DBD::Pg qw(:pg_types);
13 use Context::Preserve 'preserve_context';
16 __PACKAGE__->sql_limit_dialect ('LimitOffset');
17 __PACKAGE__->sql_quote_char ('"');
18 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
20 # Ask for a DBD::Pg with array support
21 warn __PACKAGE__.": DBD::Pg 2.9.2 or greater is strongly recommended\n"
22 if ($DBD::Pg::VERSION < 2.009002); # pg uses (used?) version::qv()
24 sub _determine_supports_insert_returning {
25 return shift->_server_info->{normalized_dbms_version} >= 8.002
31 sub with_deferred_fk_checks {
32 my ($self, $sub) = @_;
34 my $txn_scope_guard = $self->txn_scope_guard;
36 $self->_do_query('SET CONSTRAINTS ALL DEFERRED');
38 my $sg = Scope::Guard->new(sub {
39 $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE');
42 return preserve_context { $sub->() } after => sub { $txn_scope_guard->commit };
45 # only used when INSERT ... RETURNING is disabled
47 my ($self,$source,@cols) = @_;
51 my $col_info = $source->columns_info(\@cols);
54 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
55 or $self->throw_exception( sprintf(
56 'could not determine sequence for column %s.%s, please consider adding a schema-qualified sequence to its column info',
61 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
68 my ($self, $function, $sequence) = @_;
70 $self->throw_exception('No sequence to fetch') unless $sequence;
72 my ($val) = $self->_get_dbh->selectrow_array(
73 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
79 sub _dbh_get_autoinc_seq {
80 my ($self, $dbh, $source, $col) = @_;
83 my $table = $source->name;
85 # deref table name if it needs it
87 if ref $table eq 'SCALAR';
89 # parse out schema name if present
90 if( $table =~ /^(.+)\.(.+)$/ ) {
91 ( $schema, $table ) = ( $1, $2 );
94 # get the column default using a Postgres-specific pg_catalog query
95 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
97 # if no default value is set on the column, or if we can't parse the
98 # default value as a sequence, throw.
99 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
100 $seq_expr = '' unless defined $seq_expr;
101 $schema = "$schema." if defined $schema && length $schema;
102 $self->throw_exception( sprintf (
103 'no sequence found for %s%s.%s, check the RDBMS table definition or explicitly set the '.
104 "'sequence' for this column in %s",
105 $schema ? "$schema." : '',
108 $source->source_name,
115 # custom method for fetching column default, since column_info has a
116 # bug with older versions of DBD::Pg
117 sub _dbh_get_column_default {
118 my ( $self, $dbh, $schema, $table, $col ) = @_;
120 # Build and execute a query into the pg_catalog to find the Pg
121 # expression for the default value for this column in this table.
122 # If the table name is schema-qualified, query using that specific
125 # Otherwise, find the table in the standard Postgres way, using the
126 # search path. This is done with the pg_catalog.pg_table_is_visible
127 # function, which returns true if a given table is 'visible',
128 # meaning the first table of that name to be found in the search
131 # I *think* we can be assured that this query will always find the
132 # correct column according to standard Postgres semantics.
136 my $sqlmaker = $self->sql_maker;
137 local $sqlmaker->{bindtype} = 'normal';
139 my ($where, @bind) = $sqlmaker->where ({
140 'a.attnum' => {'>', 0},
141 'c.relname' => $table,
143 -not_bool => 'a.attisdropped',
144 (defined $schema && length $schema)
145 ? ( 'n.nspname' => $schema )
146 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
149 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
152 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
153 FROM pg_catalog.pg_attrdef d
154 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
155 FROM pg_catalog.pg_class c
156 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
157 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
170 sub bind_attribute_by_data_type {
171 my ($self,$data_type) = @_;
173 my $bind_attributes = {
174 bytea => { pg_type => DBD::Pg::PG_BYTEA },
175 blob => { pg_type => DBD::Pg::PG_BYTEA },
178 if( defined $bind_attributes->{$data_type} ) {
179 return $bind_attributes->{$data_type};
187 my ($self, $name) = @_;
189 $self->_get_dbh->pg_savepoint($name);
193 my ($self, $name) = @_;
195 $self->_get_dbh->pg_release($name);
199 my ($self, $name) = @_;
201 $self->_get_dbh->pg_rollback_to($name);
204 sub deployment_statements {
206 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
211 ! exists $sqltargs->{producer_args}{postgres_version}
213 my $dver = $self->_server_info->{normalized_dbms_version}
215 $sqltargs->{producer_args}{postgres_version} = $dver;
218 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
227 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
231 # In your result (table) classes
232 use base 'DBIx::Class::Core';
233 __PACKAGE__->set_primary_key('id');
237 This class implements autoincrements for PostgreSQL.
239 =head1 POSTGRESQL SCHEMA SUPPORT
241 This driver supports multiple PostgreSQL schemas, with one caveat: for
242 performance reasons, data about the search path, sequence names, and
243 so forth is queried as needed and CACHED for subsequent uses.
245 For this reason, once your schema is instantiated, you should not
246 change the PostgreSQL schema search path for that schema's database
247 connection. If you do, Bad Things may happen.
249 You should do any necessary manipulation of the search path BEFORE
250 instantiating your schema object, or as part of the on_connect_do
251 option to connect(), for example:
253 my $schema = My::Schema->connect
256 [ 'SET search_path TO myschema, foo, public' ],
262 See L<DBIx::Class/CONTRIBUTORS>
266 You may distribute this code under the same terms as Perl itself.