Commit | Line | Data |
6f4ddea1 |
1 | package # Hide from PAUSE |
855c6fd0 |
2 | DBIx::Class::SQLAHacks; |
6f4ddea1 |
3 | |
4 | use base qw/SQL::Abstract::Limit/; |
e3764383 |
5 | use strict; |
6 | use warnings; |
b2b22cd6 |
7 | use Carp::Clan qw/^DBIx::Class|^SQL::Abstract/; |
8 | |
9 | BEGIN { |
10 | # reinstall the carp()/croak() functions imported into SQL::Abstract |
11 | # as Carp and Carp::Clan do not like each other much |
12 | no warnings qw/redefine/; |
13 | no strict qw/refs/; |
14 | for my $f (qw/carp croak/) { |
15 | my $orig = \&{"SQL::Abstract::$f"}; |
16 | *{"SQL::Abstract::$f"} = sub { |
17 | |
18 | local $Carp::CarpLevel = 1; # even though Carp::Clan ignores this, $orig will not |
19 | |
20 | if (Carp::longmess() =~ /DBIx::Class::SQLAHacks::[\w]+\(\) called/) { |
21 | __PACKAGE__->can($f)->(@_); |
22 | } |
23 | else { |
24 | $orig->(@_); |
25 | } |
26 | } |
27 | } |
28 | } |
6f4ddea1 |
29 | |
30 | sub new { |
31 | my $self = shift->SUPER::new(@_); |
32 | |
33 | # This prevents the caching of $dbh in S::A::L, I believe |
34 | # If limit_dialect is a ref (like a $dbh), go ahead and replace |
35 | # it with what it resolves to: |
36 | $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect}) |
37 | if ref $self->{limit_dialect}; |
38 | |
39 | $self; |
40 | } |
41 | |
42 | |
6f4ddea1 |
43 | # Some databases (sqlite) do not handle multiple parenthesis |
44 | # around in/between arguments. A tentative x IN ( ( 1, 2 ,3) ) |
45 | # is interpreted as x IN 1 or something similar. |
46 | # |
47 | # Since we currently do not have access to the SQLA AST, resort |
48 | # to barbaric mutilation of any SQL supplied in literal form |
49 | |
50 | sub _strip_outer_paren { |
51 | my ($self, $arg) = @_; |
52 | |
53 | return $self->_SWITCH_refkind ($arg, { |
54 | ARRAYREFREF => sub { |
55 | $$arg->[0] = __strip_outer_paren ($$arg->[0]); |
56 | return $arg; |
57 | }, |
58 | SCALARREF => sub { |
59 | return \__strip_outer_paren( $$arg ); |
60 | }, |
61 | FALLBACK => sub { |
62 | return $arg |
63 | }, |
64 | }); |
65 | } |
66 | |
67 | sub __strip_outer_paren { |
68 | my $sql = shift; |
69 | |
70 | if ($sql and not ref $sql) { |
71 | while ($sql =~ /^ \s* \( (.*) \) \s* $/x ) { |
72 | $sql = $1; |
73 | } |
74 | } |
75 | |
76 | return $sql; |
77 | } |
78 | |
79 | sub _where_field_IN { |
80 | my ($self, $lhs, $op, $rhs) = @_; |
81 | $rhs = $self->_strip_outer_paren ($rhs); |
82 | return $self->SUPER::_where_field_IN ($lhs, $op, $rhs); |
83 | } |
84 | |
85 | sub _where_field_BETWEEN { |
86 | my ($self, $lhs, $op, $rhs) = @_; |
87 | $rhs = $self->_strip_outer_paren ($rhs); |
88 | return $self->SUPER::_where_field_BETWEEN ($lhs, $op, $rhs); |
89 | } |
90 | |
15827712 |
91 | # Slow but ANSI standard Limit/Offset support. DB2 uses this |
6f4ddea1 |
92 | sub _RowNumberOver { |
93 | my ($self, $sql, $order, $rows, $offset ) = @_; |
94 | |
95 | $offset += 1; |
03e1d9af |
96 | my $last = $rows + $offset - 1; |
6f4ddea1 |
97 | my ( $order_by ) = $self->_order_by( $order ); |
98 | |
99 | $sql = <<"SQL"; |
100 | SELECT * FROM |
101 | ( |
102 | SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM ( |
103 | $sql |
104 | $order_by |
105 | ) Q1 |
106 | ) Q2 |
107 | WHERE ROW_NUM BETWEEN $offset AND $last |
108 | |
109 | SQL |
110 | |
111 | return $sql; |
112 | } |
113 | |
15827712 |
114 | # Crappy Top based Limit/Offset support. MSSQL uses this currently, |
115 | # but may have to switch to RowNumberOver one day |
116 | sub _Top { |
117 | my ( $self, $sql, $order, $rows, $offset ) = @_; |
118 | |
119 | croak '$order supplied to SQLAHacks limit emulators must be a hash' |
120 | if (ref $order ne 'HASH'); |
121 | |
8f6dbee9 |
122 | $order = { %$order }; #copy |
123 | |
15827712 |
124 | my $last = $rows + $offset; |
125 | |
126 | my $req_order = $self->_order_by ($order->{order_by}); |
1cbd3034 |
127 | |
15827712 |
128 | my $limit_order = $req_order ? $order->{order_by} : $order->{_virtual_order_by}; |
129 | |
8f6dbee9 |
130 | delete $order->{$_} for qw/order_by _virtual_order_by/; |
131 | my $grpby_having = $self->_order_by ($order); |
132 | |
15827712 |
133 | my ( $order_by_inner, $order_by_outer ) = $self->_order_directions($limit_order); |
134 | |
135 | $sql =~ s/^\s*(SELECT|select)//; |
136 | |
137 | $sql = <<"SQL"; |
138 | SELECT * FROM |
139 | ( |
140 | SELECT TOP $rows * FROM |
141 | ( |
8f6dbee9 |
142 | SELECT TOP $last $sql $grpby_having $order_by_inner |
15827712 |
143 | ) AS foo |
144 | $order_by_outer |
145 | ) AS bar |
146 | $req_order |
147 | |
148 | SQL |
149 | return $sql; |
150 | } |
151 | |
152 | |
6f4ddea1 |
153 | |
154 | # While we're at it, this should make LIMIT queries more efficient, |
155 | # without digging into things too deeply |
6f4ddea1 |
156 | sub _find_syntax { |
157 | my ($self, $syntax) = @_; |
ac788c46 |
158 | return $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax); |
6f4ddea1 |
159 | } |
160 | |
161 | sub select { |
162 | my ($self, $table, $fields, $where, $order, @rest) = @_; |
1cbd3034 |
163 | |
164 | $self->{"${_}_bind"} = [] for (qw/having from order/); |
db56cf3d |
165 | |
6f4ddea1 |
166 | if (ref $table eq 'SCALAR') { |
167 | $table = $$table; |
168 | } |
169 | elsif (not ref $table) { |
170 | $table = $self->_quote($table); |
171 | } |
172 | local $self->{rownum_hack_count} = 1 |
173 | if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum'); |
174 | @rest = (-1) unless defined $rest[0]; |
e8fcf76f |
175 | croak "LIMIT 0 Does Not Compute" if $rest[0] == 0; |
6f4ddea1 |
176 | # and anyway, SQL::Abstract::Limit will cause a barf if we don't first |
db56cf3d |
177 | my ($sql, @where_bind) = $self->SUPER::select( |
6f4ddea1 |
178 | $table, $self->_recurse_fields($fields), $where, $order, @rest |
179 | ); |
180 | $sql .= |
181 | $self->{for} ? |
182 | ( |
183 | $self->{for} eq 'update' ? ' FOR UPDATE' : |
184 | $self->{for} eq 'shared' ? ' FOR SHARE' : |
185 | '' |
186 | ) : |
187 | '' |
188 | ; |
1cbd3034 |
189 | return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}, @{$self->{order_bind}} ) : $sql; |
6f4ddea1 |
190 | } |
191 | |
192 | sub insert { |
193 | my $self = shift; |
194 | my $table = shift; |
195 | $table = $self->_quote($table) unless ref($table); |
196 | $self->SUPER::insert($table, @_); |
197 | } |
198 | |
199 | sub update { |
200 | my $self = shift; |
201 | my $table = shift; |
202 | $table = $self->_quote($table) unless ref($table); |
203 | $self->SUPER::update($table, @_); |
204 | } |
205 | |
206 | sub delete { |
207 | my $self = shift; |
208 | my $table = shift; |
209 | $table = $self->_quote($table) unless ref($table); |
210 | $self->SUPER::delete($table, @_); |
211 | } |
212 | |
213 | sub _emulate_limit { |
214 | my $self = shift; |
215 | if ($_[3] == -1) { |
216 | return $_[1].$self->_order_by($_[2]); |
217 | } else { |
218 | return $self->SUPER::_emulate_limit(@_); |
219 | } |
220 | } |
221 | |
222 | sub _recurse_fields { |
223 | my ($self, $fields, $params) = @_; |
224 | my $ref = ref $fields; |
225 | return $self->_quote($fields) unless $ref; |
226 | return $$fields if $ref eq 'SCALAR'; |
227 | |
228 | if ($ref eq 'ARRAY') { |
229 | return join(', ', map { |
230 | $self->_recurse_fields($_) |
231 | .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack}) |
232 | ? ' AS col'.$self->{rownum_hack_count}++ |
233 | : '') |
234 | } @$fields); |
235 | } elsif ($ref eq 'HASH') { |
236 | foreach my $func (keys %$fields) { |
db56cf3d |
237 | if ($func eq 'distinct') { |
238 | my $_fields = $fields->{$func}; |
239 | if (ref $_fields eq 'ARRAY' && @{$_fields} > 1) { |
04ebc6f4 |
240 | croak ( |
241 | 'The select => { distinct => ... } syntax is not supported for multiple columns.' |
242 | .' Instead please use { group_by => [ qw/' . (join ' ', @$_fields) . '/ ] }' |
243 | .' or { select => [ qw/' . (join ' ', @$_fields) . '/ ], distinct => 1 }' |
244 | ); |
db56cf3d |
245 | } |
246 | else { |
247 | $_fields = @{$_fields}[0] if ref $_fields eq 'ARRAY'; |
04ebc6f4 |
248 | carp ( |
249 | 'The select => { distinct => ... } syntax will be deprecated in DBIC version 0.09,' |
250 | ." please use { group_by => '${_fields}' } or { select => '${_fields}', distinct => 1 }" |
251 | ); |
db56cf3d |
252 | } |
253 | } |
6f4ddea1 |
254 | return $self->_sqlcase($func) |
255 | .'( '.$self->_recurse_fields($fields->{$func}).' )'; |
256 | } |
257 | } |
258 | # Is the second check absolutely necessary? |
259 | elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) { |
db56cf3d |
260 | return $self->_fold_sqlbind( $fields ); |
6f4ddea1 |
261 | } |
262 | else { |
e8fcf76f |
263 | croak($ref . qq{ unexpected in _recurse_fields()}) |
6f4ddea1 |
264 | } |
265 | } |
266 | |
267 | sub _order_by { |
1cbd3034 |
268 | my ($self, $arg) = @_; |
15827712 |
269 | |
1cbd3034 |
270 | if (ref $arg eq 'HASH' and keys %$arg and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) { |
271 | |
272 | my $ret = ''; |
273 | |
274 | if (defined $arg->{group_by}) { |
6f4ddea1 |
275 | $ret = $self->_sqlcase(' group by ') |
1cbd3034 |
276 | .$self->_recurse_fields($arg->{group_by}, { no_rownum_hack => 1 }); |
6f4ddea1 |
277 | } |
15827712 |
278 | |
1cbd3034 |
279 | if (defined $arg->{having}) { |
280 | my ($frag, @bind) = $self->_recurse_where($arg->{having}); |
281 | push(@{$self->{having_bind}}, @bind); |
6f4ddea1 |
282 | $ret .= $self->_sqlcase(' having ').$frag; |
283 | } |
15827712 |
284 | |
1cbd3034 |
285 | if (defined $arg->{order_by}) { |
286 | my ($frag, @bind) = $self->SUPER::_order_by($arg->{order_by}); |
287 | push(@{$self->{order_bind}}, @bind); |
288 | $ret .= $frag; |
6f4ddea1 |
289 | } |
15827712 |
290 | |
1cbd3034 |
291 | return $ret; |
fde3719a |
292 | } |
1cbd3034 |
293 | else { |
294 | my ($sql, @bind) = $self->SUPER::_order_by ($arg); |
295 | push(@{$self->{order_bind}}, @bind); |
296 | return $sql; |
fd4cb60a |
297 | } |
6f4ddea1 |
298 | } |
299 | |
1cbd3034 |
300 | sub _order_directions { |
fd4cb60a |
301 | my ($self, $order) = @_; |
15827712 |
302 | |
1cbd3034 |
303 | # strip bind values - none of the current _order_directions users support them |
304 | return $self->SUPER::_order_directions( [ map |
305 | { ref $_ ? $_->[0] : $_ } |
306 | $self->_order_by_chunks ($order) |
307 | ]); |
fd4cb60a |
308 | } |
309 | |
6f4ddea1 |
310 | sub _table { |
311 | my ($self, $from) = @_; |
312 | if (ref $from eq 'ARRAY') { |
313 | return $self->_recurse_from(@$from); |
314 | } elsif (ref $from eq 'HASH') { |
315 | return $self->_make_as($from); |
316 | } else { |
317 | return $from; # would love to quote here but _table ends up getting called |
318 | # twice during an ->select without a limit clause due to |
319 | # the way S::A::Limit->select works. should maybe consider |
320 | # bypassing this and doing S::A::select($self, ...) in |
321 | # our select method above. meantime, quoting shims have |
322 | # been added to select/insert/update/delete here |
323 | } |
324 | } |
325 | |
326 | sub _recurse_from { |
327 | my ($self, $from, @join) = @_; |
328 | my @sqlf; |
329 | push(@sqlf, $self->_make_as($from)); |
330 | foreach my $j (@join) { |
331 | my ($to, $on) = @$j; |
332 | |
333 | # check whether a join type exists |
334 | my $join_clause = ''; |
335 | my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to; |
336 | if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) { |
337 | $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN '; |
338 | } else { |
339 | $join_clause = ' JOIN '; |
340 | } |
341 | push(@sqlf, $join_clause); |
342 | |
343 | if (ref $to eq 'ARRAY') { |
344 | push(@sqlf, '(', $self->_recurse_from(@$to), ')'); |
345 | } else { |
346 | push(@sqlf, $self->_make_as($to)); |
347 | } |
348 | push(@sqlf, ' ON ', $self->_join_condition($on)); |
349 | } |
350 | return join('', @sqlf); |
351 | } |
352 | |
db56cf3d |
353 | sub _fold_sqlbind { |
354 | my ($self, $sqlbind) = @_; |
69989ea9 |
355 | |
356 | my @sqlbind = @$$sqlbind; # copy |
357 | my $sql = shift @sqlbind; |
358 | push @{$self->{from_bind}}, @sqlbind; |
359 | |
db56cf3d |
360 | return $sql; |
6f4ddea1 |
361 | } |
362 | |
363 | sub _make_as { |
364 | my ($self, $from) = @_; |
db56cf3d |
365 | return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ |
366 | : ref $_ eq 'REF' ? $self->_fold_sqlbind($_) |
367 | : $self->_quote($_)) |
6f4ddea1 |
368 | } reverse each %{$self->_skip_options($from)}); |
369 | } |
370 | |
371 | sub _skip_options { |
372 | my ($self, $hash) = @_; |
373 | my $clean_hash = {}; |
374 | $clean_hash->{$_} = $hash->{$_} |
375 | for grep {!/^-/} keys %$hash; |
376 | return $clean_hash; |
377 | } |
378 | |
379 | sub _join_condition { |
380 | my ($self, $cond) = @_; |
381 | if (ref $cond eq 'HASH') { |
382 | my %j; |
383 | for (keys %$cond) { |
384 | my $v = $cond->{$_}; |
385 | if (ref $v) { |
e8fcf76f |
386 | croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'}) |
6f4ddea1 |
387 | if ref($v) ne 'SCALAR'; |
388 | $j{$_} = $v; |
389 | } |
390 | else { |
391 | my $x = '= '.$self->_quote($v); $j{$_} = \$x; |
392 | } |
393 | }; |
394 | return scalar($self->_recurse_where(\%j)); |
395 | } elsif (ref $cond eq 'ARRAY') { |
396 | return join(' OR ', map { $self->_join_condition($_) } @$cond); |
397 | } else { |
398 | die "Can't handle this yet!"; |
399 | } |
400 | } |
401 | |
402 | sub _quote { |
403 | my ($self, $label) = @_; |
404 | return '' unless defined $label; |
405 | return "*" if $label eq '*'; |
406 | return $label unless $self->{quote_char}; |
407 | if(ref $self->{quote_char} eq "ARRAY"){ |
408 | return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1] |
409 | if !defined $self->{name_sep}; |
410 | my $sep = $self->{name_sep}; |
411 | return join($self->{name_sep}, |
412 | map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] } |
413 | split(/\Q$sep\E/,$label)); |
414 | } |
415 | return $self->SUPER::_quote($label); |
416 | } |
417 | |
418 | sub limit_dialect { |
419 | my $self = shift; |
420 | $self->{limit_dialect} = shift if @_; |
421 | return $self->{limit_dialect}; |
422 | } |
423 | |
424 | sub quote_char { |
425 | my $self = shift; |
426 | $self->{quote_char} = shift if @_; |
427 | return $self->{quote_char}; |
428 | } |
429 | |
430 | sub name_sep { |
431 | my $self = shift; |
432 | $self->{name_sep} = shift if @_; |
433 | return $self->{name_sep}; |
434 | } |
435 | |
436 | 1; |
437 | |
438 | __END__ |
439 | |
440 | =pod |
441 | |
442 | =head1 NAME |
443 | |
855c6fd0 |
444 | DBIx::Class::SQLAHacks - This module is a subclass of SQL::Abstract::Limit |
445 | and includes a number of DBIC-specific workarounds, not yet suitable for |
446 | inclusion into SQLA proper. |
6f4ddea1 |
447 | |
448 | =head1 METHODS |
449 | |
450 | =head2 new |
451 | |
452 | Tries to determine limit dialect. |
453 | |
454 | =head2 select |
455 | |
456 | Quotes table names, handles "limit" dialects (e.g. where rownum between x and |
457 | y), supports SELECT ... FOR UPDATE and SELECT ... FOR SHARE. |
458 | |
459 | =head2 insert update delete |
460 | |
461 | Just quotes table names. |
462 | |
463 | =head2 limit_dialect |
464 | |
465 | Specifies the dialect of used for implementing an SQL "limit" clause for |
466 | restricting the number of query results returned. Valid values are: RowNum. |
467 | |
468 | See L<DBIx::Class::Storage::DBI/connect_info> for details. |
469 | |
470 | =head2 name_sep |
471 | |
472 | Character separating quoted table names. |
473 | |
474 | See L<DBIx::Class::Storage::DBI/connect_info> for details. |
475 | |
476 | =head2 quote_char |
477 | |
478 | Set to an array-ref to specify separate left and right quotes for table names. |
479 | |
480 | See L<DBIx::Class::Storage::DBI/connect_info> for details. |
481 | |
482 | =cut |
483 | |