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_select}};
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_select _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 = [];
91 for my $i (0 .. ( @$outer_select - @{$outer_attrs->{_prefetch_select}} - 1) ) {
92 my $sel = $outer_select->[$i];
94 if (ref $sel eq 'HASH' ) {
95 $sel->{-as} ||= $attrs->{as}[$i];
96 $outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
99 push @$inner_select, $sel;
101 push @{$inner_attrs->{as}}, $attrs->{as}[$i];
104 # construct the inner $from and lock it in a subquery
105 # we need to prune first, because this will determine if we need a group_by below
106 # the fake group_by is so that the pruner throws away all non-selecting, non-restricting
107 # multijoins (since we def. do not care about those inside the subquery)
109 my $subq_joinspec = do {
111 # must use it here regardless of user requests
112 local $self->{_use_join_optimizer} = 1;
114 my $inner_from = $self->_prune_unused_joins ($from, $inner_select, $where, {
115 group_by => ['dummy'], %$inner_attrs,
118 my $inner_aliastypes =
119 $self->_resolve_aliastypes_from_select_args( $inner_from, $inner_select, $where, $inner_attrs );
121 # if a multi-type non-selecting (only restricting) join was needed in the subquery
122 # add a group_by to simulate the collapse in the subq
124 ! $inner_attrs->{group_by}
127 $inner_aliastypes->{restricting}{$_}
129 ! $inner_aliastypes->{selecting}{$_}
130 } ( keys %{$inner_aliastypes->{multiplying}||{}} )
132 my $unprocessed_order_chunks;
133 ($inner_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection (
134 $inner_from, $inner_select, $inner_attrs->{order_by}
137 $self->throw_exception (
138 'A required group_by clause could not be constructed automatically due to a complex '
139 . 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
141 ) if $unprocessed_order_chunks;
144 # we already optimized $inner_from above
145 local $self->{_use_join_optimizer} = 0;
147 # generate the subquery
148 my $subq = $self->_select_args_to_query (
156 -alias => $attrs->{alias},
157 -source_handle => $inner_from->[0]{-source_handle},
158 $attrs->{alias} => $subq,
162 # Generate the outer from - this is relatively easy (really just replace
163 # the join slot with the subquery), with a major caveat - we can not
164 # join anything that is non-selecting (not part of the prefetch), but at
165 # the same time is a multi-type relationship, as it will explode the result.
167 # There are two possibilities here
168 # - either the join is non-restricting, in which case we simply throw it away
169 # - it is part of the restrictions, in which case we need to collapse the outer
170 # result by tackling yet another group_by to the outside of the query
174 # so first generate the outer_from, up to the substitution point
176 while (my $j = shift @$from) {
177 $j = [ $j ] unless ref $j eq 'ARRAY'; # promote the head-from to an AoH
179 if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
184 last; # we'll take care of what's left in $from below
187 push @outer_from, $j;
191 # scan the *remaining* from spec against different attributes, and see which joins are needed
193 my $outer_aliastypes =
194 $self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs );
196 # see what's left - throw away if not selecting/restricting
197 # also throw in a group_by if restricting to guard against
198 # cross-join explosions
200 while (my $j = shift @$from) {
201 my $alias = $j->[0]{-alias};
203 if ($outer_aliastypes->{selecting}{$alias}) {
204 push @outer_from, $j;
206 elsif ($outer_aliastypes->{restricting}{$alias}) {
207 push @outer_from, $j;
208 $outer_attrs->{group_by} ||= $outer_select unless $j->[0]{-is_single};
212 # demote the outer_from head
213 $outer_from[0] = $outer_from[0][0];
215 # This is totally horrific - the $where ends up in both the inner and outer query
216 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
217 # then if where conditions apply to the *right* side of the prefetch, you may have
218 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
219 # the outer select to exclude joins you didin't want in the first place
221 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
222 return (\@outer_from, $outer_select, $where, $outer_attrs);
226 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
228 # Due to a lack of SQLA2 we fall back to crude scans of all the
229 # select/where/order/group attributes, in order to determine what
230 # aliases are neded to fulfill the query. This information is used
231 # throughout the code to prune unnecessary JOINs from the queries
232 # in an attempt to reduce the execution time.
233 # Although the method is pretty horrific, the worst thing that can
234 # happen is for it to fail due to some scalar SQL, which in turn will
235 # result in a vocal exception.
236 sub _resolve_aliastypes_from_select_args {
237 my ( $self, $from, $select, $where, $attrs ) = @_;
239 $self->throw_exception ('Unable to analyze custom {from}')
240 if ref $from ne 'ARRAY';
242 # what we will return
245 # see what aliases are there to work with
249 $j = $j->[0] if ref $j eq 'ARRAY';
250 my $al = $j->{-alias}
253 $alias_list->{$al} = $j;
254 $aliases_by_type->{multiplying}{$al} = 1
255 if ref($_) eq 'ARRAY' and ! $j->{-is_single}; # not array == {from} head == can't be multiplying
258 # get a column to source/alias map (including unqualified ones)
259 my $colinfo = $self->_resolve_column_info ($from);
261 # set up a botched SQLA
262 my $sql_maker = $self->sql_maker;
264 # these are throw away results, do not pollute the bind stack
265 local $sql_maker->{select_bind};
266 local $sql_maker->{where_bind};
267 local $sql_maker->{group_bind};
268 local $sql_maker->{having_bind};
270 # we can't scan properly without any quoting (\b doesn't cut it
271 # everywhere), so unless there is proper quoting set - use our
272 # own weird impossible character.
273 # Also in the case of no quoting, we need to explicitly disable
274 # name_sep, otherwise sorry nasty legacy syntax like
275 # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
276 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
277 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
279 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
280 $sql_maker->{quote_char} = ["\x00", "\xFF"];
281 # if we don't unset it we screw up retarded but unfortunately working
282 # 'MAX(foo.bar)' => { '>', 3 }
283 $sql_maker->{name_sep} = '';
286 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
288 # generate sql chunks
291 $sql_maker->_recurse_where ($where),
292 $sql_maker->_parse_rs_attrs ({
293 map { $_ => $attrs->{$_} } (qw/group_by having/)
297 $sql_maker->_recurse_fields ($select),
298 ( map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker) ),
302 # throw away empty chunks
303 $_ = [ map { $_ || () } @$_ ] for values %$to_scan;
305 # first loop through all fully qualified columns and get the corresponding
306 # alias (should work even if they are in scalarrefs)
307 for my $alias (keys %$alias_list) {
309 $lquote $alias $rquote $sep
314 for my $type (keys %$to_scan) {
315 for my $piece (@{$to_scan->{$type}}) {
316 $aliases_by_type->{$type}{$alias} = 1 if ($piece =~ $al_re);
321 # now loop through unqualified column names, and try to locate them within
323 for my $col (keys %$colinfo) {
324 next if $col =~ / \. /x; # if column is qualified it was caught by the above
326 my $col_re = qr/ $lquote $col $rquote /x;
328 for my $type (keys %$to_scan) {
329 for my $piece (@{$to_scan->{$type}}) {
330 $aliases_by_type->{$type}{$colinfo->{$col}{-source_alias}} = 1 if ($piece =~ $col_re);
335 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
336 for my $j (values %$alias_list) {
337 my $alias = $j->{-alias} or next;
338 $aliases_by_type->{restricting}{$alias} = 1 if (
339 (not $j->{-join_type})
341 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
345 # mark all restricting/selecting join parents as such
346 # (e.g. join => { cds => 'tracks' } - tracks will need to bring cds too )
347 for my $type (qw/restricting selecting/) {
348 for my $alias (keys %{$aliases_by_type->{$type}||{}}) {
349 $aliases_by_type->{$type}{$_} = 1
350 for (map { values %$_ } @{ $alias_list->{$alias}{-join_path} || [] });
354 return $aliases_by_type;
357 # This is the engine behind { distinct => 1 }
358 sub _group_over_selection {
359 my ($self, $from, $select, $order_by) = @_;
361 my $rs_column_list = $self->_resolve_column_info ($from);
363 my (@group_by, %group_index);
366 if (! ref($_) or ref ($_) ne 'HASH' ) {
369 if ($rs_column_list->{$_} and $_ !~ /\./ ) {
370 # add a fully qualified version as well
371 $group_index{"$rs_column_list->{$_}{-source_alias}.$_"}++;
376 # add any order_by parts that are not already present in the group_by
377 # we need to be careful not to add any named functions/aggregates
378 # i.e. order_by => [ ... { count => 'foo' } ... ]
380 for ($self->_extract_order_criteria($order_by)) {
381 # only consider real columns (for functions the user got to do an explicit group_by)
387 my $colinfo = $rs_column_list->{$chunk} or do {
392 $chunk = "$colinfo->{-source_alias}.$chunk" if $chunk !~ /\./;
393 push @group_by, $chunk unless $group_index{$chunk}++;
397 ? (\@group_by, (@leftovers ? \@leftovers : undef) )
402 sub _resolve_ident_sources {
403 my ($self, $ident) = @_;
405 my $alias2source = {};
408 # the reason this is so contrived is that $ident may be a {from}
409 # structure, specifying multiple tables to join
410 if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
411 # this is compat mode for insert/update/delete which do not deal with aliases
412 $alias2source->{me} = $ident;
415 elsif (ref $ident eq 'ARRAY') {
419 if (ref $_ eq 'HASH') {
421 $rs_alias = $tabinfo->{-alias};
423 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
427 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
428 if ($tabinfo->{-source_handle});
432 return ($alias2source, $rs_alias);
435 # Takes $ident, \@column_names
437 # returns { $column_name => \%column_info, ... }
438 # also note: this adds -result_source => $rsrc to the column info
440 # If no columns_names are supplied returns info about *all* columns
442 sub _resolve_column_info {
443 my ($self, $ident, $colnames) = @_;
444 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
446 my (%seen_cols, @auto_colnames);
448 # compile a global list of column names, to be able to properly
449 # disambiguate unqualified column names (if at all possible)
450 for my $alias (keys %$alias2src) {
451 my $rsrc = $alias2src->{$alias};
452 for my $colname ($rsrc->columns) {
453 push @{$seen_cols{$colname}}, $alias;
454 push @auto_colnames, "$alias.$colname" unless $colnames;
460 grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
463 my (%return, $colinfos);
464 foreach my $col (@$colnames) {
465 my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
467 # if the column was seen exactly once - we know which rsrc it came from
468 $source_alias ||= $seen_cols{$colname}[0]
469 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
471 next unless $source_alias;
473 my $rsrc = $alias2src->{$source_alias}
477 %{ ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname} },
478 -result_source => $rsrc,
479 -source_alias => $source_alias,
486 # The DBIC relationship chaining implementation is pretty simple - every
487 # new related_relationship is pushed onto the {from} stack, and the {select}
488 # window simply slides further in. This means that when we count somewhere
489 # in the middle, we got to make sure that everything in the join chain is an
490 # actual inner join, otherwise the count will come back with unpredictable
491 # results (a resultset may be generated with _some_ rows regardless of if
492 # the relation which the $rs currently selects has rows or not). E.g.
493 # $artist_rs->cds->count - normally generates:
494 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
495 # which actually returns the number of artists * (number of cds || 1)
497 # So what we do here is crawl {from}, determine if the current alias is at
498 # the top of the stack, and if not - make sure the chain is inner-joined down
501 sub _inner_join_to_node {
502 my ($self, $from, $alias) = @_;
504 # subqueries and other oddness are naturally not supported
510 ref $from->[0] ne 'HASH'
514 $from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do
517 # find the current $alias in the $from structure
520 for my $j (@{$from}[1 .. $#$from]) {
521 if ($j->[0]{-alias} eq $alias) {
522 $switch_branch = $j->[0]{-join_path};
527 # something else went quite wrong
528 return $from unless $switch_branch;
530 # So it looks like we will have to switch some stuff around.
531 # local() is useless here as we will be leaving the scope
532 # anyway, and deep cloning is just too fucking expensive
533 # So replace the first hashref in the node arrayref manually
534 my @new_from = ($from->[0]);
535 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
537 for my $j (@{$from}[1 .. $#$from]) {
538 my $jalias = $j->[0]{-alias};
540 if ($sw_idx->{$jalias}) {
541 my %attrs = %{$j->[0]};
542 delete $attrs{-join_type};
556 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
557 # a condition containing 'me' or other table prefixes will not work
558 # at all. What this code tries to do (badly) is introspect the condition
559 # and remove all column qualifiers. If it bails out early (returns undef)
560 # the calling code should try another approach (e.g. a subquery)
561 sub _strip_cond_qualifiers {
562 my ($self, $where) = @_;
566 # No-op. No condition, we're updating/deleting everything
567 return $cond unless $where;
569 if (ref $where eq 'ARRAY') {
573 foreach my $key (keys %{$_}) {
575 $hash{$1} = $_->{$key};
581 elsif (ref $where eq 'HASH') {
582 if ( (keys %$where) == 1 && ( (keys %{$where})[0] eq '-and' )) {
584 my @cond = @{$where->{-and}};
585 for (my $i = 0; $i < @cond; $i++) {
586 my $entry = $cond[$i];
588 my $ref = ref $entry;
589 if ($ref eq 'HASH' or $ref eq 'ARRAY') {
590 $hash = $self->_strip_cond_qualifiers($entry);
593 $entry =~ /([^.]+)$/;
594 $hash->{$1} = $cond[++$i];
597 $self->throw_exception ("_strip_cond_qualifiers() is unable to handle a condition reftype $ref");
599 push @{$cond->{-and}}, $hash;
603 foreach my $key (keys %$where) {
604 if ($key eq '-or' && ref $where->{$key} eq 'ARRAY') {
605 $cond->{$key} = $self->_strip_cond_qualifiers($where->{$key});
609 $cond->{$1} = $where->{$key};
621 sub _extract_order_criteria {
622 my ($self, $order_by, $sql_maker) = @_;
625 my ($sql_maker, $order_by) = @_;
627 return scalar $sql_maker->_order_by_chunks ($order_by)
631 for ($sql_maker->_order_by_chunks ($order_by) ) {
632 my $chunk = ref $_ ? $_ : [ $_ ];
633 $chunk->[0] =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
634 push @chunks, $chunk;
641 return $parser->($sql_maker, $order_by);
644 $sql_maker = $self->sql_maker;
645 local $sql_maker->{quote_char};
646 return $parser->($sql_maker, $order_by);