1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use Scalar::Util qw/weaken/;
13 use DBIx::Class::ResultSetColumn;
14 use base qw/DBIx::Class/;
15 __PACKAGE__->load_components(qw/AccessorGroup/);
16 __PACKAGE__->mk_group_accessors('simple' => qw/result_source result_class/);
20 DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
24 my $rs = $schema->resultset('User')->search(registered => 1);
25 my @rows = $schema->resultset('CD')->search(year => 2005);
29 The resultset is also known as an iterator. It is responsible for handling
30 queries that may return an arbitrary number of rows, e.g. via L</search>
31 or a C<has_many> relationship.
33 In the examples below, the following table classes are used:
35 package MyApp::Schema::Artist;
36 use base qw/DBIx::Class/;
37 __PACKAGE__->load_components(qw/Core/);
38 __PACKAGE__->table('artist');
39 __PACKAGE__->add_columns(qw/artistid name/);
40 __PACKAGE__->set_primary_key('artistid');
41 __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
44 package MyApp::Schema::CD;
45 use base qw/DBIx::Class/;
46 __PACKAGE__->load_components(qw/Core/);
47 __PACKAGE__->table('cd');
48 __PACKAGE__->add_columns(qw/cdid artist title year/);
49 __PACKAGE__->set_primary_key('cdid');
50 __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
59 =item Arguments: $source, \%$attrs
61 =item Return Value: $rs
65 The resultset constructor. Takes a source object (usually a
66 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
67 L</ATTRIBUTES> below). Does not perform any queries -- these are
68 executed as needed by the other methods.
70 Generally you won't need to construct a resultset manually. You'll
71 automatically get one from e.g. a L</search> called in scalar context:
73 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
75 IMPORTANT: If called on an object, proxies to new_result instead so
77 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
79 will return a CD object, not a ResultSet.
85 return $class->new_result(@_) if ref $class;
87 my ($source, $attrs) = @_;
91 $attrs->{rows} ||= 10;
92 $attrs->{offset} ||= 0;
93 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
96 $attrs->{alias} ||= 'me';
97 $attrs->{_orig_alias} ||= $attrs->{alias};
100 result_source => $source,
101 result_class => $attrs->{result_class} || $source->result_class,
102 cond => $attrs->{where},
103 # from => $attrs->{from},
104 # collapse => $collapse,
115 =item Arguments: $cond, \%attrs?
117 =item Return Value: $resultset (scalar context), @row_objs (list context)
121 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
122 my $new_rs = $cd_rs->search({ year => 2005 });
124 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
125 # year = 2005 OR year = 2004
127 If you need to pass in additional attributes but no additional condition,
128 call it as C<search(undef, \%attrs)>.
130 # "SELECT name, artistid FROM $artist_table"
131 my @all_artists = $schema->resultset('Artist')->search(undef, {
132 columns => [qw/name artistid/],
139 my $rs = $self->search_rs( @_ );
140 return (wantarray ? $rs->all : $rs);
147 =item Arguments: $cond, \%attrs?
149 =item Return Value: $resultset
153 This method does the same exact thing as search() except it will
154 always return a resultset, even in list context.
162 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
163 my $our_attrs = exists $attrs->{_parent_attrs}
164 ? { %{delete $attrs->{_parent_attrs}} }
165 : { %{$self->{attrs}} };
166 my $having = delete $our_attrs->{having};
168 # XXX should only maintain _live_join_stack and generate _live_join_h from that
169 if ($attrs->{_live_join_stack}) {
170 foreach my $join (reverse @{$attrs->{_live_join_stack}}) {
171 $attrs->{_live_join_h} = defined $attrs->{_live_join_h}
172 ? { $join => $attrs->{_live_join_h} }
177 # merge new attrs into inherited
178 foreach my $key (qw/join prefetch/) {
179 next unless exists $attrs->{$key};
180 if (my $live_join = $attrs->{_live_join_stack} || $our_attrs->{_live_join_stack}) {
181 foreach my $join (reverse @{$live_join}) {
182 $attrs->{$key} = { $join => $attrs->{$key} };
186 $our_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, delete $attrs->{$key});
189 $our_attrs->{join} = $self->_merge_attr(
190 $our_attrs->{join}, $attrs->{_live_join_h}
191 ) if ($attrs->{_live_join_h});
193 if (defined $our_attrs->{prefetch}) {
194 $our_attrs->{join} = $self->_merge_attr(
195 $our_attrs->{join}, $our_attrs->{prefetch}
199 my $new_attrs = { %{$our_attrs}, %{$attrs} };
202 (@_ == 1 || ref $_[0] eq "HASH")
206 ? $self->throw_exception("Odd number of arguments to search")
213 if (defined $where) {
214 $new_attrs->{where} = (
215 defined $new_attrs->{where}
218 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
219 } $where, $new_attrs->{where}
225 if (defined $having) {
226 $new_attrs->{having} = (
227 defined $new_attrs->{having}
230 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
231 } $having, $new_attrs->{having}
237 my $rs = (ref $self)->new($self->result_source, $new_attrs);
238 $rs->{_parent_rs} = $self->{_parent_rs} if $self->{_parent_rs};
240 unless (@_) { # no search, effectively just a clone
241 my $rows = $self->get_cache;
243 $rs->set_cache($rows);
249 =head2 search_literal
253 =item Arguments: $sql_fragment, @bind_values
255 =item Return Value: $resultset (scalar context), @row_objs (list context)
259 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
260 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
262 Pass a literal chunk of SQL to be added to the conditional part of the
268 my ($self, $cond, @vals) = @_;
269 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
270 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
271 return $self->search(\$cond, $attrs);
278 =item Arguments: @values | \%cols, \%attrs?
280 =item Return Value: $row_object
284 Finds a row based on its primary key or unique constraint. For example, to find
285 a row by its primary key:
287 my $cd = $schema->resultset('CD')->find(5);
289 You can also find a row by a specific unique constraint using the C<key>
290 attribute. For example:
292 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
293 key => 'cd_artist_title'
296 Additionally, you can specify the columns explicitly by name:
298 my $cd = $schema->resultset('CD')->find(
300 artist => 'Massive Attack',
301 title => 'Mezzanine',
303 { key => 'cd_artist_title' }
306 If the C<key> is specified as C<primary>, it searches only on the primary key.
308 If no C<key> is specified, it searches on all unique constraints defined on the
309 source, including the primary key.
311 See also L</find_or_create> and L</update_or_create>. For information on how to
312 declare unique constraints, see
313 L<DBIx::Class::ResultSource/add_unique_constraint>.
319 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
321 # Default to the primary key, but allow a specific key
322 my @cols = exists $attrs->{key}
323 ? $self->result_source->unique_constraint_columns($attrs->{key})
324 : $self->result_source->primary_columns;
325 $self->throw_exception(
326 "Can't find unless a primary key or unique constraint is defined"
329 # Parse out a hashref from input
331 if (ref $_[0] eq 'HASH') {
332 $input_query = { %{$_[0]} };
334 elsif (@_ == @cols) {
336 @{$input_query}{@cols} = @_;
339 # Compatibility: Allow e.g. find(id => $value)
340 carp "Find by key => value deprecated; please use a hashref instead";
344 my @unique_queries = $self->_unique_queries($input_query, $attrs);
346 # Handle cases where the ResultSet defines the query, or where the user is
348 my $query = @unique_queries ? \@unique_queries : $input_query;
352 my $rs = $self->search($query, $attrs);
353 return keys %{$rs->_resolved_attrs->{collapse}} ? $rs->next : $rs->single;
356 return keys %{$self->_resolved_attrs->{collapse}}
357 ? $self->search($query)->next
358 : $self->single($query);
364 # Build a list of queries which satisfy unique constraints.
366 sub _unique_queries {
367 my ($self, $query, $attrs) = @_;
369 my @constraint_names = exists $attrs->{key}
371 : $self->result_source->unique_constraint_names;
374 foreach my $name (@constraint_names) {
375 my @unique_cols = $self->result_source->unique_constraint_columns($name);
376 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
378 next unless scalar keys %$unique_query;
380 # Add the ResultSet's alias
381 my $alias = $self->{attrs}{alias};
382 foreach my $key (grep { ! m/\./ } keys %$unique_query) {
383 $unique_query->{"$alias.$key"} = delete $unique_query->{$key};
386 push @unique_queries, $unique_query;
389 return @unique_queries;
392 # _build_unique_query
394 # Constrain the specified query hash based on the specified column names.
396 sub _build_unique_query {
397 my ($self, $query, $unique_cols) = @_;
400 map { $_ => $query->{$_} }
401 grep { exists $query->{$_} }
406 =head2 search_related
410 =item Arguments: $rel, $cond, \%attrs?
412 =item Return Value: $new_resultset
416 $new_rs = $cd_rs->search_related('artist', {
420 Searches the specified relationship, optionally specifying a condition and
421 attributes for matching records. See L</ATTRIBUTES> for more information.
426 return shift->related_resultset(shift)->search(@_);
433 =item Arguments: none
435 =item Return Value: $cursor
439 Returns a storage-driven cursor to the given resultset. See
440 L<DBIx::Class::Cursor> for more information.
447 my $attrs = { %{$self->_resolved_attrs} };
448 return $self->{cursor}
449 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
450 $attrs->{where},$attrs);
457 =item Arguments: $cond?
459 =item Return Value: $row_object?
463 my $cd = $schema->resultset('CD')->single({ year => 2001 });
465 Inflates the first result without creating a cursor if the resultset has
466 any records in it; if not returns nothing. Used by L</find> as an optimisation.
468 Can optionally take an additional condition *only* - this is a fast-code-path
469 method; if you need to add extra joins or similar call ->search and then
470 ->single without a condition on the $rs returned from that.
475 my ($self, $where) = @_;
476 my $attrs = { %{$self->_resolved_attrs} };
478 if (defined $attrs->{where}) {
481 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
482 $where, delete $attrs->{where} ]
485 $attrs->{where} = $where;
489 unless ($self->_is_unique_query($attrs->{where})) {
490 carp "Query not guaranteed to return a single row"
491 . "; please declare your unique constraints or use search instead";
494 my @data = $self->result_source->storage->select_single(
495 $attrs->{from}, $attrs->{select},
496 $attrs->{where}, $attrs
499 return (@data ? $self->_construct_object(@data) : ());
504 # Try to determine if the specified query is guaranteed to be unique, based on
505 # the declared unique constraints.
507 sub _is_unique_query {
508 my ($self, $query) = @_;
510 my $collapsed = $self->_collapse_query($query);
511 my $alias = $self->{attrs}{alias};
513 foreach my $name ($self->result_source->unique_constraint_names) {
514 my @unique_cols = map {
516 } $self->result_source->unique_constraint_columns($name);
518 # Count the values for each unique column
519 my %seen = map { $_ => 0 } @unique_cols;
521 foreach my $key (keys %$collapsed) {
522 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
523 next unless exists $seen{$aliased}; # Additional constraints are okay
524 $seen{$aliased} = scalar @{ $collapsed->{$key} };
527 # If we get 0 or more than 1 value for a column, it's not necessarily unique
528 return 1 unless grep { $_ != 1 } values %seen;
536 # Recursively collapse the query, accumulating values for each column.
538 sub _collapse_query {
539 my ($self, $query, $collapsed) = @_;
543 if (ref $query eq 'ARRAY') {
544 foreach my $subquery (@$query) {
545 next unless ref $subquery; # -or
546 # warn "ARRAY: " . Dumper $subquery;
547 $collapsed = $self->_collapse_query($subquery, $collapsed);
550 elsif (ref $query eq 'HASH') {
551 if (keys %$query and (keys %$query)[0] eq '-and') {
552 foreach my $subquery (@{$query->{-and}}) {
553 # warn "HASH: " . Dumper $subquery;
554 $collapsed = $self->_collapse_query($subquery, $collapsed);
558 # warn "LEAF: " . Dumper $query;
559 foreach my $key (keys %$query) {
560 push @{$collapsed->{$key}}, $query->{$key};
572 =item Arguments: $cond?
574 =item Return Value: $resultsetcolumn
578 my $max_length = $rs->get_column('length')->max;
580 Returns a ResultSetColumn instance for $column based on $self
585 my ($self, $column) = @_;
586 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
594 =item Arguments: $cond, \%attrs?
596 =item Return Value: $resultset (scalar context), @row_objs (list context)
600 # WHERE title LIKE '%blue%'
601 $cd_rs = $rs->search_like({ title => '%blue%'});
603 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
604 that this is simply a convenience method. You most likely want to use
605 L</search> with specific operators.
607 For more information, see L<DBIx::Class::Manual::Cookbook>.
613 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
614 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
615 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
616 return $class->search($query, { %$attrs });
623 =item Arguments: $first, $last
625 =item Return Value: $resultset (scalar context), @row_objs (list context)
629 Returns a resultset or object list representing a subset of elements from the
630 resultset slice is called on. Indexes are from 0, i.e., to get the first
633 my ($one, $two, $three) = $rs->slice(0, 2);
638 my ($self, $min, $max) = @_;
639 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
640 $attrs->{offset} = $self->{attrs}{offset} || 0;
641 $attrs->{offset} += $min;
642 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
643 return $self->search(undef(), $attrs);
644 #my $slice = (ref $self)->new($self->result_source, $attrs);
645 #return (wantarray ? $slice->all : $slice);
652 =item Arguments: none
654 =item Return Value: $result?
658 Returns the next element in the resultset (C<undef> is there is none).
660 Can be used to efficiently iterate over records in the resultset:
662 my $rs = $schema->resultset('CD')->search;
663 while (my $cd = $rs->next) {
667 Note that you need to store the resultset object, and call C<next> on it.
668 Calling C<< resultset('Table')->next >> repeatedly will always return the
669 first record from the resultset.
675 if (my $cache = $self->get_cache) {
676 $self->{all_cache_position} ||= 0;
677 return $cache->[$self->{all_cache_position}++];
679 if ($self->{attrs}{cache}) {
680 $self->{all_cache_position} = 1;
681 return ($self->all)[0];
684 exists $self->{stashed_row}
685 ? @{delete $self->{stashed_row}}
686 : $self->cursor->next
688 return unless (@row);
689 return $self->_construct_object(@row);
692 sub _resolved_attrs {
694 return $self->{_attrs} if $self->{_attrs};
696 my $attrs = $self->{attrs};
697 my $source = $self->{_parent_rs} || $self->{result_source};
698 my $alias = $attrs->{_orig_alias};
700 # XXX - lose storable dclone
701 my $record_filter = delete $attrs->{record_filter};
702 $attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } };
703 $attrs->{record_filter} = $record_filter if $record_filter;
705 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
706 if ($attrs->{columns}) {
708 } elsif (!$attrs->{select}) {
709 $attrs->{columns} = [ $self->{result_source}->columns ];
712 my $select_alias = $self->{attrs}{alias};
713 $attrs->{select} ||= [
714 map { m/\./ ? $_ : "${select_alias}.$_" } @{delete $attrs->{columns}}
717 map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}}
721 if ($adds = delete $attrs->{include_columns}) {
722 $adds = [$adds] unless ref $adds eq 'ARRAY';
723 push(@{$attrs->{select}}, @$adds);
724 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
726 if ($adds = delete $attrs->{'+select'}) {
727 $adds = [$adds] unless ref $adds eq 'ARRAY';
728 push(@{$attrs->{select}}, map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
730 if (my $adds = delete $attrs->{'+as'}) {
731 $adds = [$adds] unless ref $adds eq 'ARRAY';
732 push(@{$attrs->{as}}, @$adds);
735 $attrs->{from} ||= [ { $alias => $source->from } ];
736 $attrs->{seen_join} ||= {};
738 if (my $join = delete $attrs->{join}) {
739 foreach my $j (ref $join eq 'ARRAY' ? @$join : ($join)) {
740 if (ref $j eq 'HASH') {
741 $seen{$_} = 1 foreach keys %$j;
746 push(@{$attrs->{from}},
747 $source->resolve_join($join, $alias, $attrs->{seen_join})
751 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
752 if ($attrs->{order_by}) {
753 $attrs->{order_by} = [ $attrs->{order_by} ] unless ref $attrs->{order_by};
755 $attrs->{order_by} ||= [];
758 my $collapse = $attrs->{collapse} || {};
759 if (my $prefetch = delete $attrs->{prefetch}) {
761 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
762 if ( ref $p eq 'HASH' ) {
763 foreach my $key (keys %$p) {
764 push(@{$attrs->{from}}, $source->resolve_join($p, $alias))
768 push(@{$attrs->{from}}, $source->resolve_join($p, $alias))
771 # bring joins back to level of current class
772 $p = $self->_reduce_joins($p, $attrs) if $attrs->{_live_join_stack};
774 my @prefetch = $self->result_source->resolve_prefetch(
775 $p, $alias, {}, \@pre_order, $collapse
777 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
778 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
781 push(@{$attrs->{order_by}}, @pre_order);
783 $attrs->{collapse} = $collapse;
785 return $self->{_attrs} = $attrs;
789 my ($self, $a, $b) = @_;
792 if (ref $b eq 'HASH' && ref $a eq 'HASH') {
793 foreach my $key (keys %{$b}) {
794 if (exists $a->{$key}) {
795 $a->{$key} = $self->_merge_attr($a->{$key}, $b->{$key});
797 $a->{$key} = $b->{$key};
802 $a = [$a] unless ref $a eq 'ARRAY';
803 $b = [$b] unless ref $b eq 'ARRAY';
807 foreach my $x ($a, $b) {
808 foreach my $element (@{$x}) {
809 if (ref $element eq 'HASH') {
810 $hash = $self->_merge_attr($hash, $element);
811 } elsif (ref $element eq 'ARRAY') {
812 push(@array, @{$element});
814 push(@array, $element) unless $b == $x
815 && grep { $_ eq $element } @array;
820 @array = grep { !exists $hash->{$_} } @array;
831 # bring the joins (which are from the original class) to the level
832 # of the current class so that we can resolve them properly
834 my ($self, $p, $attrs) = @_;
837 foreach my $join (@{$attrs->{_live_join_stack}}) {
838 if (ref $p eq 'HASH') {
839 return undef unless exists $p->{$join};
841 } elsif (ref $p eq 'ARRAY') {
842 foreach my $pe (@{$p}) {
843 return undef if $pe eq $join;
844 if (ref $pe eq 'HASH' && exists $pe->{$join}) {
857 sub _construct_object {
858 my ($self, @row) = @_;
859 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
860 my $new = $self->result_class->inflate_result($self->result_source, @$info);
861 $new = $self->{_attrs}{record_filter}->($new)
862 if exists $self->{_attrs}{record_filter};
866 sub _collapse_result {
867 my ($self, $as, $row, $prefix) = @_;
872 foreach my $this_as (@$as) {
873 my $val = shift @copy;
874 if (defined $prefix) {
875 if ($this_as =~ m/^\Q${prefix}.\E(.+)$/) {
877 $remain =~ /^(?:(.*)\.)?([^.]+)$/;
878 $const{$1||''}{$2} = $val;
881 $this_as =~ /^(?:(.*)\.)?([^.]+)$/;
882 $const{$1||''}{$2} = $val;
886 my $alias = $self->{attrs}{alias};
887 my $info = [ {}, {} ];
888 foreach my $key (keys %const) {
889 if (length $key && $key ne $alias) {
891 my @parts = split(/\./, $key);
892 foreach my $p (@parts) {
893 $target = $target->[1]->{$p} ||= [];
895 $target->[0] = $const{$key};
897 $info->[0] = $const{$key};
902 if (defined $prefix) {
904 m/^\Q${prefix}.\E(.+)$/ ? ($1) : ()
905 } keys %{$self->{_attrs}{collapse}}
907 @collapse = keys %{$self->{_attrs}{collapse}};
911 my ($c) = sort { length $a <=> length $b } @collapse;
913 foreach my $p (split(/\./, $c)) {
914 $target = $target->[1]->{$p} ||= [];
916 my $c_prefix = (defined($prefix) ? "${prefix}.${c}" : $c);
917 my @co_key = @{$self->{_attrs}{collapse}{$c_prefix}};
918 my $tree = $self->_collapse_result($as, $row, $c_prefix);
919 my %co_check = map { ($_, $tree->[0]->{$_}); } @co_key;
925 !defined($tree->[0]->{$_}) || $co_check{$_} ne $tree->[0]->{$_}
930 last unless (@raw = $self->cursor->next);
931 $row = $self->{stashed_row} = \@raw;
932 $tree = $self->_collapse_result($as, $row, $c_prefix);
934 @$target = (@final ? @final : [ {}, {} ]);
935 # single empty result to indicate an empty prefetched has_many
938 #print "final info: " . Dumper($info);
946 =item Arguments: $result_source?
948 =item Return Value: $result_source
952 An accessor for the primary ResultSource object from which this ResultSet
962 =item Arguments: $cond, \%attrs??
964 =item Return Value: $count
968 Performs an SQL C<COUNT> with the same query as the resultset was built
969 with to find the number of elements. If passed arguments, does a search
970 on the resultset and counts the results of that.
972 Note: When using C<count> with C<group_by>, L<DBIX::Class> emulates C<GROUP BY>
973 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
974 not support C<DISTINCT> with multiple columns. If you are using such a
975 database, you should only use columns from the main table in your C<group_by>
982 return $self->search(@_)->count if @_ and defined $_[0];
983 return scalar @{ $self->get_cache } if $self->get_cache;
984 my $count = $self->_count;
985 return 0 unless $count;
987 $count -= $self->{attrs}{offset} if $self->{attrs}{offset};
988 $count = $self->{attrs}{rows} if
989 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
993 sub _count { # Separated out so pager can get the full count
995 my $select = { count => '*' };
997 my $attrs = { %{$self->_resolved_attrs} };
998 if (my $group_by = delete $attrs->{group_by}) {
999 delete $attrs->{having};
1000 my @distinct = (ref $group_by ? @$group_by : ($group_by));
1001 # todo: try CONCAT for multi-column pk
1002 my @pk = $self->result_source->primary_columns;
1004 my $alias = $attrs->{_orig_alias};
1005 foreach my $column (@distinct) {
1006 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
1007 @distinct = ($column);
1013 $select = { count => { distinct => \@distinct } };
1016 $attrs->{select} = $select;
1017 $attrs->{as} = [qw/count/];
1019 # offset, order by and page are not needed to count. record_filter is cdbi
1020 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
1021 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
1022 $tmp_rs->{_parent_rs} = $self->{_parent_rs} if $self->{_parent_rs};
1023 #XXX - hack to pass through parent of related resultsets
1025 my ($count) = $tmp_rs->cursor->next;
1029 =head2 count_literal
1033 =item Arguments: $sql_fragment, @bind_values
1035 =item Return Value: $count
1039 Counts the results in a literal query. Equivalent to calling L</search_literal>
1040 with the passed arguments, then L</count>.
1044 sub count_literal { shift->search_literal(@_)->count; }
1050 =item Arguments: none
1052 =item Return Value: @objects
1056 Returns all elements in the resultset. Called implicitly if the resultset
1057 is returned in list context.
1063 return @{ $self->get_cache } if $self->get_cache;
1067 # TODO: don't call resolve here
1068 if (keys %{$self->_resolved_attrs->{collapse}}) {
1069 # if ($self->{attrs}{prefetch}) {
1070 # Using $self->cursor->all is really just an optimisation.
1071 # If we're collapsing has_many prefetches it probably makes
1072 # very little difference, and this is cleaner than hacking
1073 # _construct_object to survive the approach
1074 my @row = $self->cursor->next;
1076 push(@obj, $self->_construct_object(@row));
1077 @row = (exists $self->{stashed_row}
1078 ? @{delete $self->{stashed_row}}
1079 : $self->cursor->next);
1082 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1085 $self->set_cache(\@obj) if $self->{attrs}{cache};
1093 =item Arguments: none
1095 =item Return Value: $self
1099 Resets the resultset's cursor, so you can iterate through the elements again.
1105 delete $self->{_attrs} if exists $self->{_attrs};
1106 $self->{all_cache_position} = 0;
1107 $self->cursor->reset;
1115 =item Arguments: none
1117 =item Return Value: $object?
1121 Resets the resultset and returns an object for the first result (if the
1122 resultset returns anything).
1127 return $_[0]->reset->next;
1130 # _cond_for_update_delete
1132 # update/delete require the condition to be modified to handle
1133 # the differing SQL syntax available. This transforms the $self->{cond}
1134 # appropriately, returning the new condition.
1136 sub _cond_for_update_delete {
1140 # No-op. No condition, we're updating/deleting everything
1141 return $cond unless ref $self->{cond};
1143 if (ref $self->{cond} eq 'ARRAY') {
1147 foreach my $key (keys %{$_}) {
1149 $hash{$1} = $_->{$key};
1155 elsif (ref $self->{cond} eq 'HASH') {
1156 if ((keys %{$self->{cond}})[0] eq '-and') {
1159 my @cond = @{$self->{cond}{-and}};
1160 for (my $i = 0; $i < @cond; $i++) {
1161 my $entry = $cond[$i];
1164 if (ref $entry eq 'HASH') {
1165 foreach my $key (keys %{$entry}) {
1167 $hash{$1} = $entry->{$key};
1171 $entry =~ /([^.]+)$/;
1172 $hash{$1} = $cond[++$i];
1175 push @{$cond->{-and}}, \%hash;
1179 foreach my $key (keys %{$self->{cond}}) {
1181 $cond->{$1} = $self->{cond}{$key};
1186 $self->throw_exception(
1187 "Can't update/delete on resultset with condition unless hash or array"
1199 =item Arguments: \%values
1201 =item Return Value: $storage_rv
1205 Sets the specified columns in the resultset to the supplied values in a
1206 single query. Return value will be true if the update succeeded or false
1207 if no records were updated; exact type of success value is storage-dependent.
1212 my ($self, $values) = @_;
1213 $self->throw_exception("Values for update must be a hash")
1214 unless ref $values eq 'HASH';
1216 my $cond = $self->_cond_for_update_delete;
1218 return $self->result_source->storage->update(
1219 $self->result_source->from, $values, $cond
1227 =item Arguments: \%values
1229 =item Return Value: 1
1233 Fetches all objects and updates them one at a time. Note that C<update_all>
1234 will run DBIC cascade triggers, while L</update> will not.
1239 my ($self, $values) = @_;
1240 $self->throw_exception("Values for update must be a hash")
1241 unless ref $values eq 'HASH';
1242 foreach my $obj ($self->all) {
1243 $obj->set_columns($values)->update;
1252 =item Arguments: none
1254 =item Return Value: 1
1258 Deletes the contents of the resultset from its result source. Note that this
1259 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1267 my $cond = $self->_cond_for_update_delete;
1269 $self->result_source->storage->delete($self->result_source->from, $cond);
1277 =item Arguments: none
1279 =item Return Value: 1
1283 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1284 will run DBIC cascade triggers, while L</delete> will not.
1290 $_->delete for $self->all;
1298 =item Arguments: none
1300 =item Return Value: $pager
1304 Return Value a L<Data::Page> object for the current resultset. Only makes
1305 sense for queries with a C<page> attribute.
1311 my $attrs = $self->{attrs};
1312 $self->throw_exception("Can't create pager for non-paged rs")
1313 unless $self->{attrs}{page};
1314 $attrs->{rows} ||= 10;
1315 return $self->{pager} ||= Data::Page->new(
1316 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1323 =item Arguments: $page_number
1325 =item Return Value: $rs
1329 Returns a resultset for the $page_number page of the resultset on which page
1330 is called, where each page contains a number of rows equal to the 'rows'
1331 attribute set on the resultset (10 by default).
1336 my ($self, $page) = @_;
1337 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1344 =item Arguments: \%vals
1346 =item Return Value: $object
1350 Creates an object in the resultset's result class and returns it.
1355 my ($self, $values) = @_;
1356 $self->throw_exception( "new_result needs a hash" )
1357 unless (ref $values eq 'HASH');
1358 $self->throw_exception(
1359 "Can't abstract implicit construct, condition not a hash"
1360 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1362 my $alias = $self->{attrs}{_orig_alias};
1363 foreach my $key (keys %{$self->{cond}||{}}) {
1364 $new{$1} = $self->{cond}{$key} if ($key =~ m/^(?:\Q${alias}.\E)?([^.]+)$/);
1366 my $obj = $self->result_class->new(\%new);
1367 $obj->result_source($self->result_source) if $obj->can('result_source');
1375 =item Arguments: \%vals, \%attrs?
1377 =item Return Value: $object
1381 Find an existing record from this resultset. If none exists, instantiate a new
1382 result object and return it. The object will not be saved into your storage
1383 until you call L<DBIx::Class::Row/insert> on it.
1385 If you want objects to be saved immediately, use L</find_or_create> instead.
1391 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1392 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1393 my $exists = $self->find($hash, $attrs);
1394 return defined $exists ? $exists : $self->new_result($hash);
1401 =item Arguments: \%vals
1403 =item Return Value: $object
1407 Inserts a record into the resultset and returns the object representing it.
1409 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1414 my ($self, $attrs) = @_;
1415 $self->throw_exception( "create needs a hashref" )
1416 unless ref $attrs eq 'HASH';
1417 return $self->new_result($attrs)->insert;
1420 =head2 find_or_create
1424 =item Arguments: \%vals, \%attrs?
1426 =item Return Value: $object
1430 $class->find_or_create({ key => $val, ... });
1432 Tries to find a record based on its primary key or unique constraint; if none
1433 is found, creates one and returns that instead.
1435 my $cd = $schema->resultset('CD')->find_or_create({
1437 artist => 'Massive Attack',
1438 title => 'Mezzanine',
1442 Also takes an optional C<key> attribute, to search by a specific key or unique
1443 constraint. For example:
1445 my $cd = $schema->resultset('CD')->find_or_create(
1447 artist => 'Massive Attack',
1448 title => 'Mezzanine',
1450 { key => 'cd_artist_title' }
1453 See also L</find> and L</update_or_create>. For information on how to declare
1454 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1458 sub find_or_create {
1460 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1461 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1462 my $exists = $self->find($hash, $attrs);
1463 return defined $exists ? $exists : $self->create($hash);
1466 =head2 update_or_create
1470 =item Arguments: \%col_values, { key => $unique_constraint }?
1472 =item Return Value: $object
1476 $class->update_or_create({ col => $val, ... });
1478 First, searches for an existing row matching one of the unique constraints
1479 (including the primary key) on the source of this resultset. If a row is
1480 found, updates it with the other given column values. Otherwise, creates a new
1483 Takes an optional C<key> attribute to search on a specific unique constraint.
1486 # In your application
1487 my $cd = $schema->resultset('CD')->update_or_create(
1489 artist => 'Massive Attack',
1490 title => 'Mezzanine',
1493 { key => 'cd_artist_title' }
1496 If no C<key> is specified, it searches on all unique constraints defined on the
1497 source, including the primary key.
1499 If the C<key> is specified as C<primary>, it searches only on the primary key.
1501 See also L</find> and L</find_or_create>. For information on how to declare
1502 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1506 sub update_or_create {
1508 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1509 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1511 my $row = $self->find($cond);
1513 $row->update($cond);
1517 return $self->create($cond);
1524 =item Arguments: none
1526 =item Return Value: \@cache_objects?
1530 Gets the contents of the cache for the resultset, if the cache is set.
1542 =item Arguments: \@cache_objects
1544 =item Return Value: \@cache_objects
1548 Sets the contents of the cache for the resultset. Expects an arrayref
1549 of objects of the same class as those produced by the resultset. Note that
1550 if the cache is set the resultset will return the cached objects rather
1551 than re-querying the database even if the cache attr is not set.
1556 my ( $self, $data ) = @_;
1557 $self->throw_exception("set_cache requires an arrayref")
1558 if defined($data) && (ref $data ne 'ARRAY');
1559 $self->{all_cache} = $data;
1566 =item Arguments: none
1568 =item Return Value: []
1572 Clears the cache for the resultset.
1577 shift->set_cache(undef);
1580 =head2 related_resultset
1584 =item Arguments: $relationship_name
1586 =item Return Value: $resultset
1590 Returns a related resultset for the supplied relationship name.
1592 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1596 sub related_resultset {
1597 my ($self, $rel) = @_;
1599 $self->{related_resultsets} ||= {};
1600 return $self->{related_resultsets}{$rel} ||= do {
1601 my $rel_obj = $self->result_source->relationship_info($rel);
1603 $self->throw_exception(
1604 "search_related: result source '" . $self->result_source->name .
1605 "' has no such relationship $rel")
1608 my $join_count = $self->_resolved_attrs->{seen_join}{$rel};
1609 my $alias = $join_count ? join('_', $rel, $join_count+1) : $rel;
1611 my @live_join_stack = (@{$self->{attrs}{_live_join_stack}||[]}, $rel);
1613 my $rs = $self->result_source->schema->resultset($rel_obj->{class})->search(
1618 _live_join_stack => \@live_join_stack,
1619 _parent_attrs => $self->{attrs}}
1622 # keep reference of the original resultset
1623 $rs->{_parent_rs} = $self->{_parent_rs} || $self->result_source;
1629 =head2 throw_exception
1631 See L<DBIx::Class::Schema/throw_exception> for details.
1635 sub throw_exception {
1637 $self->result_source->schema->throw_exception(@_);
1640 # XXX: FIXME: Attributes docs need clearing up
1644 The resultset takes various attributes that modify its behavior. Here's an
1651 =item Value: ($order_by | \@order_by)
1655 Which column(s) to order the results by. This is currently passed
1656 through directly to SQL, so you can give e.g. C<year DESC> for a
1657 descending order on the column `year'.
1659 Please note that if you have quoting enabled (see
1660 L<DBIx::Class::Storage/quote_char>) you will need to do C<\'year DESC' > to
1661 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
1662 so you will need to manually quote things as appropriate.)
1668 =item Value: \@columns
1672 Shortcut to request a particular set of columns to be retrieved. Adds
1673 C<me.> onto the start of any column without a C<.> in it and sets C<select>
1674 from that, then auto-populates C<as> from C<select> as normal. (You may also
1675 use the C<cols> attribute, as in earlier versions of DBIC.)
1677 =head2 include_columns
1681 =item Value: \@columns
1685 Shortcut to include additional columns in the returned results - for example
1687 $schema->resultset('CD')->search(undef, {
1688 include_columns => ['artist.name'],
1692 would return all CDs and include a 'name' column to the information
1693 passed to object inflation
1699 =item Value: \@select_columns
1703 Indicates which columns should be selected from the storage. You can use
1704 column names, or in the case of RDBMS back ends, function or stored procedure
1707 $rs = $schema->resultset('Employee')->search(undef, {
1710 { count => 'employeeid' },
1715 When you use function/stored procedure names and do not supply an C<as>
1716 attribute, the column names returned are storage-dependent. E.g. MySQL would
1717 return a column named C<count(employeeid)> in the above example.
1723 Indicates additional columns to be selected from storage. Works the same as
1724 L<select> but adds columns to the selection.
1732 Indicates additional column names for those added via L<+select>.
1740 =item Value: \@inflation_names
1744 Indicates column names for object inflation. This is used in conjunction with
1745 C<select>, usually when C<select> contains one or more function or stored
1748 $rs = $schema->resultset('Employee')->search(undef, {
1751 { count => 'employeeid' }
1753 as => ['name', 'employee_count'],
1756 my $employee = $rs->first(); # get the first Employee
1758 If the object against which the search is performed already has an accessor
1759 matching a column name specified in C<as>, the value can be retrieved using
1760 the accessor as normal:
1762 my $name = $employee->name();
1764 If on the other hand an accessor does not exist in the object, you need to
1765 use C<get_column> instead:
1767 my $employee_count = $employee->get_column('employee_count');
1769 You can create your own accessors if required - see
1770 L<DBIx::Class::Manual::Cookbook> for details.
1772 Please note: This will NOT insert an C<AS employee_count> into the SQL statement
1773 produced, it is used for internal access only. Thus attempting to use the accessor
1774 in an C<order_by> clause or similar will fail misrably.
1780 =item Value: ($rel_name | \@rel_names | \%rel_names)
1784 Contains a list of relationships that should be joined for this query. For
1787 # Get CDs by Nine Inch Nails
1788 my $rs = $schema->resultset('CD')->search(
1789 { 'artist.name' => 'Nine Inch Nails' },
1790 { join => 'artist' }
1793 Can also contain a hash reference to refer to the other relation's relations.
1796 package MyApp::Schema::Track;
1797 use base qw/DBIx::Class/;
1798 __PACKAGE__->table('track');
1799 __PACKAGE__->add_columns(qw/trackid cd position title/);
1800 __PACKAGE__->set_primary_key('trackid');
1801 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
1804 # In your application
1805 my $rs = $schema->resultset('Artist')->search(
1806 { 'track.title' => 'Teardrop' },
1808 join => { cd => 'track' },
1809 order_by => 'artist.name',
1813 If the same join is supplied twice, it will be aliased to <rel>_2 (and
1814 similarly for a third time). For e.g.
1816 my $rs = $schema->resultset('Artist')->search({
1817 'cds.title' => 'Down to Earth',
1818 'cds_2.title' => 'Popular',
1820 join => [ qw/cds cds/ ],
1823 will return a set of all artists that have both a cd with title 'Down
1824 to Earth' and a cd with title 'Popular'.
1826 If you want to fetch related objects from other tables as well, see C<prefetch>
1833 =item Value: ($rel_name | \@rel_names | \%rel_names)
1837 Contains one or more relationships that should be fetched along with the main
1838 query (when they are accessed afterwards they will have already been
1839 "prefetched"). This is useful for when you know you will need the related
1840 objects, because it saves at least one query:
1842 my $rs = $schema->resultset('Tag')->search(
1851 The initial search results in SQL like the following:
1853 SELECT tag.*, cd.*, artist.* FROM tag
1854 JOIN cd ON tag.cd = cd.cdid
1855 JOIN artist ON cd.artist = artist.artistid
1857 L<DBIx::Class> has no need to go back to the database when we access the
1858 C<cd> or C<artist> relationships, which saves us two SQL statements in this
1861 Simple prefetches will be joined automatically, so there is no need
1862 for a C<join> attribute in the above search. If you're prefetching to
1863 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
1864 specify the join as well.
1866 C<prefetch> can be used with the following relationship types: C<belongs_to>,
1867 C<has_one> (or if you're using C<add_relationship>, any relationship declared
1868 with an accessor type of 'single' or 'filter').
1878 Makes the resultset paged and specifies the page to retrieve. Effectively
1879 identical to creating a non-pages resultset and then calling ->page($page)
1882 If L<rows> attribute is not specified it defualts to 10 rows per page.
1892 Specifes the maximum number of rows for direct retrieval or the number of
1893 rows per page if the page attribute or method is used.
1899 =item Value: $offset
1903 Specifies the (zero-based) row number for the first row to be returned, or the
1904 of the first row of the first page if paging is used.
1910 =item Value: \@columns
1914 A arrayref of columns to group by. Can include columns of joined tables.
1916 group_by => [qw/ column1 column2 ... /]
1922 =item Value: $condition
1926 HAVING is a select statement attribute that is applied between GROUP BY and
1927 ORDER BY. It is applied to the after the grouping calculations have been
1930 having => { 'count(employee)' => { '>=', 100 } }
1936 =item Value: (0 | 1)
1940 Set to 1 to group by all columns.
1946 Adds to the WHERE clause.
1948 # only return rows WHERE deleted IS NULL for all searches
1949 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
1951 Can be overridden by passing C<{ where => undef }> as an attribute
1958 Set to 1 to cache search results. This prevents extra SQL queries if you
1959 revisit rows in your ResultSet:
1961 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
1963 while( my $artist = $resultset->next ) {
1967 $rs->first; # without cache, this would issue a query
1969 By default, searches are not cached.
1971 For more examples of using these attributes, see
1972 L<DBIx::Class::Manual::Cookbook>.
1978 =item Value: \@from_clause
1982 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
1983 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
1986 NOTE: Use this on your own risk. This allows you to shoot off your foot!
1988 C<join> will usually do what you need and it is strongly recommended that you
1989 avoid using C<from> unless you cannot achieve the desired result using C<join>.
1990 And we really do mean "cannot", not just tried and failed. Attempting to use
1991 this because you're having problems with C<join> is like trying to use x86
1992 ASM because you've got a syntax error in your C. Trust us on this.
1994 Now, if you're still really, really sure you need to use this (and if you're
1995 not 100% sure, ask the mailing list first), here's an explanation of how this
1998 The syntax is as follows -
2001 { <alias1> => <table1> },
2003 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2004 [], # nested JOIN (optional)
2005 { <table1.column1> => <table2.column2>, ... (more conditions) },
2007 # More of the above [ ] may follow for additional joins
2014 ON <table1.column1> = <table2.column2>
2015 <more joins may follow>
2017 An easy way to follow the examples below is to remember the following:
2019 Anything inside "[]" is a JOIN
2020 Anything inside "{}" is a condition for the enclosing JOIN
2022 The following examples utilize a "person" table in a family tree application.
2023 In order to express parent->child relationships, this table is self-joined:
2025 # Person->belongs_to('father' => 'Person');
2026 # Person->belongs_to('mother' => 'Person');
2028 C<from> can be used to nest joins. Here we return all children with a father,
2029 then search against all mothers of those children:
2031 $rs = $schema->resultset('Person')->search(
2034 alias => 'mother', # alias columns in accordance with "from"
2036 { mother => 'person' },
2039 { child => 'person' },
2041 { father => 'person' },
2042 { 'father.person_id' => 'child.father_id' }
2045 { 'mother.person_id' => 'child.mother_id' }
2052 # SELECT mother.* FROM person mother
2055 # JOIN person father
2056 # ON ( father.person_id = child.father_id )
2058 # ON ( mother.person_id = child.mother_id )
2060 The type of any join can be controlled manually. To search against only people
2061 with a father in the person table, we could explicitly use C<INNER JOIN>:
2063 $rs = $schema->resultset('Person')->search(
2066 alias => 'child', # alias columns in accordance with "from"
2068 { child => 'person' },
2070 { father => 'person', -join_type => 'inner' },
2071 { 'father.id' => 'child.father_id' }
2078 # SELECT child.* FROM person child
2079 # INNER JOIN person father ON child.father_id = father.id