Commit | Line | Data |
c443438f |
1 | package #hide from PAUSE |
2 | DBIx::Class::Storage::DBIHacks; |
d28bb90d |
3 | |
4 | # |
5 | # This module contains code that should never have seen the light of day, |
6 | # does not belong in the Storage, or is otherwise unfit for public |
6a6394f1 |
7 | # display. The arrival of SQLA2 should immediately obsolete 90% of this |
d28bb90d |
8 | # |
9 | |
10 | use strict; |
11 | use warnings; |
12 | |
13 | use base 'DBIx::Class::Storage'; |
14 | use mro 'c3'; |
15 | |
6298a324 |
16 | use List::Util 'first'; |
17 | use Scalar::Util 'blessed'; |
ea5c7509 |
18 | use Sub::Name 'subname'; |
6298a324 |
19 | use namespace::clean; |
d28bb90d |
20 | |
21 | # |
052e8431 |
22 | # This code will remove non-selecting/non-restricting joins from |
4b1b5ea3 |
23 | # {from} specs, aiding the RDBMS query optimizer |
052e8431 |
24 | # |
25 | sub _prune_unused_joins { |
ea95892e |
26 | my $self = shift; |
97e130fa |
27 | my ($from, $select, $where, $attrs, $ignore_multiplication) = @_; |
052e8431 |
28 | |
ea95892e |
29 | return $from unless $self->_use_join_optimizer; |
30 | |
052e8431 |
31 | if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY') { |
32 | return $from; # only standard {from} specs are supported |
33 | } |
34 | |
4b1b5ea3 |
35 | my $aliastypes = $self->_resolve_aliastypes_from_select_args(@_); |
36 | |
97e130fa |
37 | # don't care |
38 | delete $aliastypes->{joining}; |
39 | |
4b1b5ea3 |
40 | # a grouped set will not be affected by amount of rows. Thus any |
41 | # {multiplying} joins can go |
97e130fa |
42 | delete $aliastypes->{multiplying} |
43 | if $ignore_multiplication or $attrs->{group_by}; |
4b1b5ea3 |
44 | |
052e8431 |
45 | my @newfrom = $from->[0]; # FROM head is always present |
46 | |
a4812caa |
47 | my %need_joins; |
97e130fa |
48 | |
a4812caa |
49 | for (values %$aliastypes) { |
50 | # add all requested aliases |
51 | $need_joins{$_} = 1 for keys %$_; |
52 | |
53 | # add all their parents (as per joinpath which is an AoH { table => alias }) |
97e130fa |
54 | $need_joins{$_} = 1 for map { values %$_ } map { @{$_->{-parents}} } values %$_; |
a4812caa |
55 | } |
97e130fa |
56 | |
052e8431 |
57 | for my $j (@{$from}[1..$#$from]) { |
539ffe87 |
58 | push @newfrom, $j if ( |
4b1b5ea3 |
59 | (! $j->[0]{-alias}) # legacy crap |
539ffe87 |
60 | || |
61 | $need_joins{$j->[0]{-alias}} |
62 | ); |
052e8431 |
63 | } |
64 | |
65 | return \@newfrom; |
66 | } |
67 | |
052e8431 |
68 | # |
d28bb90d |
69 | # This is the code producing joined subqueries like: |
8273e845 |
70 | # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ... |
d28bb90d |
71 | # |
72 | sub _adjust_select_args_for_complex_prefetch { |
73 | my ($self, $from, $select, $where, $attrs) = @_; |
74 | |
d28bb90d |
75 | $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute') |
76 | if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY'); |
77 | |
1e4f9fb3 |
78 | my $root_alias = $attrs->{alias}; |
79 | |
d28bb90d |
80 | # generate inner/outer attribute lists, remove stuff that doesn't apply |
81 | my $outer_attrs = { %$attrs }; |
1e4f9fb3 |
82 | delete $outer_attrs->{$_} for qw/where bind rows offset group_by _grouped_by_distinct having/; |
d28bb90d |
83 | |
186ba34c |
84 | my $inner_attrs = { %$attrs }; |
1e4f9fb3 |
85 | delete $inner_attrs->{$_} for qw/from for collapse select as _related_results_construction/; |
d28bb90d |
86 | |
4df1400e |
87 | # there is no point of ordering the insides if there is no limit |
88 | delete $inner_attrs->{order_by} if ( |
89 | delete $inner_attrs->{_order_is_artificial} |
90 | or |
91 | ! $inner_attrs->{rows} |
92 | ); |
946f6260 |
93 | |
d28bb90d |
94 | # generate the inner/outer select lists |
95 | # for inside we consider only stuff *not* brought in by the prefetch |
96 | # on the outside we substitute any function for its alias |
97 | my $outer_select = [ @$select ]; |
97e130fa |
98 | my $inner_select; |
36fd7f07 |
99 | |
97e130fa |
100 | my ($root_node, $root_node_offset); |
27e0370d |
101 | |
102 | for my $i (0 .. $#$from) { |
103 | my $node = $from->[$i]; |
104 | my $h = (ref $node eq 'HASH') ? $node |
105 | : (ref $node eq 'ARRAY' and ref $node->[0] eq 'HASH') ? $node->[0] |
106 | : next |
107 | ; |
108 | |
1e4f9fb3 |
109 | if ( ($h->{-alias}||'') eq $root_alias and $h->{-rsrc} ) { |
97e130fa |
110 | $root_node = $h; |
111 | $root_node_offset = $i; |
27e0370d |
112 | last; |
113 | } |
114 | } |
115 | |
116 | $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute') |
97e130fa |
117 | unless $root_node; |
27e0370d |
118 | |
119 | # use the heavy duty resolver to take care of aliased/nonaliased naming |
120 | my $colinfo = $self->_resolve_column_info($from); |
121 | my $selected_root_columns; |
122 | |
1e4f9fb3 |
123 | for my $i (0 .. $#$outer_select) { |
d28bb90d |
124 | my $sel = $outer_select->[$i]; |
125 | |
1e4f9fb3 |
126 | next if ( |
127 | $colinfo->{$sel} and $colinfo->{$sel}{-source_alias} ne $root_alias |
128 | ); |
129 | |
d28bb90d |
130 | if (ref $sel eq 'HASH' ) { |
131 | $sel->{-as} ||= $attrs->{as}[$i]; |
1e4f9fb3 |
132 | $outer_select->[$i] = join ('.', $root_alias, ($sel->{-as} || "inner_column_$i") ); |
d28bb90d |
133 | } |
27e0370d |
134 | elsif (! ref $sel and my $ci = $colinfo->{$sel}) { |
135 | $selected_root_columns->{$ci->{-colname}} = 1; |
136 | } |
d28bb90d |
137 | |
138 | push @$inner_select, $sel; |
bb9bffea |
139 | |
140 | push @{$inner_attrs->{as}}, $attrs->{as}[$i]; |
d28bb90d |
141 | } |
142 | |
97e130fa |
143 | # We will need to fetch all native columns in the inner subquery, which may |
144 | # be a part of an *outer* join condition, or an order_by (which needs to be |
145 | # preserved outside) |
146 | # We can not just fetch everything because a potential has_many restricting |
147 | # join collapse *will not work* on heavy data types. |
148 | my $connecting_aliastypes = $self->_resolve_aliastypes_from_select_args( |
149 | [grep { ref($_) eq 'ARRAY' or ref($_) eq 'HASH' } @{$from}[$root_node_offset .. $#$from]], |
150 | [], |
151 | $where, |
152 | $inner_attrs |
153 | ); |
154 | |
155 | for (sort map { keys %{$_->{-seen_columns}||{}} } map { values %$_ } values %$connecting_aliastypes) { |
156 | my $ci = $colinfo->{$_} or next; |
157 | if ( |
1e4f9fb3 |
158 | $ci->{-source_alias} eq $root_alias |
97e130fa |
159 | and |
160 | ! $selected_root_columns->{$ci->{-colname}}++ |
161 | ) { |
162 | # adding it to both to keep limits not supporting dark selectors happy |
163 | push @$inner_select, $ci->{-fq_colname}; |
164 | push @{$inner_attrs->{as}}, $ci->{-fq_colname}; |
27e0370d |
165 | } |
166 | } |
167 | |
ea95892e |
168 | # construct the inner $from and lock it in a subquery |
48580715 |
169 | # we need to prune first, because this will determine if we need a group_by below |
97e130fa |
170 | # throw away all non-selecting, non-restricting multijoins |
171 | # (since we def. do not care about multiplication those inside the subquery) |
6395604e |
172 | my $inner_subq = do { |
ea95892e |
173 | |
174 | # must use it here regardless of user requests |
175 | local $self->{_use_join_optimizer} = 1; |
176 | |
97e130fa |
177 | # throw away multijoins since we def. do not care about those inside the subquery |
178 | my $inner_from = $self->_prune_unused_joins ($from, $inner_select, $where, $inner_attrs, 'ignore_multiplication'); |
ea95892e |
179 | |
887a0aef |
180 | my $inner_aliastypes = |
181 | $self->_resolve_aliastypes_from_select_args( $inner_from, $inner_select, $where, $inner_attrs ); |
182 | |
1e4f9fb3 |
183 | # uh-oh a multiplier (which is not us) left in, this is a problem |
0a3441ee |
184 | if ( |
1e4f9fb3 |
185 | $inner_aliastypes->{multiplying} |
186 | and |
187 | !$inner_aliastypes->{grouping} # if there are groups - assume user knows wtf they are up to |
0a3441ee |
188 | and |
1e4f9fb3 |
189 | my @multipliers = grep { $_ ne $root_alias } keys %{$inner_aliastypes->{multiplying}} |
0a3441ee |
190 | ) { |
1e4f9fb3 |
191 | |
192 | # if none of the multipliers came from an order_by (guaranteed to have been combined |
193 | # with a limit) - easy - just slap a group_by to simulate a collape and be on our way |
194 | if ( |
195 | ! $inner_aliastypes->{ordering} |
196 | or |
197 | ! first { $inner_aliastypes->{ordering}{$_} } @multipliers |
198 | ) { |
318e3d94 |
199 | |
1e4f9fb3 |
200 | my $unprocessed_order_chunks; |
201 | ($inner_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection ( |
202 | $inner_from, $inner_select, $inner_attrs->{order_by} |
203 | ); |
204 | |
205 | $self->throw_exception ( |
206 | 'A required group_by clause could not be constructed automatically due to a complex ' |
207 | . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable ' |
208 | . 'group_by by hand' |
209 | ) if $unprocessed_order_chunks; |
210 | } |
211 | else { |
212 | # We need to order by external columns and group at the same time |
213 | # so we can calculate the proper limit |
214 | # This doesn't really make sense in SQL, however from DBICs point |
215 | # of view is rather valid (order the leftmost objects by whatever |
216 | # criteria and get the offset/rows many). There is a way around |
217 | # this however in SQL - we simply tae the direction of each piece |
218 | # of the foreign order and convert them to MIN(X) for ASC or MAX(X) |
219 | # for DESC, and group_by the root columns. The end result should be |
220 | # exactly what we expect |
221 | |
222 | # FIXME REMOVE LATER - (just a sanity check) |
223 | if (defined ( my $impostor = first |
224 | { $_ ne $root_alias } |
225 | keys %{ $inner_aliastypes->{selecting} } |
226 | ) ) { |
227 | $self->throw_exception(sprintf |
228 | 'Unexpected inner selection during complex prefetch (%s)...', |
229 | join ', ', keys %{ $inner_aliastypes->{joining}{$impostor}{-seen_columns} || {} } |
230 | ); |
231 | } |
232 | |
233 | # supplement the main selection with pks if not already there, |
234 | # as they will have to be a part of the group_by to colapse |
235 | # things properly |
236 | my $cur_sel = { map { $_ => 1 } @$inner_select }; |
318e3d94 |
237 | |
1e4f9fb3 |
238 | my @pks = map { "$root_alias.$_" } $root_node->{-rsrc}->primary_columns |
239 | or $self->throw_exception( sprintf |
240 | 'Unable to perform complex limited prefetch off %s without declared primary key', |
241 | $root_node->{-rsrc}->source_name, |
242 | ); |
243 | for my $col (@pks) { |
244 | push @$inner_select, $col |
245 | unless $cur_sel->{$col}++; |
246 | } |
247 | |
248 | # wrap any part of the order_by that "responds" to an ordering alias |
249 | # into a MIN/MAX |
250 | # FIXME - this code is a joke, will need to be completely rewritten in |
251 | # the DQ branch. But I need to push a POC here, otherwise the |
252 | # pesky tests won't pass |
253 | my $sql_maker = $self->sql_maker; |
254 | my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep); |
255 | my $own_re = qr/ $lquote \Q$root_alias\E $rquote $sep | \b \Q$root_alias\E $sep /x; |
e6977bbb |
256 | my @order_chunks = map { ref $_ eq 'ARRAY' ? $_ : [ $_ ] } $sql_maker->_order_by_chunks($attrs->{order_by}); |
257 | my @new_order = map { \$_ } @order_chunks; |
258 | my $inner_columns_info = $self->_resolve_column_info($inner_from); |
259 | |
260 | # loop through and replace stuff that is not "ours" with a min/max func |
261 | # everything is a literal at this point, since we are likely properly |
262 | # quoted and stuff |
263 | for my $i (0 .. $#new_order) { |
264 | my $chunk = $order_chunks[$i][0]; |
265 | |
266 | # skip ourselves |
267 | next if $chunk =~ $own_re; |
268 | |
269 | my $is_desc = $chunk =~ s/\sDESC$//i; |
270 | $chunk =~ s/\sASC$//i; |
271 | |
272 | # maybe our own unqualified column |
318e3d94 |
273 | my $ord_bit = ( |
274 | $lquote and $sep and $chunk =~ /^ $lquote ([^$sep]+) $rquote $/x |
275 | ) ? $1 : $chunk; |
276 | |
e6977bbb |
277 | next if ( |
278 | $ord_bit |
279 | and |
280 | $inner_columns_info->{$ord_bit} |
281 | and |
282 | $inner_columns_info->{$ord_bit}{-source_alias} eq $root_alias |
283 | ); |
284 | |
285 | $new_order[$i] = \[ |
1e4f9fb3 |
286 | sprintf( |
287 | '%s(%s)%s', |
288 | ($is_desc ? 'MAX' : 'MIN'), |
e6977bbb |
289 | $chunk, |
1e4f9fb3 |
290 | ($is_desc ? ' DESC' : ''), |
291 | ), |
292 | @ {$order_chunks[$i]} [ 1 .. $#{$order_chunks[$i]} ] |
293 | ]; |
294 | } |
295 | |
e6977bbb |
296 | $inner_attrs->{order_by} = \@new_order; |
297 | |
298 | # do not care about leftovers here - it will be all the functions |
299 | # we just created |
1e4f9fb3 |
300 | ($inner_attrs->{group_by}) = $self->_group_over_selection ( |
301 | $inner_from, $inner_select, $inner_attrs->{order_by} |
302 | ); |
303 | } |
0a3441ee |
304 | } |
d28bb90d |
305 | |
ea95892e |
306 | # we already optimized $inner_from above |
97e130fa |
307 | # and already local()ized |
308 | $self->{_use_join_optimizer} = 0; |
d28bb90d |
309 | |
ea95892e |
310 | # generate the subquery |
6395604e |
311 | $self->_select_args_to_query ( |
ea95892e |
312 | $inner_from, |
313 | $inner_select, |
314 | $where, |
315 | $inner_attrs, |
316 | ); |
d28bb90d |
317 | }; |
318 | |
319 | # Generate the outer from - this is relatively easy (really just replace |
320 | # the join slot with the subquery), with a major caveat - we can not |
321 | # join anything that is non-selecting (not part of the prefetch), but at |
322 | # the same time is a multi-type relationship, as it will explode the result. |
323 | # |
324 | # There are two possibilities here |
325 | # - either the join is non-restricting, in which case we simply throw it away |
326 | # - it is part of the restrictions, in which case we need to collapse the outer |
327 | # result by tackling yet another group_by to the outside of the query |
328 | |
27e0370d |
329 | # work on a shallow copy |
052e8431 |
330 | $from = [ @$from ]; |
052e8431 |
331 | |
d28bb90d |
332 | my @outer_from; |
53c29913 |
333 | |
27e0370d |
334 | # we may not be the head |
97e130fa |
335 | if ($root_node_offset) { |
27e0370d |
336 | # first generate the outer_from, up to the substitution point |
97e130fa |
337 | @outer_from = splice @$from, 0, $root_node_offset; |
27e0370d |
338 | |
339 | push @outer_from, [ |
340 | { |
1e4f9fb3 |
341 | -alias => $root_alias, |
97e130fa |
342 | -rsrc => $root_node->{-rsrc}, |
1e4f9fb3 |
343 | $root_alias => $inner_subq, |
27e0370d |
344 | }, |
97e130fa |
345 | @{$from->[0]}[1 .. $#{$from->[0]}], |
27e0370d |
346 | ]; |
347 | } |
348 | else { |
27e0370d |
349 | @outer_from = { |
1e4f9fb3 |
350 | -alias => $root_alias, |
27e0370d |
351 | -rsrc => $root_node->{-rsrc}, |
1e4f9fb3 |
352 | $root_alias => $inner_subq, |
27e0370d |
353 | }; |
d28bb90d |
354 | } |
355 | |
97e130fa |
356 | shift @$from; # it's replaced in @outer_from already |
357 | |
ea95892e |
358 | # scan the *remaining* from spec against different attributes, and see which joins are needed |
052e8431 |
359 | # in what role |
360 | my $outer_aliastypes = |
539ffe87 |
361 | $self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs ); |
052e8431 |
362 | |
a4812caa |
363 | # unroll parents |
1e4f9fb3 |
364 | my ($outer_select_chain, @outer_nonselecting_chains) = map { +{ |
365 | map { $_ => 1 } map { values %$_} map { @{$_->{-parents}} } values %{ $outer_aliastypes->{$_} || {} } |
366 | } } qw/selecting restricting grouping ordering/; |
a4812caa |
367 | |
d28bb90d |
368 | # see what's left - throw away if not selecting/restricting |
a4812caa |
369 | # also throw in a group_by if a non-selecting multiplier, |
370 | # to guard against cross-join explosions |
36fd7f07 |
371 | my $need_outer_group_by; |
d28bb90d |
372 | while (my $j = shift @$from) { |
373 | my $alias = $j->[0]{-alias}; |
374 | |
a4812caa |
375 | if ( |
376 | $outer_select_chain->{$alias} |
377 | ) { |
378 | push @outer_from, $j |
d28bb90d |
379 | } |
1e4f9fb3 |
380 | elsif (first { $_->{$alias} } @outer_nonselecting_chains ) { |
d28bb90d |
381 | push @outer_from, $j; |
a4812caa |
382 | $need_outer_group_by ||= $outer_aliastypes->{multiplying}{$alias} ? 1 : 0; |
d28bb90d |
383 | } |
384 | } |
385 | |
1e4f9fb3 |
386 | if ( $need_outer_group_by and $attrs->{_grouped_by_distinct} ) { |
36fd7f07 |
387 | my $unprocessed_order_chunks; |
388 | ($outer_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection ( |
389 | \@outer_from, $outer_select, $outer_attrs->{order_by} |
390 | ); |
391 | |
392 | $self->throw_exception ( |
393 | 'A required group_by clause could not be constructed automatically due to a complex ' |
394 | . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable ' |
395 | . 'group_by by hand' |
396 | ) if $unprocessed_order_chunks; |
397 | |
398 | } |
399 | |
d28bb90d |
400 | # This is totally horrific - the $where ends up in both the inner and outer query |
401 | # Unfortunately not much can be done until SQLA2 introspection arrives, and even |
402 | # then if where conditions apply to the *right* side of the prefetch, you may have |
403 | # to both filter the inner select (e.g. to apply a limit) and then have to re-filter |
404 | # the outer select to exclude joins you didin't want in the first place |
405 | # |
406 | # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;) |
407 | return (\@outer_from, $outer_select, $where, $outer_attrs); |
408 | } |
409 | |
1a736efb |
410 | # |
411 | # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE! |
412 | # |
ad630f4b |
413 | # Due to a lack of SQLA2 we fall back to crude scans of all the |
414 | # select/where/order/group attributes, in order to determine what |
415 | # aliases are neded to fulfill the query. This information is used |
416 | # throughout the code to prune unnecessary JOINs from the queries |
417 | # in an attempt to reduce the execution time. |
418 | # Although the method is pretty horrific, the worst thing that can |
1a736efb |
419 | # happen is for it to fail due to some scalar SQL, which in turn will |
420 | # result in a vocal exception. |
539ffe87 |
421 | sub _resolve_aliastypes_from_select_args { |
052e8431 |
422 | my ( $self, $from, $select, $where, $attrs ) = @_; |
546f1cd9 |
423 | |
ad630f4b |
424 | $self->throw_exception ('Unable to analyze custom {from}') |
425 | if ref $from ne 'ARRAY'; |
546f1cd9 |
426 | |
ad630f4b |
427 | # what we will return |
964a3c71 |
428 | my $aliases_by_type; |
546f1cd9 |
429 | |
ad630f4b |
430 | # see what aliases are there to work with |
431 | my $alias_list; |
539ffe87 |
432 | for (@$from) { |
433 | my $j = $_; |
ad630f4b |
434 | $j = $j->[0] if ref $j eq 'ARRAY'; |
539ffe87 |
435 | my $al = $j->{-alias} |
436 | or next; |
437 | |
438 | $alias_list->{$al} = $j; |
97e130fa |
439 | $aliases_by_type->{multiplying}{$al} ||= { -parents => $j->{-join_path}||[] } if ( |
a4812caa |
440 | # not array == {from} head == can't be multiplying |
441 | ( ref($_) eq 'ARRAY' and ! $j->{-is_single} ) |
442 | or |
443 | # a parent of ours is already a multiplier |
444 | ( grep { $aliases_by_type->{multiplying}{$_} } @{ $j->{-join_path}||[] } ) |
445 | ); |
546f1cd9 |
446 | } |
546f1cd9 |
447 | |
318e3d94 |
448 | # get a column to source/alias map (including unambiguous unqualified ones) |
1a736efb |
449 | my $colinfo = $self->_resolve_column_info ($from); |
450 | |
ad630f4b |
451 | # set up a botched SQLA |
452 | my $sql_maker = $self->sql_maker; |
07f31d19 |
453 | |
4c2b30d6 |
454 | # these are throw away results, do not pollute the bind stack |
4c2b30d6 |
455 | local $sql_maker->{select_bind}; |
0542ec57 |
456 | local $sql_maker->{where_bind}; |
457 | local $sql_maker->{group_bind}; |
458 | local $sql_maker->{having_bind}; |
97e130fa |
459 | local $sql_maker->{from_bind}; |
3f5b99fe |
460 | |
461 | # we can't scan properly without any quoting (\b doesn't cut it |
462 | # everywhere), so unless there is proper quoting set - use our |
463 | # own weird impossible character. |
464 | # Also in the case of no quoting, we need to explicitly disable |
465 | # name_sep, otherwise sorry nasty legacy syntax like |
466 | # { 'count(foo.id)' => { '>' => 3 } } will stop working >:( |
467 | local $sql_maker->{quote_char} = $sql_maker->{quote_char}; |
468 | local $sql_maker->{name_sep} = $sql_maker->{name_sep}; |
469 | |
470 | unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) { |
e493ecb2 |
471 | $sql_maker->{quote_char} = ["\x00", "\xFF"]; |
472 | # if we don't unset it we screw up retarded but unfortunately working |
473 | # 'MAX(foo.bar)' => { '>', 3 } |
3f5b99fe |
474 | $sql_maker->{name_sep} = ''; |
475 | } |
476 | |
477 | my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep); |
07f31d19 |
478 | |
1a736efb |
479 | # generate sql chunks |
480 | my $to_scan = { |
481 | restricting => [ |
482 | $sql_maker->_recurse_where ($where), |
1e4f9fb3 |
483 | $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} }), |
484 | ], |
485 | grouping => [ |
486 | $sql_maker->_parse_rs_attrs ({ group_by => $attrs->{group_by} }), |
1a736efb |
487 | ], |
97e130fa |
488 | joining => [ |
489 | $sql_maker->_recurse_from ( |
490 | ref $from->[0] eq 'ARRAY' ? $from->[0][0] : $from->[0], |
491 | @{$from}[1 .. $#$from], |
492 | ), |
493 | ], |
1a736efb |
494 | selecting => [ |
1a736efb |
495 | $sql_maker->_recurse_fields ($select), |
1e4f9fb3 |
496 | ], |
497 | ordering => [ |
498 | map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker), |
1a736efb |
499 | ], |
500 | }; |
07f31d19 |
501 | |
1a736efb |
502 | # throw away empty chunks |
503 | $_ = [ map { $_ || () } @$_ ] for values %$to_scan; |
07f31d19 |
504 | |
318e3d94 |
505 | # first see if we have any exact matches (qualified or unqualified) |
506 | for my $type (keys %$to_scan) { |
507 | for my $piece (@{$to_scan->{$type}}) { |
508 | if ($colinfo->{$piece} and my $alias = $colinfo->{$piece}{-source_alias}) { |
509 | $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] }; |
510 | $aliases_by_type->{$type}{$alias}{-seen_columns}{$colinfo->{$piece}{-fq_colname}} = $piece; |
511 | } |
512 | } |
513 | } |
514 | |
515 | # now loop through all fully qualified columns and get the corresponding |
1a736efb |
516 | # alias (should work even if they are in scalarrefs) |
ad630f4b |
517 | for my $alias (keys %$alias_list) { |
1a736efb |
518 | my $al_re = qr/ |
97e130fa |
519 | $lquote $alias $rquote $sep (?: $lquote ([^$rquote]+) $rquote )? |
1a736efb |
520 | | |
97e130fa |
521 | \b $alias \. ([^\s\)\($rquote]+)? |
1a736efb |
522 | /x; |
523 | |
1a736efb |
524 | for my $type (keys %$to_scan) { |
525 | for my $piece (@{$to_scan->{$type}}) { |
97e130fa |
526 | if (my @matches = $piece =~ /$al_re/g) { |
527 | $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] }; |
1e4f9fb3 |
528 | $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = "$alias.$_" |
97e130fa |
529 | for grep { defined $_ } @matches; |
530 | } |
1a736efb |
531 | } |
ad630f4b |
532 | } |
1a736efb |
533 | } |
534 | |
535 | # now loop through unqualified column names, and try to locate them within |
536 | # the chunks |
537 | for my $col (keys %$colinfo) { |
3f5b99fe |
538 | next if $col =~ / \. /x; # if column is qualified it was caught by the above |
1a736efb |
539 | |
97e130fa |
540 | my $col_re = qr/ $lquote ($col) $rquote /x; |
07f31d19 |
541 | |
1a736efb |
542 | for my $type (keys %$to_scan) { |
543 | for my $piece (@{$to_scan->{$type}}) { |
318e3d94 |
544 | if ( my @matches = $piece =~ /$col_re/g) { |
a4812caa |
545 | my $alias = $colinfo->{$col}{-source_alias}; |
97e130fa |
546 | $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] }; |
1e4f9fb3 |
547 | $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = $_ |
97e130fa |
548 | for grep { defined $_ } @matches; |
a4812caa |
549 | } |
1a736efb |
550 | } |
07f31d19 |
551 | } |
552 | } |
553 | |
554 | # Add any non-left joins to the restriction list (such joins are indeed restrictions) |
ad630f4b |
555 | for my $j (values %$alias_list) { |
07f31d19 |
556 | my $alias = $j->{-alias} or next; |
97e130fa |
557 | $aliases_by_type->{restricting}{$alias} ||= { -parents => $j->{-join_path}||[] } if ( |
07f31d19 |
558 | (not $j->{-join_type}) |
559 | or |
560 | ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi) |
561 | ); |
562 | } |
563 | |
1e4f9fb3 |
564 | for (keys %$aliases_by_type) { |
565 | delete $aliases_by_type->{$_} unless keys %{$aliases_by_type->{$_}}; |
566 | } |
567 | |
964a3c71 |
568 | return $aliases_by_type; |
07f31d19 |
569 | } |
570 | |
bac358c9 |
571 | # This is the engine behind { distinct => 1 } |
0a3441ee |
572 | sub _group_over_selection { |
573 | my ($self, $from, $select, $order_by) = @_; |
574 | |
575 | my $rs_column_list = $self->_resolve_column_info ($from); |
576 | |
577 | my (@group_by, %group_index); |
578 | |
36fd7f07 |
579 | # the logic is: if it is a { func => val } we assume an aggregate, |
580 | # otherwise if \'...' or \[...] we assume the user knows what is |
581 | # going on thus group over it |
0a3441ee |
582 | for (@$select) { |
583 | if (! ref($_) or ref ($_) ne 'HASH' ) { |
584 | push @group_by, $_; |
585 | $group_index{$_}++; |
586 | if ($rs_column_list->{$_} and $_ !~ /\./ ) { |
587 | # add a fully qualified version as well |
588 | $group_index{"$rs_column_list->{$_}{-source_alias}.$_"}++; |
589 | } |
07f31d19 |
590 | } |
591 | } |
ad630f4b |
592 | |
0a3441ee |
593 | # add any order_by parts that are not already present in the group_by |
594 | # we need to be careful not to add any named functions/aggregates |
bac358c9 |
595 | # i.e. order_by => [ ... { count => 'foo' } ... ] |
14e26c5f |
596 | my @leftovers; |
bac358c9 |
597 | for ($self->_extract_order_criteria($order_by)) { |
0a3441ee |
598 | # only consider real columns (for functions the user got to do an explicit group_by) |
14e26c5f |
599 | if (@$_ != 1) { |
600 | push @leftovers, $_; |
601 | next; |
602 | } |
bac358c9 |
603 | my $chunk = $_->[0]; |
14e26c5f |
604 | my $colinfo = $rs_column_list->{$chunk} or do { |
605 | push @leftovers, $_; |
606 | next; |
607 | }; |
0a3441ee |
608 | |
609 | $chunk = "$colinfo->{-source_alias}.$chunk" if $chunk !~ /\./; |
610 | push @group_by, $chunk unless $group_index{$chunk}++; |
611 | } |
612 | |
14e26c5f |
613 | return wantarray |
614 | ? (\@group_by, (@leftovers ? \@leftovers : undef) ) |
615 | : \@group_by |
616 | ; |
07f31d19 |
617 | } |
618 | |
d28bb90d |
619 | sub _resolve_ident_sources { |
620 | my ($self, $ident) = @_; |
621 | |
622 | my $alias2source = {}; |
623 | my $rs_alias; |
624 | |
625 | # the reason this is so contrived is that $ident may be a {from} |
626 | # structure, specifying multiple tables to join |
6298a324 |
627 | if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) { |
d28bb90d |
628 | # this is compat mode for insert/update/delete which do not deal with aliases |
629 | $alias2source->{me} = $ident; |
630 | $rs_alias = 'me'; |
631 | } |
632 | elsif (ref $ident eq 'ARRAY') { |
633 | |
634 | for (@$ident) { |
635 | my $tabinfo; |
636 | if (ref $_ eq 'HASH') { |
637 | $tabinfo = $_; |
638 | $rs_alias = $tabinfo->{-alias}; |
639 | } |
640 | if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') { |
641 | $tabinfo = $_->[0]; |
642 | } |
643 | |
4376a157 |
644 | $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc} |
645 | if ($tabinfo->{-rsrc}); |
d28bb90d |
646 | } |
647 | } |
648 | |
649 | return ($alias2source, $rs_alias); |
650 | } |
651 | |
652 | # Takes $ident, \@column_names |
653 | # |
654 | # returns { $column_name => \%column_info, ... } |
655 | # also note: this adds -result_source => $rsrc to the column info |
656 | # |
09e14fdc |
657 | # If no columns_names are supplied returns info about *all* columns |
658 | # for all sources |
d28bb90d |
659 | sub _resolve_column_info { |
660 | my ($self, $ident, $colnames) = @_; |
661 | my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident); |
662 | |
52416317 |
663 | my (%seen_cols, @auto_colnames); |
d28bb90d |
664 | |
665 | # compile a global list of column names, to be able to properly |
666 | # disambiguate unqualified column names (if at all possible) |
667 | for my $alias (keys %$alias2src) { |
668 | my $rsrc = $alias2src->{$alias}; |
669 | for my $colname ($rsrc->columns) { |
670 | push @{$seen_cols{$colname}}, $alias; |
3f5b99fe |
671 | push @auto_colnames, "$alias.$colname" unless $colnames; |
d28bb90d |
672 | } |
673 | } |
674 | |
09e14fdc |
675 | $colnames ||= [ |
676 | @auto_colnames, |
677 | grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols), |
678 | ]; |
679 | |
52416317 |
680 | my (%return, $colinfos); |
d28bb90d |
681 | foreach my $col (@$colnames) { |
52416317 |
682 | my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x; |
d28bb90d |
683 | |
52416317 |
684 | # if the column was seen exactly once - we know which rsrc it came from |
685 | $source_alias ||= $seen_cols{$colname}[0] |
686 | if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1); |
d28bb90d |
687 | |
52416317 |
688 | next unless $source_alias; |
689 | |
690 | my $rsrc = $alias2src->{$source_alias} |
691 | or next; |
692 | |
693 | $return{$col} = { |
6395604e |
694 | %{ |
695 | ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname} |
696 | || |
697 | $self->throw_exception( |
698 | "No such column '$colname' on source " . $rsrc->source_name |
699 | ); |
700 | }, |
d28bb90d |
701 | -result_source => $rsrc, |
52416317 |
702 | -source_alias => $source_alias, |
81bf295c |
703 | -fq_colname => $col eq $colname ? "$source_alias.$col" : $col, |
704 | -colname => $colname, |
d28bb90d |
705 | }; |
81bf295c |
706 | |
707 | $return{"$source_alias.$colname"} = $return{$col} if $col eq $colname; |
d28bb90d |
708 | } |
709 | |
710 | return \%return; |
711 | } |
712 | |
289ac713 |
713 | # The DBIC relationship chaining implementation is pretty simple - every |
714 | # new related_relationship is pushed onto the {from} stack, and the {select} |
715 | # window simply slides further in. This means that when we count somewhere |
716 | # in the middle, we got to make sure that everything in the join chain is an |
717 | # actual inner join, otherwise the count will come back with unpredictable |
718 | # results (a resultset may be generated with _some_ rows regardless of if |
719 | # the relation which the $rs currently selects has rows or not). E.g. |
720 | # $artist_rs->cds->count - normally generates: |
721 | # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid |
722 | # which actually returns the number of artists * (number of cds || 1) |
723 | # |
724 | # So what we do here is crawl {from}, determine if the current alias is at |
725 | # the top of the stack, and if not - make sure the chain is inner-joined down |
726 | # to the root. |
727 | # |
31a8aaaf |
728 | sub _inner_join_to_node { |
289ac713 |
729 | my ($self, $from, $alias) = @_; |
730 | |
731 | # subqueries and other oddness are naturally not supported |
732 | return $from if ( |
733 | ref $from ne 'ARRAY' |
734 | || |
735 | @$from <= 1 |
736 | || |
737 | ref $from->[0] ne 'HASH' |
738 | || |
739 | ! $from->[0]{-alias} |
740 | || |
7eb76996 |
741 | $from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do |
289ac713 |
742 | ); |
743 | |
744 | # find the current $alias in the $from structure |
745 | my $switch_branch; |
746 | JOINSCAN: |
747 | for my $j (@{$from}[1 .. $#$from]) { |
748 | if ($j->[0]{-alias} eq $alias) { |
749 | $switch_branch = $j->[0]{-join_path}; |
750 | last JOINSCAN; |
751 | } |
752 | } |
753 | |
7eb76996 |
754 | # something else went quite wrong |
289ac713 |
755 | return $from unless $switch_branch; |
756 | |
757 | # So it looks like we will have to switch some stuff around. |
758 | # local() is useless here as we will be leaving the scope |
759 | # anyway, and deep cloning is just too fucking expensive |
8273e845 |
760 | # So replace the first hashref in the node arrayref manually |
289ac713 |
761 | my @new_from = ($from->[0]); |
faeb2407 |
762 | my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path |
289ac713 |
763 | |
764 | for my $j (@{$from}[1 .. $#$from]) { |
765 | my $jalias = $j->[0]{-alias}; |
766 | |
767 | if ($sw_idx->{$jalias}) { |
768 | my %attrs = %{$j->[0]}; |
769 | delete $attrs{-join_type}; |
770 | push @new_from, [ |
771 | \%attrs, |
772 | @{$j}[ 1 .. $#$j ], |
773 | ]; |
774 | } |
775 | else { |
776 | push @new_from, $j; |
777 | } |
778 | } |
779 | |
780 | return \@new_from; |
781 | } |
782 | |
bac358c9 |
783 | sub _extract_order_criteria { |
1a736efb |
784 | my ($self, $order_by, $sql_maker) = @_; |
c0748280 |
785 | |
1a736efb |
786 | my $parser = sub { |
e6977bbb |
787 | my ($sql_maker, $order_by, $orig_quote_chars) = @_; |
c0748280 |
788 | |
1a736efb |
789 | return scalar $sql_maker->_order_by_chunks ($order_by) |
790 | unless wantarray; |
c0748280 |
791 | |
e6977bbb |
792 | my ($lq, $rq, $sep) = map { quotemeta($_) } ( |
793 | ($orig_quote_chars ? @$orig_quote_chars : $sql_maker->_quote_chars), |
794 | $sql_maker->name_sep |
795 | ); |
796 | |
1a736efb |
797 | my @chunks; |
bac358c9 |
798 | for ($sql_maker->_order_by_chunks ($order_by) ) { |
e6977bbb |
799 | my $chunk = ref $_ ? [ @$_ ] : [ $_ ]; |
bac358c9 |
800 | $chunk->[0] =~ s/\s+ (?: ASC|DESC ) \s* $//ix; |
e6977bbb |
801 | |
802 | # order criteria may have come back pre-quoted (literals and whatnot) |
803 | # this is fragile, but the best we can currently do |
804 | $chunk->[0] =~ s/^ $lq (.+?) $rq $sep $lq (.+?) $rq $/"$1.$2"/xe |
805 | or $chunk->[0] =~ s/^ $lq (.+) $rq $/$1/x; |
806 | |
1a736efb |
807 | push @chunks, $chunk; |
bac6c4fb |
808 | } |
1a736efb |
809 | |
810 | return @chunks; |
811 | }; |
812 | |
813 | if ($sql_maker) { |
814 | return $parser->($sql_maker, $order_by); |
bac6c4fb |
815 | } |
816 | else { |
1a736efb |
817 | $sql_maker = $self->sql_maker; |
e6977bbb |
818 | |
819 | # pass these in to deal with literals coming from |
820 | # the user or the deep guts of prefetch |
821 | my $orig_quote_chars = [$sql_maker->_quote_chars]; |
822 | |
1a736efb |
823 | local $sql_maker->{quote_char}; |
e6977bbb |
824 | return $parser->($sql_maker, $order_by, $orig_quote_chars); |
bac6c4fb |
825 | } |
bac6c4fb |
826 | } |
827 | |
7cec4356 |
828 | sub _order_by_is_stable { |
5f11e54f |
829 | my ($self, $ident, $order_by, $where) = @_; |
c0748280 |
830 | |
5f11e54f |
831 | my $colinfo = $self->_resolve_column_info($ident, [ |
832 | (map { $_->[0] } $self->_extract_order_criteria($order_by)), |
833 | $where ? @{$self->_extract_fixed_condition_columns($where)} :(), |
834 | ]); |
c0748280 |
835 | |
7cec4356 |
836 | return undef unless keys %$colinfo; |
837 | |
838 | my $cols_per_src; |
839 | $cols_per_src->{$_->{-source_alias}}{$_->{-colname}} = $_ for values %$colinfo; |
840 | |
841 | for (values %$cols_per_src) { |
842 | my $src = (values %$_)[0]->{-result_source}; |
843 | return 1 if $src->_identifying_column_set($_); |
c0748280 |
844 | } |
845 | |
7cec4356 |
846 | return undef; |
847 | } |
848 | |
0e81e691 |
849 | # this is almost identical to the above, except it accepts only |
850 | # a single rsrc, and will succeed only if the first portion of the order |
851 | # by is stable. |
852 | # returns that portion as a colinfo hashref on success |
853 | sub _main_source_order_by_portion_is_stable { |
854 | my ($self, $main_rsrc, $order_by, $where) = @_; |
855 | |
856 | die "Huh... I expect a blessed result_source..." |
857 | if ref($main_rsrc) eq 'ARRAY'; |
858 | |
859 | my @ord_cols = map |
860 | { $_->[0] } |
861 | ( $self->_extract_order_criteria($order_by) ) |
862 | ; |
863 | return unless @ord_cols; |
864 | |
318e3d94 |
865 | my $colinfos = $self->_resolve_column_info($main_rsrc); |
866 | |
0e81e691 |
867 | for (0 .. $#ord_cols) { |
868 | if ( |
869 | ! $colinfos->{$ord_cols[$_]} |
870 | or |
871 | $colinfos->{$ord_cols[$_]}{-result_source} != $main_rsrc |
872 | ) { |
873 | $#ord_cols = $_ - 1; |
874 | last; |
875 | } |
876 | } |
877 | |
878 | # we just truncated it above |
879 | return unless @ord_cols; |
880 | |
0e81e691 |
881 | my $order_portion_ci = { map { |
882 | $colinfos->{$_}{-colname} => $colinfos->{$_}, |
883 | $colinfos->{$_}{-fq_colname} => $colinfos->{$_}, |
884 | } @ord_cols }; |
885 | |
318e3d94 |
886 | # since all we check here are the start of the order_by belonging to the |
887 | # top level $rsrc, a present identifying set will mean that the resultset |
888 | # is ordered by its leftmost table in a stable manner |
889 | # |
890 | # RV of _identifying_column_set contains unqualified names only |
891 | my $unqualified_idset = $main_rsrc->_identifying_column_set({ |
892 | ( $where ? %{ |
893 | $self->_resolve_column_info( |
894 | $main_rsrc, $self->_extract_fixed_condition_columns($where) |
895 | ) |
896 | } : () ), |
897 | %$order_portion_ci |
898 | }) or return; |
899 | |
900 | my $ret_info; |
901 | my %unqualified_idcols_from_order = map { |
902 | $order_portion_ci->{$_} ? ( $_ => $order_portion_ci->{$_} ) : () |
903 | } @$unqualified_idset; |
904 | |
905 | # extra optimization - cut the order_by at the end of the identifying set |
906 | # (just in case the user was stupid and overlooked the obvious) |
907 | for my $i (0 .. $#ord_cols) { |
908 | my $col = $ord_cols[$i]; |
909 | my $unqualified_colname = $order_portion_ci->{$col}{-colname}; |
910 | $ret_info->{$col} = { %{$order_portion_ci->{$col}}, -idx_in_order_subset => $i }; |
911 | delete $unqualified_idcols_from_order{$ret_info->{$col}{-colname}}; |
912 | |
913 | # we didn't reach the end of the identifying portion yet |
914 | return $ret_info unless keys %unqualified_idcols_from_order; |
915 | } |
0e81e691 |
916 | |
318e3d94 |
917 | die 'How did we get here...'; |
0e81e691 |
918 | } |
919 | |
5f11e54f |
920 | # returns an arrayref of column names which *definitely* have som |
921 | # sort of non-nullable equality requested in the given condition |
922 | # specification. This is used to figure out if a resultset is |
923 | # constrained to a column which is part of a unique constraint, |
924 | # which in turn allows us to better predict how ordering will behave |
925 | # etc. |
926 | # |
927 | # this is a rudimentary, incomplete, and error-prone extractor |
928 | # however this is OK - it is conservative, and if we can not find |
929 | # something that is in fact there - the stack will recover gracefully |
930 | # Also - DQ and the mst it rode in on will save us all RSN!!! |
931 | sub _extract_fixed_condition_columns { |
932 | my ($self, $where, $nested) = @_; |
933 | |
934 | return unless ref $where eq 'HASH'; |
935 | |
936 | my @cols; |
937 | for my $lhs (keys %$where) { |
938 | if ($lhs =~ /^\-and$/i) { |
939 | push @cols, ref $where->{$lhs} eq 'ARRAY' |
940 | ? ( map { $self->_extract_fixed_condition_columns($_, 1) } @{$where->{$lhs}} ) |
941 | : $self->_extract_fixed_condition_columns($where->{$lhs}, 1) |
942 | ; |
943 | } |
944 | elsif ($lhs !~ /^\-/) { |
945 | my $val = $where->{$lhs}; |
946 | |
947 | push @cols, $lhs if (defined $val and ( |
948 | ! ref $val |
949 | or |
950 | (ref $val eq 'HASH' and keys %$val == 1 and defined $val->{'='}) |
951 | )); |
952 | } |
953 | } |
954 | return $nested ? @cols : \@cols; |
c0748280 |
955 | } |
bac6c4fb |
956 | |
d28bb90d |
957 | 1; |