X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet.pm;h=e8b36cbb2ac87c94e0fb6931df9200b8b4dd526a;hb=4e8964d53864dc5ce61100fcf1418520a935a520;hp=2e9fb33b7cdc572ec55a1412d3c12c7364eef280;hpb=493a7fb086a3004029329da737831af9c2cfb5dc;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm index 2e9fb33..e8b36cb 100644 --- a/lib/DBIx/Class/ResultSet.pm +++ b/lib/DBIx/Class/ResultSet.pm @@ -6,11 +6,12 @@ use overload '0+' => \&count, 'bool' => sub { 1; }, fallback => 1; +use Carp::Clan qw/^DBIx::Class/; use Data::Page; use Storable; -use Scalar::Util qw/weaken/; - +use DBIx::Class::ResultSetColumn; use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/AccessorGroup/); __PACKAGE__->mk_group_accessors('simple' => qw/result_source result_class/); @@ -55,7 +56,9 @@ In the examples below, the following table classes are used: =over 4 -=item Arguments: ($source, \%$attrs) +=item Arguments: $source, \%$attrs + +=item Return Value: $rs =back @@ -69,76 +72,20 @@ automatically get one from e.g. a L called in scalar context: my $rs = $schema->resultset('CD')->search({ title => '100th Window' }); +IMPORTANT: If called on an object, proxies to new_result instead so + + my $cd = $schema->resultset('CD')->new({ title => 'Spoon' }); + +will return a CD object, not a ResultSet. + =cut sub new { my $class = shift; return $class->new_result(@_) if ref $class; - - my ($source, $attrs) = @_; - weaken $source; - $attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } }; - #use Data::Dumper; warn Dumper($attrs); - my $alias = ($attrs->{alias} ||= 'me'); - - $attrs->{columns} ||= delete $attrs->{cols} if $attrs->{cols}; - delete $attrs->{as} if $attrs->{columns}; - $attrs->{columns} ||= [ $source->columns ] unless $attrs->{select}; - $attrs->{select} = [ - map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} - ] if $attrs->{columns}; - $attrs->{as} ||= [ - map { m/^\Q$alias.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} - ]; - if (my $include = delete $attrs->{include_columns}) { - push(@{$attrs->{select}}, @$include); - push(@{$attrs->{as}}, map { m/([^.]+)$/; $1; } @$include); - } - #use Data::Dumper; warn Dumper(@{$attrs}{qw/select as/}); - - $attrs->{from} ||= [ { $alias => $source->from } ]; - $attrs->{seen_join} ||= {}; - my %seen; - if (my $join = delete $attrs->{join}) { - foreach my $j (ref $join eq 'ARRAY' ? @$join : ($join)) { - if (ref $j eq 'HASH') { - $seen{$_} = 1 foreach keys %$j; - } else { - $seen{$j} = 1; - } - } - push(@{$attrs->{from}}, $source->resolve_join( - $join, $attrs->{alias}, $attrs->{seen_join}) - ); - } - - $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct}; - $attrs->{order_by} = [ $attrs->{order_by} ] if - $attrs->{order_by} and !ref($attrs->{order_by}); - $attrs->{order_by} ||= []; - my $collapse = $attrs->{collapse} || {}; - if (my $prefetch = delete $attrs->{prefetch}) { - my @pre_order; - foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) { - if ( ref $p eq 'HASH' ) { - foreach my $key (keys %$p) { - push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias})) - unless $seen{$key}; - } - } else { - push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias})) - unless $seen{$p}; - } - my @prefetch = $source->resolve_prefetch( - $p, $attrs->{alias}, {}, \@pre_order, $collapse); - push(@{$attrs->{select}}, map { $_->[0] } @prefetch); - push(@{$attrs->{as}}, map { $_->[1] } @prefetch); - } - push(@{$attrs->{order_by}}, @pre_order); - } - $attrs->{collapse} = $collapse; -# use Data::Dumper; warn Dumper($collapse) if keys %{$collapse}; + my ($source, $attrs) = @_; + #weaken $source; if ($attrs->{page}) { $attrs->{rows} ||= 10; @@ -146,14 +93,13 @@ sub new { $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1)); } + $attrs->{alias} ||= 'me'; + bless { result_source => $source, result_class => $attrs->{result_class} || $source->result_class, cond => $attrs->{where}, - from => $attrs->{from}, - collapse => $collapse, count => undef, - page => delete $attrs->{page}, pager => undef, attrs => $attrs }, $class; @@ -163,17 +109,20 @@ sub new { =over 4 -=item Arguments: (\%cond?, \%attrs?) +=item Arguments: $cond, \%attrs? -=item Returns: $resultset (scalar context), @row_objs (list context) +=item Return Value: $resultset (scalar context), @row_objs (list context) =back my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001" my $new_rs = $cd_rs->search({ year => 2005 }); + my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]); + # year = 2005 OR year = 2004 + If you need to pass in additional attributes but no additional condition, -call it as C. +call it as C. # "SELECT name, artistid FROM $artist_table" my @all_artists = $schema->resultset('Artist')->search(undef, { @@ -184,54 +133,97 @@ call it as C. sub search { my $self = shift; + my $rs = $self->search_rs( @_ ); + return (wantarray ? $rs->all : $rs); +} - my $rs; - if( @_ ) { - - my $attrs = { %{$self->{attrs}} }; - my $having = delete $attrs->{having}; - $attrs = { %$attrs, %{ pop(@_) } } if @_ > 1 and ref $_[$#_] eq 'HASH'; - - my $where = (@_ - ? ((@_ == 1 || ref $_[0] eq "HASH") - ? shift - : ((@_ % 2) - ? $self->throw_exception( - "Odd number of arguments to search") - : {@_})) - : undef()); - if (defined $where) { - $attrs->{where} = (defined $attrs->{where} - ? { '-and' => - [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ } - $where, $attrs->{where} ] } - : $where); - } +=head2 search_rs - if (defined $having) { - $attrs->{having} = (defined $attrs->{having} - ? { '-and' => - [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ } - $having, $attrs->{having} ] } - : $having); - } +=over 4 + +=item Arguments: $cond, \%attrs? + +=item Return Value: $resultset + +=back + +This method does the same exact thing as search() except it will +always return a resultset, even in list context. - $rs = (ref $self)->new($self->result_source, $attrs); +=cut + +sub search_rs { + my $self = shift; + + my $rows; + + unless (@_) { # no search, effectively just a clone + $rows = $self->get_cache; } - else { - $rs = $self; - $rs->reset; + + my $attrs = {}; + $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH'; + my $our_attrs = { %{$self->{attrs}} }; + my $having = delete $our_attrs->{having}; + + # 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}); } - return (wantarray ? $rs->all : $rs); + + my $new_attrs = { %{$our_attrs}, %{$attrs} }; + my $where = (@_ + ? ( + (@_ == 1 || ref $_[0] eq "HASH") + ? shift + : ( + (@_ % 2) + ? $self->throw_exception("Odd number of arguments to search") + : {@_} + ) + ) + : undef + ); + + if (defined $where) { + $new_attrs->{where} = ( + defined $new_attrs->{where} + ? { '-and' => [ + map { + ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ + } $where, $new_attrs->{where} + ] + } + : $where); + } + + if (defined $having) { + $new_attrs->{having} = ( + defined $new_attrs->{having} + ? { '-and' => [ + map { + ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ + } $having, $new_attrs->{having} + ] + } + : $having); + } + + my $rs = (ref $self)->new($self->result_source, $new_attrs); + if ($rows) { + $rs->set_cache($rows); + } + return $rs; } =head2 search_literal =over 4 -=item Arguments: ($literal_cond, @bind?) +=item Arguments: $sql_fragment, @bind_values -=item Returns: $resultset (scalar context), @row_objs (list context) +=item Return Value: $resultset (scalar context), @row_objs (list context) =back @@ -254,79 +246,148 @@ sub search_literal { =over 4 -=item Arguments: (@colvalues) | (\%cols, \%attrs?) +=item Arguments: @values | \%cols, \%attrs? -=item Returns: $row_object +=item Return Value: $row_object =back -Finds a row based on its primary key or unique constraint. For example: +Finds a row based on its primary key or unique constraint. For example, to find +a row by its primary key: my $cd = $schema->resultset('CD')->find(5); -Also takes an optional C attribute, to search by a specific key or unique -constraint. For example: +You can also find a row by a specific unique constraint using the C +attribute. For example: + + my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', { + key => 'cd_artist_title' + }); + +Additionally, you can specify the columns explicitly by name: my $cd = $schema->resultset('CD')->find( { artist => 'Massive Attack', title => 'Mezzanine', }, - { key => 'artist_title' } + { key => 'cd_artist_title' } ); -See also L and L. +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. + +See also L and L. For information on how to +declare unique constraints, see +L. =cut sub find { - my ($self, @vals) = @_; - my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {}); + my $self = shift; + my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}); - my @cols = $self->result_source->primary_columns; - if (exists $attrs->{key}) { - my %uniq = $self->result_source->unique_constraints; - $self->throw_exception( - "Unknown key $attrs->{key} on '" . $self->result_source->name . "'" - ) unless exists $uniq{$attrs->{key}}; - @cols = @{ $uniq{$attrs->{key}} }; - } - #use Data::Dumper; warn Dumper($attrs, @vals, @cols); + # Default to the primary key, but allow a specific key + my @cols = exists $attrs->{key} + ? $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" ) unless @cols; - my $query; - if (ref $vals[0] eq 'HASH') { - $query = { %{$vals[0]} }; - } elsif (@cols == @vals) { - $query = {}; - @{$query}{@cols} = @vals; - } else { - $query = {@vals}; + # Parse out a hashref from input + my $input_query; + if (ref $_[0] eq 'HASH') { + $input_query = { %{$_[0]} }; } - foreach my $key (grep { ! m/\./ } keys %$query) { - $query->{"$self->{attrs}{alias}.$key"} = delete $query->{$key}; + elsif (@_ == @cols) { + $input_query = {}; + @{$input_query}{@cols} = @_; } - #warn Dumper($query); - + else { + # Compatibility: Allow e.g. find(id => $value) + carp "Find by key => value deprecated; please use a hashref instead"; + $input_query = {@_}; + } + + 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; + + # Run the query if (keys %$attrs) { - my $rs = $self->search($query,$attrs); - return keys %{$rs->{collapse}} ? $rs->next : $rs->single; - } else { - return keys %{$self->{collapse}} ? - $self->search($query)->next : - $self->single($query); + my $rs = $self->search($query, $attrs); + return keys %{$rs->_resolved_attrs->{collapse}} ? $rs->next : $rs->single; + } + else { + return keys %{$self->_resolved_attrs->{collapse}} + ? $self->search($query)->next + : $self->single($query); + } +} + +# _unique_queries +# +# Build a list of queries which satisfy unique constraints. + +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 @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_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}; + } + + # 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; +} + +# _build_unique_query +# +# Constrain the specified query hash based on the specified column names. + +sub _build_unique_query { + my ($self, $query, $unique_cols) = @_; + + return { + map { $_ => $query->{$_} } + grep { exists $query->{$_} } + @$unique_cols + }; } =head2 search_related =over 4 -=item Arguments: (\%cond?, \%attrs?) +=item Arguments: $rel, $cond, \%attrs? -=item Returns: $new_resultset +=item Return Value: $new_resultset =back @@ -334,7 +395,7 @@ sub find { name => 'Emo-R-Us', }); -Search the specified relationship, optionally specify a condition and +Searches the specified relationship, optionally specifying a condition and attributes for matching records. See L for more information. =cut @@ -347,9 +408,9 @@ sub search_related { =over 4 -=item Arguments: (none) +=item Arguments: none -=item Returns: $cursor +=item Return Value: $cursor =back @@ -360,9 +421,10 @@ L for more information. sub cursor { my ($self) = @_; - my $attrs = { %{$self->{attrs}} }; + + my $attrs = { %{$self->_resolved_attrs} }; return $self->{cursor} - ||= $self->result_source->storage->select($self->{from}, $attrs->{select}, + ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select}, $attrs->{where},$attrs); } @@ -370,25 +432,30 @@ sub cursor { =over 4 -=item Arguments: (\%cond) +=item Arguments: $cond? -=item Returns: $row_object +=item Return Value: $row_object? =back my $cd = $schema->resultset('CD')->single({ year => 2001 }); -Inflates the first result without creating a cursor. +Inflates the first result without creating a cursor if the resultset has +any records in it; if not returns nothing. Used by L as an optimisation. + +Can optionally take an additional condition *only* - this is a fast-code-path +method; if you need to add extra joins or similar call ->search and then +->single without a condition on the $rs returned from that. =cut sub single { my ($self, $where) = @_; - my $attrs = { %{$self->{attrs}} }; + my $attrs = { %{$self->_resolved_attrs} }; if ($where) { if (defined $attrs->{where}) { $attrs->{where} = { - '-and' => + '-and' => [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ } $where, delete $attrs->{where} ] }; @@ -396,27 +463,123 @@ sub single { $attrs->{where} = $where; } } + + 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( - $self->{from}, $attrs->{select}, - $attrs->{where},$attrs); + $attrs->{from}, $attrs->{select}, + $attrs->{where}, $attrs + ); + return (@data ? $self->_construct_object(@data) : ()); } +# _is_unique_query +# +# Try to determine if the specified query is guaranteed to be unique, based on +# the declared unique constraints. + +sub _is_unique_query { + my ($self, $query) = @_; + + my $collapsed = $self->_collapse_query($query); + my $alias = $self->{attrs}{alias}; + + foreach my $name ($self->result_source->unique_constraint_names) { + my @unique_cols = map { + "$alias.$_" + } $self->result_source->unique_constraint_columns($name); + + # Count the values for each unique column + my %seen = map { $_ => 0 } @unique_cols; + + foreach my $key (keys %$collapsed) { + my $aliased = $key =~ /\./ ? $key : "$alias.$key"; + next unless exists $seen{$aliased}; # Additional constraints are okay + $seen{$aliased} = scalar keys %{ $collapsed->{$key} }; + } + + # If we get 0 or more than 1 value for a column, it's not necessarily unique + return 1 unless grep { $_ != 1 } values %seen; + } + + return 0; +} + +# _collapse_query +# +# Recursively collapse the query, accumulating values for each column. + +sub _collapse_query { + my ($self, $query, $collapsed) = @_; + + $collapsed ||= {}; + + if (ref $query eq 'ARRAY') { + foreach my $subquery (@$query) { + next unless ref $subquery; # -or +# warn "ARRAY: " . Dumper $subquery; + $collapsed = $self->_collapse_query($subquery, $collapsed); + } + } + elsif (ref $query eq 'HASH') { + if (keys %$query and (keys %$query)[0] eq '-and') { + foreach my $subquery (@{$query->{-and}}) { +# warn "HASH: " . Dumper $subquery; + $collapsed = $self->_collapse_query($subquery, $collapsed); + } + } + else { +# warn "LEAF: " . Dumper $query; + foreach my $col (keys %$query) { + my $value = $query->{$col}; + $collapsed->{$col}{$value}++; + } + } + } + + return $collapsed; +} + +=head2 get_column + +=over 4 + +=item Arguments: $cond? + +=item Return Value: $resultsetcolumn + +=back + + my $max_length = $rs->get_column('length')->max; + +Returns a ResultSetColumn instance for $column based on $self + +=cut + +sub get_column { + my ($self, $column) = @_; + my $new = DBIx::Class::ResultSetColumn->new($self, $column); + return $new; +} =head2 search_like =over 4 -=item Arguments: (\%cond?, \%attrs?) +=item Arguments: $cond, \%attrs? -=item Returns: $resultset (scalar context), @row_objs (list context) +=item Return Value: $resultset (scalar context), @row_objs (list context) =back # WHERE title LIKE '%blue%' $cd_rs = $rs->search_like({ title => '%blue%'}); -Perform a search, but use C instead of C<=> as the condition. Note +Performs a search, but uses C instead of C<=> as the condition. Note that this is simply a convenience method. You most likely want to use L with specific operators. @@ -436,28 +599,41 @@ sub search_like { =over 4 -=item Arguments: ($first, $last) +=item Arguments: $first, $last -=item Returns: $resultset (scalar context), @row_objs (list context) +=item Return Value: $resultset (scalar context), @row_objs (list context) =back -Returns a subset of elements from the resultset. +Returns a resultset or object list representing a subset of elements from the +resultset slice is called on. Indexes are from 0, i.e., to get the first +three records, call: + + my ($one, $two, $three) = $rs->slice(0, 2); =cut sub slice { my ($self, $min, $max) = @_; - my $attrs = { %{ $self->{attrs} || {} } }; - $attrs->{offset} ||= 0; + my $attrs = {}; # = { %{ $self->{attrs} || {} } }; + $attrs->{offset} = $self->{attrs}{offset} || 0; $attrs->{offset} += $min; $attrs->{rows} = ($max ? ($max - $min + 1) : 1); - my $slice = (ref $self)->new($self->result_source, $attrs); - return (wantarray ? $slice->all : $slice); + return $self->search(undef(), $attrs); + #my $slice = (ref $self)->new($self->result_source, $attrs); + #return (wantarray ? $slice->all : $slice); } =head2 next +=over 4 + +=item Arguments: none + +=item Return Value: $result? + +=back + Returns the next element in the resultset (C is there is none). Can be used to efficiently iterate over records in the resultset: @@ -467,37 +643,37 @@ Can be used to efficiently iterate over records in the resultset: print $cd->title; } +Note that you need to store the resultset object, and call C on it. +Calling C<< resultset('Table')->next >> repeatedly will always return the +first record from the resultset. + =cut sub next { my ($self) = @_; - if (@{$self->{all_cache} || []}) { + if (my $cache = $self->get_cache) { $self->{all_cache_position} ||= 0; - return $self->{all_cache}->[$self->{all_cache_position}++]; + return $cache->[$self->{all_cache_position}++]; } if ($self->{attrs}{cache}) { $self->{all_cache_position} = 1; return ($self->all)[0]; } - my @row = (exists $self->{stashed_row} ? - @{delete $self->{stashed_row}} : - $self->cursor->next + my @row = ( + exists $self->{stashed_row} + ? @{delete $self->{stashed_row}} + : $self->cursor->next ); -# warn Dumper(\@row); use Data::Dumper; return unless (@row); return $self->_construct_object(@row); } sub _construct_object { my ($self, @row) = @_; - my @as = @{ $self->{attrs}{as} }; - - my $info = $self->_collapse_result(\@as, \@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) - if exists $self->{attrs}{record_filter}; + $new = $self->{_attrs}{record_filter}->($new) + if exists $self->{_attrs}{record_filter}; return $new; } @@ -505,8 +681,8 @@ sub _collapse_result { my ($self, $as, $row, $prefix) = @_; my %const; - my @copy = @$row; + foreach my $this_as (@$as) { my $val = shift @copy; if (defined $prefix) { @@ -521,9 +697,10 @@ sub _collapse_result { } } + my $alias = $self->{attrs}{alias}; my $info = [ {}, {} ]; foreach my $key (keys %const) { - if (length $key) { + if (length $key && $key ne $alias) { my $target = $info; my @parts = split(/\./, $key); foreach my $p (@parts) { @@ -534,14 +711,14 @@ sub _collapse_result { $info->[0] = $const{$key}; } } - + my @collapse; if (defined $prefix) { @collapse = map { - m/^\Q${prefix}.\E(.+)$/ ? ($1) : () - } keys %{$self->{collapse}} + m/^\Q${prefix}.\E(.+)$/ ? ($1) : () + } keys %{$self->{_attrs}{collapse}} } else { - @collapse = keys %{$self->{collapse}}; + @collapse = keys %{$self->{_attrs}{collapse}}; }; if (@collapse) { @@ -551,35 +728,57 @@ sub _collapse_result { $target = $target->[1]->{$p} ||= []; } my $c_prefix = (defined($prefix) ? "${prefix}.${c}" : $c); - my @co_key = @{$self->{collapse}{$c_prefix}}; - my %co_check = map { ($_, $target->[0]->{$_}); } @co_key; + my @co_key = @{$self->{_attrs}{collapse}{$c_prefix}}; my $tree = $self->_collapse_result($as, $row, $c_prefix); + my %co_check = map { ($_, $tree->[0]->{$_}); } @co_key; my (@final, @raw); - while ( !(grep { - !defined($tree->[0]->{$_}) || - $co_check{$_} ne $tree->[0]->{$_} - } @co_key) ) { + + while ( + !( + grep { + !defined($tree->[0]->{$_}) || $co_check{$_} ne $tree->[0]->{$_} + } @co_key + ) + ) { push(@final, $tree); last unless (@raw = $self->cursor->next); $row = $self->{stashed_row} = \@raw; $tree = $self->_collapse_result($as, $row, $c_prefix); - #warn Data::Dumper::Dumper($tree, $row); } - @$target = @final; + @$target = (@final ? @final : [ {}, {} ]); + # single empty result to indicate an empty prefetched has_many } + #print "final info: " . Dumper($info); return $info; } =head2 result_source -Returns a reference to the result source for this recordset. +=over 4 + +=item Arguments: $result_source? + +=item Return Value: $result_source + +=back + +An accessor for the primary ResultSource object from which this ResultSet +is derived. =cut =head2 count +=over 4 + +=item Arguments: $cond, \%attrs?? + +=item Return Value: $count + +=back + Performs an SQL C with the same query as the resultset was built with to find the number of elements. If passed arguments, does a search on the resultset and counts the results of that. @@ -595,8 +794,7 @@ clause. sub count { my $self = shift; return $self->search(@_)->count if @_ and defined $_[0]; - return scalar @{ $self->get_cache } if @{ $self->get_cache }; - + return scalar @{ $self->get_cache } if $self->get_cache; my $count = $self->_count; return 0 unless $count; @@ -609,23 +807,24 @@ sub count { sub _count { # Separated out so pager can get the full count my $self = shift; my $select = { count => '*' }; - my $attrs = { %{ $self->{attrs} } }; + + my $attrs = { %{$self->_resolved_attrs} }; if (my $group_by = delete $attrs->{group_by}) { delete $attrs->{having}; my @distinct = (ref $group_by ? @$group_by : ($group_by)); # todo: try CONCAT for multi-column pk my @pk = $self->result_source->primary_columns; if (@pk == 1) { + my $alias = $attrs->{alias}; foreach my $column (@distinct) { - if ($column =~ qr/^(?:\Q$attrs->{alias}.\E)?$pk[0]$/) { + if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) { @distinct = ($column); last; } - } + } } $select = { count => { distinct => \@distinct } }; - #use Data::Dumper; die Dumper $select; } $attrs->{select} = $select; @@ -633,13 +832,22 @@ sub _count { # Separated out so pager can get the full count # offset, order by and page are not needed to count. record_filter is cdbi delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/; - - my ($count) = (ref $self)->new($self->result_source, $attrs)->cursor->next; + + my $tmp_rs = (ref $self)->new($self->result_source, $attrs); + my ($count) = $tmp_rs->cursor->next; return $count; } =head2 count_literal +=over 4 + +=item Arguments: $sql_fragment, @bind_values + +=item Return Value: $count + +=back + Counts the results in a literal query. Equivalent to calling L with the passed arguments, then L. @@ -649,6 +857,14 @@ sub count_literal { shift->search_literal(@_)->count; } =head2 all +=over 4 + +=item Arguments: none + +=item Return Value: @objects + +=back + Returns all elements in the resultset. Called implicitly if the resultset is returned in list context. @@ -656,16 +872,17 @@ is returned in list context. sub all { my ($self) = @_; - return @{ $self->get_cache } if @{ $self->get_cache }; + return @{ $self->get_cache } if $self->get_cache; my @obj; - if (keys %{$self->{collapse}}) { + # TODO: don't call resolve here + if (keys %{$self->_resolved_attrs->{collapse}}) { +# if ($self->{attrs}{prefetch}) { # Using $self->cursor->all is really just an optimisation. # If we're collapsing has_many prefetches it probably makes # very little difference, and this is cleaner than hacking # _construct_object to survive the approach - $self->cursor->reset; my @row = $self->cursor->next; while (@row) { push(@obj, $self->_construct_object(@row)); @@ -683,12 +900,21 @@ sub all { =head2 reset +=over 4 + +=item Arguments: none + +=item Return Value: $self + +=back + Resets the resultset's cursor, so you can iterate through the elements again. =cut sub reset { my ($self) = @_; + delete $self->{_attrs} if exists $self->{_attrs}; $self->{all_cache_position} = 0; $self->cursor->reset; return $self; @@ -696,7 +922,16 @@ sub reset { =head2 first -Resets the resultset and returns the first element. +=over 4 + +=item Arguments: none + +=item Return Value: $object? + +=back + +Resets the resultset and returns an object for the first result (if the +resultset returns anything). =cut @@ -704,15 +939,84 @@ sub first { return $_[0]->reset->next; } +# _cond_for_update_delete +# +# update/delete require the condition to be modified to handle +# the differing SQL syntax available. This transforms the $self->{cond} +# appropriately, returning the new condition. + +sub _cond_for_update_delete { + my ($self) = @_; + my $cond = {}; + + # No-op. No condition, we're updating/deleting everything + return $cond unless ref $self->{cond}; + + if (ref $self->{cond} eq 'ARRAY') { + $cond = [ + map { + my %hash; + foreach my $key (keys %{$_}) { + $key =~ /([^.]+)$/; + $hash{$1} = $_->{$key}; + } + \%hash; + } @{$self->{cond}} + ]; + } + elsif (ref $self->{cond} eq 'HASH') { + if ((keys %{$self->{cond}})[0] eq '-and') { + $cond->{-and} = []; + + my @cond = @{$self->{cond}{-and}}; + for (my $i = 0; $i < @cond; $i++) { + my $entry = $cond[$i]; + + my %hash; + if (ref $entry eq 'HASH') { + foreach my $key (keys %{$entry}) { + $key =~ /([^.]+)$/; + $hash{$1} = $entry->{$key}; + } + } + else { + $entry =~ /([^.]+)$/; + $hash{$1} = $cond[++$i]; + } + + push @{$cond->{-and}}, \%hash; + } + } + else { + foreach my $key (keys %{$self->{cond}}) { + $key =~ /([^.]+)$/; + $cond->{$1} = $self->{cond}{$key}; + } + } + } + else { + $self->throw_exception( + "Can't update/delete on resultset with condition unless hash or array" + ); + } + + return $cond; +} + + =head2 update =over 4 -=item Arguments: (\%values) +=item Arguments: \%values + +=item Return Value: $storage_rv =back -Sets the specified columns in the resultset to the supplied values. +Sets the specified columns in the resultset to the supplied values in a +single query. Return value will be true if the update succeeded or false +if no records were updated; exact type of success value is storage-dependent. =cut @@ -720,8 +1024,11 @@ sub update { my ($self, $values) = @_; $self->throw_exception("Values for update must be a hash") unless ref $values eq 'HASH'; + + my $cond = $self->_cond_for_update_delete; + return $self->result_source->storage->update( - $self->result_source->from, $values, $self->{cond} + $self->result_source->from, $values, $cond ); } @@ -729,12 +1036,14 @@ sub update { =over 4 -=item Arguments: (\%values) +=item Arguments: \%values + +=item Return Value: 1 =back -Fetches all objects and updates them one at a time. Note that C -will run cascade triggers while L will not. +Fetches all objects and updates them one at a time. Note that C +will run DBIC cascade triggers, while L will not. =cut @@ -750,59 +1059,41 @@ sub update_all { =head2 delete +=over 4 + +=item Arguments: none + +=item Return Value: 1 + +=back + Deletes the contents of the resultset from its result source. Note that this -will not run cascade triggers. See L if you need triggers to run. +will not run DBIC cascade triggers. See L if you need triggers +to run. =cut sub delete { my ($self) = @_; - my $del = {}; - if (!ref($self->{cond})) { + my $cond = $self->_cond_for_update_delete; - # No-op. No condition, we're deleting everything + $self->result_source->storage->delete($self->result_source->from, $cond); + return 1; +} - } elsif (ref $self->{cond} eq 'ARRAY') { +=head2 delete_all - $del = [ map { my %hash; - foreach my $key (keys %{$_}) { - $key =~ /([^.]+)$/; - $hash{$1} = $_->{$key}; - }; \%hash; } @{$self->{cond}} ]; +=over 4 - } elsif (ref $self->{cond} eq 'HASH') { +=item Arguments: none - if ((keys %{$self->{cond}})[0] eq '-and') { +=item Return Value: 1 - $del->{-and} = [ map { my %hash; - foreach my $key (keys %{$_}) { - $key =~ /([^.]+)$/; - $hash{$1} = $_->{$key}; - }; \%hash; } @{$self->{cond}{-and}} ]; - - } else { - - foreach my $key (keys %{$self->{cond}}) { - $key =~ /([^.]+)$/; - $del->{$1} = $self->{cond}{$key}; - } - } - - } else { - $self->throw_exception( - "Can't delete on resultset with condition unless hash or array" - ); - } - - $self->result_source->storage->delete($self->result_source->from, $del); - return 1; -} - -=head2 delete_all +=back -Fetches all objects and deletes them one at a time. Note that C -will run cascade triggers while L will not. +Fetches all objects and deletes them one at a time. Note that C +will run DBIC cascade triggers, while L will not. =cut @@ -814,7 +1105,15 @@ sub delete_all { =head2 pager -Returns a L object for the current resultset. Only makes +=over 4 + +=item Arguments: none + +=item Return Value: $pager + +=back + +Return Value a L object for the current resultset. Only makes sense for queries with a C attribute. =cut @@ -823,40 +1122,44 @@ sub pager { my ($self) = @_; my $attrs = $self->{attrs}; $self->throw_exception("Can't create pager for non-paged rs") - unless $self->{page}; + unless $self->{attrs}{page}; $attrs->{rows} ||= 10; return $self->{pager} ||= Data::Page->new( - $self->_count, $attrs->{rows}, $self->{page}); + $self->_count, $attrs->{rows}, $self->{attrs}{page}); } =head2 page =over 4 -=item Arguments: ($page_num) +=item Arguments: $page_number + +=item Return Value: $rs =back -Returns a new resultset for the specified page. +Returns a resultset for the $page_number page of the resultset on which page +is called, where each page contains a number of rows equal to the 'rows' +attribute set on the resultset (10 by default). =cut sub page { my ($self, $page) = @_; - my $attrs = { %{$self->{attrs}} }; - $attrs->{page} = $page; - return (ref $self)->new($self->result_source, $attrs); + return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page }); } =head2 new_result =over 4 -=item Arguments: (\%vals) +=item Arguments: \%vals + +=item Return Value: $object =back -Creates a result in the resultset's result class. +Creates an object in the resultset's result class and returns it. =cut @@ -877,15 +1180,43 @@ sub new_result { return $obj; } +=head2 find_or_new + +=over 4 + +=item Arguments: \%vals, \%attrs? + +=item Return Value: $object + +=back + +Find an existing record from this resultset. If none exists, instantiate a new +result object and return it. The object will not be saved into your storage +until you call L on it. + +If you want objects to be saved immediately, use L instead. + +=cut + +sub find_or_new { + my $self = shift; + my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}); + my $hash = ref $_[0] eq 'HASH' ? shift : {@_}; + my $exists = $self->find($hash, $attrs); + return defined $exists ? $exists : $self->new_result($hash); +} + =head2 create =over 4 -=item Arguments: (\%vals) +=item Arguments: \%vals + +=item Return Value: $object =back -Inserts a record into the resultset and returns the object. +Inserts a record into the resultset and returns the object representing it. Effectively a shortcut for C<< ->new_result(\%vals)->insert >>. @@ -902,14 +1233,16 @@ sub create { =over 4 -=item Arguments: (\%vals, \%attrs?) +=item Arguments: \%vals, \%attrs? + +=item Return Value: $object =back $class->find_or_create({ key => $val, ... }); -Searches for a record matching the search condition; if it doesn't find one, -creates one and returns that instead. +Tries to find a record based on its primary key or unique constraint; if none +is found, creates one and returns that instead. my $cd = $schema->resultset('CD')->find_or_create({ cdid => 5, @@ -926,10 +1259,11 @@ constraint. For example: artist => 'Massive Attack', title => 'Mezzanine', }, - { key => 'artist_title' } + { key => 'cd_artist_title' } ); -See also L and L. +See also L and L. For information on how to declare +unique constraints, see L. =cut @@ -943,11 +1277,19 @@ sub find_or_create { =head2 update_or_create - $class->update_or_create({ key => $val, ... }); +=over 4 -First, search for an existing row matching one of the unique constraints -(including the primary key) on the source of this resultset. If a row is -found, update it with the other given column values. Otherwise, create a new +=item Arguments: \%col_values, { key => $unique_constraint }? + +=item Return Value: $object + +=back + + $class->update_or_create({ col => $val, ... }); + +First, searches for an existing row matching one of the unique constraints +(including the primary key) on the source of this resultset. If a row is +found, updates it with the other given column values. Otherwise, creates a new row. Takes an optional C attribute to search on a specific unique constraint. @@ -960,94 +1302,103 @@ For example: title => 'Mezzanine', year => 1998, }, - { key => 'artist_title' } + { key => 'cd_artist_title' } ); If no C is specified, it searches on all unique constraints defined on the source, including the primary key. -If the C is specified as C, search only on the primary key. +If the C is specified as C, it searches only on the primary key. -See also L and L. +See also L and L. For information on how to declare +unique constraints, see L. =cut sub update_or_create { my $self = shift; my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {}); - my $hash = ref $_[0] eq 'HASH' ? shift : {@_}; - - my %unique_constraints = $self->result_source->unique_constraints; - my @constraint_names = (exists $attrs->{key} - ? ($attrs->{key}) - : keys %unique_constraints); - - my @unique_hashes; - foreach my $name (@constraint_names) { - my @unique_cols = @{ $unique_constraints{$name} }; - my %unique_hash = - map { $_ => $hash->{$_} } - grep { exists $hash->{$_} } - @unique_cols; - - push @unique_hashes, \%unique_hash - if (scalar keys %unique_hash == scalar @unique_cols); - } + my $cond = ref $_[0] eq 'HASH' ? shift : {@_}; - if (@unique_hashes) { - my $row = $self->single(\@unique_hashes); - if (defined $row) { - $row->set_columns($hash); - $row->update; - return $row; - } + my $row = $self->find($cond); + if (defined $row) { + $row->update($cond); + return $row; } - return $self->create($hash); + return $self->create($cond); } =head2 get_cache -Gets the contents of the cache for the resultset. +=over 4 + +=item Arguments: none + +=item Return Value: \@cache_objects? + +=back + +Gets the contents of the cache for the resultset, if the cache is set. =cut sub get_cache { - shift->{all_cache} || []; + shift->{all_cache}; } =head2 set_cache +=over 4 + +=item Arguments: \@cache_objects + +=item Return Value: \@cache_objects + +=back + Sets the contents of the cache for the resultset. Expects an arrayref -of objects of the same class as those produced by the resultset. +of objects of the same class as those produced by the resultset. Note that +if the cache is set the resultset will return the cached objects rather +than re-querying the database even if the cache attr is not set. =cut sub set_cache { my ( $self, $data ) = @_; $self->throw_exception("set_cache requires an arrayref") - if ref $data ne 'ARRAY'; - my $result_class = $self->result_class; - foreach( @$data ) { - $self->throw_exception( - "cannot cache object of type '$_', expected '$result_class'" - ) if ref $_ ne $result_class; - } + if defined($data) && (ref $data ne 'ARRAY'); $self->{all_cache} = $data; } =head2 clear_cache +=over 4 + +=item Arguments: none + +=item Return Value: [] + +=back + Clears the cache for the resultset. =cut sub clear_cache { - shift->set_cache([]); + shift->set_cache(undef); } =head2 related_resultset +=over 4 + +=item Arguments: $relationship_name + +=item Return Value: $resultset + +=back + Returns a related resultset for the supplied relationship name. $artist_rs = $schema->resultset('CD')->related_resultset('Artist'); @@ -1055,35 +1406,183 @@ Returns a related resultset for the supplied relationship name. =cut sub related_resultset { - my ( $self, $rel, @rest ) = @_; + my ($self, $rel) = @_; + $self->{related_resultsets} ||= {}; return $self->{related_resultsets}{$rel} ||= do { - #warn "fetching related resultset for rel '$rel'"; - my $rel_obj = $self->result_source->relationship_info($rel); - $self->throw_exception( - "search_related: result source '" . $self->result_source->name . - "' has no such relationship ${rel}") - unless $rel_obj; #die Dumper $self->{attrs}; - - my $rs = $self->search(undef, { join => $rel }); - my $alias = defined $rs->{attrs}{seen_join}{$rel} - && $rs->{attrs}{seen_join}{$rel} > 1 - ? join('_', $rel, $rs->{attrs}{seen_join}{$rel}) - : $rel; - - $self->result_source->schema->resultset($rel_obj->{class} - )->search( undef, - { %{$rs->{attrs}}, - alias => $alias, - select => undef, - as => undef } - )->search(@rest); + my $rel_obj = $self->result_source->relationship_info($rel); + + $self->throw_exception( + "search_related: result source '" . $self->result_source->name . + "' has no such relationship $rel") + unless $rel_obj; + + my ($from,$seen) = $self->_resolve_from($rel); + + my $join_count = $seen->{$rel}; + my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel); + + $self->result_source->schema->resultset($rel_obj->{class})->search_rs( + undef, { + %{$self->{attrs}||{}}, + join => undef, + prefetch => undef, + select => undef, + as => undef, + alias => $alias, + where => $self->{cond}, + seen_join => $seen, + from => $from, + }); }; } +sub _resolve_from { + my ($self, $extra_join) = @_; + my $source = $self->result_source; + my $attrs = $self->{attrs}; + + my $from = $attrs->{from} + || [ { $attrs->{alias} => $source->from } ]; + + my $seen = { %{$attrs->{seen_join}||{}} }; + + my $join = ($attrs->{join} + ? [ $attrs->{join}, $extra_join ] + : $extra_join); + push(@{$from}, + $source->resolve_join($join, $attrs->{alias}, $seen) + ); + + return ($from,$seen); +} + +sub _resolved_attrs { + my $self = shift; + return $self->{_attrs} if $self->{_attrs}; + + my $attrs = { %{$self->{attrs}||{}} }; + my $source = $self->{result_source}; + my $alias = $attrs->{alias}; + + $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols}; + if ($attrs->{columns}) { + delete $attrs->{as}; + } 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}} + ]; + + my $adds; + if ($adds = delete $attrs->{include_columns}) { + $adds = [$adds] unless ref $adds eq 'ARRAY'; + push(@{$attrs->{select}}, @$adds); + push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds); + } + if ($adds = delete $attrs->{'+select'}) { + $adds = [$adds] unless ref $adds eq 'ARRAY'; + 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} ||= [ { 'me' => $source->from } ]; + + if (exists $attrs->{join} || exists $attrs->{prefetch}) { + my $join = delete $attrs->{join} || {}; + + if (defined $attrs->{prefetch}) { + $join = $self->_merge_attr( + $join, $attrs->{prefetch} + ); + } + + $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}; + } else { + $attrs->{order_by} ||= []; + } + + my $collapse = $attrs->{collapse} || {}; + if (my $prefetch = delete $attrs->{prefetch}) { + my @pre_order; + 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 + ); + push(@{$attrs->{select}}, map { $_->[0] } @prefetch); + push(@{$attrs->{as}}, map { $_->[1] } @prefetch); + } + push(@{$attrs->{order_by}}, @pre_order); + } + $attrs->{collapse} = $collapse; + + return $self->{_attrs} = $attrs; +} + +sub _merge_attr { + my ($self, $a, $b) = @_; + return $b unless $a; + + if (ref $b eq 'HASH' && ref $a eq 'HASH') { + foreach my $key (keys %{$b}) { + if (exists $a->{$key}) { + $a->{$key} = $self->_merge_attr($a->{$key}, $b->{$key}); + } else { + $a->{$key} = $b->{$key}; + } + } + return $a; + } else { + $a = [$a] unless ref $a eq 'ARRAY'; + $b = [$b] unless ref $b eq 'ARRAY'; + + my $hash = {}; + my @array; + foreach my $x ($a, $b) { + foreach my $element (@{$x}) { + if (ref $element eq 'HASH') { + $hash = $self->_merge_attr($hash, $element); + } elsif (ref $element eq 'ARRAY') { + push(@array, @{$element}); + } else { + push(@array, $element) unless $b == $x + && grep { $_ eq $element } @array; + } + } + } + + @array = grep { !exists $hash->{$_} } @array; + + return keys %{$hash} + ? ( scalar(@array) + ? [$hash, @array] + : $hash + ) + : \@array; + } +} + =head2 throw_exception -See Schema's throw_exception +See L for details. =cut @@ -1092,24 +1591,35 @@ sub throw_exception { $self->result_source->schema->throw_exception(@_); } -=head1 ATTRIBUTES +# XXX: FIXME: Attributes docs need clearing up -XXX: FIXME: Attributes docs need clearing up +=head1 ATTRIBUTES The resultset takes various attributes that modify its behavior. Here's an overview of them: =head2 order_by +=over 4 + +=item Value: ($order_by | \@order_by) + +=back + Which column(s) to order the results by. This is currently passed through directly to SQL, so you can give e.g. C for a descending order on the column `year'. +Please note that if you have quoting enabled (see +L) you will need to do C<\'year DESC' > to +specify an order. (The scalar ref causes it to be passed as raw sql to the DB, +so you will need to manually quote things as appropriate.) + =head2 columns =over 4 -=item Arguments: (\@columns) +=item Value: \@columns =back @@ -1122,7 +1632,7 @@ use the C attribute, as in earlier versions of DBIC.) =over 4 -=item Arguments: (\@columns) +=item Value: \@columns =back @@ -1140,7 +1650,7 @@ passed to object inflation =over 4 -=item Arguments: (\@columns) +=item Value: \@select_columns =back @@ -1160,11 +1670,28 @@ When you use function/stored procedure names and do not supply an C attribute, the column names returned are storage-dependent. E.g. MySQL would return a column named C in the above example. +=head2 +select + +=over 4 + +Indicates additional columns to be selected from storage. Works the same as +L