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 oboslete 90% of this
13 use base 'DBIx::Class::Storage';
16 use Carp::Clan qw/^DBIx::Class/;
17 use List::Util 'first';
18 use Scalar::Util 'blessed';
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(@_);
37 # a grouped set will not be affected by amount of rows. Thus any
38 # {multiplying} joins can go
39 delete $aliastypes->{multiplying} if $attrs->{group_by};
41 my @newfrom = $from->[0]; # FROM head is always present
43 my %need_joins = (map { %{$_||{}} } (values %$aliastypes) );
44 for my $j (@{$from}[1..$#$from]) {
45 push @newfrom, $j if (
46 (! $j->[0]{-alias}) # legacy crap
48 $need_joins{$j->[0]{-alias}}
56 # This is the code producing joined subqueries like:
57 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
59 sub _adjust_select_args_for_complex_prefetch {
60 my ($self, $from, $select, $where, $attrs) = @_;
62 $self->throw_exception ('Nothing to prefetch... how did we get here?!')
63 if not @{$attrs->{_prefetch_selector_range}};
65 $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
66 if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
69 # generate inner/outer attribute lists, remove stuff that doesn't apply
70 my $outer_attrs = { %$attrs };
71 delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
73 my $inner_attrs = { %$attrs };
74 delete $inner_attrs->{$_} for qw/for collapse _prefetch_selector_range _collapse_order_by select as/;
77 # bring over all non-collapse-induced order_by into the inner query (if any)
78 # the outer one will have to keep them all
79 delete $inner_attrs->{order_by};
80 if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
81 $inner_attrs->{order_by} = [
82 @{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
86 # generate the inner/outer select lists
87 # for inside we consider only stuff *not* brought in by the prefetch
88 # on the outside we substitute any function for its alias
89 my $outer_select = [ @$select ];
90 my $inner_select = [];
92 my ($p_start, $p_end) = @{$outer_attrs->{_prefetch_selector_range}};
93 for my $i (0 .. $p_start - 1, $p_end + 1 .. $#$outer_select) {
94 my $sel = $outer_select->[$i];
96 if (ref $sel eq 'HASH' ) {
97 $sel->{-as} ||= $attrs->{as}[$i];
98 $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
101 push @$inner_select, $sel;
103 push @{$inner_attrs->{as}}, $attrs->{as}[$i];
106 # construct the inner $from and lock it in a subquery
107 # we need to prune first, because this will determine if we need a group_by below
108 # the fake group_by is so that the pruner throws away all non-selecting, non-restricting
109 # multijoins (since we def. do not care about those inside the subquery)
111 my $subq_joinspec = do {
113 # must use it here regardless of user requests
114 local $self->{_use_join_optimizer} = 1;
116 my $inner_from = $self->_prune_unused_joins ($from, $inner_select, $where, {
117 group_by => ['dummy'], %$inner_attrs,
120 my $inner_aliastypes =
121 $self->_resolve_aliastypes_from_select_args( $inner_from, $inner_select, $where, $inner_attrs );
123 # if a multi-type non-selecting (only restricting) join was needed in the subquery
124 # add a group_by to simulate the collapse in the subq
126 ! $inner_attrs->{group_by}
129 $inner_aliastypes->{restricting}{$_}
131 ! $inner_aliastypes->{selecting}{$_}
132 } ( keys %{$inner_aliastypes->{multiplying}||{}} )
134 my $unprocessed_order_chunks;
135 ($inner_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection (
136 $inner_from, $inner_select, $inner_attrs->{order_by}
139 $self->throw_exception (
140 'A required group_by clause could not be constructed automatically due to a complex '
141 . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
143 ) if $unprocessed_order_chunks;
146 # we already optimized $inner_from above
147 local $self->{_use_join_optimizer} = 0;
149 # generate the subquery
150 my $subq = $self->_select_args_to_query (
158 -alias => $attrs->{alias},
159 -rsrc => $inner_from->[0]{-rsrc},
160 $attrs->{alias} => $subq,
164 # Generate the outer from - this is relatively easy (really just replace
165 # the join slot with the subquery), with a major caveat - we can not
166 # join anything that is non-selecting (not part of the prefetch), but at
167 # the same time is a multi-type relationship, as it will explode the result.
169 # There are two possibilities here
170 # - either the join is non-restricting, in which case we simply throw it away
171 # - it is part of the restrictions, in which case we need to collapse the outer
172 # result by tackling yet another group_by to the outside of the query
176 # so first generate the outer_from, up to the substitution point
178 while (my $j = shift @$from) {
179 $j = [ $j ] unless ref $j eq 'ARRAY'; # promote the head-from to an AoH
181 if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
186 last; # we'll take care of what's left in $from below
189 push @outer_from, $j;
193 # scan the *remaining* from spec against different attributes, and see which joins are needed
195 my $outer_aliastypes =
196 $self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs );
198 # see what's left - throw away if not selecting/restricting
199 # also throw in a group_by if restricting to guard against
200 # cross-join explosions
202 my $need_outer_group_by;
203 while (my $j = shift @$from) {
204 my $alias = $j->[0]{-alias};
206 if ($outer_aliastypes->{selecting}{$alias}) {
207 push @outer_from, $j;
209 elsif ($outer_aliastypes->{restricting}{$alias}) {
210 push @outer_from, $j;
211 $need_outer_group_by ||= ! $j->[0]{-is_single};
215 # demote the outer_from head
216 $outer_from[0] = $outer_from[0][0];
218 if ($need_outer_group_by and ! $outer_attrs->{group_by}) {
220 my $unprocessed_order_chunks;
221 ($outer_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection (
222 \@outer_from, $outer_select, $outer_attrs->{order_by}
225 $self->throw_exception (
226 'A required group_by clause could not be constructed automatically due to a complex '
227 . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
229 ) if $unprocessed_order_chunks;
233 # This is totally horrific - the $where ends up in both the inner and outer query
234 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
235 # then if where conditions apply to the *right* side of the prefetch, you may have
236 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
237 # the outer select to exclude joins you didin't want in the first place
239 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
240 return (\@outer_from, $outer_select, $where, $outer_attrs);
244 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
246 # Due to a lack of SQLA2 we fall back to crude scans of all the
247 # select/where/order/group attributes, in order to determine what
248 # aliases are neded to fulfill the query. This information is used
249 # throughout the code to prune unnecessary JOINs from the queries
250 # in an attempt to reduce the execution time.
251 # Although the method is pretty horrific, the worst thing that can
252 # happen is for it to fail due to some scalar SQL, which in turn will
253 # result in a vocal exception.
254 sub _resolve_aliastypes_from_select_args {
255 my ( $self, $from, $select, $where, $attrs ) = @_;
257 $self->throw_exception ('Unable to analyze custom {from}')
258 if ref $from ne 'ARRAY';
260 # what we will return
263 # see what aliases are there to work with
267 $j = $j->[0] if ref $j eq 'ARRAY';
268 my $al = $j->{-alias}
271 $alias_list->{$al} = $j;
272 $aliases_by_type->{multiplying}{$al} = 1
273 if ref($_) eq 'ARRAY' and ! $j->{-is_single}; # not array == {from} head == can't be multiplying
276 # get a column to source/alias map (including unqualified ones)
277 my $colinfo = $self->_resolve_column_info ($from);
279 # set up a botched SQLA
280 my $sql_maker = $self->sql_maker;
282 # these are throw away results, do not pollute the bind stack
283 local $sql_maker->{select_bind};
284 local $sql_maker->{where_bind};
285 local $sql_maker->{group_bind};
286 local $sql_maker->{having_bind};
288 # we can't scan properly without any quoting (\b doesn't cut it
289 # everywhere), so unless there is proper quoting set - use our
290 # own weird impossible character.
291 # Also in the case of no quoting, we need to explicitly disable
292 # name_sep, otherwise sorry nasty legacy syntax like
293 # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
294 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
295 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
297 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
298 $sql_maker->{quote_char} = ["\x00", "\xFF"];
299 # if we don't unset it we screw up retarded but unfortunately working
300 # 'MAX(foo.bar)' => { '>', 3 }
301 $sql_maker->{name_sep} = '';
304 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
306 # generate sql chunks
309 $sql_maker->_recurse_where ($where),
310 $sql_maker->_parse_rs_attrs ({
311 map { $_ => $attrs->{$_} } (qw/group_by having/)
315 $sql_maker->_recurse_fields ($select),
316 ( map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker) ),
320 # throw away empty chunks
321 $_ = [ map { $_ || () } @$_ ] for values %$to_scan;
323 # first loop through all fully qualified columns and get the corresponding
324 # alias (should work even if they are in scalarrefs)
325 for my $alias (keys %$alias_list) {
327 $lquote $alias $rquote $sep
332 for my $type (keys %$to_scan) {
333 for my $piece (@{$to_scan->{$type}}) {
334 $aliases_by_type->{$type}{$alias} = 1 if ($piece =~ $al_re);
339 # now loop through unqualified column names, and try to locate them within
341 for my $col (keys %$colinfo) {
342 next if $col =~ / \. /x; # if column is qualified it was caught by the above
344 my $col_re = qr/ $lquote $col $rquote /x;
346 for my $type (keys %$to_scan) {
347 for my $piece (@{$to_scan->{$type}}) {
348 $aliases_by_type->{$type}{$colinfo->{$col}{-source_alias}} = 1 if ($piece =~ $col_re);
353 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
354 for my $j (values %$alias_list) {
355 my $alias = $j->{-alias} or next;
356 $aliases_by_type->{restricting}{$alias} = 1 if (
357 (not $j->{-join_type})
359 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
363 # mark all restricting/selecting join parents as such
364 # (e.g. join => { cds => 'tracks' } - tracks will need to bring cds too )
365 for my $type (qw/restricting selecting/) {
366 for my $alias (keys %{$aliases_by_type->{$type}||{}}) {
367 $aliases_by_type->{$type}{$_} = 1
368 for (map { values %$_ } @{ $alias_list->{$alias}{-join_path} || [] });
372 return $aliases_by_type;
375 # This is the engine behind { distinct => 1 }
376 sub _group_over_selection {
377 my ($self, $from, $select, $order_by) = @_;
379 my $rs_column_list = $self->_resolve_column_info ($from);
381 my (@group_by, %group_index);
383 # the logic is: if it is a { func => val } we assume an aggregate,
384 # otherwise if \'...' or \[...] we assume the user knows what is
385 # going on thus group over it
387 if (! ref($_) or ref ($_) ne 'HASH' ) {
390 if ($rs_column_list->{$_} and $_ !~ /\./ ) {
391 # add a fully qualified version as well
392 $group_index{"$rs_column_list->{$_}{-source_alias}.$_"}++;
397 # add any order_by parts that are not already present in the group_by
398 # we need to be careful not to add any named functions/aggregates
399 # i.e. order_by => [ ... { count => 'foo' } ... ]
401 for ($self->_extract_order_criteria($order_by)) {
402 # only consider real columns (for functions the user got to do an explicit group_by)
408 my $colinfo = $rs_column_list->{$chunk} or do {
413 $chunk = "$colinfo->{-source_alias}.$chunk" if $chunk !~ /\./;
414 push @group_by, $chunk unless $group_index{$chunk}++;
418 ? (\@group_by, (@leftovers ? \@leftovers : undef) )
423 sub _resolve_ident_sources {
424 my ($self, $ident) = @_;
426 my $alias2source = {};
429 # the reason this is so contrived is that $ident may be a {from}
430 # structure, specifying multiple tables to join
431 if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
432 # this is compat mode for insert/update/delete which do not deal with aliases
433 $alias2source->{me} = $ident;
436 elsif (ref $ident eq 'ARRAY') {
440 if (ref $_ eq 'HASH') {
442 $rs_alias = $tabinfo->{-alias};
444 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
448 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc}
449 if ($tabinfo->{-rsrc});
453 return ($alias2source, $rs_alias);
456 # Takes $ident, \@column_names
458 # returns { $column_name => \%column_info, ... }
459 # also note: this adds -result_source => $rsrc to the column info
461 # If no columns_names are supplied returns info about *all* columns
463 sub _resolve_column_info {
464 my ($self, $ident, $colnames) = @_;
465 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
467 my (%seen_cols, @auto_colnames);
469 # compile a global list of column names, to be able to properly
470 # disambiguate unqualified column names (if at all possible)
471 for my $alias (keys %$alias2src) {
472 my $rsrc = $alias2src->{$alias};
473 for my $colname ($rsrc->columns) {
474 push @{$seen_cols{$colname}}, $alias;
475 push @auto_colnames, "$alias.$colname" unless $colnames;
481 grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
484 my (%return, $colinfos);
485 foreach my $col (@$colnames) {
486 my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
488 # if the column was seen exactly once - we know which rsrc it came from
489 $source_alias ||= $seen_cols{$colname}[0]
490 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
492 next unless $source_alias;
494 my $rsrc = $alias2src->{$source_alias}
498 %{ ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname} },
499 -result_source => $rsrc,
500 -source_alias => $source_alias,
507 # The DBIC relationship chaining implementation is pretty simple - every
508 # new related_relationship is pushed onto the {from} stack, and the {select}
509 # window simply slides further in. This means that when we count somewhere
510 # in the middle, we got to make sure that everything in the join chain is an
511 # actual inner join, otherwise the count will come back with unpredictable
512 # results (a resultset may be generated with _some_ rows regardless of if
513 # the relation which the $rs currently selects has rows or not). E.g.
514 # $artist_rs->cds->count - normally generates:
515 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
516 # which actually returns the number of artists * (number of cds || 1)
518 # So what we do here is crawl {from}, determine if the current alias is at
519 # the top of the stack, and if not - make sure the chain is inner-joined down
522 sub _inner_join_to_node {
523 my ($self, $from, $alias) = @_;
525 # subqueries and other oddness are naturally not supported
531 ref $from->[0] ne 'HASH'
535 $from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do
538 # find the current $alias in the $from structure
541 for my $j (@{$from}[1 .. $#$from]) {
542 if ($j->[0]{-alias} eq $alias) {
543 $switch_branch = $j->[0]{-join_path};
548 # something else went quite wrong
549 return $from unless $switch_branch;
551 # So it looks like we will have to switch some stuff around.
552 # local() is useless here as we will be leaving the scope
553 # anyway, and deep cloning is just too fucking expensive
554 # So replace the first hashref in the node arrayref manually
555 my @new_from = ($from->[0]);
556 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
558 for my $j (@{$from}[1 .. $#$from]) {
559 my $jalias = $j->[0]{-alias};
561 if ($sw_idx->{$jalias}) {
562 my %attrs = %{$j->[0]};
563 delete $attrs{-join_type};
577 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
578 # a condition containing 'me' or other table prefixes will not work
579 # at all. What this code tries to do (badly) is introspect the condition
580 # and remove all column qualifiers. If it bails out early (returns undef)
581 # the calling code should try another approach (e.g. a subquery)
583 sub _strip_cond_qualifiers_from_array {
584 my ($self, $where) = @_;
586 for (my $i = 0; $i < @$where; $i++) {
587 my $entry = $where->[$i];
589 my $ref = ref $entry;
590 if ($ref eq 'HASH' or $ref eq 'ARRAY') {
591 $hash = $self->_strip_cond_qualifiers($entry);
594 $entry =~ /([^.]+)$/;
595 $hash->{$1} = $where->[++$i];
602 sub _strip_cond_qualifiers {
603 my ($self, $where) = @_;
607 # No-op. No condition, we're updating/deleting everything
608 return $cond unless $where;
610 if (ref $where eq 'ARRAY') {
611 $cond = $self->_strip_cond_qualifiers_from_array($where);
613 elsif (ref $where eq 'HASH') {
614 if ( (keys %$where) == 1 && ( (keys %{$where})[0] eq '-and' )) {
616 $self->_strip_cond_qualifiers_from_array($where->{-and});
619 foreach my $key (keys %$where) {
620 if ($key eq '-or' && ref $where->{$key} eq 'ARRAY') {
621 $cond->{$key} = $self->_strip_cond_qualifiers($where->{$key});
625 $cond->{$1} = $where->{$key};
637 sub _extract_order_criteria {
638 my ($self, $order_by, $sql_maker) = @_;
641 my ($sql_maker, $order_by) = @_;
643 return scalar $sql_maker->_order_by_chunks ($order_by)
647 for ($sql_maker->_order_by_chunks ($order_by) ) {
648 my $chunk = ref $_ ? $_ : [ $_ ];
649 $chunk->[0] =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
650 push @chunks, $chunk;
657 return $parser->($sql_maker, $order_by);
660 $sql_maker = $self->sql_maker;
661 local $sql_maker->{quote_char};
662 return $parser->($sql_maker, $order_by);