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 Sub::Name 'subname';
22 # This code will remove non-selecting/non-restricting joins from
23 # {from} specs, aiding the RDBMS query optimizer
25 sub _prune_unused_joins {
27 my ($from, $select, $where, $attrs) = @_;
29 return $from unless $self->_use_join_optimizer;
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
35 my $aliastypes = $self->_resolve_aliastypes_from_select_args(@_);
38 delete $aliastypes->{joining};
40 # a grouped set will not be affected by amount of rows. Thus any
41 # {multiplying} joins can go
42 delete $aliastypes->{multiplying}
43 if $attrs->{_force_prune_multiplying_joins} or $attrs->{group_by};
45 my @newfrom = $from->[0]; # FROM head is always present
49 for (values %$aliastypes) {
50 # add all requested aliases
51 $need_joins{$_} = 1 for keys %$_;
53 # add all their parents (as per joinpath which is an AoH { table => alias })
54 $need_joins{$_} = 1 for map { values %$_ } map { @{$_->{-parents}} } values %$_;
57 for my $j (@{$from}[1..$#$from]) {
58 push @newfrom, $j if (
59 (! $j->[0]{-alias}) # legacy crap
61 $need_joins{$j->[0]{-alias}}
69 # This is the code producing joined subqueries like:
70 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
72 sub _adjust_select_args_for_complex_prefetch {
73 my ($self, $from, $select, $where, $attrs) = @_;
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');
78 my $root_alias = $attrs->{alias};
80 # generate inner/outer attribute lists, remove stuff that doesn't apply
81 my $outer_attrs = { %$attrs };
82 delete $outer_attrs->{$_} for qw/where bind rows offset group_by _grouped_by_distinct having/;
84 my $inner_attrs = { %$attrs };
85 delete $inner_attrs->{$_} for qw/from for collapse select as _related_results_construction/;
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}
91 ! $inner_attrs->{rows}
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 ];
100 my ($root_node, $root_node_offset);
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]
109 if ( ($h->{-alias}||'') eq $root_alias and $h->{-rsrc} ) {
111 $root_node_offset = $i;
116 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
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;
123 for my $i (0 .. $#$outer_select) {
124 my $sel = $outer_select->[$i];
127 $colinfo->{$sel} and $colinfo->{$sel}{-source_alias} ne $root_alias
130 if (ref $sel eq 'HASH' ) {
131 $sel->{-as} ||= $attrs->{as}[$i];
132 $outer_select->[$i] = join ('.', $root_alias, ($sel->{-as} || "inner_column_$i") );
134 elsif (! ref $sel and my $ci = $colinfo->{$sel}) {
135 $selected_root_columns->{$ci->{-colname}} = 1;
138 push @$inner_select, $sel;
140 push @{$inner_attrs->{as}}, $attrs->{as}[$i];
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
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(
155 for (sort map { keys %{$_->{-seen_columns}||{}} } map { values %$_ } values %$connecting_aliastypes) {
156 my $ci = $colinfo->{$_} or next;
158 $ci->{-source_alias} eq $root_alias
160 ! $selected_root_columns->{$ci->{-colname}}++
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};
168 # construct the inner $from and lock it in a subquery
169 # we need to prune first, because this will determine if we need a group_by below
170 # throw away all non-selecting, non-restricting multijoins
171 # (since we def. do not care about multiplication those inside the subquery)
172 my $inner_subq = do {
174 # must use it here regardless of user requests
175 local $self->{_use_join_optimizer} = 1;
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, {
179 %$inner_attrs, _force_prune_multiplying_joins => 1
182 my $inner_aliastypes =
183 $self->_resolve_aliastypes_from_select_args( $inner_from, $inner_select, $where, $inner_attrs );
185 # uh-oh a multiplier (which is not us) left in, this is a problem
187 $inner_aliastypes->{multiplying}
189 # if there are user-supplied groups - assume user knows wtf they are up to
190 ( ! $inner_aliastypes->{grouping} or $inner_attrs->{_grouped_by_distinct} )
192 my @multipliers = grep { $_ ne $root_alias } keys %{$inner_aliastypes->{multiplying}}
195 # if none of the multipliers came from an order_by (guaranteed to have been combined
196 # with a limit) - easy - just slap a group_by to simulate a collape and be on our way
198 ! $inner_aliastypes->{ordering}
200 ! first { $inner_aliastypes->{ordering}{$_} } @multipliers
203 my $unprocessed_order_chunks;
204 ($inner_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection ({
207 select => $inner_select,
210 $self->throw_exception (
211 'A required group_by clause could not be constructed automatically due to a complex '
212 . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
214 ) if $unprocessed_order_chunks;
217 # We need to order by external columns and group at the same time
218 # so we can calculate the proper limit
219 # This doesn't really make sense in SQL, however from DBICs point
220 # of view is rather valid (order the leftmost objects by whatever
221 # criteria and get the offset/rows many). There is a way around
222 # this however in SQL - we simply tae the direction of each piece
223 # of the foreign order and convert them to MIN(X) for ASC or MAX(X)
224 # for DESC, and group_by the root columns. The end result should be
225 # exactly what we expect
227 # supplement the main selection with pks if not already there,
228 # as they will have to be a part of the group_by to colapse
230 my $cur_sel = { map { $_ => 1 } @$inner_select };
232 my @pks = map { "$root_alias.$_" } $root_node->{-rsrc}->primary_columns
233 or $self->throw_exception( sprintf
234 'Unable to perform complex limited prefetch off %s without declared primary key',
235 $root_node->{-rsrc}->source_name,
238 push @$inner_select, $col
239 unless $cur_sel->{$col}++;
242 # wrap any part of the order_by that "responds" to an ordering alias
244 # FIXME - this code is a joke, will need to be completely rewritten in
245 # the DQ branch. But I need to push a POC here, otherwise the
246 # pesky tests won't pass
247 my $sql_maker = $self->sql_maker;
248 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
249 my $own_re = qr/ $lquote \Q$root_alias\E $rquote $sep | \b \Q$root_alias\E $sep /x;
250 my @order_chunks = map { ref $_ eq 'ARRAY' ? $_ : [ $_ ] } $sql_maker->_order_by_chunks($attrs->{order_by});
251 my @new_order = map { \$_ } @order_chunks;
252 my $inner_columns_info = $self->_resolve_column_info($inner_from);
254 # loop through and replace stuff that is not "ours" with a min/max func
255 # everything is a literal at this point, since we are likely properly
257 for my $i (0 .. $#new_order) {
258 my $chunk = $order_chunks[$i][0];
261 next if $chunk =~ $own_re;
263 ($chunk, my $is_desc) = $sql_maker->_split_order_chunk($chunk);
265 # maybe our own unqualified column
267 $lquote and $sep and $chunk =~ /^ $lquote ([^$sep]+) $rquote $/x
273 $inner_columns_info->{$ord_bit}
275 $inner_columns_info->{$ord_bit}{-source_alias} eq $root_alias
281 ($is_desc ? 'MAX' : 'MIN'),
283 ($is_desc ? ' DESC' : ''),
285 @ {$order_chunks[$i]} [ 1 .. $#{$order_chunks[$i]} ]
289 $inner_attrs->{order_by} = \@new_order;
291 # do not care about leftovers here - it will be all the functions
293 ($inner_attrs->{group_by}) = $self->_group_over_selection ({
296 select => $inner_select,
301 # we already optimized $inner_from above
302 # and already local()ized
303 $self->{_use_join_optimizer} = 0;
305 # generate the subquery
306 $self->_select_args_to_query (
314 # Generate the outer from - this is relatively easy (really just replace
315 # the join slot with the subquery), with a major caveat - we can not
316 # join anything that is non-selecting (not part of the prefetch), but at
317 # the same time is a multi-type relationship, as it will explode the result.
319 # There are two possibilities here
320 # - either the join is non-restricting, in which case we simply throw it away
321 # - it is part of the restrictions, in which case we need to collapse the outer
322 # result by tackling yet another group_by to the outside of the query
324 # work on a shallow copy
329 # we may not be the head
330 if ($root_node_offset) {
331 # first generate the outer_from, up and including the substitution point
332 @outer_from = splice @$from, 0, $root_node_offset;
336 -alias => $root_alias,
337 -rsrc => $root_node->{-rsrc},
338 $root_alias => $inner_subq,
340 @{$from->[0]}[1 .. $#{$from->[0]}],
345 -alias => $root_alias,
346 -rsrc => $root_node->{-rsrc},
347 $root_alias => $inner_subq,
351 shift @$from; # what we just replaced above
353 # scan the *remaining* from spec against different attributes, and see which joins are needed
355 my $outer_aliastypes =
356 $self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs );
359 my ($outer_select_chain, @outer_nonselecting_chains) = map { +{
360 map { $_ => 1 } map { values %$_} map { @{$_->{-parents}} } values %{ $outer_aliastypes->{$_} || {} }
361 } } qw/selecting restricting grouping ordering/;
363 # see what's left - throw away if not selecting/restricting
364 # also throw in a group_by if a non-selecting multiplier,
365 # to guard against cross-join explosions
366 my $need_outer_group_by;
367 while (my $j = shift @$from) {
368 my $alias = $j->[0]{-alias};
371 $outer_select_chain->{$alias}
375 elsif (first { $_->{$alias} } @outer_nonselecting_chains ) {
376 push @outer_from, $j;
377 $need_outer_group_by ||= $outer_aliastypes->{multiplying}{$alias} ? 1 : 0;
381 if ( $need_outer_group_by and $attrs->{_grouped_by_distinct} ) {
382 my $unprocessed_order_chunks;
383 ($outer_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection ({
385 from => \@outer_from,
386 select => $outer_select,
389 $self->throw_exception (
390 'A required group_by clause could not be constructed automatically due to a complex '
391 . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
393 ) if $unprocessed_order_chunks;
397 # This is totally horrific - the $where ends up in both the inner and outer query
398 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
399 # then if where conditions apply to the *right* side of the prefetch, you may have
400 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
401 # the outer select to exclude joins you didin't want in the first place
403 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
404 return (\@outer_from, $outer_select, $where, $outer_attrs);
408 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
410 # Due to a lack of SQLA2 we fall back to crude scans of all the
411 # select/where/order/group attributes, in order to determine what
412 # aliases are neded to fulfill the query. This information is used
413 # throughout the code to prune unnecessary JOINs from the queries
414 # in an attempt to reduce the execution time.
415 # Although the method is pretty horrific, the worst thing that can
416 # happen is for it to fail due to some scalar SQL, which in turn will
417 # result in a vocal exception.
418 sub _resolve_aliastypes_from_select_args {
419 my ( $self, $from, $select, $where, $attrs ) = @_;
421 $self->throw_exception ('Unable to analyze custom {from}')
422 if ref $from ne 'ARRAY';
424 # what we will return
427 # see what aliases are there to work with
431 $j = $j->[0] if ref $j eq 'ARRAY';
432 my $al = $j->{-alias}
435 $alias_list->{$al} = $j;
436 $aliases_by_type->{multiplying}{$al} ||= { -parents => $j->{-join_path}||[] } if (
437 # not array == {from} head == can't be multiplying
438 ( ref($_) eq 'ARRAY' and ! $j->{-is_single} )
440 # a parent of ours is already a multiplier
441 ( grep { $aliases_by_type->{multiplying}{$_} } @{ $j->{-join_path}||[] } )
445 # get a column to source/alias map (including unambiguous unqualified ones)
446 my $colinfo = $self->_resolve_column_info ($from);
448 # set up a botched SQLA
449 my $sql_maker = $self->sql_maker;
451 # these are throw away results, do not pollute the bind stack
452 local $sql_maker->{select_bind};
453 local $sql_maker->{where_bind};
454 local $sql_maker->{group_bind};
455 local $sql_maker->{having_bind};
456 local $sql_maker->{from_bind};
458 # we can't scan properly without any quoting (\b doesn't cut it
459 # everywhere), so unless there is proper quoting set - use our
460 # own weird impossible character.
461 # Also in the case of no quoting, we need to explicitly disable
462 # name_sep, otherwise sorry nasty legacy syntax like
463 # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
464 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
465 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
467 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
468 $sql_maker->{quote_char} = ["\x00", "\xFF"];
469 # if we don't unset it we screw up retarded but unfortunately working
470 # 'MAX(foo.bar)' => { '>', 3 }
471 $sql_maker->{name_sep} = '';
474 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
476 # generate sql chunks
479 $sql_maker->_recurse_where ($where),
480 $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} }),
483 $sql_maker->_parse_rs_attrs ({ group_by => $attrs->{group_by} }),
486 $sql_maker->_recurse_from (
487 ref $from->[0] eq 'ARRAY' ? $from->[0][0] : $from->[0],
488 @{$from}[1 .. $#$from],
492 $sql_maker->_recurse_fields ($select),
495 map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker),
499 # throw away empty chunks
500 $_ = [ map { $_ || () } @$_ ] for values %$to_scan;
502 # first see if we have any exact matches (qualified or unqualified)
503 for my $type (keys %$to_scan) {
504 for my $piece (@{$to_scan->{$type}}) {
505 if ($colinfo->{$piece} and my $alias = $colinfo->{$piece}{-source_alias}) {
506 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
507 $aliases_by_type->{$type}{$alias}{-seen_columns}{$colinfo->{$piece}{-fq_colname}} = $piece;
512 # now loop through all fully qualified columns and get the corresponding
513 # alias (should work even if they are in scalarrefs)
514 for my $alias (keys %$alias_list) {
516 $lquote $alias $rquote $sep (?: $lquote ([^$rquote]+) $rquote )?
518 \b $alias \. ([^\s\)\($rquote]+)?
521 for my $type (keys %$to_scan) {
522 for my $piece (@{$to_scan->{$type}}) {
523 if (my @matches = $piece =~ /$al_re/g) {
524 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
525 $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = "$alias.$_"
526 for grep { defined $_ } @matches;
532 # now loop through unqualified column names, and try to locate them within
534 for my $col (keys %$colinfo) {
535 next if $col =~ / \. /x; # if column is qualified it was caught by the above
537 my $col_re = qr/ $lquote ($col) $rquote /x;
539 for my $type (keys %$to_scan) {
540 for my $piece (@{$to_scan->{$type}}) {
541 if ( my @matches = $piece =~ /$col_re/g) {
542 my $alias = $colinfo->{$col}{-source_alias};
543 $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
544 $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = $_
545 for grep { defined $_ } @matches;
551 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
552 for my $j (values %$alias_list) {
553 my $alias = $j->{-alias} or next;
554 $aliases_by_type->{restricting}{$alias} ||= { -parents => $j->{-join_path}||[] } if (
555 (not $j->{-join_type})
557 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
561 for (keys %$aliases_by_type) {
562 delete $aliases_by_type->{$_} unless keys %{$aliases_by_type->{$_}};
565 return $aliases_by_type;
568 # This is the engine behind { distinct => 1 }
569 sub _group_over_selection {
570 my ($self, $attrs) = @_;
572 my $colinfos = $self->_resolve_column_info ($attrs->{from});
574 my (@group_by, %group_index);
576 # the logic is: if it is a { func => val } we assume an aggregate,
577 # otherwise if \'...' or \[...] we assume the user knows what is
578 # going on thus group over it
579 for (@{$attrs->{select}}) {
580 if (! ref($_) or ref ($_) ne 'HASH' ) {
583 if ($colinfos->{$_} and $_ !~ /\./ ) {
584 # add a fully qualified version as well
585 $group_index{"$colinfos->{$_}{-source_alias}.$_"}++;
590 # add any order_by parts *from the main source* that are not already
591 # present in the group_by
592 # we need to be careful not to add any named functions/aggregates
593 # i.e. order_by => [ ... { count => 'foo' } ... ]
595 for ($self->_extract_order_criteria($attrs->{order_by})) {
596 # only consider real columns (for functions the user got to do an explicit group_by)
606 $colinfos->{$chunk}{-source_alias} ne $attrs->{alias}
612 $chunk = $colinfos->{$chunk}{-fq_colname};
613 push @group_by, $chunk unless $group_index{$chunk}++;
617 ? (\@group_by, (@leftovers ? \@leftovers : undef) )
622 sub _resolve_ident_sources {
623 my ($self, $ident) = @_;
625 my $alias2source = {};
627 # the reason this is so contrived is that $ident may be a {from}
628 # structure, specifying multiple tables to join
629 if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
630 # this is compat mode for insert/update/delete which do not deal with aliases
631 $alias2source->{me} = $ident;
633 elsif (ref $ident eq 'ARRAY') {
637 if (ref $_ eq 'HASH') {
640 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
644 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc}
645 if ($tabinfo->{-rsrc});
649 return $alias2source;
652 # Takes $ident, \@column_names
654 # returns { $column_name => \%column_info, ... }
655 # also note: this adds -result_source => $rsrc to the column info
657 # If no columns_names are supplied returns info about *all* columns
659 sub _resolve_column_info {
660 my ($self, $ident, $colnames) = @_;
661 my $alias2src = $self->_resolve_ident_sources($ident);
663 my (%seen_cols, @auto_colnames);
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;
671 push @auto_colnames, "$alias.$colname" unless $colnames;
677 grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
680 my (%return, $colinfos);
681 foreach my $col (@$colnames) {
682 my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
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);
688 next unless $source_alias;
690 my $rsrc = $alias2src->{$source_alias}
695 ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname}
697 $self->throw_exception(
698 "No such column '$colname' on source " . $rsrc->source_name
701 -result_source => $rsrc,
702 -source_alias => $source_alias,
703 -fq_colname => $col eq $colname ? "$source_alias.$col" : $col,
704 -colname => $colname,
707 $return{"$source_alias.$colname"} = $return{$col} if $col eq $colname;
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)
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
728 sub _inner_join_to_node {
729 my ($self, $from, $alias) = @_;
731 # subqueries and other oddness are naturally not supported
737 ref $from->[0] ne 'HASH'
741 $from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do
744 # find the current $alias in the $from structure
747 for my $j (@{$from}[1 .. $#$from]) {
748 if ($j->[0]{-alias} eq $alias) {
749 $switch_branch = $j->[0]{-join_path};
754 # something else went quite wrong
755 return $from unless $switch_branch;
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
760 # So replace the first hashref in the node arrayref manually
761 my @new_from = ($from->[0]);
762 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
764 for my $j (@{$from}[1 .. $#$from]) {
765 my $jalias = $j->[0]{-alias};
767 if ($sw_idx->{$jalias}) {
768 my %attrs = %{$j->[0]};
769 delete $attrs{-join_type};
783 sub _extract_order_criteria {
784 my ($self, $order_by, $sql_maker) = @_;
787 my ($sql_maker, $order_by, $orig_quote_chars) = @_;
789 return scalar $sql_maker->_order_by_chunks ($order_by)
792 my ($lq, $rq, $sep) = map { quotemeta($_) } (
793 ($orig_quote_chars ? @$orig_quote_chars : $sql_maker->_quote_chars),
798 for ($sql_maker->_order_by_chunks ($order_by) ) {
799 my $chunk = ref $_ ? [ @$_ ] : [ $_ ];
800 ($chunk->[0]) = $sql_maker->_split_order_chunk($chunk->[0]);
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;
807 push @chunks, $chunk;
814 return $parser->($sql_maker, $order_by);
817 $sql_maker = $self->sql_maker;
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];
823 local $sql_maker->{quote_char};
824 return $parser->($sql_maker, $order_by, $orig_quote_chars);
828 sub _order_by_is_stable {
829 my ($self, $ident, $order_by, $where) = @_;
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)} :(),
836 return undef unless keys %$colinfo;
839 $cols_per_src->{$_->{-source_alias}}{$_->{-colname}} = $_ for values %$colinfo;
841 for (values %$cols_per_src) {
842 my $src = (values %$_)[0]->{-result_source};
843 return 1 if $src->_identifying_column_set($_);
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
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) = @_;
856 die "Huh... I expect a blessed result_source..."
857 if ref($main_rsrc) eq 'ARRAY';
861 ( $self->_extract_order_criteria($order_by) )
863 return unless @ord_cols;
865 my $colinfos = $self->_resolve_column_info($main_rsrc);
867 for (0 .. $#ord_cols) {
869 ! $colinfos->{$ord_cols[$_]}
871 $colinfos->{$ord_cols[$_]}{-result_source} != $main_rsrc
878 # we just truncated it above
879 return unless @ord_cols;
881 my $order_portion_ci = { map {
882 $colinfos->{$_}{-colname} => $colinfos->{$_},
883 $colinfos->{$_}{-fq_colname} => $colinfos->{$_},
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
890 # RV of _identifying_column_set contains unqualified names only
891 my $unqualified_idset = $main_rsrc->_identifying_column_set({
893 $self->_resolve_column_info(
894 $main_rsrc, $self->_extract_fixed_condition_columns($where)
901 my %unqualified_idcols_from_order = map {
902 $order_portion_ci->{$_} ? ( $_ => $order_portion_ci->{$_} ) : ()
903 } @$unqualified_idset;
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}};
913 # we didn't reach the end of the identifying portion yet
914 return $ret_info unless keys %unqualified_idcols_from_order;
917 die 'How did we get here...';
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
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) = @_;
934 return unless ref $where eq 'HASH';
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)
944 elsif ($lhs !~ /^\-/) {
945 my $val = $where->{$lhs};
947 push @cols, $lhs if (defined $val and (
950 (ref $val eq 'HASH' and keys %$val == 1 and defined $val->{'='})
954 return $nested ? @cols : \@cols;