1 package #hide from PAUSE
2 DBIx::Class::Storage::DBIHacks;
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
7 # display. The arrival of SQLA2 should immediately obsolete 90% of this
13 use base 'DBIx::Class::Storage';
16 use List::Util 'first';
17 use Scalar::Util 'blessed';
18 use DBIx::Class::_Util qw(UNRESOLVABLE_CONDITION serialize);
19 use SQL::Abstract qw(is_plain_value is_literal_value);
20 use DBIx::Class::Carp;
24 # This code will remove non-selecting/non-restricting joins from
25 # {from} specs, aiding the RDBMS query optimizer
27 sub _prune_unused_joins {
28 my ($self, $attrs) = @_;
30 # only standard {from} specs are supported, and we could be disabled in general
31 return ($attrs->{from}, {}) unless (
32 ref $attrs->{from} eq 'ARRAY'
36 ref $attrs->{from}[0] eq 'HASH'
38 ref $attrs->{from}[1] eq 'ARRAY'
40 $self->_use_join_optimizer
43 my $orig_aliastypes = $self->_resolve_aliastypes_from_select_args($attrs);
45 my $new_aliastypes = { %$orig_aliastypes };
47 # we will be recreating this entirely
48 my @reclassify = 'joining';
50 # a grouped set will not be affected by amount of rows. Thus any
51 # purely multiplicator classifications can go
52 # (will be reintroduced below if needed by something else)
53 push @reclassify, qw(multiplying premultiplied)
54 if $attrs->{_force_prune_multiplying_joins} or $attrs->{group_by};
56 # nuke what will be recalculated
57 delete @{$new_aliastypes}{@reclassify};
59 my @newfrom = $attrs->{from}[0]; # FROM head is always present
61 # recalculate what we need once the multipliers are potentially gone
62 # ignore premultiplies, since they do not add any value to anything
64 for ( @{$new_aliastypes}{grep { $_ ne 'premultiplied' } keys %$new_aliastypes }) {
65 # add all requested aliases
66 $need_joins{$_} = 1 for keys %$_;
68 # add all their parents (as per joinpath which is an AoH { table => alias })
69 $need_joins{$_} = 1 for map { values %$_ } map { @{$_->{-parents}} } values %$_;
72 for my $j (@{$attrs->{from}}[1..$#{$attrs->{from}}]) {
73 push @newfrom, $j if (
74 (! defined $j->[0]{-alias}) # legacy crap
76 $need_joins{$j->[0]{-alias}}
80 # we have a new set of joiners - for everything we nuked pull the classification
81 # off the original stack
82 for my $ctype (@reclassify) {
83 $new_aliastypes->{$ctype} = { map
84 { $need_joins{$_} ? ( $_ => $orig_aliastypes->{$ctype}{$_} ) : () }
85 keys %{$orig_aliastypes->{$ctype}}
89 return ( \@newfrom, $new_aliastypes );
93 # This is the code producing joined subqueries like:
94 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
96 sub _adjust_select_args_for_complex_prefetch {
97 my ($self, $attrs) = @_;
99 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute') unless (
100 ref $attrs->{from} eq 'ARRAY'
102 @{$attrs->{from}} > 1
104 ref $attrs->{from}[0] eq 'HASH'
106 ref $attrs->{from}[1] eq 'ARRAY'
109 my $root_alias = $attrs->{alias};
111 # generate inner/outer attribute lists, remove stuff that doesn't apply
112 my $outer_attrs = { %$attrs };
113 delete @{$outer_attrs}{qw(from bind rows offset group_by _grouped_by_distinct having)};
115 my $inner_attrs = { %$attrs, _simple_passthrough_construction => 1 };
116 delete @{$inner_attrs}{qw(for collapse select as)};
118 # there is no point of ordering the insides if there is no limit
119 delete $inner_attrs->{order_by} if (
120 delete $inner_attrs->{_order_is_artificial}
122 ! $inner_attrs->{rows}
125 # generate the inner/outer select lists
126 # for inside we consider only stuff *not* brought in by the prefetch
127 # on the outside we substitute any function for its alias
128 $outer_attrs->{select} = [ @{$attrs->{select}} ];
130 my ($root_node, $root_node_offset);
132 for my $i (0 .. $#{$inner_attrs->{from}}) {
133 my $node = $inner_attrs->{from}[$i];
134 my $h = (ref $node eq 'HASH') ? $node
135 : (ref $node eq 'ARRAY' and ref $node->[0] eq 'HASH') ? $node->[0]
139 if ( ($h->{-alias}||'') eq $root_alias and $h->{-rsrc} ) {
141 $root_node_offset = $i;
146 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
149 # use the heavy duty resolver to take care of aliased/nonaliased naming
150 my $colinfo = $self->_resolve_column_info($inner_attrs->{from});
151 my $selected_root_columns;
153 for my $i (0 .. $#{$outer_attrs->{select}}) {
154 my $sel = $outer_attrs->{select}->[$i];
157 $colinfo->{$sel} and $colinfo->{$sel}{-source_alias} ne $root_alias
160 if (ref $sel eq 'HASH' ) {
161 $sel->{-as} ||= $attrs->{as}[$i];
162 $outer_attrs->{select}->[$i] = join ('.', $root_alias, ($sel->{-as} || "inner_column_$i") );
164 elsif (! ref $sel and my $ci = $colinfo->{$sel}) {
165 $selected_root_columns->{$ci->{-colname}} = 1;
168 push @{$inner_attrs->{select}}, $sel;
170 push @{$inner_attrs->{as}}, $attrs->{as}[$i];
173 # We will need to fetch all native columns in the inner subquery, which may
174 # be a part of an *outer* join condition, or an order_by (which needs to be
175 # preserved outside), or wheres. In other words everything but the inner
177 # We can not just fetch everything because a potential has_many restricting
178 # join collapse *will not work* on heavy data types.
179 my $connecting_aliastypes = $self->_resolve_aliastypes_from_select_args({
184 for (sort map { keys %{$_->{-seen_columns}||{}} } map { values %$_ } values %$connecting_aliastypes) {
185 my $ci = $colinfo->{$_} or next;
187 $ci->{-source_alias} eq $root_alias
189 ! $selected_root_columns->{$ci->{-colname}}++
191 # adding it to both to keep limits not supporting dark selectors happy
192 push @{$inner_attrs->{select}}, $ci->{-fq_colname};
193 push @{$inner_attrs->{as}}, $ci->{-fq_colname};
197 # construct the inner {from} and lock it in a subquery
198 # we need to prune first, because this will determine if we need a group_by below
199 # throw away all non-selecting, non-restricting multijoins
200 # (since we def. do not care about multiplication of the contents of the subquery)
201 my $inner_subq = do {
203 # must use it here regardless of user requests (vastly gentler on optimizer)
204 local $self->{_use_join_optimizer} = 1;
206 # throw away multijoins since we def. do not care about those inside the subquery
207 ($inner_attrs->{from}, my $inner_aliastypes) = $self->_prune_unused_joins ({
208 %$inner_attrs, _force_prune_multiplying_joins => 1
211 # uh-oh a multiplier (which is not us) left in, this is a problem for limits
212 # we will need to add a group_by to collapse the resultset for proper counts
214 grep { $_ ne $root_alias } keys %{ $inner_aliastypes->{multiplying} || {} }
216 # if there are user-supplied groups - assume user knows wtf they are up to
217 ( ! $inner_aliastypes->{grouping} or $inner_attrs->{_grouped_by_distinct} )
220 my $cur_sel = { map { $_ => 1 } @{$inner_attrs->{select}} };
222 # *possibly* supplement the main selection with pks if not already
223 # there, as they will have to be a part of the group_by to collapse
225 my $inner_select_with_extras;
226 my @pks = map { "$root_alias.$_" } $root_node->{-rsrc}->primary_columns
227 or $self->throw_exception( sprintf
228 'Unable to perform complex limited prefetch off %s without declared primary key',
229 $root_node->{-rsrc}->source_name,
232 push @{ $inner_select_with_extras ||= [ @{$inner_attrs->{select}} ] }, $col
233 unless $cur_sel->{$col}++;
236 ($inner_attrs->{group_by}, $inner_attrs->{order_by}) = $self->_group_over_selection({
238 $inner_select_with_extras ? ( select => $inner_select_with_extras ) : (),
239 _aliastypes => $inner_aliastypes,
243 # we already optimized $inner_attrs->{from} above
244 # and already local()ized
245 $self->{_use_join_optimizer} = 0;
247 # generate the subquery
248 $self->_select_args_to_query (
249 @{$inner_attrs}{qw(from select where)},
254 # Generate the outer from - this is relatively easy (really just replace
255 # the join slot with the subquery), with a major caveat - we can not
256 # join anything that is non-selecting (not part of the prefetch), but at
257 # the same time is a multi-type relationship, as it will explode the result.
259 # There are two possibilities here
260 # - either the join is non-restricting, in which case we simply throw it away
261 # - it is part of the restrictions, in which case we need to collapse the outer
262 # result by tackling yet another group_by to the outside of the query
264 # work on a shallow copy
265 my @orig_from = @{$attrs->{from}};
268 $outer_attrs->{from} = \ my @outer_from;
270 # we may not be the head
271 if ($root_node_offset) {
272 # first generate the outer_from, up to the substitution point
273 @outer_from = splice @orig_from, 0, $root_node_offset;
275 # substitute the subq at the right spot
278 -alias => $root_alias,
279 -rsrc => $root_node->{-rsrc},
280 $root_alias => $inner_subq,
282 # preserve attrs from what is now the head of the from after the splice
283 @{$orig_from[0]}[1 .. $#{$orig_from[0]}],
288 -alias => $root_alias,
289 -rsrc => $root_node->{-rsrc},
290 $root_alias => $inner_subq,
294 shift @orig_from; # what we just replaced above
296 # scan the *remaining* from spec against different attributes, and see which joins are needed
298 my $outer_aliastypes = $outer_attrs->{_aliastypes} =
299 $self->_resolve_aliastypes_from_select_args({ %$outer_attrs, from => \@orig_from });
302 my ($outer_select_chain, @outer_nonselecting_chains) = map { +{
303 map { $_ => 1 } map { values %$_} map { @{$_->{-parents}} } values %{ $outer_aliastypes->{$_} || {} }
304 } } qw/selecting restricting grouping ordering/;
306 # see what's left - throw away if not selecting/restricting
307 my $may_need_outer_group_by;
308 while (my $j = shift @orig_from) {
309 my $alias = $j->[0]{-alias};
312 $outer_select_chain->{$alias}
316 elsif (first { $_->{$alias} } @outer_nonselecting_chains ) {
317 push @outer_from, $j;
318 $may_need_outer_group_by ||= $outer_aliastypes->{multiplying}{$alias} ? 1 : 0;
322 # also throw in a synthetic group_by if a non-selecting multiplier,
323 # to guard against cross-join explosions
324 # the logic is somewhat fragile, but relies on the idea that if a user supplied
325 # a group by on their own - they know what they were doing
326 if ( $may_need_outer_group_by and $attrs->{_grouped_by_distinct} ) {
327 ($outer_attrs->{group_by}, $outer_attrs->{order_by}) = $self->_group_over_selection ({
329 from => \@outer_from,
333 # This is totally horrific - the {where} ends up in both the inner and outer query
334 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
335 # then if where conditions apply to the *right* side of the prefetch, you may have
336 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
337 # the outer select to exclude joins you didn't want in the first place
339 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
344 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
346 # Due to a lack of SQLA2 we fall back to crude scans of all the
347 # select/where/order/group attributes, in order to determine what
348 # aliases are needed to fulfill the query. This information is used
349 # throughout the code to prune unnecessary JOINs from the queries
350 # in an attempt to reduce the execution time.
351 # Although the method is pretty horrific, the worst thing that can
352 # happen is for it to fail due to some scalar SQL, which in turn will
353 # result in a vocal exception.
354 sub _resolve_aliastypes_from_select_args {
355 my ( $self, $attrs ) = @_;
357 $self->throw_exception ('Unable to analyze custom {from}')
358 if ref $attrs->{from} ne 'ARRAY';
360 # what we will return
363 # see what aliases are there to work with
364 # and record who is a multiplier and who is premultiplied
366 for my $node (@{$attrs->{from}}) {
369 $j = $j->[0] if ref $j eq 'ARRAY';
370 my $al = $j->{-alias}
373 $alias_list->{$al} = $j;
375 $aliases_by_type->{multiplying}{$al} ||= { -parents => $j->{-join_path}||[] }
376 # not array == {from} head == can't be multiplying
377 if ref($node) eq 'ARRAY' and ! $j->{-is_single};
379 $aliases_by_type->{premultiplied}{$al} ||= { -parents => $j->{-join_path}||[] }
380 # parts of the path that are not us but are multiplying
381 if grep { $aliases_by_type->{multiplying}{$_} }
384 @{ $j->{-join_path}||[] }
387 # get a column to source/alias map (including unambiguous unqualified ones)
388 my $colinfo = $self->_resolve_column_info ($attrs->{from});
390 # set up a botched SQLA
391 my $sql_maker = $self->sql_maker;
393 # these are throw away results, do not pollute the bind stack
394 local $sql_maker->{where_bind};
395 local $sql_maker->{group_bind};
396 local $sql_maker->{having_bind};
397 local $sql_maker->{from_bind};
399 # we can't scan properly without any quoting (\b doesn't cut it
400 # everywhere), so unless there is proper quoting set - use our
401 # own weird impossible character.
402 # Also in the case of no quoting, we need to explicitly disable
403 # name_sep, otherwise sorry nasty legacy syntax like
404 # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
405 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
406 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
408 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
409 $sql_maker->{quote_char} = ["\x00", "\xFF"];
410 # if we don't unset it we screw up retarded but unfortunately working
411 # 'MAX(foo.bar)' => { '>', 3 }
412 $sql_maker->{name_sep} = '';
415 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
417 # generate sql chunks
420 ($sql_maker->_recurse_where ($attrs->{where}))[0],
421 $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} }),
424 $sql_maker->_parse_rs_attrs ({ group_by => $attrs->{group_by} }),
427 $sql_maker->_recurse_from (
428 ref $attrs->{from}[0] eq 'ARRAY' ? $attrs->{from}[0][0] : $attrs->{from}[0],
429 @{$attrs->{from}}[1 .. $#{$attrs->{from}}],
433 # kill all selectors which look like a proper subquery
434 # this is a sucky heuristic *BUT* - if we get it wrong the query will simply
435 # fail to run, so we are relatively safe
437 { $_ !~ / \A \s* \( \s* SELECT \s+ .+? \s+ FROM \s+ .+? \) \s* \z /xsi }
439 { ($sql_maker->_recurse_fields($_))[0] }
444 ( my $sql = (ref $_ ? $_->[0] : $_) ) =~ s/ \s+ (?: ASC | DESC ) \s* \z //xi;
447 $sql_maker->_order_by_chunks( $attrs->{order_by} ),
451 # throw away empty-string chunks, and make sure no binds snuck in
452 # note that we operate over @{$to_scan->{$type}}, hence the
453 # semi-mindbending ... map ... for values ...
457 : (length ref $_) ? (require Data::Dumper::Concise && $self->throw_exception(
458 "Unexpected ref in scan-plan: " . Data::Dumper::Concise::Dumper($_)
462 } @$_ ] ) for values %$to_scan;
464 # throw away empty to-scan's
468 delete $to_scan->{$_}
469 ) for keys %$to_scan;
472 # the actual scan, per type
473 for my $type (keys %$to_scan) {
475 # first see if we have any exact matches (qualified or unqualified)
476 for my $piece (@{$to_scan->{$type}}) {
477 if ($colinfo->{$piece} and my $alias = $colinfo->{$piece}{-source_alias}) {
478 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
479 $aliases_by_type->{$type}{$alias}{-seen_columns}{$colinfo->{$piece}{-fq_colname}} = $piece;
483 # now loop through all fully qualified columns and get the corresponding
484 # alias (should work even if they are in scalarrefs)
485 for my $alias (keys %$alias_list) {
487 $lquote $alias $rquote $sep (?: $lquote ([^$rquote]+) $rquote )?
489 \b $alias \. ([^\s\)\($rquote]+)?
492 for my $piece (@{$to_scan->{$type}}) {
493 if (my @matches = $piece =~ /$al_re/g) {
494 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
495 $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = "$alias.$_"
496 for grep { defined $_ } @matches;
501 # now loop through unqualified column names, and try to locate them within
503 for my $col (keys %$colinfo) {
504 next if $col =~ / \. /x; # if column is qualified it was caught by the above
506 my $col_re = qr/ $lquote ($col) $rquote /x;
508 for my $piece (@{$to_scan->{$type}}) {
509 if ( my @matches = $piece =~ /$col_re/g) {
510 my $alias = $colinfo->{$col}{-source_alias};
511 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
512 $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = $_
513 for grep { defined $_ } @matches;
519 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
523 ! $aliases_by_type->{restricting}{ $_->{-alias} }
528 $_->{-join_type} !~ /^left (?: \s+ outer)? $/xi
531 $aliases_by_type->{restricting}{ $_->{-alias} } = { -parents => $_->{-join_path}||[] }
532 ) for values %$alias_list;
536 keys %{$aliases_by_type->{$_}}
538 delete $aliases_by_type->{$_}
539 ) for keys %$aliases_by_type;
544 # This is the engine behind { distinct => 1 } and the general
545 # complex prefetch grouper
546 sub _group_over_selection {
547 my ($self, $attrs) = @_;
549 my $colinfos = $self->_resolve_column_info ($attrs->{from});
551 my (@group_by, %group_index);
553 # the logic is: if it is a { func => val } we assume an aggregate,
554 # otherwise if \'...' or \[...] we assume the user knows what is
555 # going on thus group over it
556 for (@{$attrs->{select}}) {
557 if (! ref($_) or ref ($_) ne 'HASH' ) {
560 if ($colinfos->{$_} and $_ !~ /\./ ) {
561 # add a fully qualified version as well
562 $group_index{"$colinfos->{$_}{-source_alias}.$_"}++;
567 my @order_by = $self->_extract_order_criteria($attrs->{order_by})
568 or return (\@group_by, $attrs->{order_by});
570 # add any order_by parts that are not already present in the group_by
571 # to maintain SQL cross-compatibility and general sanity
573 # also in case the original selection is *not* unique, or in case part
574 # of the ORDER BY refers to a multiplier - we will need to replace the
575 # skipped order_by elements with their MIN/MAX equivalents as to maintain
576 # the proper overall order without polluting the group criteria (and
577 # possibly changing the outcome entirely)
579 my ($leftovers, $sql_maker, @new_order_by, $order_chunks, $aliastypes);
581 my $group_already_unique = $self->_columns_comprise_identifying_set($colinfos, \@group_by);
583 for my $o_idx (0 .. $#order_by) {
585 # if the chunk is already a min/max function - there is nothing left to touch
586 next if $order_by[$o_idx][0] =~ /^ (?: min | max ) \s* \( .+ \) $/ix;
588 # only consider real columns (for functions the user got to do an explicit group_by)
591 @{$order_by[$o_idx]} != 1
593 # only declare an unknown *plain* identifier as "leftover" if we are called with
594 # aliastypes to examine. If there are none - we are still in _resolve_attrs, and
595 # can just assume the user knows what they want
596 ( ! ( $chunk_ci = $colinfos->{$order_by[$o_idx][0]} ) and $attrs->{_aliastypes} )
598 push @$leftovers, $order_by[$o_idx][0];
601 next unless $chunk_ci;
603 # no duplication of group criteria
604 next if $group_index{$chunk_ci->{-fq_colname}};
607 $attrs->{_aliastypes}
609 $self->_resolve_aliastypes_from_select_args({
610 from => $attrs->{from},
611 order_by => $attrs->{order_by},
613 ) if $group_already_unique;
615 # check that we are not ordering by a multiplier (if a check is requested at all)
617 $group_already_unique
619 ! $aliastypes->{multiplying}{$chunk_ci->{-source_alias}}
621 ! $aliastypes->{premultiplied}{$chunk_ci->{-source_alias}}
623 push @group_by, $chunk_ci->{-fq_colname};
624 $group_index{$chunk_ci->{-fq_colname}}++
627 # We need to order by external columns without adding them to the group
628 # (eiehter a non-unique selection, or a multi-external)
630 # This doesn't really make sense in SQL, however from DBICs point
631 # of view is rather valid (e.g. order the leftmost objects by whatever
632 # criteria and get the offset/rows many). There is a way around
633 # this however in SQL - we simply tae the direction of each piece
634 # of the external order and convert them to MIN(X) for ASC or MAX(X)
635 # for DESC, and group_by the root columns. The end result should be
636 # exactly what we expect
638 # FIXME - this code is a joke, will need to be completely rewritten in
639 # the DQ branch. But I need to push a POC here, otherwise the
640 # pesky tests won't pass
641 # wrap any part of the order_by that "responds" to an ordering alias
643 $sql_maker ||= $self->sql_maker;
645 map { ref $_ eq 'ARRAY' ? $_ : [ $_ ] } $sql_maker->_order_by_chunks($attrs->{order_by})
648 my ($chunk, $is_desc) = $sql_maker->_split_order_chunk($order_chunks->[$o_idx][0]);
650 $new_order_by[$o_idx] = \[
651 sprintf( '%s( %s )%s',
652 ($is_desc ? 'MAX' : 'MIN'),
654 ($is_desc ? ' DESC' : ''),
656 @ {$order_chunks->[$o_idx]} [ 1 .. $#{$order_chunks->[$o_idx]} ]
661 $self->throw_exception ( sprintf
662 'Unable to programatically derive a required group_by from the supplied '
663 . 'order_by criteria. To proceed either add an explicit group_by, or '
664 . 'simplify your order_by to only include plain columns '
665 . '(supplied order_by: %s)',
666 join ', ', map { "'$_'" } @$leftovers,
669 # recreate the untouched order parts
671 $new_order_by[$_] ||= \ $order_chunks->[$_] for ( 0 .. $#$order_chunks );
676 (@new_order_by ? \@new_order_by : $attrs->{order_by} ), # same ref as original == unchanged
680 sub _resolve_ident_sources {
681 my ($self, $ident) = @_;
683 my $alias2source = {};
685 # the reason this is so contrived is that $ident may be a {from}
686 # structure, specifying multiple tables to join
687 if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
688 # this is compat mode for insert/update/delete which do not deal with aliases
689 $alias2source->{me} = $ident;
691 elsif (ref $ident eq 'ARRAY') {
695 if (ref $_ eq 'HASH') {
698 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
702 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc}
703 if ($tabinfo->{-rsrc});
707 return $alias2source;
710 # Takes $ident, \@column_names
712 # returns { $column_name => \%column_info, ... }
713 # also note: this adds -result_source => $rsrc to the column info
715 # If no columns_names are supplied returns info about *all* columns
717 sub _resolve_column_info {
718 my ($self, $ident, $colnames) = @_;
720 return {} if $colnames and ! @$colnames;
722 my $alias2src = $self->_resolve_ident_sources($ident);
724 my (%seen_cols, @auto_colnames);
726 # compile a global list of column names, to be able to properly
727 # disambiguate unqualified column names (if at all possible)
728 for my $alias (keys %$alias2src) {
729 my $rsrc = $alias2src->{$alias};
730 for my $colname ($rsrc->columns) {
731 push @{$seen_cols{$colname}}, $alias;
732 push @auto_colnames, "$alias.$colname" unless $colnames;
738 grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
741 my (%return, $colinfos);
742 foreach my $col (@$colnames) {
743 my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
745 # if the column was seen exactly once - we know which rsrc it came from
746 $source_alias ||= $seen_cols{$colname}[0]
747 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
749 next unless $source_alias;
751 my $rsrc = $alias2src->{$source_alias}
756 ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname}
758 $self->throw_exception(
759 "No such column '$colname' on source " . $rsrc->source_name
762 -result_source => $rsrc,
763 -source_alias => $source_alias,
764 -fq_colname => $col eq $colname ? "$source_alias.$col" : $col,
765 -colname => $colname,
768 $return{"$source_alias.$colname"} = $return{$col} if $col eq $colname;
774 # The DBIC relationship chaining implementation is pretty simple - every
775 # new related_relationship is pushed onto the {from} stack, and the {select}
776 # window simply slides further in. This means that when we count somewhere
777 # in the middle, we got to make sure that everything in the join chain is an
778 # actual inner join, otherwise the count will come back with unpredictable
779 # results (a resultset may be generated with _some_ rows regardless of if
780 # the relation which the $rs currently selects has rows or not). E.g.
781 # $artist_rs->cds->count - normally generates:
782 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
783 # which actually returns the number of artists * (number of cds || 1)
785 # So what we do here is crawl {from}, determine if the current alias is at
786 # the top of the stack, and if not - make sure the chain is inner-joined down
789 sub _inner_join_to_node {
790 my ($self, $from, $alias) = @_;
792 my $switch_branch = $self->_find_join_path_to_node($from, $alias);
794 return $from unless @{$switch_branch||[]};
796 # So it looks like we will have to switch some stuff around.
797 # local() is useless here as we will be leaving the scope
798 # anyway, and deep cloning is just too fucking expensive
799 # So replace the first hashref in the node arrayref manually
800 my @new_from = ($from->[0]);
801 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
803 for my $j (@{$from}[1 .. $#$from]) {
804 my $jalias = $j->[0]{-alias};
806 if ($sw_idx->{$jalias}) {
807 my %attrs = %{$j->[0]};
808 delete $attrs{-join_type};
822 sub _find_join_path_to_node {
823 my ($self, $from, $target_alias) = @_;
825 # subqueries and other oddness are naturally not supported
829 ref $from->[0] ne 'HASH'
831 ! defined $from->[0]{-alias}
834 # no path - the head is the alias
835 return [] if $from->[0]{-alias} eq $target_alias;
837 for my $i (1 .. $#$from) {
838 return $from->[$i][0]{-join_path} if ( ($from->[$i][0]{-alias}||'') eq $target_alias );
841 # something else went quite wrong
845 sub _extract_order_criteria {
846 my ($self, $order_by, $sql_maker) = @_;
849 my ($sql_maker, $order_by, $orig_quote_chars) = @_;
851 return scalar $sql_maker->_order_by_chunks ($order_by)
854 my ($lq, $rq, $sep) = map { quotemeta($_) } (
855 ($orig_quote_chars ? @$orig_quote_chars : $sql_maker->_quote_chars),
860 for ($sql_maker->_order_by_chunks ($order_by) ) {
861 my $chunk = ref $_ ? [ @$_ ] : [ $_ ];
862 ($chunk->[0]) = $sql_maker->_split_order_chunk($chunk->[0]);
864 # order criteria may have come back pre-quoted (literals and whatnot)
865 # this is fragile, but the best we can currently do
866 $chunk->[0] =~ s/^ $lq (.+?) $rq $sep $lq (.+?) $rq $/"$1.$2"/xe
867 or $chunk->[0] =~ s/^ $lq (.+) $rq $/$1/x;
869 push @chunks, $chunk;
876 return $parser->($sql_maker, $order_by);
879 $sql_maker = $self->sql_maker;
881 # pass these in to deal with literals coming from
882 # the user or the deep guts of prefetch
883 my $orig_quote_chars = [$sql_maker->_quote_chars];
885 local $sql_maker->{quote_char};
886 return $parser->($sql_maker, $order_by, $orig_quote_chars);
890 sub _order_by_is_stable {
891 my ($self, $ident, $order_by, $where) = @_;
894 ( map { $_->[0] } $self->_extract_order_criteria($order_by) ),
895 ( $where ? keys %{ $self->_extract_fixed_condition_columns($where) } : () ),
898 my $colinfo = $self->_resolve_column_info($ident, \@cols);
900 return keys %$colinfo
901 ? $self->_columns_comprise_identifying_set( $colinfo, \@cols )
906 sub _columns_comprise_identifying_set {
907 my ($self, $colinfo, $columns) = @_;
910 $cols_per_src -> {$_->{-source_alias}} -> {$_->{-colname}} = $_
911 for grep { defined $_ } @{$colinfo}{@$columns};
913 for (values %$cols_per_src) {
914 my $src = (values %$_)[0]->{-result_source};
915 return 1 if $src->_identifying_column_set($_);
921 # this is almost similar to _order_by_is_stable, except it takes
922 # a single rsrc, and will succeed only if the first portion of the order
924 # returns that portion as a colinfo hashref on success
925 sub _extract_colinfo_of_stable_main_source_order_by_portion {
926 my ($self, $attrs) = @_;
928 my $nodes = $self->_find_join_path_to_node($attrs->{from}, $attrs->{alias});
930 return unless defined $nodes;
934 ( $self->_extract_order_criteria($attrs->{order_by}) )
936 return unless @ord_cols;
938 my $valid_aliases = { map { $_ => 1 } (
939 $attrs->{from}[0]{-alias},
940 map { values %$_ } @$nodes,
943 my $colinfos = $self->_resolve_column_info($attrs->{from});
945 my ($colinfos_to_return, $seen_main_src_cols);
947 for my $col (@ord_cols) {
948 # if order criteria is unresolvable - there is nothing we can do
949 my $colinfo = $colinfos->{$col} or last;
951 # if we reached the end of the allowed aliases - also nothing we can do
952 last unless $valid_aliases->{$colinfo->{-source_alias}};
954 $colinfos_to_return->{$col} = $colinfo;
956 $seen_main_src_cols->{$colinfo->{-colname}} = 1
957 if $colinfo->{-source_alias} eq $attrs->{alias};
960 # FIXME the condition may be singling out things on its own, so we
961 # conceivable could come back wi "stable-ordered by nothing"
962 # not confient enough in the parser yet, so punt for the time being
963 return unless $seen_main_src_cols;
965 my $main_src_fixed_cols_from_cond = [ $attrs->{where}
969 ( $colinfos->{$_} and $colinfos->{$_}{-source_alias} eq $attrs->{alias} )
970 ? $colinfos->{$_}{-colname}
973 keys %{ $self->_extract_fixed_condition_columns($attrs->{where}) }
978 return $attrs->{result_source}->_identifying_column_set([
979 keys %$seen_main_src_cols,
980 @$main_src_fixed_cols_from_cond,
981 ]) ? $colinfos_to_return : ();
984 # Attempts to flatten a passed in SQLA condition as much as possible towards
985 # a plain hashref, *without* altering its semantics. Required by
986 # create/populate being able to extract definitive conditions from preexisting
987 # resultset {where} stacks
989 # FIXME - while relatively robust, this is still imperfect, one of the first
990 # things to tackle with DQ
992 my ($self, $where, $where_is_anded_array) = @_;
999 elsif ($where_is_anded_array or ref $where eq 'HASH') {
1003 my @pieces = $where_is_anded_array ? @$where : $where;
1005 my $chunk = shift @pieces;
1007 if (ref $chunk eq 'HASH') {
1008 for (sort keys %$chunk) {
1010 # Match SQLA 1.79 behavior
1012 is_literal_value($chunk->{$_})
1013 ? carp 'Hash-pairs consisting of an empty string with a literal are deprecated, use -and => [ $literal ] instead'
1014 : $self->throw_exception("Supplying an empty left hand side argument is not supported in hash-pairs")
1018 push @pairs, $_ => $chunk->{$_};
1021 elsif (ref $chunk eq 'ARRAY') {
1022 push @pairs, -or => $chunk
1025 elsif ( ! length ref $chunk) {
1027 # Match SQLA 1.79 behavior
1028 $self->throw_exception("Supplying an empty left hand side argument is not supported in array-pairs")
1029 if $where_is_anded_array and (! defined $chunk or $chunk eq '');
1031 push @pairs, $chunk, shift @pieces;
1034 push @pairs, '', $chunk;
1038 return unless @pairs;
1040 my @conds = $self->_collapse_cond_unroll_pairs(\@pairs)
1043 # Consolidate various @conds back into something more compact
1044 for my $c (@conds) {
1045 if (ref $c ne 'HASH') {
1046 push @{$fin->{-and}}, $c;
1049 for my $col (sort keys %$c) {
1051 # consolidate all -and nodes
1052 if ($col =~ /^\-and$/i) {
1053 push @{$fin->{-and}},
1054 ref $c->{$col} eq 'ARRAY' ? @{$c->{$col}}
1055 : ref $c->{$col} eq 'HASH' ? %{$c->{$col}}
1056 : { $col => $c->{$col} }
1059 elsif ($col =~ /^\-/) {
1060 push @{$fin->{-and}}, { $col => $c->{$col} };
1062 elsif (exists $fin->{$col}) {
1063 $fin->{$col} = [ -and => map {
1064 (ref $_ eq 'ARRAY' and ($_->[0]||'') =~ /^\-and$/i )
1068 } ($fin->{$col}, $c->{$col}) ];
1071 $fin->{$col} = $c->{$col};
1077 elsif (ref $where eq 'ARRAY') {
1078 # we are always at top-level here, it is safe to dump empty *standalone* pieces
1081 for (my $i = 0; $i <= $#$where; $i++ ) {
1083 # Match SQLA 1.79 behavior
1084 $self->throw_exception(
1085 "Supplying an empty left hand side argument is not supported in array-pairs"
1086 ) if (! defined $where->[$i] or ! length $where->[$i]);
1088 my $logic_mod = lc ( ($where->[$i] =~ /^(\-(?:and|or))$/i)[0] || '' );
1092 $self->throw_exception("Unsupported top-level op/arg pair: [ $logic_mod => $where->[$i] ]")
1093 unless ref $where->[$i] eq 'HASH' or ref $where->[$i] eq 'ARRAY';
1095 my $sub_elt = $self->_collapse_cond({ $logic_mod => $where->[$i] })
1098 my @keys = keys %$sub_elt;
1099 if ( @keys == 1 and $keys[0] !~ /^\-/ ) {
1100 $fin_idx->{ "COL_$keys[0]_" . serialize $sub_elt } = $sub_elt;
1103 $fin_idx->{ "SER_" . serialize $sub_elt } = $sub_elt;
1106 elsif (! length ref $where->[$i] ) {
1107 my $sub_elt = $self->_collapse_cond({ @{$where}[$i, $i+1] })
1110 $fin_idx->{ "COL_$where->[$i]_" . serialize $sub_elt } = $sub_elt;
1114 $fin_idx->{ "SER_" . serialize $where->[$i] } = $self->_collapse_cond( $where->[$i] ) || next;
1121 elsif ( keys %$fin_idx == 1 ) {
1122 $fin = (values %$fin_idx)[0];
1127 # at this point everything is at most one level deep - unroll if needed
1128 for (sort keys %$fin_idx) {
1129 if ( ref $fin_idx->{$_} eq 'HASH' and keys %{$fin_idx->{$_}} == 1 ) {
1130 my ($l, $r) = %{$fin_idx->{$_}};
1136 ( @$r == 1 and $l =~ /^\-and$/i )
1149 $l =~ /^\-(?:and|or)$/i
1159 push @or, $fin_idx->{$_};
1167 # not a hash not an array
1168 $fin = { -and => [ $where ] };
1171 # unroll single-element -and's
1177 my $and = delete $fin->{-and};
1180 # at this point we have @$and == 1
1182 ref $and->[0] eq 'HASH'
1184 ! grep { exists $fin->{$_} } keys %{$and->[0]}
1191 $fin->{-and} = $and;
1196 # compress same-column conds found in $fin
1197 for my $col ( grep { $_ !~ /^\-/ } keys %$fin ) {
1198 next unless ref $fin->{$col} eq 'ARRAY' and ($fin->{$col}[0]||'') =~ /^\-and$/i;
1199 my $val_bag = { map {
1200 (! defined $_ ) ? ( UNDEF => undef )
1201 : ( ! length ref $_ or is_plain_value $_ ) ? ( "VAL_$_" => $_ )
1202 : ( ( 'SER_' . serialize $_ ) => $_ )
1203 } @{$fin->{$col}}[1 .. $#{$fin->{$col}}] };
1205 if (keys %$val_bag == 1 ) {
1206 ($fin->{$col}) = values %$val_bag;
1209 $fin->{$col} = [ -and => map { $val_bag->{$_} } sort keys %$val_bag ];
1213 return keys %$fin ? $fin : ();
1216 sub _collapse_cond_unroll_pairs {
1217 my ($self, $pairs) = @_;
1222 my ($lhs, $rhs) = splice @$pairs, 0, 2;
1225 push @conds, $self->_collapse_cond($rhs);
1227 elsif ( $lhs =~ /^\-and$/i ) {
1228 push @conds, $self->_collapse_cond($rhs, (ref $rhs eq 'ARRAY'));
1230 elsif ( $lhs =~ /^\-or$/i ) {
1231 push @conds, $self->_collapse_cond(
1232 (ref $rhs eq 'HASH') ? [ map { $_ => $rhs->{$_} } sort keys %$rhs ] : $rhs
1236 if (ref $rhs eq 'HASH' and ! keys %$rhs) {
1237 # FIXME - SQLA seems to be doing... nothing...?
1239 # normalize top level -ident, for saner extract_fixed_condition_columns code
1240 elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{-ident}) {
1241 push @conds, { $lhs => { '=', $rhs } };
1243 elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{-value} and is_plain_value $rhs->{-value}) {
1244 push @conds, { $lhs => $rhs->{-value} };
1246 elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{'='}) {
1247 if ( length ref $rhs->{'='} and is_literal_value $rhs->{'='} ) {
1248 push @conds, { $lhs => $rhs };
1251 for my $p ($self->_collapse_cond_unroll_pairs([ $lhs => $rhs->{'='} ])) {
1253 # extra sanity check
1255 require Data::Dumper::Concise;
1256 local $Data::Dumper::Deepcopy = 1;
1257 $self->throw_exception(
1258 "Internal error: unexpected collapse unroll:"
1259 . Data::Dumper::Concise::Dumper { in => { $lhs => $rhs }, out => $p }
1268 # the unroller recursion may return a '=' prepended value already
1269 ref $r eq 'HASH' and keys %$rhs == 1 and exists $rhs->{'='}
1274 : { $l => { '=' => $r } }
1279 elsif (ref $rhs eq 'ARRAY') {
1280 # some of these conditionals encounter multi-values - roll them out using
1281 # an unshift, which will cause extra looping in the while{} above
1283 push @conds, { $lhs => [] };
1285 elsif ( ($rhs->[0]||'') =~ /^\-(?:and|or)$/i ) {
1286 $self->throw_exception("Value modifier not followed by any values: $lhs => [ $rhs->[0] ] ")
1289 if( $rhs->[0] =~ /^\-and$/i ) {
1290 unshift @$pairs, map { $lhs => $_ } @{$rhs}[1..$#$rhs];
1292 # if not an AND then it's an OR
1294 unshift @$pairs, $lhs => $rhs->[1];
1297 push @conds, { $lhs => [ @{$rhs}[1..$#$rhs] ] };
1300 elsif (@$rhs == 1) {
1301 unshift @$pairs, $lhs => $rhs->[0];
1304 push @conds, { $lhs => $rhs };
1307 # unroll func + { -value => ... }
1311 ( my ($subop) = keys %$rhs ) == 1
1313 length ref ((values %$rhs)[0])
1315 my $vref = is_plain_value( (values %$rhs)[0] )
1317 push @conds, { $lhs => { $subop => $$vref } }
1320 push @conds, { $lhs => $rhs };
1328 # Analyzes a given condition and attempts to extract all columns
1329 # with a definitive fixed-condition criteria. Returns a hashref
1330 # of k/v pairs suitable to be passed to set_columns(), with a
1331 # MAJOR CAVEAT - multi-value (contradictory) equalities are still
1332 # represented as a reference to the UNRESOVABLE_CONDITION constant
1333 # The reason we do this is that some codepaths only care about the
1334 # codition being stable, as opposed to actually making sense
1336 # The normal mode is used to figure out if a resultset is constrained
1337 # to a column which is part of a unique constraint, which in turn
1338 # allows us to better predict how ordering will behave etc.
1340 # With the optional "consider_nulls" boolean argument, the function
1341 # is instead used to infer inambiguous values from conditions
1342 # (e.g. the inheritance of resultset conditions on new_result)
1344 sub _extract_fixed_condition_columns {
1345 my ($self, $where, $consider_nulls) = @_;
1346 my $where_hash = $self->_collapse_cond($_[1]);
1350 for $c (keys %$where_hash) {
1353 if (!defined ($v = $where_hash->{$c}) ) {
1354 $vals->{UNDEF} = $v if $consider_nulls
1361 if (exists $v->{-value}) {
1362 if (defined $v->{-value}) {
1363 $vals->{"VAL_$v->{-value}"} = $v->{-value}
1365 elsif( $consider_nulls ) {
1366 $vals->{UNDEF} = $v->{-value};
1369 # do not need to check for plain values - _collapse_cond did it for us
1371 length ref $v->{'='}
1374 ( ref $v->{'='} eq 'HASH' and keys %{$v->{'='}} == 1 and exists $v->{'='}{-ident} )
1376 is_literal_value($v->{'='})
1379 $vals->{ 'SER_' . serialize $v->{'='} } = $v->{'='};
1387 $vals->{"VAL_$v"} = $v;
1389 elsif (ref $v eq 'ARRAY' and ($v->[0]||'') eq '-and') {
1390 for ( @{$v}[1..$#$v] ) {
1391 my $subval = $self->_extract_fixed_condition_columns({ $c => $_ }, 'consider nulls'); # always fish nulls out on recursion
1392 next unless exists $subval->{$c}; # didn't find anything
1394 ! defined $subval->{$c} ? 'UNDEF'
1395 : ( ! length ref $subval->{$c} or is_plain_value $subval->{$c} ) ? "VAL_$subval->{$c}"
1396 : ( 'SER_' . serialize $subval->{$c} )
1401 if (keys %$vals == 1) {
1402 ($res->{$c}) = (values %$vals)
1403 unless !$consider_nulls and exists $vals->{UNDEF};
1405 elsif (keys %$vals > 1) {
1406 $res->{$c} = UNRESOLVABLE_CONDITION;