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 $inner_attrs->{group_by} = $self->_group_over_selection (
133 $inner_from, $inner_select, $inner_attrs->{order_by}
137 # we already optimized $inner_from above
138 local $self->{_use_join_optimizer} = 0;
140 # generate the subquery
141 my $subq = $self->_select_args_to_query (
149 -alias => $attrs->{alias},
150 -source_handle => $inner_from->[0]{-source_handle},
151 $attrs->{alias} => $subq,
155 # Generate the outer from - this is relatively easy (really just replace
156 # the join slot with the subquery), with a major caveat - we can not
157 # join anything that is non-selecting (not part of the prefetch), but at
158 # the same time is a multi-type relationship, as it will explode the result.
160 # There are two possibilities here
161 # - either the join is non-restricting, in which case we simply throw it away
162 # - it is part of the restrictions, in which case we need to collapse the outer
163 # result by tackling yet another group_by to the outside of the query
167 # so first generate the outer_from, up to the substitution point
169 while (my $j = shift @$from) {
170 $j = [ $j ] unless ref $j eq 'ARRAY'; # promote the head-from to an AoH
172 if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
177 last; # we'll take care of what's left in $from below
180 push @outer_from, $j;
184 # scan the *remaining* from spec against different attributes, and see which joins are needed
186 my $outer_aliastypes =
187 $self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs );
189 # see what's left - throw away if not selecting/restricting
190 # also throw in a group_by if restricting to guard against
191 # cross-join explosions
193 while (my $j = shift @$from) {
194 my $alias = $j->[0]{-alias};
196 if ($outer_aliastypes->{selecting}{$alias}) {
197 push @outer_from, $j;
199 elsif ($outer_aliastypes->{restricting}{$alias}) {
200 push @outer_from, $j;
201 $outer_attrs->{group_by} ||= $outer_select unless $j->[0]{-is_single};
205 # demote the outer_from head
206 $outer_from[0] = $outer_from[0][0];
208 # This is totally horrific - the $where ends up in both the inner and outer query
209 # Unfortunately not much can be done until SQLA2 introspection arrives, and even
210 # then if where conditions apply to the *right* side of the prefetch, you may have
211 # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
212 # the outer select to exclude joins you didin't want in the first place
214 # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
215 return (\@outer_from, $outer_select, $where, $outer_attrs);
219 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
221 # Due to a lack of SQLA2 we fall back to crude scans of all the
222 # select/where/order/group attributes, in order to determine what
223 # aliases are neded to fulfill the query. This information is used
224 # throughout the code to prune unnecessary JOINs from the queries
225 # in an attempt to reduce the execution time.
226 # Although the method is pretty horrific, the worst thing that can
227 # happen is for it to fail due to some scalar SQL, which in turn will
228 # result in a vocal exception.
229 sub _resolve_aliastypes_from_select_args {
230 my ( $self, $from, $select, $where, $attrs ) = @_;
232 $self->throw_exception ('Unable to analyze custom {from}')
233 if ref $from ne 'ARRAY';
235 # what we will return
238 # see what aliases are there to work with
242 $j = $j->[0] if ref $j eq 'ARRAY';
243 my $al = $j->{-alias}
246 $alias_list->{$al} = $j;
247 $aliases_by_type->{multiplying}{$al} = 1
248 if ref($_) eq 'ARRAY' and ! $j->{-is_single}; # not array == {from} head == can't be multiplying
251 # get a column to source/alias map (including unqualified ones)
252 my $colinfo = $self->_resolve_column_info ($from);
254 # set up a botched SQLA
255 my $sql_maker = $self->sql_maker;
257 # these are throw away results, do not pollute the bind stack
258 local $sql_maker->{having_bind};
259 local $sql_maker->{select_bind};
261 # we can't scan properly without any quoting (\b doesn't cut it
262 # everywhere), so unless there is proper quoting set - use our
263 # own weird impossible character.
264 # Also in the case of no quoting, we need to explicitly disable
265 # name_sep, otherwise sorry nasty legacy syntax like
266 # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
267 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
268 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
270 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
271 $sql_maker->{quote_char} = ["\x00", "\xFF"];
272 # if we don't unset it we screw up retarded but unfortunately working
273 # 'MAX(foo.bar)' => { '>', 3 }
274 $sql_maker->{name_sep} = '';
277 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
279 # generate sql chunks
282 $sql_maker->_recurse_where ($where),
283 $sql_maker->_parse_rs_attrs ({
284 map { $_ => $attrs->{$_} } (qw/group_by having/)
288 $sql_maker->_recurse_fields ($select),
289 ( map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker) ),
293 # throw away empty chunks
294 $_ = [ map { $_ || () } @$_ ] for values %$to_scan;
296 # first loop through all fully qualified columns and get the corresponding
297 # alias (should work even if they are in scalarrefs)
298 for my $alias (keys %$alias_list) {
300 $lquote $alias $rquote $sep
305 for my $type (keys %$to_scan) {
306 for my $piece (@{$to_scan->{$type}}) {
307 $aliases_by_type->{$type}{$alias} = 1 if ($piece =~ $al_re);
312 # now loop through unqualified column names, and try to locate them within
314 for my $col (keys %$colinfo) {
315 next if $col =~ / \. /x; # if column is qualified it was caught by the above
317 my $col_re = qr/ $lquote $col $rquote /x;
319 for my $type (keys %$to_scan) {
320 for my $piece (@{$to_scan->{$type}}) {
321 $aliases_by_type->{$type}{$colinfo->{$col}{-source_alias}} = 1 if ($piece =~ $col_re);
326 # Add any non-left joins to the restriction list (such joins are indeed restrictions)
327 for my $j (values %$alias_list) {
328 my $alias = $j->{-alias} or next;
329 $aliases_by_type->{restricting}{$alias} = 1 if (
330 (not $j->{-join_type})
332 ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
336 # mark all restricting/selecting join parents as such
337 # (e.g. join => { cds => 'tracks' } - tracks will need to bring cds too )
338 for my $type (qw/restricting selecting/) {
339 for my $alias (keys %{$aliases_by_type->{$type}||{}}) {
340 $aliases_by_type->{$type}{$_} = 1
341 for (map { values %$_ } @{ $alias_list->{$alias}{-join_path} || [] });
345 return $aliases_by_type;
348 # This is the engine behind { distinct => 1 }
349 sub _group_over_selection {
350 my ($self, $from, $select, $order_by) = @_;
352 my $rs_column_list = $self->_resolve_column_info ($from);
354 my (@group_by, %group_index);
357 if (! ref($_) or ref ($_) ne 'HASH' ) {
360 if ($rs_column_list->{$_} and $_ !~ /\./ ) {
361 # add a fully qualified version as well
362 $group_index{"$rs_column_list->{$_}{-source_alias}.$_"}++;
367 # add any order_by parts that are not already present in the group_by
368 # we need to be careful not to add any named functions/aggregates
369 # i.e. order_by => [ ... { count => 'foo' } ... ]
370 for ($self->_extract_order_criteria($order_by)) {
371 # only consider real columns (for functions the user got to do an explicit group_by)
374 my $colinfo = $rs_column_list->{$chunk} or next;
376 $chunk = "$colinfo->{-source_alias}.$chunk" if $chunk !~ /\./;
377 push @group_by, $chunk unless $group_index{$chunk}++;
383 sub _resolve_ident_sources {
384 my ($self, $ident) = @_;
386 my $alias2source = {};
389 # the reason this is so contrived is that $ident may be a {from}
390 # structure, specifying multiple tables to join
391 if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
392 # this is compat mode for insert/update/delete which do not deal with aliases
393 $alias2source->{me} = $ident;
396 elsif (ref $ident eq 'ARRAY') {
400 if (ref $_ eq 'HASH') {
402 $rs_alias = $tabinfo->{-alias};
404 if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
408 $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-source_handle}->resolve
409 if ($tabinfo->{-source_handle});
413 return ($alias2source, $rs_alias);
416 # Takes $ident, \@column_names
418 # returns { $column_name => \%column_info, ... }
419 # also note: this adds -result_source => $rsrc to the column info
421 # If no columns_names are supplied returns info about *all* columns
423 sub _resolve_column_info {
424 my ($self, $ident, $colnames) = @_;
425 my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
427 my (%seen_cols, @auto_colnames);
429 # compile a global list of column names, to be able to properly
430 # disambiguate unqualified column names (if at all possible)
431 for my $alias (keys %$alias2src) {
432 my $rsrc = $alias2src->{$alias};
433 for my $colname ($rsrc->columns) {
434 push @{$seen_cols{$colname}}, $alias;
435 push @auto_colnames, "$alias.$colname" unless $colnames;
441 grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
444 my (%return, $colinfos);
445 foreach my $col (@$colnames) {
446 my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
448 # if the column was seen exactly once - we know which rsrc it came from
449 $source_alias ||= $seen_cols{$colname}[0]
450 if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
452 next unless $source_alias;
454 my $rsrc = $alias2src->{$source_alias}
458 %{ ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname} },
459 -result_source => $rsrc,
460 -source_alias => $source_alias,
467 # The DBIC relationship chaining implementation is pretty simple - every
468 # new related_relationship is pushed onto the {from} stack, and the {select}
469 # window simply slides further in. This means that when we count somewhere
470 # in the middle, we got to make sure that everything in the join chain is an
471 # actual inner join, otherwise the count will come back with unpredictable
472 # results (a resultset may be generated with _some_ rows regardless of if
473 # the relation which the $rs currently selects has rows or not). E.g.
474 # $artist_rs->cds->count - normally generates:
475 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
476 # which actually returns the number of artists * (number of cds || 1)
478 # So what we do here is crawl {from}, determine if the current alias is at
479 # the top of the stack, and if not - make sure the chain is inner-joined down
482 sub _inner_join_to_node {
483 my ($self, $from, $alias) = @_;
485 # subqueries and other oddness are naturally not supported
491 ref $from->[0] ne 'HASH'
495 $from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do
498 # find the current $alias in the $from structure
501 for my $j (@{$from}[1 .. $#$from]) {
502 if ($j->[0]{-alias} eq $alias) {
503 $switch_branch = $j->[0]{-join_path};
508 # something else went quite wrong
509 return $from unless $switch_branch;
511 # So it looks like we will have to switch some stuff around.
512 # local() is useless here as we will be leaving the scope
513 # anyway, and deep cloning is just too fucking expensive
514 # So replace the first hashref in the node arrayref manually
515 my @new_from = ($from->[0]);
516 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
518 for my $j (@{$from}[1 .. $#$from]) {
519 my $jalias = $j->[0]{-alias};
521 if ($sw_idx->{$jalias}) {
522 my %attrs = %{$j->[0]};
523 delete $attrs{-join_type};
537 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
538 # a condition containing 'me' or other table prefixes will not work
539 # at all. What this code tries to do (badly) is introspect the condition
540 # and remove all column qualifiers. If it bails out early (returns undef)
541 # the calling code should try another approach (e.g. a subquery)
542 sub _strip_cond_qualifiers {
543 my ($self, $where) = @_;
547 # No-op. No condition, we're updating/deleting everything
548 return $cond unless $where;
550 if (ref $where eq 'ARRAY') {
554 foreach my $key (keys %{$_}) {
556 $hash{$1} = $_->{$key};
562 elsif (ref $where eq 'HASH') {
563 if ( (keys %$where) == 1 && ( (keys %{$where})[0] eq '-and' )) {
565 my @cond = @{$where->{-and}};
566 for (my $i = 0; $i < @cond; $i++) {
567 my $entry = $cond[$i];
569 my $ref = ref $entry;
570 if ($ref eq 'HASH' or $ref eq 'ARRAY') {
571 $hash = $self->_strip_cond_qualifiers($entry);
574 $entry =~ /([^.]+)$/;
575 $hash->{$1} = $cond[++$i];
578 $self->throw_exception ("_strip_cond_qualifiers() is unable to handle a condition reftype $ref");
580 push @{$cond->{-and}}, $hash;
584 foreach my $key (keys %$where) {
585 if ($key eq '-or' && ref $where->{$key} eq 'ARRAY') {
586 $cond->{$key} = $self->_strip_cond_qualifiers($where->{$key});
590 $cond->{$1} = $where->{$key};
602 sub _extract_order_criteria {
603 my ($self, $order_by, $sql_maker) = @_;
606 my ($sql_maker, $order_by) = @_;
608 return scalar $sql_maker->_order_by_chunks ($order_by)
612 for ($sql_maker->_order_by_chunks ($order_by) ) {
613 my $chunk = ref $_ ? $_ : [ $_ ];
614 $chunk->[0] =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
615 push @chunks, $chunk;
622 return $parser->($sql_maker, $order_by);
625 $sql_maker = $self->sql_maker;
626 local $sql_maker->{quote_char};
627 return $parser->($sql_maker, $order_by);