1 package DBIx::Class::Storage::DBI::Pg;
7 DBIx::Class::Storage::DBI::MultiColumnIn
12 use Context::Preserve 'preserve_context';
15 __PACKAGE__->sql_limit_dialect ('LimitOffset');
16 __PACKAGE__->sql_quote_char ('"');
17 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
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,
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
166 sub bind_attribute_by_data_type {
167 my ($self,$data_type) = @_;
169 $bind_attributes ||= do {
172 # Ask for a DBD::Pg with array support
173 warn __PACKAGE__.": DBD::Pg 2.9.2 or greater is strongly recommended\n"
174 if ($DBD::Pg::VERSION < 2.009002); # pg uses (used?) version::qv()
176 bytea => { pg_type => DBD::Pg::PG_BYTEA() },
177 blob => { pg_type => DBD::Pg::PG_BYTEA() },
181 if( defined $bind_attributes->{$data_type} ) {
182 return $bind_attributes->{$data_type};
190 my ($self, $name) = @_;
192 $self->_get_dbh->pg_savepoint($name);
196 my ($self, $name) = @_;
198 $self->_get_dbh->pg_release($name);
202 my ($self, $name) = @_;
204 $self->_get_dbh->pg_rollback_to($name);
207 sub deployment_statements {
209 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
214 ! exists $sqltargs->{producer_args}{postgres_version}
216 my $dver = $self->_server_info->{normalized_dbms_version}
218 $sqltargs->{producer_args}{postgres_version} = $dver;
221 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
230 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
234 # In your result (table) classes
235 use base 'DBIx::Class::Core';
236 __PACKAGE__->set_primary_key('id');
240 This class implements autoincrements for PostgreSQL.
242 =head1 POSTGRESQL SCHEMA SUPPORT
244 This driver supports multiple PostgreSQL schemas, with one caveat: for
245 performance reasons, data about the search path, sequence names, and
246 so forth is queried as needed and CACHED for subsequent uses.
248 For this reason, once your schema is instantiated, you should not
249 change the PostgreSQL schema search path for that schema's database
250 connection. If you do, Bad Things may happen.
252 You should do any necessary manipulation of the search path BEFORE
253 instantiating your schema object, or as part of the on_connect_do
254 option to connect(), for example:
256 my $schema = My::Schema->connect
259 [ 'SET search_path TO myschema, foo, public' ],
265 See L<DBIx::Class/CONTRIBUTORS>
269 You may distribute this code under the same terms as Perl itself.