1 package DBIx::Class::Storage::DBI::Pg;
6 use base qw/DBIx::Class::Storage::DBI::SetConstraintsDeferred/;
12 __PACKAGE__->sql_limit_dialect ('LimitOffset');
13 __PACKAGE__->sql_quote_char ('"');
14 __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg');
15 __PACKAGE__->_use_multicolumn_in (1);
17 sub _determine_supports_insert_returning {
18 return shift->_server_info->{normalized_dbms_version} >= 8.002
24 # only used when INSERT ... RETURNING is disabled
26 my ($self,$source,@cols) = @_;
30 my $col_info = $source->columns_info(\@cols);
33 my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) )
34 or $self->throw_exception( sprintf(
35 "Could not determine sequence for column '%s.%s', please consider adding a schema-qualified sequence to its column info",
40 push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq});
47 my ($self, $function, $sequence) = @_;
49 $self->throw_exception('No sequence to fetch') unless $sequence;
51 my ($val) = $self->_get_dbh->selectrow_array(
52 sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence)
58 sub _dbh_get_autoinc_seq {
59 my ($self, $dbh, $source, $col) = @_;
62 my $table = $source->name;
64 # deref table name if it needs it
66 if ref $table eq 'SCALAR';
68 # parse out schema name if present
69 if( $table =~ /^(.+)\.(.+)$/ ) {
70 ( $schema, $table ) = ( $1, $2 );
73 # get the column default using a Postgres-specific pg_catalog query
74 my $seq_expr = $self->_dbh_get_column_default( $dbh, $schema, $table, $col );
76 # if no default value is set on the column, or if we can't parse the
77 # default value as a sequence, throw.
78 unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) {
79 $seq_expr = '' unless defined $seq_expr;
80 $schema = "$schema." if defined $schema && length $schema;
81 $self->throw_exception( sprintf (
82 "No sequence found for '%s%s.%s', check the RDBMS table definition or explicitly set the ".
83 "'sequence' for this column in %s",
84 $schema ? "$schema." : '',
91 return $1; # exception thrown unless match is made above
94 # custom method for fetching column default, since column_info has a
95 # bug with older versions of DBD::Pg
96 sub _dbh_get_column_default {
97 my ( $self, $dbh, $schema, $table, $col ) = @_;
99 # Build and execute a query into the pg_catalog to find the Pg
100 # expression for the default value for this column in this table.
101 # If the table name is schema-qualified, query using that specific
104 # Otherwise, find the table in the standard Postgres way, using the
105 # search path. This is done with the pg_catalog.pg_table_is_visible
106 # function, which returns true if a given table is 'visible',
107 # meaning the first table of that name to be found in the search
110 # I *think* we can be assured that this query will always find the
111 # correct column according to standard Postgres semantics.
115 my $sqlmaker = $self->sql_maker;
116 local $sqlmaker->{bindtype} = 'normal';
118 my ($where, @bind) = $sqlmaker->where ({
119 'a.attnum' => {'>', 0},
120 'c.relname' => $table,
122 -not_bool => 'a.attisdropped',
123 (defined $schema && length $schema)
124 ? ( 'n.nspname' => $schema )
125 : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' )
128 my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind);
131 (SELECT pg_catalog.pg_get_expr(d.adbin, d.adrelid)
132 FROM pg_catalog.pg_attrdef d
133 WHERE d.adrelid = a.attrelid AND d.adnum = a.attnum AND a.atthasdef)
134 FROM pg_catalog.pg_class c
135 LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
136 JOIN pg_catalog.pg_attribute a ON a.attrelid = c.oid
149 sub bind_attribute_by_data_type {
150 my ($self,$data_type) = @_;
152 if ($self->_is_binary_lob_type($data_type)) {
153 # this is a hot-ish codepath, use an escape flag to minimize
154 # amount of function/method calls
155 # additionally version.pm is cock, and memleaks on multiple
157 # the flag is stored in the DBD namespace, so that Class::Unload
158 # will work (unlikely, but still)
159 unless ($DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__) {
160 if ($self->_server_info->{normalized_dbms_version} >= 9.0) {
161 try { DBD::Pg->VERSION('2.17.2'); 1 } or carp (
162 __PACKAGE__.': BYTEA columns are known to not work on Pg >= 9.0 with DBD::Pg < 2.17.2'
165 elsif (not try { DBD::Pg->VERSION('2.9.2'); 1 } ) { carp (
166 __PACKAGE__.': DBD::Pg 2.9.2 or greater is strongly recommended for BYTEA column support'
169 $DBD::Pg::__DBIC_DBD_VERSION_CHECK_DONE__ = 1;
172 return { pg_type => DBD::Pg::PG_BYTEA() };
179 sub _exec_svp_begin {
180 my ($self, $name) = @_;
182 $self->_dbh->pg_savepoint($name);
185 sub _exec_svp_release {
186 my ($self, $name) = @_;
188 $self->_dbh->pg_release($name);
191 sub _exec_svp_rollback {
192 my ($self, $name) = @_;
194 $self->_dbh->pg_rollback_to($name);
197 sub deployment_statements {
199 my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_;
204 ! exists $sqltargs->{producer_args}{postgres_version}
206 my $dver = $self->_server_info->{normalized_dbms_version}
208 $sqltargs->{producer_args}{postgres_version} = $dver;
211 $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest);
220 DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL
224 # In your result (table) classes
225 use base 'DBIx::Class::Core';
226 __PACKAGE__->set_primary_key('id');
230 This class implements autoincrements for PostgreSQL.
232 =head1 POSTGRESQL SCHEMA SUPPORT
234 This driver supports multiple PostgreSQL schemas, with one caveat: for
235 performance reasons, data about the search path, sequence names, and
236 so forth is queried as needed and CACHED for subsequent uses.
238 For this reason, once your schema is instantiated, you should not
239 change the PostgreSQL schema search path for that schema's database
240 connection. If you do, Bad Things may happen.
242 You should do any necessary manipulation of the search path BEFORE
243 instantiating your schema object, or as part of the on_connect_do
244 option to connect(), for example:
246 my $schema = My::Schema->connect
249 [ 'SET search_path TO myschema, foo, public' ],
253 =head1 FURTHER QUESTIONS?
255 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
257 =head1 COPYRIGHT AND LICENSE
259 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
260 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
261 redistribute it and/or modify it under the same terms as the
262 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.