Commit | Line | Data |
843f8ecd |
1 | package DBIx::Class::Storage::DBI::Pg; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
be860760 |
6 | use base qw/ |
7 | DBIx::Class::Storage::DBI::MultiColumnIn |
be860760 |
8 | /; |
ac45262b |
9 | use mro 'c3'; |
843f8ecd |
10 | |
ac45262b |
11 | use DBD::Pg qw(:pg_types); |
4d4dc518 |
12 | use Scope::Guard (); |
6298a324 |
13 | use Context::Preserve 'preserve_context'; |
14 | use namespace::clean; |
843f8ecd |
15 | |
6a247f33 |
16 | __PACKAGE__->sql_limit_dialect ('LimitOffset'); |
2b8cc2f2 |
17 | __PACKAGE__->sql_quote_char ('"'); |
6f7a118e |
18 | __PACKAGE__->datetime_parser_type ('DateTime::Format::Pg'); |
6a247f33 |
19 | |
ac45262b |
20 | # Ask for a DBD::Pg with array support |
21c63647 |
21 | warn __PACKAGE__.": DBD::Pg 2.9.2 or greater is strongly recommended\n" |
ac45262b |
22 | if ($DBD::Pg::VERSION < 2.009002); # pg uses (used?) version::qv() |
17614944 |
23 | |
bbdda281 |
24 | sub _determine_supports_insert_returning { |
25 | return shift->_server_info->{normalized_dbms_version} >= 8.002 |
26 | ? 1 |
27 | : 0 |
28 | ; |
38d5ea9f |
29 | } |
30 | |
e96a93df |
31 | sub with_deferred_fk_checks { |
32 | my ($self, $sub) = @_; |
33 | |
4d4dc518 |
34 | my $txn_scope_guard = $self->txn_scope_guard; |
35 | |
36 | $self->_do_query('SET CONSTRAINTS ALL DEFERRED'); |
38d5ea9f |
37 | |
4d4dc518 |
38 | my $sg = Scope::Guard->new(sub { |
39 | $self->_do_query('SET CONSTRAINTS ALL IMMEDIATE'); |
40 | }); |
41 | |
6298a324 |
42 | return preserve_context { $sub->() } after => sub { $txn_scope_guard->commit }; |
e96a93df |
43 | } |
44 | |
bab40dee |
45 | # only used when INSERT ... RETURNING is disabled |
38d5ea9f |
46 | sub last_insert_id { |
47 | my ($self,$source,@cols) = @_; |
48 | |
49 | my @values; |
50 | |
52416317 |
51 | my $col_info = $source->columns_info(\@cols); |
52 | |
38d5ea9f |
53 | for my $col (@cols) { |
52416317 |
54 | my $seq = ( $col_info->{$col}{sequence} ||= $self->dbh_do('_dbh_get_autoinc_seq', $source, $col) ) |
38d5ea9f |
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', |
57 | $source->name, |
58 | $col, |
59 | )); |
60 | |
61 | push @values, $self->_dbh->last_insert_id(undef, undef, undef, undef, {sequence => $seq}); |
62 | } |
63 | |
64 | return @values; |
65 | } |
66 | |
4d4dc518 |
67 | sub _sequence_fetch { |
68 | my ($self, $function, $sequence) = @_; |
69 | |
70 | $self->throw_exception('No sequence to fetch') unless $sequence; |
38d5ea9f |
71 | |
4d4dc518 |
72 | my ($val) = $self->_get_dbh->selectrow_array( |
07cda1c5 |
73 | sprintf ("select %s('%s')", $function, (ref $sequence eq 'SCALAR') ? $$sequence : $sequence) |
4d4dc518 |
74 | ); |
75 | |
76 | return $val; |
38d5ea9f |
77 | } |
9a0b7b26 |
78 | |
2d424996 |
79 | sub _dbh_get_autoinc_seq { |
80 | my ($self, $dbh, $source, $col) = @_; |
0063119f |
81 | |
2d424996 |
82 | my $schema; |
83 | my $table = $source->name; |
0063119f |
84 | |
2d424996 |
85 | # deref table name if it needs it |
86 | $table = $$table |
87 | if ref $table eq 'SCALAR'; |
0063119f |
88 | |
2d424996 |
89 | # parse out schema name if present |
90 | if( $table =~ /^(.+)\.(.+)$/ ) { |
91 | ( $schema, $table ) = ( $1, $2 ); |
92 | } |
0680ac39 |
93 | |
2d424996 |
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 ); |
96 | |
97 | # if no default value is set on the column, or if we can't parse the |
98 | # default value as a sequence, throw. |
5861223d |
99 | unless ( defined $seq_expr and $seq_expr =~ /^nextval\(+'([^']+)'::(?:text|regclass)\)/i ) { |
2d424996 |
100 | $seq_expr = '' unless defined $seq_expr; |
101 | $schema = "$schema." if defined $schema && length $schema; |
d3fdc7b8 |
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." : '', |
106 | $table, |
107 | $col, |
108 | $source->source_name, |
109 | )); |
777f7527 |
110 | } |
2d424996 |
111 | |
112 | return $1; |
777f7527 |
113 | } |
114 | |
2d424996 |
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 ) = @_; |
119 | |
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 |
123 | # schema name. |
124 | |
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 |
129 | # path. |
130 | |
131 | # I *think* we can be assured that this query will always find the |
132 | # correct column according to standard Postgres semantics. |
133 | # |
134 | # -- rbuels |
135 | |
136 | my $sqlmaker = $self->sql_maker; |
137 | local $sqlmaker->{bindtype} = 'normal'; |
138 | |
139 | my ($where, @bind) = $sqlmaker->where ({ |
140 | 'a.attnum' => {'>', 0}, |
141 | 'c.relname' => $table, |
142 | 'a.attname' => $col, |
143 | -not_bool => 'a.attisdropped', |
144 | (defined $schema && length $schema) |
145 | ? ( 'n.nspname' => $schema ) |
146 | : ( -bool => \'pg_catalog.pg_table_is_visible(c.oid)' ) |
147 | }); |
148 | |
149 | my ($seq_expr) = $dbh->selectrow_array(<<EOS,undef,@bind); |
150 | |
151 | SELECT |
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 |
158 | $where |
159 | |
160 | EOS |
161 | |
162 | return $seq_expr; |
163 | } |
164 | |
165 | |
4f533e8c |
166 | sub sqlt_type { |
167 | return 'PostgreSQL'; |
168 | } |
169 | |
a71859b4 |
170 | sub bind_attribute_by_data_type { |
171 | my ($self,$data_type) = @_; |
172 | |
173 | my $bind_attributes = { |
eda28767 |
174 | bytea => { pg_type => DBD::Pg::PG_BYTEA }, |
5ba88f68 |
175 | blob => { pg_type => DBD::Pg::PG_BYTEA }, |
a71859b4 |
176 | }; |
d4daee7b |
177 | |
a71859b4 |
178 | if( defined $bind_attributes->{$data_type} ) { |
9fdf90df |
179 | return $bind_attributes->{$data_type}; |
a71859b4 |
180 | } |
181 | else { |
182 | return; |
183 | } |
184 | } |
185 | |
adb3554a |
186 | sub _svp_begin { |
eeb8cfeb |
187 | my ($self, $name) = @_; |
adb3554a |
188 | |
9ae966b9 |
189 | $self->_get_dbh->pg_savepoint($name); |
adb3554a |
190 | } |
191 | |
192 | sub _svp_release { |
eeb8cfeb |
193 | my ($self, $name) = @_; |
adb3554a |
194 | |
9ae966b9 |
195 | $self->_get_dbh->pg_release($name); |
adb3554a |
196 | } |
197 | |
198 | sub _svp_rollback { |
eeb8cfeb |
199 | my ($self, $name) = @_; |
adb3554a |
200 | |
9ae966b9 |
201 | $self->_get_dbh->pg_rollback_to($name); |
adb3554a |
202 | } |
203 | |
c6375b4d |
204 | sub deployment_statements { |
205 | my $self = shift;; |
206 | my ($schema, $type, $version, $dir, $sqltargs, @rest) = @_; |
207 | |
208 | $sqltargs ||= {}; |
209 | |
96736321 |
210 | if ( |
211 | ! exists $sqltargs->{producer_args}{postgres_version} |
212 | and |
213 | my $dver = $self->_server_info->{normalized_dbms_version} |
214 | ) { |
215 | $sqltargs->{producer_args}{postgres_version} = $dver; |
c6375b4d |
216 | } |
217 | |
218 | $self->next::method($schema, $type, $version, $dir, $sqltargs, @rest); |
219 | } |
220 | |
843f8ecd |
221 | 1; |
222 | |
fd159e2a |
223 | __END__ |
224 | |
75d07914 |
225 | =head1 NAME |
843f8ecd |
226 | |
227 | DBIx::Class::Storage::DBI::Pg - Automatic primary key class for PostgreSQL |
228 | |
229 | =head1 SYNOPSIS |
230 | |
d88ecca6 |
231 | # In your result (table) classes |
232 | use base 'DBIx::Class::Core'; |
843f8ecd |
233 | __PACKAGE__->set_primary_key('id'); |
843f8ecd |
234 | |
235 | =head1 DESCRIPTION |
236 | |
237 | This class implements autoincrements for PostgreSQL. |
238 | |
7c0176a1 |
239 | =head1 POSTGRESQL SCHEMA SUPPORT |
240 | |
4f609014 |
241 | This driver supports multiple PostgreSQL schemas, with one caveat: for |
6ff1d58c |
242 | performance reasons, data about the search path, sequence names, and |
243 | so forth is queried as needed and CACHED for subsequent uses. |
7c0176a1 |
244 | |
4f609014 |
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. |
248 | |
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: |
7c0176a1 |
252 | |
253 | my $schema = My::Schema->connect |
254 | ( $dsn,$user,$pass, |
255 | { on_connect_do => |
256 | [ 'SET search_path TO myschema, foo, public' ], |
257 | }, |
258 | ); |
259 | |
7ff926e6 |
260 | =head1 AUTHORS |
7c0176a1 |
261 | |
7ff926e6 |
262 | See L<DBIx::Class/CONTRIBUTORS> |
843f8ecd |
263 | |
264 | =head1 LICENSE |
265 | |
266 | You may distribute this code under the same terms as Perl itself. |
267 | |
268 | =cut |