1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
13 use Scalar::Util qw/weaken/;
15 use DBIx::Class::ResultSetColumn;
16 use base qw/DBIx::Class/;
17 __PACKAGE__->load_components(qw/AccessorGroup/);
18 __PACKAGE__->mk_group_accessors('simple' => qw/result_source result_class/);
22 DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
26 my $rs = $schema->resultset('User')->search(registered => 1);
27 my @rows = $schema->resultset('CD')->search(year => 2005);
31 The resultset is also known as an iterator. It is responsible for handling
32 queries that may return an arbitrary number of rows, e.g. via L</search>
33 or a C<has_many> relationship.
35 In the examples below, the following table classes are used:
37 package MyApp::Schema::Artist;
38 use base qw/DBIx::Class/;
39 __PACKAGE__->load_components(qw/Core/);
40 __PACKAGE__->table('artist');
41 __PACKAGE__->add_columns(qw/artistid name/);
42 __PACKAGE__->set_primary_key('artistid');
43 __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
46 package MyApp::Schema::CD;
47 use base qw/DBIx::Class/;
48 __PACKAGE__->load_components(qw/Core/);
49 __PACKAGE__->table('cd');
50 __PACKAGE__->add_columns(qw/cdid artist title year/);
51 __PACKAGE__->set_primary_key('cdid');
52 __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
61 =item Arguments: $source, \%$attrs
63 =item Return Value: $rs
67 The resultset constructor. Takes a source object (usually a
68 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
69 L</ATTRIBUTES> below). Does not perform any queries -- these are
70 executed as needed by the other methods.
72 Generally you won't need to construct a resultset manually. You'll
73 automatically get one from e.g. a L</search> called in scalar context:
75 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
77 IMPORTANT: If called on an object, proxies to new_result instead so
79 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
81 will return a CD object, not a ResultSet.
87 return $class->new_result(@_) if ref $class;
89 my ($source, $attrs) = @_;
93 $attrs->{rows} ||= 10;
94 $attrs->{offset} ||= 0;
95 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
98 $attrs->{alias} ||= 'me';
101 result_source => $source,
102 result_class => $attrs->{result_class} || $source->result_class,
103 cond => $attrs->{where},
104 # from => $attrs->{from},
105 # collapse => $collapse,
107 page => delete $attrs->{page},
117 =item Arguments: $cond, \%attrs?
119 =item Return Value: $resultset (scalar context), @row_objs (list context)
123 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
124 my $new_rs = $cd_rs->search({ year => 2005 });
126 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
127 # year = 2005 OR year = 2004
129 If you need to pass in additional attributes but no additional condition,
130 call it as C<search(undef, \%attrs)>.
132 # "SELECT name, artistid FROM $artist_table"
133 my @all_artists = $schema->resultset('Artist')->search(undef, {
134 columns => [qw/name artistid/],
141 my $rs = $self->search_rs( @_ );
142 return (wantarray ? $rs->all : $rs);
149 =item Arguments: $cond, \%attrs?
151 =item Return Value: $resultset
155 This method does the same exact thing as search() except it will
156 always return a resultset, even in list context.
163 my $our_attrs = { %{$self->{attrs}} };
164 my $having = delete $our_attrs->{having};
166 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
168 # merge new attrs into old
169 foreach my $key (qw/join prefetch/) {
170 next unless (exists $attrs->{$key});
171 if (exists $our_attrs->{$key}) {
172 $our_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
174 $our_attrs->{$key} = $attrs->{$key};
176 delete $attrs->{$key};
179 if (exists $our_attrs->{prefetch}) {
180 $our_attrs->{join} = $self->_merge_attr($our_attrs->{join}, $our_attrs->{prefetch}, 1);
183 my $new_attrs = { %{$our_attrs}, %{$attrs} };
185 # merge new where and having into old
187 ? ((@_ == 1 || ref $_[0] eq "HASH")
190 ? $self->throw_exception(
191 "Odd number of arguments to search")
194 if (defined $where) {
195 $new_attrs->{where} = (defined $new_attrs->{where}
197 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
198 $where, $new_attrs->{where} ] }
202 if (defined $having) {
203 $new_attrs->{having} = (defined $new_attrs->{having}
205 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
206 $having, $new_attrs->{having} ] }
210 my $rs = (ref $self)->new($self->result_source, $new_attrs);
211 $rs->{_parent_rs} = $self->{_parent_rs} if ($self->{_parent_rs}); #XXX - hack to pass through parent of related resultsets
213 unless (@_) { # no search, effectively just a clone
214 my $rows = $self->get_cache;
216 $rs->set_cache($rows);
223 =head2 search_literal
227 =item Arguments: $sql_fragment, @bind_values
229 =item Return Value: $resultset (scalar context), @row_objs (list context)
233 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
234 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
236 Pass a literal chunk of SQL to be added to the conditional part of the
242 my ($self, $cond, @vals) = @_;
243 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
244 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
245 return $self->search(\$cond, $attrs);
252 =item Arguments: @values | \%cols, \%attrs?
254 =item Return Value: $row_object
258 Finds a row based on its primary key or unique constraint. For example, to find
259 a row by its primary key:
261 my $cd = $schema->resultset('CD')->find(5);
263 You can also find a row by a specific unique constraint using the C<key>
264 attribute. For example:
266 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', { key => 'artist_title' });
268 Additionally, you can specify the columns explicitly by name:
270 my $cd = $schema->resultset('CD')->find(
272 artist => 'Massive Attack',
273 title => 'Mezzanine',
275 { key => 'artist_title' }
278 If the C<key> is specified as C<primary>, it searches only on the primary key.
280 See also L</find_or_create> and L</update_or_create>. For information on how to
281 declare unique constraints, see
282 L<DBIx::Class::ResultSource/add_unique_constraint>.
288 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
290 # Default to the primary key, but allow a specific key
291 my @cols = exists $attrs->{key}
292 ? $self->result_source->unique_constraint_columns($attrs->{key})
293 : $self->result_source->primary_columns;
294 $self->throw_exception(
295 "Can't find unless a primary key or unique constraint is defined"
298 # Parse out a hashref from input
300 if (ref $_[0] eq 'HASH') {
301 $query = { %{$_[0]} };
303 elsif (@_ == @cols) {
305 @{$query}{@cols} = @_;
308 # Compatibility: Allow e.g. find(id => $value)
309 carp "find by key => value deprecated; please use a hashref instead";
313 # Add the ResultSet's alias
314 foreach my $key (grep { ! m/\./ } keys %$query) {
315 $query->{"$self->{attrs}{alias}.$key"} = delete $query->{$key};
320 my $rs = $self->search($query, $attrs);
322 return keys %{$rs->{_attrs}->{collapse}} ? $rs->next : $rs->single;
326 return (keys %{$self->{_attrs}->{collapse}})
327 ? $self->search($query)->next
328 : $self->single($query);
332 # _build_unique_query
334 # Constrain the specified query hash based on the specified column names.
336 sub _build_unique_query {
337 my ($self, $query, $unique_cols) = @_;
340 map { $_ => $query->{$_} }
341 grep { exists $query->{$_} }
344 return \%unique_query;
347 =head2 search_related
351 =item Arguments: $cond, \%attrs?
353 =item Return Value: $new_resultset
357 $new_rs = $cd_rs->search_related('artist', {
361 Searches the specified relationship, optionally specifying a condition and
362 attributes for matching records. See L</ATTRIBUTES> for more information.
367 return shift->related_resultset(shift)->search(@_);
374 =item Arguments: none
376 =item Return Value: $cursor
380 Returns a storage-driven cursor to the given resultset. See
381 L<DBIx::Class::Cursor> for more information.
389 my $attrs = { %{$self->{_attrs}} };
390 return $self->{cursor}
391 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
392 $attrs->{where},$attrs);
399 =item Arguments: $cond?
401 =item Return Value: $row_object?
405 my $cd = $schema->resultset('CD')->single({ year => 2001 });
407 Inflates the first result without creating a cursor if the resultset has
408 any records in it; if not returns nothing. Used by L</find> as an optimisation.
410 Can optionally take an additional condition *only* - this is a fast-code-path
411 method; if you need to add extra joins or similar call ->search and then
412 ->single without a condition on the $rs returned from that.
417 my ($self, $where) = @_;
419 my $attrs = { %{$self->{_attrs}} };
421 if (defined $attrs->{where}) {
424 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
425 $where, delete $attrs->{where} ]
428 $attrs->{where} = $where;
432 my @data = $self->result_source->storage->select_single(
433 $attrs->{from}, $attrs->{select},
434 $attrs->{where},$attrs);
435 return (@data ? $self->_construct_object(@data) : ());
442 =item Arguments: $cond?
444 =item Return Value: $resultsetcolumn
448 my $max_length = $rs->get_column('length')->max;
450 Returns a ResultSetColumn instance for $column based on $self
455 my ($self, $column) = @_;
457 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
465 =item Arguments: $cond, \%attrs?
467 =item Return Value: $resultset (scalar context), @row_objs (list context)
471 # WHERE title LIKE '%blue%'
472 $cd_rs = $rs->search_like({ title => '%blue%'});
474 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
475 that this is simply a convenience method. You most likely want to use
476 L</search> with specific operators.
478 For more information, see L<DBIx::Class::Manual::Cookbook>.
484 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
485 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
486 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
487 return $class->search($query, { %$attrs });
494 =item Arguments: $first, $last
496 =item Return Value: $resultset (scalar context), @row_objs (list context)
500 Returns a resultset or object list representing a subset of elements from the
501 resultset slice is called on. Indexes are from 0, i.e., to get the first
504 my ($one, $two, $three) = $rs->slice(0, 2);
509 my ($self, $min, $max) = @_;
510 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
511 $attrs->{offset} = $self->{attrs}{offset} || 0;
512 $attrs->{offset} += $min;
513 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
514 return $self->search(undef(), $attrs);
515 #my $slice = (ref $self)->new($self->result_source, $attrs);
516 #return (wantarray ? $slice->all : $slice);
523 =item Arguments: none
525 =item Return Value: $result?
529 Returns the next element in the resultset (C<undef> is there is none).
531 Can be used to efficiently iterate over records in the resultset:
533 my $rs = $schema->resultset('CD')->search;
534 while (my $cd = $rs->next) {
538 Note that you need to store the resultset object, and call C<next> on it.
539 Calling C<< resultset('Table')->next >> repeatedly will always return the
540 first record from the resultset.
546 if (my $cache = $self->get_cache) {
547 $self->{all_cache_position} ||= 0;
548 return $cache->[$self->{all_cache_position}++];
550 if ($self->{attrs}{cache}) {
551 $self->{all_cache_position} = 1;
552 return ($self->all)[0];
554 my @row = (exists $self->{stashed_row} ?
555 @{delete $self->{stashed_row}} :
558 return unless (@row);
559 return $self->_construct_object(@row);
565 return if(exists $self->{_attrs}); #return if _resolve has already been called
567 my $attrs = $self->{attrs};
568 my $source = ($self->{_parent_rs}) ? $self->{_parent_rs} : $self->{result_source};
570 # XXX - lose storable dclone
571 my $record_filter = delete $attrs->{record_filter} if (defined $attrs->{record_filter});
572 $attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } };
573 $attrs->{record_filter} = $record_filter if ($record_filter);
574 $self->{attrs}->{record_filter} = $record_filter if ($record_filter);
576 my $alias = $attrs->{alias};
578 $attrs->{columns} ||= delete $attrs->{cols} if $attrs->{cols};
579 delete $attrs->{as} if $attrs->{columns};
580 $attrs->{columns} ||= [ $self->{result_source}->columns ] unless $attrs->{select};
581 my $select_alias = ($self->{_parent_rs}) ? $self->{attrs}->{_live_join} : $alias;
583 map { m/\./ ? $_ : "${select_alias}.$_" } @{delete $attrs->{columns}}
584 ] if $attrs->{columns};
586 map { m/^\Q$alias.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}}
588 if (my $include = delete $attrs->{include_columns}) {
589 push(@{$attrs->{select}}, @$include);
590 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1; } @$include);
593 $attrs->{from} ||= [ { $alias => $source->from } ];
594 $attrs->{seen_join} ||= {};
596 if (my $join = delete $attrs->{join}) {
597 foreach my $j (ref $join eq 'ARRAY' ? @$join : ($join)) {
598 if (ref $j eq 'HASH') {
599 $seen{$_} = 1 foreach keys %$j;
605 push(@{$attrs->{from}}, $source->resolve_join($join, $attrs->{alias}, $attrs->{seen_join}));
607 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
608 $attrs->{order_by} = [ $attrs->{order_by} ] if
609 $attrs->{order_by} and !ref($attrs->{order_by});
610 $attrs->{order_by} ||= [];
612 if(my $seladds = delete($attrs->{'+select'})) {
613 my @seladds = (ref($seladds) eq 'ARRAY' ? @$seladds : ($seladds));
615 @{ $attrs->{select} },
616 map { (m/\./ || ref($_)) ? $_ : "${alias}.$_" } $seladds
619 if(my $asadds = delete($attrs->{'+as'})) {
620 my @asadds = (ref($asadds) eq 'ARRAY' ? @$asadds : ($asadds));
621 $attrs->{as} = [ @{ $attrs->{as} }, @asadds ];
624 my $collapse = $attrs->{collapse} || {};
625 if (my $prefetch = delete $attrs->{prefetch}) {
627 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
628 if ( ref $p eq 'HASH' ) {
629 foreach my $key (keys %$p) {
630 push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias}))
634 push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias}))
637 my @prefetch = $source->resolve_prefetch(
638 $p, $attrs->{alias}, {}, \@pre_order, $collapse);
639 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
640 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
642 push(@{$attrs->{order_by}}, @pre_order);
644 $attrs->{collapse} = $collapse;
645 $self->{_attrs} = $attrs;
649 my ($self, $a, $b, $is_prefetch) = @_;
652 if (ref $b eq 'HASH' && ref $a eq 'HASH') {
653 foreach my $key (keys %{$b}) {
654 if (exists $a->{$key}) {
655 $a->{$key} = $self->_merge_attr($a->{$key}, $b->{$key}, $is_prefetch);
657 $a->{$key} = delete $b->{$key};
662 $a = [$a] unless (ref $a eq 'ARRAY');
663 $b = [$b] unless (ref $b eq 'ARRAY');
668 foreach my $element (@{$_}) {
669 if (ref $element eq 'HASH') {
670 $hash = $self->_merge_attr($hash, $element, $is_prefetch);
671 } elsif (ref $element eq 'ARRAY') {
672 $array = [@{$array}, @{$element}];
674 if (($b == $_) && $is_prefetch) {
675 $self->_merge_array($array, $element, $is_prefetch);
677 push(@{$array}, $element);
683 if ((keys %{$hash}) && (scalar(@{$array} > 0))) {
684 return [$hash, @{$array}];
686 return (keys %{$hash}) ? $hash : $array;
692 my ($self, $a, $b) = @_;
694 $b = [$b] unless (ref $b eq 'ARRAY');
695 # add elements from @{$b} to @{$a} which aren't already in @{$a}
696 foreach my $b_element (@{$b}) {
697 push(@{$a}, $b_element) unless grep {$b_element eq $_} @{$a};
701 sub _construct_object {
702 my ($self, @row) = @_;
703 my @as = @{ $self->{_attrs}{as} };
705 my $info = $self->_collapse_result(\@as, \@row);
706 my $new = $self->result_class->inflate_result($self->result_source, @$info);
707 $new = $self->{_attrs}{record_filter}->($new)
708 if exists $self->{_attrs}{record_filter};
712 sub _collapse_result {
713 my ($self, $as, $row, $prefix) = @_;
715 my $live_join = $self->{attrs}->{_live_join} ||="";
719 foreach my $this_as (@$as) {
720 my $val = shift @copy;
721 if (defined $prefix) {
722 if ($this_as =~ m/^\Q${prefix}.\E(.+)$/) {
724 $remain =~ /^(?:(.*)\.)?([^.]+)$/;
725 $const{$1||''}{$2} = $val;
728 $this_as =~ /^(?:(.*)\.)?([^.]+)$/;
729 $const{$1||''}{$2} = $val;
733 my $info = [ {}, {} ];
734 foreach my $key (keys %const) {
735 if (length $key && $key ne $live_join) {
737 my @parts = split(/\./, $key);
738 foreach my $p (@parts) {
739 $target = $target->[1]->{$p} ||= [];
741 $target->[0] = $const{$key};
743 $info->[0] = $const{$key};
748 if (defined $prefix) {
750 m/^\Q${prefix}.\E(.+)$/ ? ($1) : ()
751 } keys %{$self->{_attrs}->{collapse}}
753 @collapse = keys %{$self->{_attrs}->{collapse}};
757 my ($c) = sort { length $a <=> length $b } @collapse;
759 foreach my $p (split(/\./, $c)) {
760 $target = $target->[1]->{$p} ||= [];
762 my $c_prefix = (defined($prefix) ? "${prefix}.${c}" : $c);
763 my @co_key = @{$self->{_attrs}->{collapse}{$c_prefix}};
764 my %co_check = map { ($_, $target->[0]->{$_}); } @co_key;
765 my $tree = $self->_collapse_result($as, $row, $c_prefix);
768 !defined($tree->[0]->{$_}) ||
769 $co_check{$_} ne $tree->[0]->{$_}
772 last unless (@raw = $self->cursor->next);
773 $row = $self->{stashed_row} = \@raw;
774 $tree = $self->_collapse_result($as, $row, $c_prefix);
776 @$target = (@final ? @final : [ {}, {} ]);
777 # single empty result to indicate an empty prefetched has_many
786 =item Arguments: $result_source?
788 =item Return Value: $result_source
792 An accessor for the primary ResultSource object from which this ResultSet
802 =item Arguments: $cond, \%attrs??
804 =item Return Value: $count
808 Performs an SQL C<COUNT> with the same query as the resultset was built
809 with to find the number of elements. If passed arguments, does a search
810 on the resultset and counts the results of that.
812 Note: When using C<count> with C<group_by>, L<DBIX::Class> emulates C<GROUP BY>
813 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
814 not support C<DISTINCT> with multiple columns. If you are using such a
815 database, you should only use columns from the main table in your C<group_by>
822 return $self->search(@_)->count if @_ and defined $_[0];
823 return scalar @{ $self->get_cache } if $self->get_cache;
825 my $count = $self->_count;
826 return 0 unless $count;
828 $count -= $self->{attrs}{offset} if $self->{attrs}{offset};
829 $count = $self->{attrs}{rows} if
830 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
834 sub _count { # Separated out so pager can get the full count
836 my $select = { count => '*' };
839 my $attrs = { %{ $self->{_attrs} } };
840 if (my $group_by = delete $attrs->{group_by}) {
841 delete $attrs->{having};
842 my @distinct = (ref $group_by ? @$group_by : ($group_by));
843 # todo: try CONCAT for multi-column pk
844 my @pk = $self->result_source->primary_columns;
846 foreach my $column (@distinct) {
847 if ($column =~ qr/^(?:\Q$attrs->{alias}.\E)?$pk[0]$/) {
848 @distinct = ($column);
854 $select = { count => { distinct => \@distinct } };
857 $attrs->{select} = $select;
858 $attrs->{as} = [qw/count/];
860 # offset, order by and page are not needed to count. record_filter is cdbi
861 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
862 my ($count) = (ref $self)->new($self->result_source, $attrs)->cursor->next;
870 =item Arguments: $sql_fragment, @bind_values
872 =item Return Value: $count
876 Counts the results in a literal query. Equivalent to calling L</search_literal>
877 with the passed arguments, then L</count>.
881 sub count_literal { shift->search_literal(@_)->count; }
887 =item Arguments: none
889 =item Return Value: @objects
893 Returns all elements in the resultset. Called implicitly if the resultset
894 is returned in list context.
900 return @{ $self->get_cache } if $self->get_cache;
904 # TODO: don't call resolve here
906 if (keys %{$self->{_attrs}->{collapse}}) {
907 # if ($self->{attrs}->{prefetch}) {
908 # Using $self->cursor->all is really just an optimisation.
909 # If we're collapsing has_many prefetches it probably makes
910 # very little difference, and this is cleaner than hacking
911 # _construct_object to survive the approach
912 my @row = $self->cursor->next;
914 push(@obj, $self->_construct_object(@row));
915 @row = (exists $self->{stashed_row}
916 ? @{delete $self->{stashed_row}}
917 : $self->cursor->next);
920 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
923 $self->set_cache(\@obj) if $self->{attrs}{cache};
931 =item Arguments: none
933 =item Return Value: $self
937 Resets the resultset's cursor, so you can iterate through the elements again.
943 delete $self->{_attrs} if (exists $self->{_attrs});
945 $self->{all_cache_position} = 0;
946 $self->cursor->reset;
954 =item Arguments: none
956 =item Return Value: $object?
960 Resets the resultset and returns an object for the first result (if the
961 resultset returns anything).
966 return $_[0]->reset->next;
969 # _cond_for_update_delete
971 # update/delete require the condition to be modified to handle
972 # the differing SQL syntax available. This transforms the $self->{cond}
973 # appropriately, returning the new condition.
975 sub _cond_for_update_delete {
979 if (!ref($self->{cond})) {
980 # No-op. No condition, we're updating/deleting everything
982 elsif (ref $self->{cond} eq 'ARRAY') {
986 foreach my $key (keys %{$_}) {
988 $hash{$1} = $_->{$key};
994 elsif (ref $self->{cond} eq 'HASH') {
995 if ((keys %{$self->{cond}})[0] eq '-and') {
998 my @cond = @{$self->{cond}{-and}};
999 for (my $i = 0; $i <= @cond - 1; $i++) {
1000 my $entry = $cond[$i];
1003 if (ref $entry eq 'HASH') {
1004 foreach my $key (keys %{$entry}) {
1006 $hash{$1} = $entry->{$key};
1010 $entry =~ /([^.]+)$/;
1011 $hash{$1} = $cond[++$i];
1014 push @{$cond->{-and}}, \%hash;
1018 foreach my $key (keys %{$self->{cond}}) {
1020 $cond->{$1} = $self->{cond}{$key};
1025 $self->throw_exception(
1026 "Can't update/delete on resultset with condition unless hash or array"
1038 =item Arguments: \%values
1040 =item Return Value: $storage_rv
1044 Sets the specified columns in the resultset to the supplied values in a
1045 single query. Return value will be true if the update succeeded or false
1046 if no records were updated; exact type of success value is storage-dependent.
1051 my ($self, $values) = @_;
1052 $self->throw_exception("Values for update must be a hash")
1053 unless ref $values eq 'HASH';
1055 my $cond = $self->_cond_for_update_delete;
1057 return $self->result_source->storage->update(
1058 $self->result_source->from, $values, $cond
1066 =item Arguments: \%values
1068 =item Return Value: 1
1072 Fetches all objects and updates them one at a time. Note that C<update_all>
1073 will run DBIC cascade triggers, while L</update> will not.
1078 my ($self, $values) = @_;
1079 $self->throw_exception("Values for update must be a hash")
1080 unless ref $values eq 'HASH';
1081 foreach my $obj ($self->all) {
1082 $obj->set_columns($values)->update;
1091 =item Arguments: none
1093 =item Return Value: 1
1097 Deletes the contents of the resultset from its result source. Note that this
1098 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1107 my $cond = $self->_cond_for_update_delete;
1109 $self->result_source->storage->delete($self->result_source->from, $cond);
1117 =item Arguments: none
1119 =item Return Value: 1
1123 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1124 will run DBIC cascade triggers, while L</delete> will not.
1130 $_->delete for $self->all;
1138 =item Arguments: none
1140 =item Return Value: $pager
1144 Return Value a L<Data::Page> object for the current resultset. Only makes
1145 sense for queries with a C<page> attribute.
1151 my $attrs = $self->{attrs};
1152 $self->throw_exception("Can't create pager for non-paged rs")
1153 unless $self->{page};
1154 $attrs->{rows} ||= 10;
1155 return $self->{pager} ||= Data::Page->new(
1156 $self->_count, $attrs->{rows}, $self->{page});
1163 =item Arguments: $page_number
1165 =item Return Value: $rs
1169 Returns a resultset for the $page_number page of the resultset on which page
1170 is called, where each page contains a number of rows equal to the 'rows'
1171 attribute set on the resultset (10 by default).
1176 my ($self, $page) = @_;
1177 my $attrs = { %{$self->{attrs}} };
1178 $attrs->{page} = $page;
1179 return (ref $self)->new($self->result_source, $attrs);
1186 =item Arguments: \%vals
1188 =item Return Value: $object
1192 Creates an object in the resultset's result class and returns it.
1197 my ($self, $values) = @_;
1198 $self->throw_exception( "new_result needs a hash" )
1199 unless (ref $values eq 'HASH');
1200 $self->throw_exception(
1201 "Can't abstract implicit construct, condition not a hash"
1202 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1204 my $alias = $self->{attrs}{alias};
1205 foreach my $key (keys %{$self->{cond}||{}}) {
1206 $new{$1} = $self->{cond}{$key} if ($key =~ m/^(?:\Q${alias}.\E)?([^.]+)$/);
1208 my $obj = $self->result_class->new(\%new);
1209 $obj->result_source($self->result_source) if $obj->can('result_source');
1217 =item Arguments: \%vals, \%attrs?
1219 =item Return Value: $object
1223 Find an existing record from this resultset. If none exists, instantiate a new
1224 result object and return it. The object will not be saved into your storage
1225 until you call L<DBIx::Class::Row/insert> on it.
1227 If you want objects to be saved immediately, use L</find_or_create> instead.
1233 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1234 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1235 my $exists = $self->find($hash, $attrs);
1236 return defined $exists ? $exists : $self->new_result($hash);
1243 =item Arguments: \%vals
1245 =item Return Value: $object
1249 Inserts a record into the resultset and returns the object representing it.
1251 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1256 my ($self, $attrs) = @_;
1257 $self->throw_exception( "create needs a hashref" )
1258 unless ref $attrs eq 'HASH';
1259 return $self->new_result($attrs)->insert;
1262 =head2 find_or_create
1266 =item Arguments: \%vals, \%attrs?
1268 =item Return Value: $object
1272 $class->find_or_create({ key => $val, ... });
1274 Searches for a record matching the search condition; if it doesn't find one,
1275 creates one and returns that instead.
1277 my $cd = $schema->resultset('CD')->find_or_create({
1279 artist => 'Massive Attack',
1280 title => 'Mezzanine',
1284 Also takes an optional C<key> attribute, to search by a specific key or unique
1285 constraint. For example:
1287 my $cd = $schema->resultset('CD')->find_or_create(
1289 artist => 'Massive Attack',
1290 title => 'Mezzanine',
1292 { key => 'artist_title' }
1295 See also L</find> and L</update_or_create>. For information on how to declare
1296 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1300 sub find_or_create {
1302 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1303 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1304 my $exists = $self->find($hash, $attrs);
1305 return defined $exists ? $exists : $self->create($hash);
1308 =head2 update_or_create
1312 =item Arguments: \%col_values, { key => $unique_constraint }?
1314 =item Return Value: $object
1318 $class->update_or_create({ col => $val, ... });
1320 First, searches for an existing row matching one of the unique constraints
1321 (including the primary key) on the source of this resultset. If a row is
1322 found, updates it with the other given column values. Otherwise, creates a new
1325 Takes an optional C<key> attribute to search on a specific unique constraint.
1328 # In your application
1329 my $cd = $schema->resultset('CD')->update_or_create(
1331 artist => 'Massive Attack',
1332 title => 'Mezzanine',
1335 { key => 'artist_title' }
1338 If no C<key> is specified, it searches on all unique constraints defined on the
1339 source, including the primary key.
1341 If the C<key> is specified as C<primary>, it searches only on the primary key.
1343 See also L</find> and L</find_or_create>. For information on how to declare
1344 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1348 sub update_or_create {
1350 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1351 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1353 my @constraint_names = exists $attrs->{key}
1355 : $self->result_source->unique_constraint_names;
1356 $self->throw_exception(
1357 "update_or_create requires a primary key or unique constraint; none is defined on "
1358 . $self->result_source->name
1359 ) unless @constraint_names;
1362 foreach my $name (@constraint_names) {
1363 my @unique_cols = $self->result_source->unique_constraint_columns($name);
1364 my $unique_query = $self->_build_unique_query($hash, \@unique_cols);
1366 push @unique_queries, $unique_query
1367 if keys %$unique_query == @unique_cols;
1370 if (@unique_queries) {
1371 my $row = $self->single(\@unique_queries);
1373 $row->update($hash);
1378 return $self->create($hash);
1385 =item Arguments: none
1387 =item Return Value: \@cache_objects?
1391 Gets the contents of the cache for the resultset, if the cache is set.
1403 =item Arguments: \@cache_objects
1405 =item Return Value: \@cache_objects
1409 Sets the contents of the cache for the resultset. Expects an arrayref
1410 of objects of the same class as those produced by the resultset. Note that
1411 if the cache is set the resultset will return the cached objects rather
1412 than re-querying the database even if the cache attr is not set.
1417 my ( $self, $data ) = @_;
1418 $self->throw_exception("set_cache requires an arrayref")
1419 if defined($data) && (ref $data ne 'ARRAY');
1420 $self->{all_cache} = $data;
1427 =item Arguments: none
1429 =item Return Value: []
1433 Clears the cache for the resultset.
1438 shift->set_cache(undef);
1441 =head2 related_resultset
1445 =item Arguments: $relationship_name
1447 =item Return Value: $resultset
1451 Returns a related resultset for the supplied relationship name.
1453 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1457 sub related_resultset {
1458 my ( $self, $rel ) = @_;
1460 $self->{related_resultsets} ||= {};
1461 return $self->{related_resultsets}{$rel} ||= do {
1462 #warn "fetching related resultset for rel '$rel' " . $self->result_source->{name};
1463 my $rel_obj = $self->result_source->relationship_info($rel);
1464 $self->throw_exception(
1465 "search_related: result source '" . $self->result_source->name .
1466 "' has no such relationship ${rel}")
1467 unless $rel_obj; #die Dumper $self->{attrs};
1469 my $rs = $self->result_source->schema->resultset($rel_obj->{class}
1471 { %{$self->{attrs}},
1475 _live_join => $rel }
1478 # keep reference of the original resultset
1479 $rs->{_parent_rs} = $self->result_source;
1484 =head2 throw_exception
1486 See L<DBIx::Class::Schema/throw_exception> for details.
1490 sub throw_exception {
1492 $self->result_source->schema->throw_exception(@_);
1495 # XXX: FIXME: Attributes docs need clearing up
1499 The resultset takes various attributes that modify its behavior. Here's an
1506 =item Value: ($order_by | \@order_by)
1510 Which column(s) to order the results by. This is currently passed
1511 through directly to SQL, so you can give e.g. C<year DESC> for a
1512 descending order on the column `year'.
1514 Please note that if you have quoting enabled (see
1515 L<DBIx::Class::Storage/quote_char>) you will need to do C<\'year DESC' > to
1516 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
1517 so you will need to manually quote things as appropriate.)
1523 =item Value: \@columns
1527 Shortcut to request a particular set of columns to be retrieved. Adds
1528 C<me.> onto the start of any column without a C<.> in it and sets C<select>
1529 from that, then auto-populates C<as> from C<select> as normal. (You may also
1530 use the C<cols> attribute, as in earlier versions of DBIC.)
1532 =head2 include_columns
1536 =item Value: \@columns
1540 Shortcut to include additional columns in the returned results - for example
1542 $schema->resultset('CD')->search(undef, {
1543 include_columns => ['artist.name'],
1547 would return all CDs and include a 'name' column to the information
1548 passed to object inflation
1554 =item Value: \@select_columns
1558 Indicates which columns should be selected from the storage. You can use
1559 column names, or in the case of RDBMS back ends, function or stored procedure
1562 $rs = $schema->resultset('Employee')->search(undef, {
1565 { count => 'employeeid' },
1570 When you use function/stored procedure names and do not supply an C<as>
1571 attribute, the column names returned are storage-dependent. E.g. MySQL would
1572 return a column named C<count(employeeid)> in the above example.
1578 Indicates additional columns to be selected from storage. Works the same as
1579 L<select> but adds columns to the selection.
1587 Indicates additional column names for those added via L<+select>.
1595 =item Value: \@inflation_names
1599 Indicates column names for object inflation. This is used in conjunction with
1600 C<select>, usually when C<select> contains one or more function or stored
1603 $rs = $schema->resultset('Employee')->search(undef, {
1606 { count => 'employeeid' }
1608 as => ['name', 'employee_count'],
1611 my $employee = $rs->first(); # get the first Employee
1613 If the object against which the search is performed already has an accessor
1614 matching a column name specified in C<as>, the value can be retrieved using
1615 the accessor as normal:
1617 my $name = $employee->name();
1619 If on the other hand an accessor does not exist in the object, you need to
1620 use C<get_column> instead:
1622 my $employee_count = $employee->get_column('employee_count');
1624 You can create your own accessors if required - see
1625 L<DBIx::Class::Manual::Cookbook> for details.
1627 Please note: This will NOT insert an C<AS employee_count> into the SQL statement
1628 produced, it is used for internal access only. Thus attempting to use the accessor
1629 in an C<order_by> clause or similar will fail misrably.
1635 =item Value: ($rel_name | \@rel_names | \%rel_names)
1639 Contains a list of relationships that should be joined for this query. For
1642 # Get CDs by Nine Inch Nails
1643 my $rs = $schema->resultset('CD')->search(
1644 { 'artist.name' => 'Nine Inch Nails' },
1645 { join => 'artist' }
1648 Can also contain a hash reference to refer to the other relation's relations.
1651 package MyApp::Schema::Track;
1652 use base qw/DBIx::Class/;
1653 __PACKAGE__->table('track');
1654 __PACKAGE__->add_columns(qw/trackid cd position title/);
1655 __PACKAGE__->set_primary_key('trackid');
1656 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
1659 # In your application
1660 my $rs = $schema->resultset('Artist')->search(
1661 { 'track.title' => 'Teardrop' },
1663 join => { cd => 'track' },
1664 order_by => 'artist.name',
1668 If the same join is supplied twice, it will be aliased to <rel>_2 (and
1669 similarly for a third time). For e.g.
1671 my $rs = $schema->resultset('Artist')->search({
1672 'cds.title' => 'Down to Earth',
1673 'cds_2.title' => 'Popular',
1675 join => [ qw/cds cds/ ],
1678 will return a set of all artists that have both a cd with title 'Down
1679 to Earth' and a cd with title 'Popular'.
1681 If you want to fetch related objects from other tables as well, see C<prefetch>
1688 =item Value: ($rel_name | \@rel_names | \%rel_names)
1692 Contains one or more relationships that should be fetched along with the main
1693 query (when they are accessed afterwards they will have already been
1694 "prefetched"). This is useful for when you know you will need the related
1695 objects, because it saves at least one query:
1697 my $rs = $schema->resultset('Tag')->search(
1706 The initial search results in SQL like the following:
1708 SELECT tag.*, cd.*, artist.* FROM tag
1709 JOIN cd ON tag.cd = cd.cdid
1710 JOIN artist ON cd.artist = artist.artistid
1712 L<DBIx::Class> has no need to go back to the database when we access the
1713 C<cd> or C<artist> relationships, which saves us two SQL statements in this
1716 Simple prefetches will be joined automatically, so there is no need
1717 for a C<join> attribute in the above search. If you're prefetching to
1718 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
1719 specify the join as well.
1721 C<prefetch> can be used with the following relationship types: C<belongs_to>,
1722 C<has_one> (or if you're using C<add_relationship>, any relationship declared
1723 with an accessor type of 'single' or 'filter').
1733 Makes the resultset paged and specifies the page to retrieve. Effectively
1734 identical to creating a non-pages resultset and then calling ->page($page)
1737 If L<rows> attribute is not specified it defualts to 10 rows per page.
1747 Specifes the maximum number of rows for direct retrieval or the number of
1748 rows per page if the page attribute or method is used.
1754 =item Value: $offset
1758 Specifies the (zero-based) row number for the first row to be returned, or the
1759 of the first row of the first page if paging is used.
1765 =item Value: \@columns
1769 A arrayref of columns to group by. Can include columns of joined tables.
1771 group_by => [qw/ column1 column2 ... /]
1777 =item Value: $condition
1781 HAVING is a select statement attribute that is applied between GROUP BY and
1782 ORDER BY. It is applied to the after the grouping calculations have been
1785 having => { 'count(employee)' => { '>=', 100 } }
1791 =item Value: (0 | 1)
1795 Set to 1 to group by all columns.
1799 Set to 1 to cache search results. This prevents extra SQL queries if you
1800 revisit rows in your ResultSet:
1802 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
1804 while( my $artist = $resultset->next ) {
1808 $rs->first; # without cache, this would issue a query
1810 By default, searches are not cached.
1812 For more examples of using these attributes, see
1813 L<DBIx::Class::Manual::Cookbook>.
1819 =item Value: \@from_clause
1823 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
1824 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
1827 NOTE: Use this on your own risk. This allows you to shoot off your foot!
1829 C<join> will usually do what you need and it is strongly recommended that you
1830 avoid using C<from> unless you cannot achieve the desired result using C<join>.
1831 And we really do mean "cannot", not just tried and failed. Attempting to use
1832 this because you're having problems with C<join> is like trying to use x86
1833 ASM because you've got a syntax error in your C. Trust us on this.
1835 Now, if you're still really, really sure you need to use this (and if you're
1836 not 100% sure, ask the mailing list first), here's an explanation of how this
1839 The syntax is as follows -
1842 { <alias1> => <table1> },
1844 { <alias2> => <table2>, -join_type => 'inner|left|right' },
1845 [], # nested JOIN (optional)
1846 { <table1.column1> => <table2.column2>, ... (more conditions) },
1848 # More of the above [ ] may follow for additional joins
1855 ON <table1.column1> = <table2.column2>
1856 <more joins may follow>
1858 An easy way to follow the examples below is to remember the following:
1860 Anything inside "[]" is a JOIN
1861 Anything inside "{}" is a condition for the enclosing JOIN
1863 The following examples utilize a "person" table in a family tree application.
1864 In order to express parent->child relationships, this table is self-joined:
1866 # Person->belongs_to('father' => 'Person');
1867 # Person->belongs_to('mother' => 'Person');
1869 C<from> can be used to nest joins. Here we return all children with a father,
1870 then search against all mothers of those children:
1872 $rs = $schema->resultset('Person')->search(
1875 alias => 'mother', # alias columns in accordance with "from"
1877 { mother => 'person' },
1880 { child => 'person' },
1882 { father => 'person' },
1883 { 'father.person_id' => 'child.father_id' }
1886 { 'mother.person_id' => 'child.mother_id' }
1893 # SELECT mother.* FROM person mother
1896 # JOIN person father
1897 # ON ( father.person_id = child.father_id )
1899 # ON ( mother.person_id = child.mother_id )
1901 The type of any join can be controlled manually. To search against only people
1902 with a father in the person table, we could explicitly use C<INNER JOIN>:
1904 $rs = $schema->resultset('Person')->search(
1907 alias => 'child', # alias columns in accordance with "from"
1909 { child => 'person' },
1911 { father => 'person', -join_type => 'inner' },
1912 { 'father.id' => 'child.father_id' }
1919 # SELECT child.* FROM person child
1920 # INNER JOIN person father ON child.father_id = father.id