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