1 package # hide from the pauses
2 DBIx::Class::ResultSource::RowParser;
7 use base 'DBIx::Class';
10 use List::Util qw(first max);
12 use DBIx::Class::ResultSource::RowParser::Util qw(
13 assemble_simple_parser
14 assemble_collapsing_parser
17 use DBIx::Class::Carp;
21 # Accepts a prefetch map (one or more relationships for the current source),
22 # returns a set of select/as pairs for each of those relationships. Columns
23 # are fully qualified inflation_slot names
24 sub _resolve_selection_from_prefetch {
25 my ($self, $pre, $alias_map, $pref_path) = @_;
27 # internal recursion marker
30 if (not defined $pre or not length $pre) {
33 elsif( ref $pre eq 'ARRAY' ) {
34 map { $self->_resolve_selection_from_prefetch( $_, $alias_map, [ @$pref_path ] ) }
37 elsif( ref $pre eq 'HASH' ) {
39 $self->_resolve_selection_from_prefetch($_, $alias_map, [ @$pref_path ] ),
40 $self->related_source($_)->_resolve_selection_from_prefetch(
41 $pre->{$_}, $alias_map, [ @$pref_path, $_] )
45 $self->throw_exception(
46 "don't know how to resolve prefetch reftype ".ref($pre));
50 $p = $p->{$_} for @$pref_path, $pre;
52 $self->throw_exception (
53 "Unable to resolve prefetch '$pre' - join alias map does not contain an entry for path: "
54 . join (' -> ', @$pref_path, $pre)
55 ) if (ref $p->{-join_aliases} ne 'ARRAY' or not @{$p->{-join_aliases}} );
57 # this shift() is critical - it is what allows prefetch => [ (foo) x 2 ] to work
58 my $src_alias = shift @{$p->{-join_aliases}};
60 # ordered [select => as] pairs
62 "${src_alias}.$_" => join ( '.',
67 ] } $self->related_source($pre)->columns;
71 sub _resolve_prefetch {
73 'There is no good reason to call this internal deprecated method - '
74 . 'please open a ticket detailing your usage, so that a better plan can '
75 . 'be devised for your case. In either case _resolve_prefetch() is '
76 . 'deprecated in favor of _resolve_selection_from_prefetch(), which has '
77 . 'a greatly simplified arglist.'
80 $_[0]->_resolve_selection_from_prefetch( $_[1], $_[3] );
84 # Takes an arrayref of {as} dbic column aliases and the collapse and select
85 # attributes from the same $rs (the selector requirement is a temporary
86 # workaround... I hope), and returns a coderef capable of:
87 # my $me_pref_clps = $coderef->([$rs->cursor->next/all])
88 # Where the $me_pref_clps arrayref is the future argument to inflate_result()
90 # For an example of this coderef in action (and to see its guts) look at
91 # t/resultset/rowparser_internals.t
93 # This is a huge performance win, as we call the same code for every row
94 # returned from the db, thus avoiding repeated method lookups when traversing
97 # Also since the coderef is completely stateless (the returned structure is
98 # always fresh on every new invocation) this is a very good opportunity for
99 # memoization if further speed improvements are needed
101 # The way we construct this coderef is somewhat fugly, although the result is
102 # really worth it. The final coderef does not perform any kind of recursion -
103 # the entire nested structure constructor is rolled out into a single scope.
105 # In any case - the output of this thing is meticulously micro-tested, so
106 # any sort of adjustment/rewrite should be relatively easy (fsvo relatively)
109 # $args and $attrs are separated to delineate what is core collapser stuff and
110 # what is dbic $rs specific
111 my ($self, $args, $attrs) = @_;
113 die "HRI without pruning makes zero sense"
114 if ( $args->{hri_style} && ! $args->{prune_null_branches} );
117 hri_style => $args->{hri_style},
118 prune_null_branches => $args->{prune_null_branches},
120 { $args->{inflate_map}[$_] => $_ }
121 ( 0 .. $#{$args->{inflate_map}} )
125 my $check_null_columns;
127 my $src = (! $args->{collapse} ) ? assemble_simple_parser(\%common) : do {
128 my $collapse_map = $self->_resolve_collapse ({
130 # only consider real columns (not functions) during collapse resolution
131 # this check shouldn't really be here, as fucktards are not supposed to
132 # alias random crap to existing column names anyway, but still - just in
134 # FIXME !!!! - this does not yet deal with unbalanced selectors correctly
135 # (it is now trivial as the attrs specify where things go out of sync
138 { ref $attrs->{select}[$common{val_index}{$_}] ? () : ( $_ => $common{val_index}{$_} ) }
139 keys %{$common{val_index}}
141 premultiplied => $args->{premultiplied},
144 $check_null_columns = $collapse_map->{-identifying_columns}
145 if @{$collapse_map->{-identifying_columns}};
147 assemble_collapsing_parser({
149 collapse_map => $collapse_map,
154 if DBIx::Class::_ENV_::STRESSTEST_UTF8_UPGRADE_GENERATED_COLLAPSER_SOURCE;
157 $args->{eval} ? ( eval "sub $src" || die $@ ) : $src,
163 # Takes an arrayref selection list and generates a collapse-map representing
164 # row-object fold-points. Every relationship is assigned a set of unique,
165 # non-nullable columns (which may *not even be* from the same resultset)
166 # and the collapser will use this information to correctly distinguish
167 # data of individual to-be-row-objects. See t/resultset/rowparser_internals.t
168 # for extensive RV examples
169 sub _resolve_collapse {
170 my ($self, $args, $common_args) = @_;
172 # for comprehensible error messages put ourselves at the head of the relationship chain
173 $args->{_rel_chain} ||= [ $self->source_name ];
175 # record top-level fully-qualified column index, signify toplevelness
176 unless ($common_args->{_as_fq_idx}) {
177 $common_args->{_as_fq_idx} = { %{$args->{as}} };
178 $args->{_is_top_level} = 1;
181 my ($my_cols, $rel_cols, $native_cols);
182 for (keys %{$args->{as}}) {
183 if ($_ =~ /^ ([^\.]+) \. (.+) /x) {
184 $rel_cols->{$1}{$2} = 1;
187 $native_cols->{$_} = $my_cols->{$_} = {}; # important for ||='s below
192 # run through relationships, collect metadata
193 for my $rel (keys %$rel_cols) {
194 my $inf = $self->relationship_info ($rel);
197 is_single => ( $inf->{attrs}{accessor} && $inf->{attrs}{accessor} ne 'multi' ),
198 is_inner => ( ( $inf->{attrs}{join_type} || '' ) !~ /^left/i),
199 rsrc => $self->related_source($rel),
200 fk_map => $self->_resolve_relationship_condition(
202 self_alias => "\xFE", # irrelevant
203 foreign_alias => "\xFF", # irrelevant
208 # inject non-left fk-bridges from *INNER-JOINED* children (if any)
209 for my $rel (grep { $relinfo->{$_}{is_inner} } keys %$relinfo) {
210 my $ri = $relinfo->{$rel};
211 for (keys %{$ri->{fk_map}} ) {
212 # need to know source from *our* pov, hence $rel.col
213 $my_cols->{$_} ||= { via_fk => "$rel.$ri->{fk_map}{$_}" }
214 if defined $rel_cols->{$rel}{$ri->{fk_map}{$_}} # in fact selected
218 # if the parent is already defined *AND* we have an inner reverse relationship
219 # (i.e. do not exist without it) , assume all of its related FKs are selected
220 # (even if they in fact are NOT in the select list). Keep a record of what we
221 # assumed, and if any such phantom-column becomes part of our own collapser,
222 # throw everything assumed-from-parent away and replace with the collapser of
223 # the parent (whatever it may be)
224 my $assumed_from_parent;
225 if ( ! $args->{_parent_info}{underdefined} and ! $args->{_parent_info}{rev_rel_is_optional} ) {
226 for my $col ( values %{$args->{_parent_info}{rel_condition} || {}} ) {
227 next if exists $my_cols->{$col};
228 $my_cols->{$col} = {};
229 $assumed_from_parent->{columns}{$col}++;
233 # get colinfo for everything
235 my $ci = $self->columns_info;
236 $my_cols->{$_}{colinfo} = $ci->{$_} for keys %$my_cols;
241 # first try to reuse the parent's collapser (i.e. reuse collapser over 1:1)
242 # (makes for a leaner coderef later)
244 ! $collapse_map->{-identifying_columns}
246 $args->{_parent_info}{collapser_reusable}
248 $collapse_map->{-identifying_columns} = $args->{_parent_info}{collapse_on_idcols}
251 # Still don't know how to collapse - in case we are a *single* relationship
252 # AND our parent is defined AND we have any *native* non-nullable pieces: then
253 # we are still good to go
254 # NOTE: it doesn't matter if the nonnullable set is unique or not - it will be
255 # made unique by the parents identifying cols
257 ! $collapse_map->{-identifying_columns}
259 $args->{_parent_info}{is_single}
261 @{ $args->{_parent_info}{collapse_on_idcols} }
263 ( my @native_nonnull_cols = grep {
264 $native_cols->{$_}{colinfo}
266 ! $native_cols->{$_}{colinfo}{is_nullable}
267 } keys %$native_cols )
270 $collapse_map->{-identifying_columns} = [ __unique_numlist(
271 @{ $args->{_parent_info}{collapse_on_idcols}||[] },
273 # FIXME - we don't really need *all* of the columns, $our_nonnull_cols[0]
274 # is sufficient. However map the entire thing to engage the extra nonnull
275 # explicit checks, just to be on the safe side
276 # Remove some day in the future
279 $common_args->{_as_fq_idx}{join ('.',
280 @{$args->{_rel_chain}}[1 .. $#{$args->{_rel_chain}}],
289 # Still don't know how to collapse - try to resolve based on our columns (plus already inserted FK bridges)
291 ! $collapse_map->{-identifying_columns}
295 my $idset = $self->_identifying_column_set ({map { $_ => $my_cols->{$_}{colinfo} } keys %$my_cols})
297 # see if the resulting collapser relies on any implied columns,
298 # and fix stuff up if this is the case
299 my @reduced_set = grep { ! $assumed_from_parent->{columns}{$_} } @$idset;
301 $collapse_map->{-identifying_columns} = [ __unique_numlist(
302 @{ $args->{_parent_info}{collapse_on_idcols}||[] },
307 @{$args->{_rel_chain}}[1 .. $#{$args->{_rel_chain}}],
308 ( $my_cols->{$_}{via_fk} || $_ ),
311 $common_args->{_as_fq_idx}->{$fqc};
318 # Stil don't know how to collapse - keep descending down 1:1 chains - if
319 # a related non-LEFT 1:1 is resolvable - its condition will collapse us
321 unless ($collapse_map->{-identifying_columns}) {
324 for my $rel (keys %$relinfo) {
325 next unless ($relinfo->{$rel}{is_single} && $relinfo->{$rel}{is_inner});
327 if ( my $rel_collapse = $relinfo->{$rel}{rsrc}->_resolve_collapse ({
328 as => $rel_cols->{$rel},
329 _rel_chain => [ @{$args->{_rel_chain}}, $rel ],
330 _parent_info => { underdefined => 1 },
332 push @candidates, $rel_collapse->{-identifying_columns};
336 # get the set with least amount of columns
337 # FIXME - maybe need to implement a data type order as well (i.e. prefer several ints
338 # to a single varchar)
340 ($collapse_map->{-identifying_columns}) = sort { scalar @$a <=> scalar @$b } (@candidates);
344 # Stil don't know how to collapse, and we are the root node. Last ditch
345 # effort in case we are *NOT* premultiplied.
346 # Run through *each multi* all the way down, left or not, and all
347 # *left* singles (a single may become a multi underneath) . When everything
348 # gets back see if all the rels link to us definitively. If this is the
349 # case we are good - either one of them will define us, or if all are NULLs
350 # we know we are "unique" due to the "non-premultiplied" check
352 ! $collapse_map->{-identifying_columns}
354 ! $args->{premultiplied}
356 $args->{_is_top_level}
358 my (@collapse_sets, $uncollapsible_chain);
360 for my $rel (keys %$relinfo) {
362 # we already looked at these higher up
363 next if ($relinfo->{$rel}{is_single} && $relinfo->{$rel}{is_inner});
365 if (my $clps = $relinfo->{$rel}{rsrc}->_resolve_collapse ({
366 as => $rel_cols->{$rel},
367 _rel_chain => [ @{$args->{_rel_chain}}, $rel ],
368 _parent_info => { underdefined => 1 },
371 # for singles use the idcols wholesale (either there or not)
372 if ($relinfo->{$rel}{is_single}) {
373 push @collapse_sets, $clps->{-identifying_columns};
375 elsif (! $relinfo->{$rel}{fk_map}) {
376 $uncollapsible_chain = 1;
380 my $defined_cols_parent_side;
382 for my $fq_col ( grep { /^$rel\.[^\.]+$/ } keys %{$args->{as}} ) {
383 my ($col) = $fq_col =~ /([^\.]+)$/;
385 $defined_cols_parent_side->{$_} = $args->{as}{$fq_col} for grep
386 { $relinfo->{$rel}{fk_map}{$_} eq $col }
387 keys %{$relinfo->{$rel}{fk_map}}
391 if (my $set = $self->_identifying_column_set([ keys %$defined_cols_parent_side ]) ) {
392 push @collapse_sets, [ sort map { $defined_cols_parent_side->{$_} } @$set ];
395 $uncollapsible_chain = 1;
401 $uncollapsible_chain = 1;
406 unless ($uncollapsible_chain) {
407 # if we got here - we are good to go, but the construction is tricky
408 # since our children will want to include our collapse criteria - we
409 # don't give them anything (safe, since they are all collapsible on their own)
410 # in addition we record the individual collapse possibilities
411 # of all left children node collapsers, and merge them in the rowparser
413 $collapse_map->{-identifying_columns} = [];
414 $collapse_map->{-identifying_columns_variants} = [ sort {
415 (scalar @$a) <=> (scalar @$b) or max(@$a) <=> max(@$b)
420 # stop descending into children if we were called by a parent for first-pass
421 # and don't despair if nothing was found (there may be other parallel branches
423 if ($args->{_parent_info}{underdefined}) {
424 return $collapse_map->{-identifying_columns} ? $collapse_map : undef
426 # nothing down the chain resolved - can't calculate a collapse-map
427 elsif (! $collapse_map->{-identifying_columns}) {
428 $self->throw_exception ( sprintf
429 "Unable to calculate a definitive collapse column set for %s%s: fetch more unique non-nullable columns",
431 @{$args->{_rel_chain}} > 1
432 ? sprintf (' (last member of the %s chain)', join ' -> ', @{$args->{_rel_chain}} )
438 # If we got that far - we are collapsable - GREAT! Now go down all children
439 # a second time, and fill in the rest
441 $collapse_map->{-identifying_columns} = [ __unique_numlist(
442 @{ $args->{_parent_info}{collapse_on_idcols}||[] },
443 @{ $collapse_map->{-identifying_columns} },
446 for my $rel (sort keys %$relinfo) {
448 $collapse_map->{$rel} = $relinfo->{$rel}{rsrc}->_resolve_collapse ({
449 as => { map { $_ => 1 } ( keys %{$rel_cols->{$rel}} ) },
450 _rel_chain => [ @{$args->{_rel_chain}}, $rel],
453 collapse_on_idcols => [ @{$collapse_map->{-identifying_columns}} ],
455 rel_condition => $relinfo->{$rel}{fk_map},
457 is_optional => ! $relinfo->{$rel}{is_inner},
459 is_single => $relinfo->{$rel}{is_single},
461 # if there is at least one *inner* reverse relationship which is HASH-based (equality only)
462 # we can safely assume that the child can not exist without us
463 rev_rel_is_optional => ( first
464 { ref $_->{cond} eq 'HASH' and ($_->{attrs}{join_type}||'') !~ /^left/i }
465 values %{ $self->reverse_relationship_info($rel) },
468 # if this is a 1:1 our own collapser can be used as a collapse-map
469 # (regardless of left or not)
470 collapser_reusable => (
471 $relinfo->{$rel}{is_single}
473 $relinfo->{$rel}{is_inner}
475 @{$collapse_map->{-identifying_columns}}
480 $collapse_map->{$rel}{-is_single} = 1 if $relinfo->{$rel}{is_single};
481 $collapse_map->{$rel}{-is_optional} ||= 1 unless $relinfo->{$rel}{is_inner};
484 return $collapse_map;
487 # adding a dep on MoreUtils *just* for this is retarded
488 sub __unique_numlist {
489 sort { $a <=> $b } keys %{ {map { $_ => 1 } @_ }}