Commit | Line | Data |
6f4ddea1 |
1 | package # Hide from PAUSE |
855c6fd0 |
2 | DBIx::Class::SQLAHacks; |
6f4ddea1 |
3 | |
998373c2 |
4 | # This module is a subclass of SQL::Abstract::Limit and includes a number |
5 | # of DBIC-specific workarounds, not yet suitable for inclusion into the |
6 | # SQLA core |
7 | |
6f4ddea1 |
8 | use base qw/SQL::Abstract::Limit/; |
e3764383 |
9 | use strict; |
10 | use warnings; |
6298a324 |
11 | use List::Util 'first'; |
12 | use Sub::Name 'subname'; |
13 | use namespace::clean; |
ac322978 |
14 | use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/; |
b2b22cd6 |
15 | |
16 | BEGIN { |
17 | # reinstall the carp()/croak() functions imported into SQL::Abstract |
18 | # as Carp and Carp::Clan do not like each other much |
19 | no warnings qw/redefine/; |
20 | no strict qw/refs/; |
21 | for my $f (qw/carp croak/) { |
329d7385 |
22 | |
b2b22cd6 |
23 | my $orig = \&{"SQL::Abstract::$f"}; |
6298a324 |
24 | *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" => |
8637bb24 |
25 | sub { |
26 | if (Carp::longmess() =~ /DBIx::Class::SQLAHacks::[\w]+ .+? called \s at/x) { |
27 | __PACKAGE__->can($f)->(@_); |
28 | } |
29 | else { |
30 | goto $orig; |
31 | } |
32 | }; |
b2b22cd6 |
33 | } |
34 | } |
6f4ddea1 |
35 | |
998373c2 |
36 | |
37 | # Tries to determine limit dialect. |
38 | # |
6f4ddea1 |
39 | sub new { |
40 | my $self = shift->SUPER::new(@_); |
41 | |
42 | # This prevents the caching of $dbh in S::A::L, I believe |
43 | # If limit_dialect is a ref (like a $dbh), go ahead and replace |
44 | # it with what it resolves to: |
45 | $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect}) |
46 | if ref $self->{limit_dialect}; |
47 | |
48 | $self; |
49 | } |
50 | |
a54bd479 |
51 | # !!! THIS IS ALSO HORRIFIC !!! /me ashamed |
52 | # |
75f025cf |
53 | # Generates inner/outer select lists for various limit dialects |
81446c4f |
54 | # which result in one or more subqueries (e.g. RNO, Top, RowNum) |
55 | # Any non-root-table columns need to have their table qualifier |
a54bd479 |
56 | # turned into a column alias (otherwise names in subqueries clash |
81446c4f |
57 | # and/or lose their source table) |
a54bd479 |
58 | # |
75f025cf |
59 | # Returns inner/outer strings of SQL QUOTED selectors with aliases |
a54bd479 |
60 | # (to be used in whatever select statement), and an alias index hashref |
61 | # of QUOTED SEL => QUOTED ALIAS pairs (to maybe be used for string-subst |
75f025cf |
62 | # higher up). |
63 | # If an order_by is supplied, the inner select needs to bring out columns |
64 | # used in implicit (non-selected) orders, and the order condition itself |
65 | # needs to be realiased to the proper names in the outer query. Thus we |
66 | # also return a hashref (order doesn't matter) of QUOTED EXTRA-SEL => |
67 | # QUOTED ALIAS pairs, which is a list of extra selectors that do *not* |
68 | # exist in the original select list |
a54bd479 |
69 | |
70 | sub _subqueried_limit_attrs { |
75f025cf |
71 | my ($self, $rs_attrs) = @_; |
81446c4f |
72 | |
a54bd479 |
73 | croak 'Limit dialect implementation usable only in the context of DBIC (missing $rs_attrs)' |
74 | unless ref ($rs_attrs) eq 'HASH'; |
75 | |
76 | my ($re_sep, $re_alias) = map { quotemeta $_ } ( |
77 | $self->name_sep || '.', |
78 | $rs_attrs->{alias}, |
79 | ); |
81446c4f |
80 | |
a54bd479 |
81 | # correlate select and as, build selection index |
82 | my (@sel, $in_sel_index); |
81446c4f |
83 | for my $i (0 .. $#{$rs_attrs->{select}}) { |
a54bd479 |
84 | |
81446c4f |
85 | my $s = $rs_attrs->{select}[$i]; |
a54bd479 |
86 | my $sql_sel = $self->_recurse_fields ($s); |
87 | my $sql_alias = (ref $s) eq 'HASH' ? $s->{-as} : undef; |
88 | |
89 | |
81446c4f |
90 | push @sel, { |
a54bd479 |
91 | sql => $sql_sel, |
81446c4f |
92 | unquoted_sql => do { local $self->{quote_char}; $self->_recurse_fields ($s) }, |
93 | as => |
a54bd479 |
94 | $sql_alias |
81446c4f |
95 | || |
96 | $rs_attrs->{as}[$i] |
97 | || |
98 | croak "Select argument $i ($s) without corresponding 'as'" |
99 | , |
100 | }; |
a54bd479 |
101 | |
102 | $in_sel_index->{$sql_sel}++; |
103 | $in_sel_index->{$self->_quote ($sql_alias)}++ if $sql_alias; |
104 | |
75f025cf |
105 | # record unqualified versions too, so we do not have |
106 | # to reselect the same column twice (in qualified and |
107 | # unqualified form) |
108 | if (! ref $s && $sql_sel =~ / $re_sep (.+) $/x) { |
109 | $in_sel_index->{$1}++; |
110 | } |
81446c4f |
111 | } |
112 | |
81446c4f |
113 | |
114 | # re-alias and remove any name separators from aliases, |
115 | # unless we are dealing with the current source alias |
a54bd479 |
116 | # (which will transcend the subqueries as it is necessary |
81446c4f |
117 | # for possible further chaining) |
a54bd479 |
118 | my (@in_sel, @out_sel, %renamed); |
81446c4f |
119 | for my $node (@sel) { |
6298a324 |
120 | if (first { $_ =~ / (?<! $re_alias ) $re_sep /x } ($node->{as}, $node->{unquoted_sql}) ) { |
a54bd479 |
121 | $node->{as} =~ s/ $re_sep /__/xg; |
122 | my $quoted_as = $self->_quote($node->{as}); |
123 | push @in_sel, sprintf '%s AS %s', $node->{sql}, $quoted_as; |
124 | push @out_sel, $quoted_as; |
125 | $renamed{$node->{sql}} = $quoted_as; |
81446c4f |
126 | } |
127 | else { |
a54bd479 |
128 | push @in_sel, $node->{sql}; |
129 | push @out_sel, $self->_quote ($node->{as}); |
81446c4f |
130 | } |
131 | } |
132 | |
75f025cf |
133 | # see if the order gives us anything |
a54bd479 |
134 | my %extra_order_sel; |
75f025cf |
135 | for my $chunk ($self->_order_by_chunks ($rs_attrs->{order_by})) { |
136 | # order with bind |
137 | $chunk = $chunk->[0] if (ref $chunk) eq 'ARRAY'; |
138 | $chunk =~ s/\s+ (?: ASC|DESC ) \s* $//ix; |
a54bd479 |
139 | |
75f025cf |
140 | next if $in_sel_index->{$chunk}; |
a54bd479 |
141 | |
75f025cf |
142 | $extra_order_sel{$chunk} ||= $self->_quote ( |
143 | 'ORDER__BY__' . scalar keys %extra_order_sel |
144 | ); |
a54bd479 |
145 | } |
75f025cf |
146 | |
a54bd479 |
147 | return ( |
148 | (map { join (', ', @$_ ) } ( |
149 | \@in_sel, |
150 | \@out_sel) |
151 | ), |
152 | \%renamed, |
153 | keys %extra_order_sel ? \%extra_order_sel : (), |
154 | ); |
81446c4f |
155 | } |
156 | |
a54bd479 |
157 | # ANSI standard Limit/Offset implementation. DB2 and MSSQL >= 2005 use this |
6f4ddea1 |
158 | sub _RowNumberOver { |
a6b68a60 |
159 | my ($self, $sql, $rs_attrs, $rows, $offset ) = @_; |
6f4ddea1 |
160 | |
81446c4f |
161 | # mangle the input sql as we will be replacing the selector |
162 | $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix |
cb478051 |
163 | or croak "Unrecognizable SELECT: $sql"; |
164 | |
a54bd479 |
165 | # get selectors, and scan the order_by (if any) |
75f025cf |
166 | my ($in_sel, $out_sel, $alias_map, $extra_order_sel) |
167 | = $self->_subqueried_limit_attrs ( $rs_attrs ); |
81446c4f |
168 | |
a6b68a60 |
169 | # make up an order if none exists |
a54bd479 |
170 | my $requested_order = (delete $rs_attrs->{order_by}) || $self->_rno_default_order; |
171 | my $rno_ord = $self->_order_by ($requested_order); |
172 | |
173 | # this is the order supplement magic |
174 | my $mid_sel = $out_sel; |
175 | if ($extra_order_sel) { |
20f44a33 |
176 | for my $extra_col (sort |
177 | { $extra_order_sel->{$a} cmp $extra_order_sel->{$b} } |
178 | keys %$extra_order_sel |
179 | ) { |
a54bd479 |
180 | $in_sel .= sprintf (', %s AS %s', |
181 | $extra_col, |
182 | $extra_order_sel->{$extra_col}, |
183 | ); |
184 | |
185 | $mid_sel .= ', ' . $extra_order_sel->{$extra_col}; |
186 | } |
187 | } |
188 | |
189 | # and this is order re-alias magic |
190 | for ($extra_order_sel, $alias_map) { |
191 | for my $col (keys %$_) { |
192 | my $re_col = quotemeta ($col); |
193 | $rno_ord =~ s/$re_col/$_->{$col}/; |
194 | } |
195 | } |
6f4ddea1 |
196 | |
81446c4f |
197 | # whatever is left of the order_by (only where is processed at this point) |
a6b68a60 |
198 | my $group_having = $self->_parse_rs_attrs($rs_attrs); |
6f4ddea1 |
199 | |
a6b68a60 |
200 | my $qalias = $self->_quote ($rs_attrs->{alias}); |
81446c4f |
201 | my $idx_name = $self->_quote ('rno__row__index'); |
202 | |
cb478051 |
203 | $sql = sprintf (<<EOS, $offset + 1, $offset + $rows, ); |
6f4ddea1 |
204 | |
a54bd479 |
205 | SELECT $out_sel FROM ( |
206 | SELECT $mid_sel, ROW_NUMBER() OVER( $rno_ord ) AS $idx_name FROM ( |
207 | SELECT $in_sel ${sql}${group_having} |
cb478051 |
208 | ) $qalias |
75f025cf |
209 | ) $qalias WHERE $idx_name BETWEEN %u AND %u |
6553ac38 |
210 | |
211 | EOS |
212 | |
213 | $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger |
6f4ddea1 |
214 | return $sql; |
215 | } |
216 | |
84ddb3da |
217 | # some databases are happy with OVER (), some need OVER (ORDER BY (SELECT (1)) ) |
218 | sub _rno_default_order { |
219 | return undef; |
220 | } |
221 | |
193590c2 |
222 | # Informix specific limit, almost like LIMIT/OFFSET |
223 | sub _SkipFirst { |
a6b68a60 |
224 | my ($self, $sql, $rs_attrs, $rows, $offset) = @_; |
193590c2 |
225 | |
226 | $sql =~ s/^ \s* SELECT \s+ //ix |
227 | or croak "Unrecognizable SELECT: $sql"; |
228 | |
229 | return sprintf ('SELECT %s%s%s%s', |
230 | $offset |
75f025cf |
231 | ? sprintf ('SKIP %u ', $offset) |
193590c2 |
232 | : '' |
233 | , |
75f025cf |
234 | sprintf ('FIRST %u ', $rows), |
193590c2 |
235 | $sql, |
a6b68a60 |
236 | $self->_parse_rs_attrs ($rs_attrs), |
193590c2 |
237 | ); |
238 | } |
239 | |
145b2a3d |
240 | # Firebird specific limit, reverse of _SkipFirst for Informix |
241 | sub _FirstSkip { |
a6b68a60 |
242 | my ($self, $sql, $rs_attrs, $rows, $offset) = @_; |
145b2a3d |
243 | |
244 | $sql =~ s/^ \s* SELECT \s+ //ix |
245 | or croak "Unrecognizable SELECT: $sql"; |
246 | |
247 | return sprintf ('SELECT %s%s%s%s', |
75f025cf |
248 | sprintf ('FIRST %u ', $rows), |
145b2a3d |
249 | $offset |
75f025cf |
250 | ? sprintf ('SKIP %u ', $offset) |
145b2a3d |
251 | : '' |
252 | , |
253 | $sql, |
a6b68a60 |
254 | $self->_parse_rs_attrs ($rs_attrs), |
145b2a3d |
255 | ); |
256 | } |
257 | |
81446c4f |
258 | # WhOracle limits |
259 | sub _RowNum { |
260 | my ( $self, $sql, $rs_attrs, $rows, $offset ) = @_; |
261 | |
262 | # mangle the input sql as we will be replacing the selector |
263 | $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix |
264 | or croak "Unrecognizable SELECT: $sql"; |
265 | |
a54bd479 |
266 | my ($insel, $outsel) = $self->_subqueried_limit_attrs ($rs_attrs); |
81446c4f |
267 | |
268 | my $qalias = $self->_quote ($rs_attrs->{alias}); |
269 | my $idx_name = $self->_quote ('rownum__index'); |
270 | my $order_group_having = $self->_parse_rs_attrs($rs_attrs); |
271 | |
272 | $sql = sprintf (<<EOS, $offset + 1, $offset + $rows, ); |
273 | |
274 | SELECT $outsel FROM ( |
275 | SELECT $outsel, ROWNUM $idx_name FROM ( |
276 | SELECT $insel ${sql}${order_group_having} |
277 | ) $qalias |
75f025cf |
278 | ) $qalias WHERE $idx_name BETWEEN %u AND %u |
81446c4f |
279 | |
280 | EOS |
281 | |
282 | $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger |
283 | return $sql; |
284 | } |
285 | |
a54bd479 |
286 | # Crappy Top based Limit/Offset support. Legacy for MSSQL < 2005 |
15827712 |
287 | sub _Top { |
a6b68a60 |
288 | my ( $self, $sql, $rs_attrs, $rows, $offset ) = @_; |
15827712 |
289 | |
81446c4f |
290 | # mangle the input sql as we will be replacing the selector |
291 | $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix |
b1e1d073 |
292 | or croak "Unrecognizable SELECT: $sql"; |
b1e1d073 |
293 | |
81446c4f |
294 | # get selectors |
a54bd479 |
295 | my ($in_sel, $out_sel, $alias_map, $extra_order_sel) |
75f025cf |
296 | = $self->_subqueried_limit_attrs ($rs_attrs); |
81446c4f |
297 | |
a54bd479 |
298 | my $requested_order = delete $rs_attrs->{order_by}; |
81446c4f |
299 | |
a54bd479 |
300 | my $order_by_requested = $self->_order_by ($requested_order); |
301 | |
302 | # make up an order unless supplied |
303 | my $inner_order = ($order_by_requested |
304 | ? $requested_order |
81446c4f |
305 | : [ map |
a54bd479 |
306 | { join ('', $rs_attrs->{alias}, $self->{name_sep}||'.', $_ ) } |
307 | ( $rs_attrs->{_rsroot_source_handle}->resolve->_pri_cols ) |
81446c4f |
308 | ] |
a54bd479 |
309 | ); |
81446c4f |
310 | |
a54bd479 |
311 | my ($order_by_inner, $order_by_reversed); |
81446c4f |
312 | |
a54bd479 |
313 | # localise as we already have all the bind values we need |
314 | { |
315 | local $self->{order_bind}; |
316 | $order_by_inner = $self->_order_by ($inner_order); |
ac93965c |
317 | |
a54bd479 |
318 | my @out_chunks; |
319 | for my $ch ($self->_order_by_chunks ($inner_order)) { |
320 | $ch = $ch->[0] if ref $ch eq 'ARRAY'; |
20f44a33 |
321 | |
a54bd479 |
322 | $ch =~ s/\s+ ( ASC|DESC ) \s* $//ix; |
323 | my $dir = uc ($1||'ASC'); |
b1e1d073 |
324 | |
a54bd479 |
325 | push @out_chunks, \join (' ', $ch, $dir eq 'ASC' ? 'DESC' : 'ASC' ); |
326 | } |
b1e1d073 |
327 | |
20f44a33 |
328 | $order_by_reversed = $self->_order_by (\@out_chunks); |
42e5b103 |
329 | } |
b1e1d073 |
330 | |
a54bd479 |
331 | # this is the order supplement magic |
332 | my $mid_sel = $out_sel; |
333 | if ($extra_order_sel) { |
20f44a33 |
334 | for my $extra_col (sort |
335 | { $extra_order_sel->{$a} cmp $extra_order_sel->{$b} } |
336 | keys %$extra_order_sel |
337 | ) { |
a54bd479 |
338 | $in_sel .= sprintf (', %s AS %s', |
339 | $extra_col, |
340 | $extra_order_sel->{$extra_col}, |
42e5b103 |
341 | ); |
b1e1d073 |
342 | |
a54bd479 |
343 | $mid_sel .= ', ' . $extra_order_sel->{$extra_col}; |
42e5b103 |
344 | } |
25abda27 |
345 | |
346 | # since whatever order bindvals there are, they will be realiased |
347 | # and need to show up in front of the entire initial inner subquery |
348 | # Unshift *from_bind* to make this happen (horrible, horrible, but |
349 | # we don't have another mechanism yet) |
350 | unshift @{$self->{from_bind}}, @{$self->{order_bind}}; |
b1e1d073 |
351 | } |
352 | |
a54bd479 |
353 | # and this is order re-alias magic |
354 | for my $map ($extra_order_sel, $alias_map) { |
355 | for my $col (keys %$map) { |
356 | my $re_col = quotemeta ($col); |
357 | $_ =~ s/$re_col/$map->{$col}/ |
358 | for ($order_by_reversed, $order_by_requested); |
b1e1d073 |
359 | } |
360 | } |
15827712 |
361 | |
a54bd479 |
362 | # generate the rest of the sql |
363 | my $grpby_having = $self->_parse_rs_attrs ($rs_attrs); |
15827712 |
364 | |
a54bd479 |
365 | my $quoted_rs_alias = $self->_quote ($rs_attrs->{alias}); |
b1e1d073 |
366 | |
75f025cf |
367 | $sql = sprintf ('SELECT TOP %u %s %s %s %s', |
a54bd479 |
368 | $rows + ($offset||0), |
369 | $in_sel, |
370 | $sql, |
371 | $grpby_having, |
372 | $order_by_inner, |
373 | ); |
15827712 |
374 | |
75f025cf |
375 | $sql = sprintf ('SELECT TOP %u %s FROM ( %s ) %s %s', |
a54bd479 |
376 | $rows, |
377 | $mid_sel, |
378 | $sql, |
379 | $quoted_rs_alias, |
380 | $order_by_reversed, |
381 | ) if $offset; |
15827712 |
382 | |
75f025cf |
383 | $sql = sprintf ('SELECT TOP %u %s FROM ( %s ) %s %s', |
a54bd479 |
384 | $rows, |
a54bd479 |
385 | $out_sel, |
386 | $sql, |
387 | $quoted_rs_alias, |
20f44a33 |
388 | $order_by_requested, |
76fc0d71 |
389 | ) if ( ($offset && $order_by_requested) || ($mid_sel ne $out_sel) ); |
b1e1d073 |
390 | |
75f025cf |
391 | $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger |
392 | return $sql; |
393 | } |
394 | |
395 | # This is the most evil limit "dialect" (more of a hack) for *really* |
396 | # stupid databases. It works by ordering the set by some unique column, |
397 | # and calculating amount of rows that have a less-er value (thus |
398 | # emulating a RowNum-like index). Of course this implies the set can |
399 | # only be ordered by a single unique columns. |
400 | sub _GenericSubQ { |
401 | my ($self, $sql, $rs_attrs, $rows, $offset) = @_; |
402 | |
403 | my $root_rsrc = $rs_attrs->{_rsroot_source_handle}->resolve; |
404 | my $root_tbl_name = $root_rsrc->name; |
405 | |
406 | # mangle the input sql as we will be replacing the selector |
407 | $sql =~ s/^ \s* SELECT \s+ .+? \s+ (?= \b FROM \b )//ix |
408 | or croak "Unrecognizable SELECT: $sql"; |
409 | |
410 | my ($order_by, @rest) = do { |
411 | local $self->{quote_char}; |
412 | $self->_order_by_chunks ($rs_attrs->{order_by}) |
413 | }; |
414 | |
415 | unless ( |
416 | $order_by |
417 | && |
418 | ! @rest |
419 | && |
420 | ( ! ref $order_by |
421 | || |
422 | ( ref $order_by eq 'ARRAY' and @$order_by == 1 ) |
423 | ) |
424 | ) { |
425 | croak ( |
426 | 'Generic Subquery Limit does not work on resultsets without an order, or resultsets ' |
427 | . 'with complex order criteria (multicolumn and/or functions). Provide a single, ' |
428 | . 'unique-column order criteria.' |
429 | ); |
430 | } |
431 | |
432 | ($order_by) = @$order_by if ref $order_by; |
433 | |
434 | $order_by =~ s/\s+ ( ASC|DESC ) \s* $//ix; |
435 | my $direction = lc ($1 || 'asc'); |
436 | |
437 | my ($unq_sort_col) = $order_by =~ /(?:^|\.)([^\.]+)$/; |
438 | |
439 | my $inf = $root_rsrc->storage->_resolve_column_info ( |
440 | $rs_attrs->{from}, [$order_by, $unq_sort_col] |
441 | ); |
442 | |
443 | my $ord_colinfo = $inf->{$order_by} || croak "Unable to determine source of order-criteria '$order_by'"; |
444 | |
445 | if ($ord_colinfo->{-result_source}->name ne $root_tbl_name) { |
446 | croak "Generic Subquery Limit order criteria can be only based on the root-source '" |
447 | . $root_rsrc->source_name . "' (aliased as '$rs_attrs->{alias}')"; |
448 | } |
449 | |
450 | # make sure order column is qualified |
451 | $order_by = "$rs_attrs->{alias}.$order_by" |
452 | unless $order_by =~ /^$rs_attrs->{alias}\./; |
453 | |
454 | my $is_u; |
455 | my $ucs = { $root_rsrc->unique_constraints }; |
456 | for (values %$ucs ) { |
457 | if (@$_ == 1 && "$rs_attrs->{alias}.$_->[0]" eq $order_by) { |
458 | $is_u++; |
459 | last; |
460 | } |
461 | } |
462 | croak "Generic Subquery Limit order criteria column '$order_by' must be unique (no unique constraint found)" |
463 | unless $is_u; |
464 | |
465 | my ($in_sel, $out_sel, $alias_map, $extra_order_sel) |
466 | = $self->_subqueried_limit_attrs ($rs_attrs); |
467 | |
468 | my $cmp_op = $direction eq 'desc' ? '>' : '<'; |
469 | my $count_tbl_alias = 'rownum__emulation'; |
470 | |
b13d2248 |
471 | my $order_sql = $self->_order_by (delete $rs_attrs->{order_by}); |
472 | my $group_having_sql = $self->_parse_rs_attrs($rs_attrs); |
75f025cf |
473 | |
474 | # add the order supplement (if any) as this is what will be used for the outer WHERE |
475 | $in_sel .= ", $_" for keys %{$extra_order_sel||{}}; |
476 | |
477 | $sql = sprintf (<<EOS, |
478 | SELECT $out_sel |
479 | FROM ( |
b13d2248 |
480 | SELECT $in_sel ${sql}${group_having_sql} |
75f025cf |
481 | ) %s |
482 | WHERE ( SELECT COUNT(*) FROM %s %s WHERE %s $cmp_op %s ) %s |
b13d2248 |
483 | $order_sql |
75f025cf |
484 | EOS |
485 | ( map { $self->_quote ($_) } ( |
486 | $rs_attrs->{alias}, |
487 | $root_tbl_name, |
488 | $count_tbl_alias, |
489 | "$count_tbl_alias.$unq_sort_col", |
490 | $order_by, |
491 | )), |
492 | $offset |
493 | ? sprintf ('BETWEEN %u AND %u', $offset, $offset + $rows - 1) |
494 | : sprintf ('< %u', $rows ) |
495 | , |
496 | ); |
497 | |
498 | $sql =~ s/\s*\n\s*/ /g; # easier to read in the debugger |
b1e1d073 |
499 | return $sql; |
15827712 |
500 | } |
a54bd479 |
501 | |
6f4ddea1 |
502 | |
503 | # While we're at it, this should make LIMIT queries more efficient, |
504 | # without digging into things too deeply |
6f4ddea1 |
505 | sub _find_syntax { |
506 | my ($self, $syntax) = @_; |
ac788c46 |
507 | return $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax); |
6f4ddea1 |
508 | } |
509 | |
998373c2 |
510 | # Quotes table names, handles "limit" dialects (e.g. where rownum between x and |
a6b68a60 |
511 | # y) |
6f4ddea1 |
512 | sub select { |
a6b68a60 |
513 | my ($self, $table, $fields, $where, $rs_attrs, @rest) = @_; |
1cbd3034 |
514 | |
c2b7c5dc |
515 | if (not ref($table) or ref($table) eq 'SCALAR') { |
6f4ddea1 |
516 | $table = $self->_quote($table); |
517 | } |
c2b7c5dc |
518 | |
6f4ddea1 |
519 | @rest = (-1) unless defined $rest[0]; |
e8fcf76f |
520 | croak "LIMIT 0 Does Not Compute" if $rest[0] == 0; |
6f4ddea1 |
521 | # and anyway, SQL::Abstract::Limit will cause a barf if we don't first |
a6b68a60 |
522 | |
49afd714 |
523 | my ($sql, @bind) = $self->SUPER::select( |
a6b68a60 |
524 | $table, $self->_recurse_fields($fields), $where, $rs_attrs, @rest |
6f4ddea1 |
525 | ); |
49afd714 |
526 | push @{$self->{where_bind}}, @bind; |
583a0c65 |
527 | |
528 | # this *must* be called, otherwise extra binds will remain in the sql-maker |
49afd714 |
529 | my @all_bind = $self->_assemble_binds; |
583a0c65 |
530 | |
49afd714 |
531 | return wantarray ? ($sql, @all_bind) : $sql; |
583a0c65 |
532 | } |
533 | |
534 | sub _assemble_binds { |
535 | my $self = shift; |
536 | return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/from where having order/); |
6f4ddea1 |
537 | } |
538 | |
998373c2 |
539 | # Quotes table names, and handles default inserts |
6f4ddea1 |
540 | sub insert { |
541 | my $self = shift; |
542 | my $table = shift; |
c2b7c5dc |
543 | $table = $self->_quote($table); |
7a72e5a5 |
544 | |
545 | # SQLA will emit INSERT INTO $table ( ) VALUES ( ) |
546 | # which is sadly understood only by MySQL. Change default behavior here, |
547 | # until SQLA2 comes with proper dialect support |
548 | if (! $_[0] or (ref $_[0] eq 'HASH' and !keys %{$_[0]} ) ) { |
28d28903 |
549 | my $sql = "INSERT INTO ${table} DEFAULT VALUES"; |
550 | |
ef8d02eb |
551 | if (my $ret = ($_[1]||{})->{returning} ) { |
552 | $sql .= $self->_insert_returning ($ret); |
28d28903 |
553 | } |
554 | |
555 | return $sql; |
7a72e5a5 |
556 | } |
557 | |
6f4ddea1 |
558 | $self->SUPER::insert($table, @_); |
559 | } |
560 | |
998373c2 |
561 | # Just quotes table names. |
6f4ddea1 |
562 | sub update { |
563 | my $self = shift; |
564 | my $table = shift; |
c2b7c5dc |
565 | $table = $self->_quote($table); |
6f4ddea1 |
566 | $self->SUPER::update($table, @_); |
567 | } |
568 | |
998373c2 |
569 | # Just quotes table names. |
6f4ddea1 |
570 | sub delete { |
571 | my $self = shift; |
572 | my $table = shift; |
c2b7c5dc |
573 | $table = $self->_quote($table); |
6f4ddea1 |
574 | $self->SUPER::delete($table, @_); |
575 | } |
576 | |
577 | sub _emulate_limit { |
578 | my $self = shift; |
a6b68a60 |
579 | # my ( $syntax, $sql, $order, $rows, $offset ) = @_; |
580 | |
6f4ddea1 |
581 | if ($_[3] == -1) { |
a6b68a60 |
582 | return $_[1] . $self->_parse_rs_attrs($_[2]); |
6f4ddea1 |
583 | } else { |
584 | return $self->SUPER::_emulate_limit(@_); |
585 | } |
586 | } |
587 | |
588 | sub _recurse_fields { |
81446c4f |
589 | my ($self, $fields) = @_; |
6f4ddea1 |
590 | my $ref = ref $fields; |
591 | return $self->_quote($fields) unless $ref; |
592 | return $$fields if $ref eq 'SCALAR'; |
593 | |
594 | if ($ref eq 'ARRAY') { |
81446c4f |
595 | return join(', ', map { $self->_recurse_fields($_) } @$fields); |
83e09b5b |
596 | } |
597 | elsif ($ref eq 'HASH') { |
81446c4f |
598 | my %hash = %$fields; # shallow copy |
83e09b5b |
599 | |
50136dd9 |
600 | my $as = delete $hash{-as}; # if supplied |
601 | |
81446c4f |
602 | my ($func, $args, @toomany) = %hash; |
603 | |
604 | # there should be only one pair |
605 | if (@toomany) { |
606 | croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields ); |
607 | } |
50136dd9 |
608 | |
609 | if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) { |
610 | croak ( |
611 | 'The select => { distinct => ... } syntax is not supported for multiple columns.' |
612 | .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }' |
613 | .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }' |
83e09b5b |
614 | ); |
6f4ddea1 |
615 | } |
83e09b5b |
616 | |
50136dd9 |
617 | my $select = sprintf ('%s( %s )%s', |
618 | $self->_sqlcase($func), |
619 | $self->_recurse_fields($args), |
620 | $as |
0491b597 |
621 | ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) ) |
50136dd9 |
622 | : '' |
623 | ); |
624 | |
83e09b5b |
625 | return $select; |
6f4ddea1 |
626 | } |
627 | # Is the second check absolutely necessary? |
628 | elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) { |
db56cf3d |
629 | return $self->_fold_sqlbind( $fields ); |
6f4ddea1 |
630 | } |
631 | else { |
e8fcf76f |
632 | croak($ref . qq{ unexpected in _recurse_fields()}) |
6f4ddea1 |
633 | } |
634 | } |
635 | |
a6b68a60 |
636 | my $for_syntax = { |
637 | update => 'FOR UPDATE', |
638 | shared => 'FOR SHARE', |
639 | }; |
640 | |
641 | # this used to be a part of _order_by but is broken out for clarity. |
642 | # What we have been doing forever is hijacking the $order arg of |
643 | # SQLA::select to pass in arbitrary pieces of data (first the group_by, |
644 | # then pretty much the entire resultset attr-hash, as more and more |
645 | # things in the SQLA space need to have mopre info about the $rs they |
646 | # create SQL for. The alternative would be to keep expanding the |
647 | # signature of _select with more and more positional parameters, which |
648 | # is just gross. All hail SQLA2! |
649 | sub _parse_rs_attrs { |
1cbd3034 |
650 | my ($self, $arg) = @_; |
15827712 |
651 | |
a6b68a60 |
652 | my $sql = ''; |
1cbd3034 |
653 | |
b03f30a3 |
654 | if (my $g = $self->_recurse_fields($arg->{group_by}) ) { |
a6b68a60 |
655 | $sql .= $self->_sqlcase(' group by ') . $g; |
656 | } |
1cbd3034 |
657 | |
a6b68a60 |
658 | if (defined $arg->{having}) { |
659 | my ($frag, @bind) = $self->_recurse_where($arg->{having}); |
660 | push(@{$self->{having_bind}}, @bind); |
661 | $sql .= $self->_sqlcase(' having ') . $frag; |
662 | } |
15827712 |
663 | |
a6b68a60 |
664 | if (defined $arg->{order_by}) { |
665 | $sql .= $self->_order_by ($arg->{order_by}); |
666 | } |
15827712 |
667 | |
a6b68a60 |
668 | if (my $for = $arg->{for}) { |
669 | $sql .= " $for_syntax->{$for}" if $for_syntax->{$for}; |
670 | } |
671 | |
672 | return $sql; |
673 | } |
674 | |
675 | sub _order_by { |
676 | my ($self, $arg) = @_; |
15827712 |
677 | |
a6b68a60 |
678 | # check that we are not called in legacy mode (order_by as 4th argument) |
679 | if (ref $arg eq 'HASH' and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) { |
680 | return $self->_parse_rs_attrs ($arg); |
fde3719a |
681 | } |
1cbd3034 |
682 | else { |
683 | my ($sql, @bind) = $self->SUPER::_order_by ($arg); |
a6b68a60 |
684 | push @{$self->{order_bind}}, @bind; |
1cbd3034 |
685 | return $sql; |
fd4cb60a |
686 | } |
6f4ddea1 |
687 | } |
688 | |
1cbd3034 |
689 | sub _order_directions { |
fd4cb60a |
690 | my ($self, $order) = @_; |
15827712 |
691 | |
1cbd3034 |
692 | # strip bind values - none of the current _order_directions users support them |
693 | return $self->SUPER::_order_directions( [ map |
694 | { ref $_ ? $_->[0] : $_ } |
695 | $self->_order_by_chunks ($order) |
696 | ]); |
fd4cb60a |
697 | } |
698 | |
6f4ddea1 |
699 | sub _table { |
700 | my ($self, $from) = @_; |
701 | if (ref $from eq 'ARRAY') { |
702 | return $self->_recurse_from(@$from); |
703 | } elsif (ref $from eq 'HASH') { |
704 | return $self->_make_as($from); |
705 | } else { |
706 | return $from; # would love to quote here but _table ends up getting called |
707 | # twice during an ->select without a limit clause due to |
708 | # the way S::A::Limit->select works. should maybe consider |
709 | # bypassing this and doing S::A::select($self, ...) in |
710 | # our select method above. meantime, quoting shims have |
711 | # been added to select/insert/update/delete here |
712 | } |
713 | } |
714 | |
b8391c87 |
715 | sub _generate_join_clause { |
716 | my ($self, $join_type) = @_; |
717 | |
718 | return sprintf ('%s JOIN ', |
719 | $join_type ? ' ' . uc($join_type) : '' |
720 | ); |
721 | } |
722 | |
6f4ddea1 |
723 | sub _recurse_from { |
724 | my ($self, $from, @join) = @_; |
725 | my @sqlf; |
726 | push(@sqlf, $self->_make_as($from)); |
727 | foreach my $j (@join) { |
728 | my ($to, $on) = @$j; |
729 | |
aa82ce29 |
730 | |
6f4ddea1 |
731 | # check whether a join type exists |
6f4ddea1 |
732 | my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to; |
aa82ce29 |
733 | my $join_type; |
734 | if (ref($to_jt) eq 'HASH' and defined($to_jt->{-join_type})) { |
735 | $join_type = $to_jt->{-join_type}; |
736 | $join_type =~ s/^\s+ | \s+$//xg; |
6f4ddea1 |
737 | } |
aa82ce29 |
738 | |
de5f71ef |
739 | $join_type = $self->{_default_jointype} if not defined $join_type; |
aa82ce29 |
740 | |
b8391c87 |
741 | push @sqlf, $self->_generate_join_clause( $join_type ); |
6f4ddea1 |
742 | |
743 | if (ref $to eq 'ARRAY') { |
744 | push(@sqlf, '(', $self->_recurse_from(@$to), ')'); |
745 | } else { |
746 | push(@sqlf, $self->_make_as($to)); |
747 | } |
748 | push(@sqlf, ' ON ', $self->_join_condition($on)); |
749 | } |
750 | return join('', @sqlf); |
751 | } |
752 | |
db56cf3d |
753 | sub _fold_sqlbind { |
754 | my ($self, $sqlbind) = @_; |
69989ea9 |
755 | |
756 | my @sqlbind = @$$sqlbind; # copy |
757 | my $sql = shift @sqlbind; |
758 | push @{$self->{from_bind}}, @sqlbind; |
759 | |
db56cf3d |
760 | return $sql; |
6f4ddea1 |
761 | } |
762 | |
763 | sub _make_as { |
764 | my ($self, $from) = @_; |
db56cf3d |
765 | return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ |
766 | : ref $_ eq 'REF' ? $self->_fold_sqlbind($_) |
767 | : $self->_quote($_)) |
6f4ddea1 |
768 | } reverse each %{$self->_skip_options($from)}); |
769 | } |
770 | |
771 | sub _skip_options { |
772 | my ($self, $hash) = @_; |
773 | my $clean_hash = {}; |
774 | $clean_hash->{$_} = $hash->{$_} |
775 | for grep {!/^-/} keys %$hash; |
776 | return $clean_hash; |
777 | } |
778 | |
779 | sub _join_condition { |
780 | my ($self, $cond) = @_; |
781 | if (ref $cond eq 'HASH') { |
782 | my %j; |
783 | for (keys %$cond) { |
784 | my $v = $cond->{$_}; |
785 | if (ref $v) { |
e8fcf76f |
786 | croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'}) |
6f4ddea1 |
787 | if ref($v) ne 'SCALAR'; |
788 | $j{$_} = $v; |
789 | } |
790 | else { |
791 | my $x = '= '.$self->_quote($v); $j{$_} = \$x; |
792 | } |
793 | }; |
794 | return scalar($self->_recurse_where(\%j)); |
795 | } elsif (ref $cond eq 'ARRAY') { |
796 | return join(' OR ', map { $self->_join_condition($_) } @$cond); |
797 | } else { |
798 | die "Can't handle this yet!"; |
799 | } |
800 | } |
801 | |
6f4ddea1 |
802 | sub limit_dialect { |
803 | my $self = shift; |
b2c7cf74 |
804 | if (@_) { |
805 | $self->{limit_dialect} = shift; |
806 | undef $self->{_cached_syntax}; |
807 | } |
6f4ddea1 |
808 | return $self->{limit_dialect}; |
809 | } |
810 | |
998373c2 |
811 | # Set to an array-ref to specify separate left and right quotes for table names. |
812 | # A single scalar is equivalen to [ $char, $char ] |
6f4ddea1 |
813 | sub quote_char { |
814 | my $self = shift; |
815 | $self->{quote_char} = shift if @_; |
816 | return $self->{quote_char}; |
817 | } |
818 | |
998373c2 |
819 | # Character separating quoted table names. |
6f4ddea1 |
820 | sub name_sep { |
821 | my $self = shift; |
822 | $self->{name_sep} = shift if @_; |
823 | return $self->{name_sep}; |
824 | } |
825 | |
826 | 1; |