X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet.pm;h=af68b29bca13d4c0fec9127a8d9e446cb2b4acbd;hb=d180c0f33c2fbbe3a20f994b1c61703c67128e6e;hp=11a21c009f31e9452461d93b35bcfaf4cfb3d544;hpb=9755b3df195932ab24dec8503f5e4f62f43bbe4c;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm index 11a21c0..af68b29 100644 --- a/lib/DBIx/Class/ResultSet.pm +++ b/lib/DBIx/Class/ResultSet.pm @@ -12,8 +12,6 @@ use Storable; use DBIx::Class::ResultSetColumn; use base qw/DBIx::Class/; -use Data::Dumper; $Data::Dumper::Indent = 1; - __PACKAGE__->load_components(qw/AccessorGroup/); __PACKAGE__->mk_group_accessors('simple' => qw/result_source result_class/); @@ -88,6 +86,7 @@ sub new { my ($source, $attrs) = @_; #weaken $source; + $attrs = { %{$attrs||{}} }; if ($attrs->{page}) { $attrs->{rows} ||= 10; @@ -97,14 +96,18 @@ sub new { $attrs->{alias} ||= 'me'; - bless { + my $self = { result_source => $source, result_class => $attrs->{result_class} || $source->result_class, cond => $attrs->{where}, count => undef, pager => undef, attrs => $attrs - }, $class; + }; + + bless $self, $class; + + return $self; } =head2 search @@ -131,6 +134,8 @@ call it as C. columns => [qw/name artistid/], }); +For a list of attributes that can be passed to C, see L. For more examples of using this function, see L. + =cut sub search { @@ -167,18 +172,28 @@ sub search_rs { $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH'; my $our_attrs = { %{$self->{attrs}} }; my $having = delete $our_attrs->{having}; + my $where = delete $our_attrs->{where}; + + my $new_attrs = { %{$our_attrs}, %{$attrs} }; # merge new attrs into inherited foreach my $key (qw/join prefetch/) { next unless exists $attrs->{$key}; - $our_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, delete $attrs->{$key}); + $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key}); } - - my $new_attrs = { %{$our_attrs}, %{$attrs} }; - my $where = (@_ + + my $cond = (@_ ? ( (@_ == 1 || ref $_[0] eq "HASH") - ? shift + ? ( + (ref $_[0] eq 'HASH') + ? ( + (keys %{ $_[0] } > 0) + ? shift + : undef + ) + : shift + ) : ( (@_ % 2) ? $self->throw_exception("Odd number of arguments to search") @@ -200,6 +215,18 @@ sub search_rs { : $where); } + if (defined $cond) { + $new_attrs->{where} = ( + defined $new_attrs->{where} + ? { '-and' => [ + map { + ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ + } $cond, $new_attrs->{where} + ] + } + : $cond); + } + if (defined $having) { $new_attrs->{having} = ( defined $new_attrs->{having} @@ -281,6 +308,9 @@ If the C is specified as C, it searches only on the primary key. If no C is specified, it searches on all unique constraints defined on the source, including the primary key. +If your table does not have a primary key, you B provide a value for the +C attribute matching one of the unique constraints on the source. + See also L and L. For information on how to declare unique constraints, see L. @@ -296,7 +326,7 @@ sub find { ? $self->result_source->unique_constraint_columns($attrs->{key}) : $self->result_source->primary_columns; $self->throw_exception( - "Can't find unless a primary key or unique constraint is defined" + "Can't find unless a primary key is defined or unique constraint is specified" ) unless @cols; # Parse out a hashref from input @@ -314,11 +344,31 @@ sub find { $input_query = {@_}; } + my (%related, $info); + + foreach my $key (keys %$input_query) { + if (ref($input_query->{$key}) + && ($info = $self->result_source->relationship_info($key))) { + my $rel_q = $self->result_source->resolve_condition( + $info->{cond}, delete $input_query->{$key}, $key + ); + die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY'; + @related{keys %$rel_q} = values %$rel_q; + } + } + if (my @keys = keys %related) { + @{$input_query}{@keys} = values %related; + } + my @unique_queries = $self->_unique_queries($input_query, $attrs); - # Handle cases where the ResultSet defines the query, or where the user is - # abusing find - my $query = @unique_queries ? \@unique_queries : $input_query; + # Build the final query: Default to the disjunction of the unique queries, + # but allow the input query in case the ResultSet defines the query or the + # user is abusing find + my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias}; + my $query = @unique_queries + ? [ map { $self->_add_alias($_, $alias) } @unique_queries ] + : $self->_add_alias($input_query, $alias); # Run the query if (keys %$attrs) { @@ -332,6 +382,22 @@ sub find { } } +# _add_alias +# +# Add the specified alias to the specified query hash. A copy is made so the +# original query is not modified. + +sub _add_alias { + my ($self, $query, $alias) = @_; + + my %aliased = %$query; + foreach my $col (grep { ! m/\./ } keys %aliased) { + $aliased{"$alias.$col"} = delete $aliased{$col}; + } + + return \%aliased; +} + # _unique_queries # # Build a list of queries which satisfy unique constraints. @@ -339,31 +405,27 @@ sub find { sub _unique_queries { my ($self, $query, $attrs) = @_; - my $alias = $self->{attrs}{alias}; my @constraint_names = exists $attrs->{key} ? ($attrs->{key}) : $self->result_source->unique_constraint_names; + my $where = $self->_collapse_cond($self->{attrs}{where} || {}); + my $num_where = scalar keys %$where; + my @unique_queries; foreach my $name (@constraint_names) { my @unique_cols = $self->result_source->unique_constraint_columns($name); my $unique_query = $self->_build_unique_query($query, \@unique_cols); + my $num_cols = scalar @unique_cols; my $num_query = scalar keys %$unique_query; - next unless $num_query; - # Add the ResultSet's alias - foreach my $col (grep { ! m/\./ } keys %$unique_query) { - $unique_query->{"$alias.$col"} = delete $unique_query->{$col}; + my $total = $num_query + $num_where; + if ($num_query && ($num_query == $num_cols || $total == $num_cols)) { + # The query is either unique on its own or is unique in combination with + # the existing where clause + push @unique_queries, $unique_query; } - - # XXX: Assuming quite a bit about $self->{attrs}{where} - my $num_cols = scalar @unique_cols; - my $num_where = exists $self->{attrs}{where} - ? scalar keys %{ $self->{attrs}{where} } - : 0; - push @unique_queries, $unique_query - if $num_query + $num_where == $num_cols; } return @unique_queries; @@ -466,17 +528,18 @@ sub single { } } - unless ($self->_is_unique_query($attrs->{where})) { - carp "Query not guaranteed to return a single row" - . "; please declare your unique constraints or use search instead"; - } +# XXX: Disabled since it doesn't infer uniqueness in all cases +# unless ($self->_is_unique_query($attrs->{where})) { +# carp "Query not guaranteed to return a single row" +# . "; please declare your unique constraints or use search instead"; +# } my @data = $self->result_source->storage->select_single( $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs ); - return (@data ? $self->_construct_object(@data) : ()); + return (@data ? ($self->_construct_object(@data))[0] : ()); } # _is_unique_query @@ -558,7 +621,7 @@ sub _collapse_query { my $max_length = $rs->get_column('length')->max; -Returns a ResultSetColumn instance for $column based on $self +Returns a L instance for a column of the ResultSet. =cut @@ -661,22 +724,29 @@ sub next { $self->{all_cache_position} = 1; return ($self->all)[0]; } + if ($self->{stashed_objects}) { + my $obj = shift(@{$self->{stashed_objects}}); + delete $self->{stashed_objects} unless @{$self->{stashed_objects}}; + return $obj; + } my @row = ( exists $self->{stashed_row} ? @{delete $self->{stashed_row}} : $self->cursor->next ); return unless (@row); - return $self->_construct_object(@row); + my ($row, @more) = $self->_construct_object(@row); + $self->{stashed_objects} = \@more if @more; + return $row; } sub _construct_object { my ($self, @row) = @_; my $info = $self->_collapse_result($self->{_attrs}{as}, \@row); - my $new = $self->result_class->inflate_result($self->result_source, @$info); - $new = $self->{_attrs}{record_filter}->($new) + my @new = $self->result_class->inflate_result($self->result_source, @$info); + @new = $self->{_attrs}{record_filter}->(@new) if exists $self->{_attrs}{record_filter}; - return $new; + return @new; } sub _collapse_result { @@ -768,6 +838,20 @@ sub _collapse_result { An accessor for the primary ResultSource object from which this ResultSet is derived. +=head2 result_class + +=over 4 + +=item Arguments: $result_class? + +=item Return Value: $result_class + +=back + +An accessor for the class to use when creating row objects. Defaults to +C<< result_source->result_class >> - which in most cases is the name of the +L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class. + =cut @@ -948,13 +1032,14 @@ sub first { # appropriately, returning the new condition. sub _cond_for_update_delete { - my ($self) = @_; + my ($self, $full_cond) = @_; my $cond = {}; + $full_cond ||= $self->{cond}; # No-op. No condition, we're updating/deleting everything - return $cond unless ref $self->{cond}; + return $cond unless ref $full_cond; - if (ref $self->{cond} eq 'ARRAY') { + if (ref $full_cond eq 'ARRAY') { $cond = [ map { my %hash; @@ -963,36 +1048,33 @@ sub _cond_for_update_delete { $hash{$1} = $_->{$key}; } \%hash; - } @{$self->{cond}} + } @{$full_cond} ]; } - elsif (ref $self->{cond} eq 'HASH') { - if ((keys %{$self->{cond}})[0] eq '-and') { + elsif (ref $full_cond eq 'HASH') { + if ((keys %{$full_cond})[0] eq '-and') { $cond->{-and} = []; - my @cond = @{$self->{cond}{-and}}; + my @cond = @{$full_cond->{-and}}; for (my $i = 0; $i < @cond; $i++) { my $entry = $cond[$i]; - my %hash; + my $hash; if (ref $entry eq 'HASH') { - foreach my $key (keys %{$entry}) { - $key =~ /([^.]+)$/; - $hash{$1} = $entry->{$key}; - } + $hash = $self->_cond_for_update_delete($entry); } else { $entry =~ /([^.]+)$/; - $hash{$1} = $cond[++$i]; + $hash->{$1} = $cond[++$i]; } - push @{$cond->{-and}}, \%hash; + push @{$cond->{-and}}, $hash; } } else { - foreach my $key (keys %{$self->{cond}}) { + foreach my $key (keys %{$full_cond}) { $key =~ /([^.]+)$/; - $cond->{$1} = $self->{cond}{$key}; + $cond->{$1} = $full_cond->{$key}; } } } @@ -1071,7 +1153,7 @@ sub update_all { Deletes the contents of the resultset from its result source. Note that this will not run DBIC cascade triggers. See L if you need triggers -to run. +to run. See also L. =cut @@ -1172,16 +1254,77 @@ sub new_result { $self->throw_exception( "Can't abstract implicit construct, condition not a hash" ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH')); - my %new = %$values; + my $alias = $self->{attrs}{alias}; - foreach my $key (keys %{$self->{cond}||{}}) { - $new{$1} = $self->{cond}{$key} if ($key =~ m/^(?:\Q${alias}.\E)?([^.]+)$/); - } + my $collapsed_cond = $self->{cond} ? $self->_collapse_cond($self->{cond}) : {}; + my %new = ( + %{ $self->_remove_alias($values, $alias) }, + %{ $self->_remove_alias($collapsed_cond, $alias) }, + -result_source => $self->result_source, + ); + my $obj = $self->result_class->new(\%new); - $obj->result_source($self->result_source) if $obj->can('result_source'); return $obj; } +# _collapse_cond +# +# Recursively collapse the condition. + +sub _collapse_cond { + my ($self, $cond, $collapsed) = @_; + + $collapsed ||= {}; + + if (ref $cond eq 'ARRAY') { + foreach my $subcond (@$cond) { + next unless ref $subcond; # -or +# warn "ARRAY: " . Dumper $subcond; + $collapsed = $self->_collapse_cond($subcond, $collapsed); + } + } + elsif (ref $cond eq 'HASH') { + if (keys %$cond and (keys %$cond)[0] eq '-and') { + foreach my $subcond (@{$cond->{-and}}) { +# warn "HASH: " . Dumper $subcond; + $collapsed = $self->_collapse_cond($subcond, $collapsed); + } + } + else { +# warn "LEAF: " . Dumper $cond; + foreach my $col (keys %$cond) { + my $value = $cond->{$col}; + $collapsed->{$col} = $value; + } + } + } + + return $collapsed; +} + +# _remove_alias +# +# Remove the specified alias from the specified query hash. A copy is made so +# the original query is not modified. + +sub _remove_alias { + my ($self, $query, $alias) = @_; + + my %orig = %{ $query || {} }; + my %unaliased; + + foreach my $key (keys %orig) { + if ($key !~ /\./) { + $unaliased{$key} = $orig{$key}; + next; + } + $unaliased{$1} = $orig{$key} + if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/; + } + + return \%unaliased; +} + =head2 find_or_new =over 4 @@ -1322,7 +1465,7 @@ sub update_or_create { my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}); my $cond = ref $_[0] eq 'HASH' ? shift : {@_}; - my $row = $self->find($cond); + my $row = $self->find($cond, $attrs); if (defined $row) { $row->update($cond); return $row; @@ -1434,7 +1577,7 @@ sub related_resultset { alias => $alias, where => $self->{cond}, seen_join => $seen, - _parent_from => $from, + from => $from, }); }; } @@ -1444,7 +1587,7 @@ sub _resolve_from { my $source = $self->result_source; my $attrs = $self->{attrs}; - my $from = $attrs->{_parent_from} + my $from = $attrs->{from} || [ { $attrs->{alias} => $source->from } ]; my $seen = { %{$attrs->{seen_join}||{}} }; @@ -1452,9 +1595,10 @@ sub _resolve_from { my $join = ($attrs->{join} ? [ $attrs->{join}, $extra_join ] : $extra_join); - push(@{$from}, - $source->resolve_join($join, $attrs->{alias}, $seen) - ); + $from = [ + @$from, + ($join ? $source->resolve_join($join, $attrs->{alias}, $seen) : ()), + ]; return ($from,$seen); } @@ -1473,13 +1617,21 @@ sub _resolved_attrs { } elsif (!$attrs->{select}) { $attrs->{columns} = [ $source->columns ]; } - - $attrs->{select} ||= [ - map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} - ]; - $attrs->{as} ||= [ - map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} - ]; + + $attrs->{select} = + ($attrs->{select} + ? (ref $attrs->{select} eq 'ARRAY' + ? [ @{$attrs->{select}} ] + : [ $attrs->{select} ]) + : [ map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} ] + ); + $attrs->{as} = + ($attrs->{as} + ? (ref $attrs->{as} eq 'ARRAY' + ? [ @{$attrs->{as}} ] + : [ $attrs->{as} ]) + : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} ] + ); my $adds; if ($adds = delete $attrs->{include_columns}) { @@ -1489,15 +1641,15 @@ sub _resolved_attrs { } if ($adds = delete $attrs->{'+select'}) { $adds = [$adds] unless ref $adds eq 'ARRAY'; - push(@{$attrs->{select}}, map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds); + push(@{$attrs->{select}}, + map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds); } if (my $adds = delete $attrs->{'+as'}) { $adds = [$adds] unless ref $adds eq 'ARRAY'; push(@{$attrs->{as}}, @$adds); } - $attrs->{from} ||= delete $attrs->{_parent_from} - || [ { 'me' => $source->from } ]; + $attrs->{from} ||= [ { 'me' => $source->from } ]; if (exists $attrs->{join} || exists $attrs->{prefetch}) { my $join = delete $attrs->{join} || {}; @@ -1508,25 +1660,31 @@ sub _resolved_attrs { ); } - push(@{$attrs->{from}}, - $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} }) - ); + $attrs->{from} = # have to copy here to avoid corrupting the original + [ + @{$attrs->{from}}, + $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} }) + ]; } $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct}; if ($attrs->{order_by}) { - $attrs->{order_by} = [ $attrs->{order_by} ] unless ref $attrs->{order_by}; + $attrs->{order_by} = (ref($attrs->{order_by}) eq 'ARRAY' + ? [ @{$attrs->{order_by}} ] + : [ $attrs->{order_by} ]); } else { - $attrs->{order_by} ||= []; + $attrs->{order_by} = []; } my $collapse = $attrs->{collapse} || {}; if (my $prefetch = delete $attrs->{prefetch}) { + $prefetch = $self->_merge_attr({}, $prefetch); my @pre_order; + my $seen = $attrs->{seen_join} || {}; foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) { # bring joins back to level of current class my @prefetch = $source->resolve_prefetch( - $p, $alias, { %{$attrs->{seen_join}||{}} }, \@pre_order, $collapse + $p, $alias, $seen, \@pre_order, $collapse ); push(@{$attrs->{select}}, map { $_->[0] } @prefetch); push(@{$attrs->{as}}, map { $_->[1] } @prefetch); @@ -1540,7 +1698,8 @@ sub _resolved_attrs { sub _merge_attr { my ($self, $a, $b) = @_; - return $b unless $a; + return $b unless defined($a); + return $a unless defined($b); if (ref $b eq 'HASH' && ref $a eq 'HASH') { foreach my $key (keys %{$b}) { @@ -1724,9 +1883,15 @@ use C instead: You can create your own accessors if required - see L for details. -Please note: This will NOT insert an C into the SQL statement -produced, it is used for internal access only. Thus attempting to use the accessor -in an C clause or similar will fail misrably. +Please note: This will NOT insert an C into the SQL +statement produced, it is used for internal access only. Thus +attempting to use the accessor in an C clause or similar +will fail miserably. + +To get around this limitation, you can supply literal SQL to your +C