1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::ResultSetColumn;
13 use DBIx::Class::ResultSourceHandle;
16 use base qw/DBIx::Class/;
18 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
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 })->all();
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');
57 If a resultset is used in a numeric context it returns the L</count>.
58 However, if it is used in a booleand context it is always true. So if
59 you want to check if a resultset has any results use C<if $rs != 0>.
60 C<if $rs> will always be true.
68 =item Arguments: $source, \%$attrs
70 =item Return Value: $rs
74 The resultset constructor. Takes a source object (usually a
75 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
76 L</ATTRIBUTES> below). Does not perform any queries -- these are
77 executed as needed by the other methods.
79 Generally you won't need to construct a resultset manually. You'll
80 automatically get one from e.g. a L</search> called in scalar context:
82 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
84 IMPORTANT: If called on an object, proxies to new_result instead so
86 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
88 will return a CD object, not a ResultSet.
94 return $class->new_result(@_) if ref $class;
96 my ($source, $attrs) = @_;
97 $source = $source->handle
98 unless $source->isa('DBIx::Class::ResultSourceHandle');
99 $attrs = { %{$attrs||{}} };
101 if ($attrs->{page}) {
102 $attrs->{rows} ||= 10;
105 $attrs->{alias} ||= 'me';
107 # Creation of {} and bless separated to mitigate RH perl bug
108 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
110 _source_handle => $source,
111 cond => $attrs->{where},
120 $attrs->{result_class} || $source->resolve->result_class
130 =item Arguments: $cond, \%attrs?
132 =item Return Value: $resultset (scalar context), @row_objs (list context)
136 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
137 my $new_rs = $cd_rs->search({ year => 2005 });
139 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
140 # year = 2005 OR year = 2004
142 If you need to pass in additional attributes but no additional condition,
143 call it as C<search(undef, \%attrs)>.
145 # "SELECT name, artistid FROM $artist_table"
146 my @all_artists = $schema->resultset('Artist')->search(undef, {
147 columns => [qw/name artistid/],
150 For a list of attributes that can be passed to C<search>, see
151 L</ATTRIBUTES>. For more examples of using this function, see
152 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
153 documentation for the first argument, see L<SQL::Abstract>.
155 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
161 my $rs = $self->search_rs( @_ );
162 return (wantarray ? $rs->all : $rs);
169 =item Arguments: $cond, \%attrs?
171 =item Return Value: $resultset
175 This method does the same exact thing as search() except it will
176 always return a resultset, even in list context.
184 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
185 my $our_attrs = { %{$self->{attrs}} };
186 my $having = delete $our_attrs->{having};
187 my $where = delete $our_attrs->{where};
191 my %safe = (alias => 1, cache => 1);
194 (@_ && defined($_[0])) # @_ == () or (undef)
196 (keys %$attrs # empty attrs or only 'safe' attrs
197 && List::Util::first { !$safe{$_} } keys %$attrs)
199 # no search, effectively just a clone
200 $rows = $self->get_cache;
203 my $new_attrs = { %{$our_attrs}, %{$attrs} };
205 # merge new attrs into inherited
206 foreach my $key (qw/join prefetch +select +as/) {
207 next unless exists $attrs->{$key};
208 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
213 (@_ == 1 || ref $_[0] eq "HASH")
215 (ref $_[0] eq 'HASH')
217 (keys %{ $_[0] } > 0)
225 ? $self->throw_exception("Odd number of arguments to search")
232 if (defined $where) {
233 $new_attrs->{where} = (
234 defined $new_attrs->{where}
237 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
238 } $where, $new_attrs->{where}
245 $new_attrs->{where} = (
246 defined $new_attrs->{where}
249 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
250 } $cond, $new_attrs->{where}
256 if (defined $having) {
257 $new_attrs->{having} = (
258 defined $new_attrs->{having}
261 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
262 } $having, $new_attrs->{having}
268 my $rs = (ref $self)->new($self->result_source, $new_attrs);
270 $rs->set_cache($rows);
275 =head2 search_literal
279 =item Arguments: $sql_fragment, @bind_values
281 =item Return Value: $resultset (scalar context), @row_objs (list context)
285 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
286 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
288 Pass a literal chunk of SQL to be added to the conditional part of the
291 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
292 only be used in that context. There are known problems using C<search_literal>
293 in chained queries; it can result in bind values in the wrong order. See
294 L<DBIx::Class::Manual::Cookbook/Searching> and
295 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
296 require C<search_literal>.
301 my ($self, $cond, @vals) = @_;
302 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
303 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
304 return $self->search(\$cond, $attrs);
311 =item Arguments: @values | \%cols, \%attrs?
313 =item Return Value: $row_object | undef
317 Finds a row based on its primary key or unique constraint. For example, to find
318 a row by its primary key:
320 my $cd = $schema->resultset('CD')->find(5);
322 You can also find a row by a specific unique constraint using the C<key>
323 attribute. For example:
325 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
326 key => 'cd_artist_title'
329 Additionally, you can specify the columns explicitly by name:
331 my $cd = $schema->resultset('CD')->find(
333 artist => 'Massive Attack',
334 title => 'Mezzanine',
336 { key => 'cd_artist_title' }
339 If the C<key> is specified as C<primary>, it searches only on the primary key.
341 If no C<key> is specified, it searches on all unique constraints defined on the
342 source for which column data is provided, including the primary key.
344 If your table does not have a primary key, you B<must> provide a value for the
345 C<key> attribute matching one of the unique constraints on the source.
347 In addition to C<key>, L</find> recognizes and applies standard
348 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
350 Note: If your query does not return only one row, a warning is generated:
352 Query returned more than one row
354 See also L</find_or_create> and L</update_or_create>. For information on how to
355 declare unique constraints, see
356 L<DBIx::Class::ResultSource/add_unique_constraint>.
362 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
364 # Default to the primary key, but allow a specific key
365 my @cols = exists $attrs->{key}
366 ? $self->result_source->unique_constraint_columns($attrs->{key})
367 : $self->result_source->primary_columns;
368 $self->throw_exception(
369 "Can't find unless a primary key is defined or unique constraint is specified"
372 # Parse out a hashref from input
374 if (ref $_[0] eq 'HASH') {
375 $input_query = { %{$_[0]} };
377 elsif (@_ == @cols) {
379 @{$input_query}{@cols} = @_;
382 # Compatibility: Allow e.g. find(id => $value)
383 carp "Find by key => value deprecated; please use a hashref instead";
387 my (%related, $info);
389 KEY: foreach my $key (keys %$input_query) {
390 if (ref($input_query->{$key})
391 && ($info = $self->result_source->relationship_info($key))) {
392 my $val = delete $input_query->{$key};
393 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
394 my $rel_q = $self->result_source->resolve_condition(
395 $info->{cond}, $val, $key
397 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
398 @related{keys %$rel_q} = values %$rel_q;
401 if (my @keys = keys %related) {
402 @{$input_query}{@keys} = values %related;
406 # Build the final query: Default to the disjunction of the unique queries,
407 # but allow the input query in case the ResultSet defines the query or the
408 # user is abusing find
409 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
411 if (exists $attrs->{key}) {
412 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
413 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
414 $query = $self->_add_alias($unique_query, $alias);
417 my @unique_queries = $self->_unique_queries($input_query, $attrs);
418 $query = @unique_queries
419 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
420 : $self->_add_alias($input_query, $alias);
425 my $rs = $self->search($query, $attrs);
426 if (keys %{$rs->_resolved_attrs->{collapse}}) {
428 carp "Query returned more than one row" if $rs->next;
436 if (keys %{$self->_resolved_attrs->{collapse}}) {
437 my $rs = $self->search($query);
439 carp "Query returned more than one row" if $rs->next;
443 return $self->single($query);
450 # Add the specified alias to the specified query hash. A copy is made so the
451 # original query is not modified.
454 my ($self, $query, $alias) = @_;
456 my %aliased = %$query;
457 foreach my $col (grep { ! m/\./ } keys %aliased) {
458 $aliased{"$alias.$col"} = delete $aliased{$col};
466 # Build a list of queries which satisfy unique constraints.
468 sub _unique_queries {
469 my ($self, $query, $attrs) = @_;
471 my @constraint_names = exists $attrs->{key}
473 : $self->result_source->unique_constraint_names;
475 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
476 my $num_where = scalar keys %$where;
479 foreach my $name (@constraint_names) {
480 my @unique_cols = $self->result_source->unique_constraint_columns($name);
481 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
483 my $num_cols = scalar @unique_cols;
484 my $num_query = scalar keys %$unique_query;
486 my $total = $num_query + $num_where;
487 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
488 # The query is either unique on its own or is unique in combination with
489 # the existing where clause
490 push @unique_queries, $unique_query;
494 return @unique_queries;
497 # _build_unique_query
499 # Constrain the specified query hash based on the specified column names.
501 sub _build_unique_query {
502 my ($self, $query, $unique_cols) = @_;
505 map { $_ => $query->{$_} }
506 grep { exists $query->{$_} }
511 =head2 search_related
515 =item Arguments: $rel, $cond, \%attrs?
517 =item Return Value: $new_resultset
521 $new_rs = $cd_rs->search_related('artist', {
525 Searches the specified relationship, optionally specifying a condition and
526 attributes for matching records. See L</ATTRIBUTES> for more information.
531 return shift->related_resultset(shift)->search(@_);
534 =head2 search_related_rs
536 This method works exactly the same as search_related, except that
537 it guarantees a restultset, even in list context.
541 sub search_related_rs {
542 return shift->related_resultset(shift)->search_rs(@_);
549 =item Arguments: none
551 =item Return Value: $cursor
555 Returns a storage-driven cursor to the given resultset. See
556 L<DBIx::Class::Cursor> for more information.
563 my $attrs = { %{$self->_resolved_attrs} };
564 return $self->{cursor}
565 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
566 $attrs->{where},$attrs);
573 =item Arguments: $cond?
575 =item Return Value: $row_object?
579 my $cd = $schema->resultset('CD')->single({ year => 2001 });
581 Inflates the first result without creating a cursor if the resultset has
582 any records in it; if not returns nothing. Used by L</find> as a lean version of
585 While this method can take an optional search condition (just like L</search>)
586 being a fast-code-path it does not recognize search attributes. If you need to
587 add extra joins or similar, call L</search> and then chain-call L</single> on the
588 L<DBIx::Class::ResultSet> returned.
594 As of 0.08100, this method enforces the assumption that the preceeding
595 query returns only one row. If more than one row is returned, you will receive
598 Query returned more than one row
600 In this case, you should be using L</first> or L</find> instead, or if you really
601 know what you are doing, use the L</rows> attribute to explicitly limit the size
609 my ($self, $where) = @_;
610 my $attrs = { %{$self->_resolved_attrs} };
612 if (defined $attrs->{where}) {
615 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
616 $where, delete $attrs->{where} ]
619 $attrs->{where} = $where;
623 # XXX: Disabled since it doesn't infer uniqueness in all cases
624 # unless ($self->_is_unique_query($attrs->{where})) {
625 # carp "Query not guaranteed to return a single row"
626 # . "; please declare your unique constraints or use search instead";
629 my @data = $self->result_source->storage->select_single(
630 $attrs->{from}, $attrs->{select},
631 $attrs->{where}, $attrs
634 return (@data ? ($self->_construct_object(@data))[0] : undef);
639 # Try to determine if the specified query is guaranteed to be unique, based on
640 # the declared unique constraints.
642 sub _is_unique_query {
643 my ($self, $query) = @_;
645 my $collapsed = $self->_collapse_query($query);
646 my $alias = $self->{attrs}{alias};
648 foreach my $name ($self->result_source->unique_constraint_names) {
649 my @unique_cols = map {
651 } $self->result_source->unique_constraint_columns($name);
653 # Count the values for each unique column
654 my %seen = map { $_ => 0 } @unique_cols;
656 foreach my $key (keys %$collapsed) {
657 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
658 next unless exists $seen{$aliased}; # Additional constraints are okay
659 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
662 # If we get 0 or more than 1 value for a column, it's not necessarily unique
663 return 1 unless grep { $_ != 1 } values %seen;
671 # Recursively collapse the query, accumulating values for each column.
673 sub _collapse_query {
674 my ($self, $query, $collapsed) = @_;
678 if (ref $query eq 'ARRAY') {
679 foreach my $subquery (@$query) {
680 next unless ref $subquery; # -or
681 # warn "ARRAY: " . Dumper $subquery;
682 $collapsed = $self->_collapse_query($subquery, $collapsed);
685 elsif (ref $query eq 'HASH') {
686 if (keys %$query and (keys %$query)[0] eq '-and') {
687 foreach my $subquery (@{$query->{-and}}) {
688 # warn "HASH: " . Dumper $subquery;
689 $collapsed = $self->_collapse_query($subquery, $collapsed);
693 # warn "LEAF: " . Dumper $query;
694 foreach my $col (keys %$query) {
695 my $value = $query->{$col};
696 $collapsed->{$col}{$value}++;
708 =item Arguments: $cond?
710 =item Return Value: $resultsetcolumn
714 my $max_length = $rs->get_column('length')->max;
716 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
721 my ($self, $column) = @_;
722 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
730 =item Arguments: $cond, \%attrs?
732 =item Return Value: $resultset (scalar context), @row_objs (list context)
736 # WHERE title LIKE '%blue%'
737 $cd_rs = $rs->search_like({ title => '%blue%'});
739 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
740 that this is simply a convenience method retained for ex Class::DBI users.
741 You most likely want to use L</search> with specific operators.
743 For more information, see L<DBIx::Class::Manual::Cookbook>.
749 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
750 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
751 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
752 return $class->search($query, { %$attrs });
759 =item Arguments: $first, $last
761 =item Return Value: $resultset (scalar context), @row_objs (list context)
765 Returns a resultset or object list representing a subset of elements from the
766 resultset slice is called on. Indexes are from 0, i.e., to get the first
769 my ($one, $two, $three) = $rs->slice(0, 2);
774 my ($self, $min, $max) = @_;
775 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
776 $attrs->{offset} = $self->{attrs}{offset} || 0;
777 $attrs->{offset} += $min;
778 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
779 return $self->search(undef(), $attrs);
780 #my $slice = (ref $self)->new($self->result_source, $attrs);
781 #return (wantarray ? $slice->all : $slice);
788 =item Arguments: none
790 =item Return Value: $result?
794 Returns the next element in the resultset (C<undef> is there is none).
796 Can be used to efficiently iterate over records in the resultset:
798 my $rs = $schema->resultset('CD')->search;
799 while (my $cd = $rs->next) {
803 Note that you need to store the resultset object, and call C<next> on it.
804 Calling C<< resultset('Table')->next >> repeatedly will always return the
805 first record from the resultset.
811 if (my $cache = $self->get_cache) {
812 $self->{all_cache_position} ||= 0;
813 return $cache->[$self->{all_cache_position}++];
815 if ($self->{attrs}{cache}) {
816 $self->{all_cache_position} = 1;
817 return ($self->all)[0];
819 if ($self->{stashed_objects}) {
820 my $obj = shift(@{$self->{stashed_objects}});
821 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
825 exists $self->{stashed_row}
826 ? @{delete $self->{stashed_row}}
827 : $self->cursor->next
829 return undef unless (@row);
830 my ($row, @more) = $self->_construct_object(@row);
831 $self->{stashed_objects} = \@more if @more;
835 sub _construct_object {
836 my ($self, @row) = @_;
837 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
838 my @new = $self->result_class->inflate_result($self->result_source, @$info);
839 @new = $self->{_attrs}{record_filter}->(@new)
840 if exists $self->{_attrs}{record_filter};
844 sub _collapse_result {
845 my ($self, $as_proto, $row) = @_;
849 # 'foo' => [ undef, 'foo' ]
850 # 'foo.bar' => [ 'foo', 'bar' ]
851 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
853 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
855 my %collapse = %{$self->{_attrs}{collapse}||{}};
859 # if we're doing collapsing (has_many prefetch) we need to grab records
860 # until the PK changes, so fill @pri_index. if not, we leave it empty so
861 # we know we don't have to bother.
863 # the reason for not using the collapse stuff directly is because if you
864 # had for e.g. two artists in a row with no cds, the collapse info for
865 # both would be NULL (undef) so you'd lose the second artist
867 # store just the index so we can check the array positions from the row
868 # without having to contruct the full hash
870 if (keys %collapse) {
871 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
872 foreach my $i (0 .. $#construct_as) {
873 next if defined($construct_as[$i][0]); # only self table
874 if (delete $pri{$construct_as[$i][1]}) {
875 push(@pri_index, $i);
877 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
881 # no need to do an if, it'll be empty if @pri_index is empty anyway
883 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
887 do { # no need to check anything at the front, we always want the first row
891 foreach my $this_as (@construct_as) {
892 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
895 push(@const_rows, \%const);
897 } until ( # no pri_index => no collapse => drop straight out
900 do { # get another row, stash it, drop out if different PK
902 @copy = $self->cursor->next;
903 $self->{stashed_row} = \@copy;
905 # last thing in do block, counts as true if anything doesn't match
907 # check xor defined first for NULL vs. NOT NULL then if one is
908 # defined the other must be so check string equality
911 (defined $pri_vals{$_} ^ defined $copy[$_])
912 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
917 my $alias = $self->{attrs}{alias};
924 foreach my $const (@const_rows) {
925 scalar @const_keys or do {
926 @const_keys = sort { length($a) <=> length($b) } keys %$const;
928 foreach my $key (@const_keys) {
931 my @parts = split(/\./, $key);
933 my $data = $const->{$key};
934 foreach my $p (@parts) {
935 $target = $target->[1]->{$p} ||= [];
937 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
938 # collapsing at this point and on final part
939 my $pos = $collapse_pos{$cur};
940 CK: foreach my $ck (@ckey) {
941 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
942 $collapse_pos{$cur} = $data;
943 delete @collapse_pos{ # clear all positioning for sub-entries
944 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
951 if (exists $collapse{$cur}) {
952 $target = $target->[-1];
955 $target->[0] = $data;
957 $info->[0] = $const->{$key};
969 =item Arguments: $result_source?
971 =item Return Value: $result_source
975 An accessor for the primary ResultSource object from which this ResultSet
982 =item Arguments: $result_class?
984 =item Return Value: $result_class
988 An accessor for the class to use when creating row objects. Defaults to
989 C<< result_source->result_class >> - which in most cases is the name of the
990 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
995 my ($self, $result_class) = @_;
997 $self->ensure_class_loaded($result_class);
998 $self->_result_class($result_class);
1000 $self->_result_class;
1007 =item Arguments: $cond, \%attrs??
1009 =item Return Value: $count
1013 Performs an SQL C<COUNT> with the same query as the resultset was built
1014 with to find the number of elements. If passed arguments, does a search
1015 on the resultset and counts the results of that.
1017 Note: When using C<count> with C<group_by>, L<DBIx::Class> emulates C<GROUP BY>
1018 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
1019 not support C<DISTINCT> with multiple columns. If you are using such a
1020 database, you should only use columns from the main table in your C<group_by>
1027 return $self->search(@_)->count if @_ and defined $_[0];
1028 return scalar @{ $self->get_cache } if $self->get_cache;
1029 my $count = $self->_count;
1030 return 0 unless $count;
1032 # need to take offset from resolved attrs
1034 $count -= $self->{_attrs}{offset} if $self->{_attrs}{offset};
1035 $count = $self->{attrs}{rows} if
1036 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
1037 $count = 0 if ($count < 0);
1041 sub _count { # Separated out so pager can get the full count
1043 my $select = { count => '*' };
1045 my $attrs = { %{$self->_resolved_attrs} };
1046 if (my $group_by = delete $attrs->{group_by}) {
1047 delete $attrs->{having};
1048 my @distinct = (ref $group_by ? @$group_by : ($group_by));
1049 # todo: try CONCAT for multi-column pk
1050 my @pk = $self->result_source->primary_columns;
1052 my $alias = $attrs->{alias};
1053 foreach my $column (@distinct) {
1054 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
1055 @distinct = ($column);
1061 $select = { count => { distinct => \@distinct } };
1064 $attrs->{select} = $select;
1065 $attrs->{as} = [qw/count/];
1067 # offset, order by and page are not needed to count. record_filter is cdbi
1068 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
1070 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
1071 my ($count) = $tmp_rs->cursor->next;
1079 =head2 count_literal
1083 =item Arguments: $sql_fragment, @bind_values
1085 =item Return Value: $count
1089 Counts the results in a literal query. Equivalent to calling L</search_literal>
1090 with the passed arguments, then L</count>.
1094 sub count_literal { shift->search_literal(@_)->count; }
1100 =item Arguments: none
1102 =item Return Value: @objects
1106 Returns all elements in the resultset. Called implicitly if the resultset
1107 is returned in list context.
1114 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1117 return @{ $self->get_cache } if $self->get_cache;
1121 # TODO: don't call resolve here
1122 if (keys %{$self->_resolved_attrs->{collapse}}) {
1123 # if ($self->{attrs}{prefetch}) {
1124 # Using $self->cursor->all is really just an optimisation.
1125 # If we're collapsing has_many prefetches it probably makes
1126 # very little difference, and this is cleaner than hacking
1127 # _construct_object to survive the approach
1128 my @row = $self->cursor->next;
1130 push(@obj, $self->_construct_object(@row));
1131 @row = (exists $self->{stashed_row}
1132 ? @{delete $self->{stashed_row}}
1133 : $self->cursor->next);
1136 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1139 $self->set_cache(\@obj) if $self->{attrs}{cache};
1147 =item Arguments: none
1149 =item Return Value: $self
1153 Resets the resultset's cursor, so you can iterate through the elements again.
1159 delete $self->{_attrs} if exists $self->{_attrs};
1160 $self->{all_cache_position} = 0;
1161 $self->cursor->reset;
1169 =item Arguments: none
1171 =item Return Value: $object?
1175 Resets the resultset and returns an object for the first result (if the
1176 resultset returns anything).
1181 return $_[0]->reset->next;
1184 # _cond_for_update_delete
1186 # update/delete require the condition to be modified to handle
1187 # the differing SQL syntax available. This transforms the $self->{cond}
1188 # appropriately, returning the new condition.
1190 sub _cond_for_update_delete {
1191 my ($self, $full_cond) = @_;
1194 $full_cond ||= $self->{cond};
1195 # No-op. No condition, we're updating/deleting everything
1196 return $cond unless ref $full_cond;
1198 if (ref $full_cond eq 'ARRAY') {
1202 foreach my $key (keys %{$_}) {
1204 $hash{$1} = $_->{$key};
1210 elsif (ref $full_cond eq 'HASH') {
1211 if ((keys %{$full_cond})[0] eq '-and') {
1214 my @cond = @{$full_cond->{-and}};
1215 for (my $i = 0; $i < @cond; $i++) {
1216 my $entry = $cond[$i];
1219 if (ref $entry eq 'HASH') {
1220 $hash = $self->_cond_for_update_delete($entry);
1223 $entry =~ /([^.]+)$/;
1224 $hash->{$1} = $cond[++$i];
1227 push @{$cond->{-and}}, $hash;
1231 foreach my $key (keys %{$full_cond}) {
1233 $cond->{$1} = $full_cond->{$key};
1238 $self->throw_exception(
1239 "Can't update/delete on resultset with condition unless hash or array"
1251 =item Arguments: \%values
1253 =item Return Value: $storage_rv
1257 Sets the specified columns in the resultset to the supplied values in a
1258 single query. Return value will be true if the update succeeded or false
1259 if no records were updated; exact type of success value is storage-dependent.
1264 my ($self, $values) = @_;
1265 $self->throw_exception("Values for update must be a hash")
1266 unless ref $values eq 'HASH';
1268 my $cond = $self->_cond_for_update_delete;
1270 return $self->result_source->storage->update(
1271 $self->result_source, $values, $cond
1279 =item Arguments: \%values
1281 =item Return Value: 1
1285 Fetches all objects and updates them one at a time. Note that C<update_all>
1286 will run DBIC cascade triggers, while L</update> will not.
1291 my ($self, $values) = @_;
1292 $self->throw_exception("Values for update must be a hash")
1293 unless ref $values eq 'HASH';
1294 foreach my $obj ($self->all) {
1295 $obj->set_columns($values)->update;
1304 =item Arguments: none
1306 =item Return Value: 1
1310 Deletes the contents of the resultset from its result source. Note that this
1311 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1312 to run. See also L<DBIx::Class::Row/delete>.
1314 delete may not generate correct SQL for a query with joins or a resultset
1315 chained from a related resultset. In this case it will generate a warning:-
1317 WARNING! Currently $rs->delete() does not generate proper SQL on
1318 joined resultsets, and may delete rows well outside of the contents
1319 of $rs. Use at your own risk
1321 In these cases you may find that delete_all is more appropriate, or you
1322 need to respecify your query in a way that can be expressed without a join.
1328 $self->throw_exception("Delete should not be passed any arguments")
1330 carp( 'WARNING! Currently $rs->delete() does not generate proper SQL'
1331 . ' on joined resultsets, and may delete rows well outside of the'
1332 . ' contents of $rs. Use at your own risk' )
1333 if ( $self->{attrs}{seen_join} );
1334 my $cond = $self->_cond_for_update_delete;
1336 $self->result_source->storage->delete($self->result_source, $cond);
1344 =item Arguments: none
1346 =item Return Value: 1
1350 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1351 will run DBIC cascade triggers, while L</delete> will not.
1357 $_->delete for $self->all;
1365 =item Arguments: \@data;
1369 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1370 For the arrayref of hashrefs style each hashref should be a structure suitable
1371 forsubmitting to a $resultset->create(...) method.
1373 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1374 to insert the data, as this is a faster method.
1376 Otherwise, each set of data is inserted into the database using
1377 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
1378 objects is returned.
1380 Example: Assuming an Artist Class that has many CDs Classes relating:
1382 my $Artist_rs = $schema->resultset("Artist");
1384 ## Void Context Example
1385 $Artist_rs->populate([
1386 { artistid => 4, name => 'Manufactured Crap', cds => [
1387 { title => 'My First CD', year => 2006 },
1388 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1391 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1392 { title => 'My parents sold me to a record company' ,year => 2005 },
1393 { title => 'Why Am I So Ugly?', year => 2006 },
1394 { title => 'I Got Surgery and am now Popular', year => 2007 }
1399 ## Array Context Example
1400 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1401 { name => "Artist One"},
1402 { name => "Artist Two"},
1403 { name => "Artist Three", cds=> [
1404 { title => "First CD", year => 2007},
1405 { title => "Second CD", year => 2008},
1409 print $ArtistOne->name; ## response is 'Artist One'
1410 print $ArtistThree->cds->count ## reponse is '2'
1412 For the arrayref of arrayrefs style, the first element should be a list of the
1413 fieldsnames to which the remaining elements are rows being inserted. For
1416 $Arstist_rs->populate([
1417 [qw/artistid name/],
1418 [100, 'A Formally Unknown Singer'],
1419 [101, 'A singer that jumped the shark two albums ago'],
1420 [102, 'An actually cool singer.'],
1423 Please note an important effect on your data when choosing between void and
1424 wantarray context. Since void context goes straight to C<insert_bulk> in
1425 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1426 c<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1427 create primary keys for you, you will find that your PKs are empty. In this
1428 case you will have to use the wantarray context in order to create those
1434 my $self = shift @_;
1435 my $data = ref $_[0][0] eq 'HASH'
1436 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1437 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1439 if(defined wantarray) {
1441 foreach my $item (@$data) {
1442 push(@created, $self->create($item));
1446 my ($first, @rest) = @$data;
1448 my @names = grep {!ref $first->{$_}} keys %$first;
1449 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1450 my @pks = $self->result_source->primary_columns;
1452 ## do the belongs_to relationships
1453 foreach my $index (0..$#$data) {
1454 if( grep { !defined $data->[$index]->{$_} } @pks ) {
1455 my @ret = $self->populate($data);
1459 foreach my $rel (@rels) {
1460 next unless $data->[$index]->{$rel} && ref $data->[$index]->{$rel} eq "HASH";
1461 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1462 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1463 my $related = $result->result_source->resolve_condition(
1464 $result->result_source->relationship_info($reverse)->{cond},
1469 delete $data->[$index]->{$rel};
1470 $data->[$index] = {%{$data->[$index]}, %$related};
1472 push @names, keys %$related if $index == 0;
1476 ## do bulk insert on current row
1477 my @values = map { [ @$_{@names} ] } @$data;
1479 $self->result_source->storage->insert_bulk(
1480 $self->result_source,
1485 ## do the has_many relationships
1486 foreach my $item (@$data) {
1488 foreach my $rel (@rels) {
1489 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1491 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1492 || $self->throw_exception('Cannot find the relating object.');
1494 my $child = $parent->$rel;
1496 my $related = $child->result_source->resolve_condition(
1497 $parent->result_source->relationship_info($rel)->{cond},
1502 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1503 my @populate = map { {%$_, %$related} } @rows_to_add;
1505 $child->populate( \@populate );
1511 =head2 _normalize_populate_args ($args)
1513 Private method used by L</populate> to normalize its incoming arguments. Factored
1514 out in case you want to subclass and accept new argument structures to the
1515 L</populate> method.
1519 sub _normalize_populate_args {
1520 my ($self, $data) = @_;
1521 my @names = @{shift(@$data)};
1522 my @results_to_create;
1523 foreach my $datum (@$data) {
1524 my %result_to_create;
1525 foreach my $index (0..$#names) {
1526 $result_to_create{$names[$index]} = $$datum[$index];
1528 push @results_to_create, \%result_to_create;
1530 return \@results_to_create;
1537 =item Arguments: none
1539 =item Return Value: $pager
1543 Return Value a L<Data::Page> object for the current resultset. Only makes
1544 sense for queries with a C<page> attribute.
1550 my $attrs = $self->{attrs};
1551 $self->throw_exception("Can't create pager for non-paged rs")
1552 unless $self->{attrs}{page};
1553 $attrs->{rows} ||= 10;
1554 return $self->{pager} ||= Data::Page->new(
1555 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1562 =item Arguments: $page_number
1564 =item Return Value: $rs
1568 Returns a resultset for the $page_number page of the resultset on which page
1569 is called, where each page contains a number of rows equal to the 'rows'
1570 attribute set on the resultset (10 by default).
1575 my ($self, $page) = @_;
1576 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1583 =item Arguments: \%vals
1585 =item Return Value: $rowobject
1589 Creates a new row object in the resultset's result class and returns
1590 it. The row is not inserted into the database at this point, call
1591 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1592 will tell you whether the row object has been inserted or not.
1594 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1599 my ($self, $values) = @_;
1600 $self->throw_exception( "new_result needs a hash" )
1601 unless (ref $values eq 'HASH');
1604 my $alias = $self->{attrs}{alias};
1607 defined $self->{cond}
1608 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1610 %new = %{$self->{attrs}{related_objects}};
1612 $self->throw_exception(
1613 "Can't abstract implicit construct, condition not a hash"
1614 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1616 my $collapsed_cond = (
1618 ? $self->_collapse_cond($self->{cond})
1622 # precendence must be given to passed values over values inherited from
1623 # the cond, so the order here is important.
1624 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1625 while( my($col,$value) = each %implied ){
1626 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1627 $new{$col} = $value->{'='};
1630 $new{$col} = $value if $self->_is_deterministic_value($value);
1636 %{ $self->_remove_alias($values, $alias) },
1637 -source_handle => $self->_source_handle,
1638 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1641 return $self->result_class->new(\%new);
1644 # _is_deterministic_value
1646 # Make an effor to strip non-deterministic values from the condition,
1647 # to make sure new_result chokes less
1649 sub _is_deterministic_value {
1652 my $ref_type = ref $value;
1653 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1654 return 1 if Scalar::Util::blessed($value);
1660 # Recursively collapse the condition.
1662 sub _collapse_cond {
1663 my ($self, $cond, $collapsed) = @_;
1667 if (ref $cond eq 'ARRAY') {
1668 foreach my $subcond (@$cond) {
1669 next unless ref $subcond; # -or
1670 # warn "ARRAY: " . Dumper $subcond;
1671 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1674 elsif (ref $cond eq 'HASH') {
1675 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1676 foreach my $subcond (@{$cond->{-and}}) {
1677 # warn "HASH: " . Dumper $subcond;
1678 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1682 # warn "LEAF: " . Dumper $cond;
1683 foreach my $col (keys %$cond) {
1684 my $value = $cond->{$col};
1685 $collapsed->{$col} = $value;
1695 # Remove the specified alias from the specified query hash. A copy is made so
1696 # the original query is not modified.
1699 my ($self, $query, $alias) = @_;
1701 my %orig = %{ $query || {} };
1704 foreach my $key (keys %orig) {
1706 $unaliased{$key} = $orig{$key};
1709 $unaliased{$1} = $orig{$key}
1710 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
1720 =item Arguments: \%vals, \%attrs?
1722 =item Return Value: $rowobject
1726 my $artist = $schema->resultset('Artist')->find_or_new(
1727 { artist => 'fred' }, { key => 'artists' });
1729 $cd->cd_to_producer->find_or_new({ producer => $producer },
1730 { key => 'primary });
1732 Find an existing record from this resultset, based on its primary
1733 key, or a unique constraint. If none exists, instantiate a new result
1734 object and return it. The object will not be saved into your storage
1735 until you call L<DBIx::Class::Row/insert> on it.
1737 You most likely want this method when looking for existing rows using
1738 a unique constraint that is not the primary key, or looking for
1741 If you want objects to be saved immediately, use L</find_or_create> instead.
1743 B<Note>: C<find_or_new> is probably not what you want when creating a
1744 new row in a table that uses primary keys supplied by the
1745 database. Passing in a primary key column with a value of I<undef>
1746 will cause L</find> to attempt to search for a row with a value of
1753 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1754 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1755 my $exists = $self->find($hash, $attrs);
1756 return defined $exists ? $exists : $self->new_result($hash);
1763 =item Arguments: \%vals
1765 =item Return Value: a L<DBIx::Class::Row> $object
1769 Attempt to create a single new row or a row with multiple related rows
1770 in the table represented by the resultset (and related tables). This
1771 will not check for duplicate rows before inserting, use
1772 L</find_or_create> to do that.
1774 To create one row for this resultset, pass a hashref of key/value
1775 pairs representing the columns of the table and the values you wish to
1776 store. If the appropriate relationships are set up, foreign key fields
1777 can also be passed an object representing the foreign row, and the
1778 value will be set to its primary key.
1780 To create related objects, pass a hashref for the value if the related
1781 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
1782 and use the name of the relationship as the key. (NOT the name of the field,
1783 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
1784 of hashrefs containing the data for each of the rows to create in the foreign
1785 tables, again using the relationship name as the key.
1787 Instead of hashrefs of plain related data (key/value pairs), you may
1788 also pass new or inserted objects. New objects (not inserted yet, see
1789 L</new>), will be inserted into their appropriate tables.
1791 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1793 Example of creating a new row.
1795 $person_rs->create({
1796 name=>"Some Person",
1797 email=>"somebody@someplace.com"
1800 Example of creating a new row and also creating rows in a related C<has_many>
1801 or C<has_one> resultset. Note Arrayref.
1804 { artistid => 4, name => 'Manufactured Crap', cds => [
1805 { title => 'My First CD', year => 2006 },
1806 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1811 Example of creating a new row and also creating a row in a related
1812 C<belongs_to>resultset. Note Hashref.
1815 title=>"Music for Silly Walks",
1818 name=>"Silly Musician",
1825 my ($self, $attrs) = @_;
1826 $self->throw_exception( "create needs a hashref" )
1827 unless ref $attrs eq 'HASH';
1828 return $self->new_result($attrs)->insert;
1831 =head2 find_or_create
1835 =item Arguments: \%vals, \%attrs?
1837 =item Return Value: $rowobject
1841 $cd->cd_to_producer->find_or_create({ producer => $producer },
1842 { key => 'primary });
1844 Tries to find a record based on its primary key or unique constraints; if none
1845 is found, creates one and returns that instead.
1847 my $cd = $schema->resultset('CD')->find_or_create({
1849 artist => 'Massive Attack',
1850 title => 'Mezzanine',
1854 Also takes an optional C<key> attribute, to search by a specific key or unique
1855 constraint. For example:
1857 my $cd = $schema->resultset('CD')->find_or_create(
1859 artist => 'Massive Attack',
1860 title => 'Mezzanine',
1862 { key => 'cd_artist_title' }
1865 B<Note>: Because find_or_create() reads from the database and then
1866 possibly inserts based on the result, this method is subject to a race
1867 condition. Another process could create a record in the table after
1868 the find has completed and before the create has started. To avoid
1869 this problem, use find_or_create() inside a transaction.
1871 B<Note>: C<find_or_create> is probably not what you want when creating
1872 a new row in a table that uses primary keys supplied by the
1873 database. Passing in a primary key column with a value of I<undef>
1874 will cause L</find> to attempt to search for a row with a value of
1877 See also L</find> and L</update_or_create>. For information on how to declare
1878 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1882 sub find_or_create {
1884 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1885 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1886 my $exists = $self->find($hash, $attrs);
1887 return defined $exists ? $exists : $self->create($hash);
1890 =head2 update_or_create
1894 =item Arguments: \%col_values, { key => $unique_constraint }?
1896 =item Return Value: $rowobject
1900 $resultset->update_or_create({ col => $val, ... });
1902 First, searches for an existing row matching one of the unique constraints
1903 (including the primary key) on the source of this resultset. If a row is
1904 found, updates it with the other given column values. Otherwise, creates a new
1907 Takes an optional C<key> attribute to search on a specific unique constraint.
1910 # In your application
1911 my $cd = $schema->resultset('CD')->update_or_create(
1913 artist => 'Massive Attack',
1914 title => 'Mezzanine',
1917 { key => 'cd_artist_title' }
1920 $cd->cd_to_producer->update_or_create({
1921 producer => $producer,
1928 If no C<key> is specified, it searches on all unique constraints defined on the
1929 source, including the primary key.
1931 If the C<key> is specified as C<primary>, it searches only on the primary key.
1933 See also L</find> and L</find_or_create>. For information on how to declare
1934 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1936 B<Note>: C<update_or_create> is probably not what you want when
1937 looking for a row in a table that uses primary keys supplied by the
1938 database, unless you actually have a key value. Passing in a primary
1939 key column with a value of I<undef> will cause L</find> to attempt to
1940 search for a row with a value of I<NULL>.
1944 sub update_or_create {
1946 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1947 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1949 my $row = $self->find($cond, $attrs);
1951 $row->update($cond);
1955 return $self->create($cond);
1962 =item Arguments: none
1964 =item Return Value: \@cache_objects?
1968 Gets the contents of the cache for the resultset, if the cache is set.
1970 The cache is populated either by using the L</prefetch> attribute to
1971 L</search> or by calling L</set_cache>.
1983 =item Arguments: \@cache_objects
1985 =item Return Value: \@cache_objects
1989 Sets the contents of the cache for the resultset. Expects an arrayref
1990 of objects of the same class as those produced by the resultset. Note that
1991 if the cache is set the resultset will return the cached objects rather
1992 than re-querying the database even if the cache attr is not set.
1994 The contents of the cache can also be populated by using the
1995 L</prefetch> attribute to L</search>.
2000 my ( $self, $data ) = @_;
2001 $self->throw_exception("set_cache requires an arrayref")
2002 if defined($data) && (ref $data ne 'ARRAY');
2003 $self->{all_cache} = $data;
2010 =item Arguments: none
2012 =item Return Value: []
2016 Clears the cache for the resultset.
2021 shift->set_cache(undef);
2024 =head2 related_resultset
2028 =item Arguments: $relationship_name
2030 =item Return Value: $resultset
2034 Returns a related resultset for the supplied relationship name.
2036 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2040 sub related_resultset {
2041 my ($self, $rel) = @_;
2043 $self->{related_resultsets} ||= {};
2044 return $self->{related_resultsets}{$rel} ||= do {
2045 my $rel_obj = $self->result_source->relationship_info($rel);
2047 $self->throw_exception(
2048 "search_related: result source '" . $self->result_source->source_name .
2049 "' has no such relationship $rel")
2052 my ($from,$seen) = $self->_resolve_from($rel);
2054 my $join_count = $seen->{$rel};
2055 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2057 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2058 my %attrs = %{$self->{attrs}||{}};
2059 delete @attrs{qw(result_class alias)};
2063 if (my $cache = $self->get_cache) {
2064 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2065 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2070 my $rel_source = $self->result_source->related_source($rel);
2074 # The reason we do this now instead of passing the alias to the
2075 # search_rs below is that if you wrap/overload resultset on the
2076 # source you need to know what alias it's -going- to have for things
2077 # to work sanely (e.g. RestrictWithObject wants to be able to add
2078 # extra query restrictions, and these may need to be $alias.)
2080 my $attrs = $rel_source->resultset_attributes;
2081 local $attrs->{alias} = $alias;
2083 $rel_source->resultset
2091 where => $self->{cond},
2096 $new->set_cache($new_cache) if $new_cache;
2101 =head2 current_source_alias
2105 =item Arguments: none
2107 =item Return Value: $source_alias
2111 Returns the current table alias for the result source this resultset is built
2112 on, that will be used in the SQL query. Usually it is C<me>.
2114 Currently the source alias that refers to the result set returned by a
2115 L</search>/L</find> family method depends on how you got to the resultset: it's
2116 C<me> by default, but eg. L</search_related> aliases it to the related result
2117 source name (and keeps C<me> referring to the original result set). The long
2118 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2119 (and make this method unnecessary).
2121 Thus it's currently necessary to use this method in predefined queries (see
2122 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2123 source alias of the current result set:
2125 # in a result set class
2127 my ($self, $user) = @_;
2129 my $me = $self->current_source_alias;
2131 return $self->search(
2132 "$me.modified" => $user->id,
2138 sub current_source_alias {
2141 return ($self->{attrs} || {})->{alias} || 'me';
2145 my ($self, $extra_join) = @_;
2146 my $source = $self->result_source;
2147 my $attrs = $self->{attrs};
2149 my $from = $attrs->{from}
2150 || [ { $attrs->{alias} => $source->from } ];
2152 my $seen = { %{$attrs->{seen_join}||{}} };
2154 my $join = ($attrs->{join}
2155 ? [ $attrs->{join}, $extra_join ]
2158 # we need to take the prefetch the attrs into account before we
2159 # ->resolve_join as otherwise they get lost - captainL
2160 my $merged = $self->_merge_attr( $join, $attrs->{prefetch} );
2164 ($join ? $source->resolve_join($merged, $attrs->{alias}, $seen) : ()),
2167 return ($from,$seen);
2170 sub _resolved_attrs {
2172 return $self->{_attrs} if $self->{_attrs};
2174 my $attrs = { %{$self->{attrs}||{}} };
2175 my $source = $self->result_source;
2176 my $alias = $attrs->{alias};
2178 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2179 if ($attrs->{columns}) {
2180 delete $attrs->{as};
2181 } elsif (!$attrs->{select}) {
2182 $attrs->{columns} = [ $source->columns ];
2187 ? (ref $attrs->{select} eq 'ARRAY'
2188 ? [ @{$attrs->{select}} ]
2189 : [ $attrs->{select} ])
2190 : [ map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} ]
2194 ? (ref $attrs->{as} eq 'ARRAY'
2195 ? [ @{$attrs->{as}} ]
2197 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} ]
2201 if ($adds = delete $attrs->{include_columns}) {
2202 $adds = [$adds] unless ref $adds eq 'ARRAY';
2203 push(@{$attrs->{select}}, @$adds);
2204 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
2206 if ($adds = delete $attrs->{'+select'}) {
2207 $adds = [$adds] unless ref $adds eq 'ARRAY';
2208 push(@{$attrs->{select}},
2209 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
2211 if (my $adds = delete $attrs->{'+as'}) {
2212 $adds = [$adds] unless ref $adds eq 'ARRAY';
2213 push(@{$attrs->{as}}, @$adds);
2216 $attrs->{from} ||= [ { 'me' => $source->from } ];
2218 if (exists $attrs->{join} || exists $attrs->{prefetch}) {
2219 my $join = delete $attrs->{join} || {};
2221 if (defined $attrs->{prefetch}) {
2222 $join = $self->_merge_attr(
2223 $join, $attrs->{prefetch}
2228 $attrs->{from} = # have to copy here to avoid corrupting the original
2231 $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} })
2236 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
2237 if ($attrs->{order_by}) {
2238 $attrs->{order_by} = (ref($attrs->{order_by}) eq 'ARRAY'
2239 ? [ @{$attrs->{order_by}} ]
2240 : [ $attrs->{order_by} ]);
2242 $attrs->{order_by} = [];
2245 my $collapse = $attrs->{collapse} || {};
2246 if (my $prefetch = delete $attrs->{prefetch}) {
2247 $prefetch = $self->_merge_attr({}, $prefetch);
2249 my $seen = $attrs->{seen_join} || {};
2250 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
2251 # bring joins back to level of current class
2252 my @prefetch = $source->resolve_prefetch(
2253 $p, $alias, $seen, \@pre_order, $collapse
2255 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
2256 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
2258 push(@{$attrs->{order_by}}, @pre_order);
2260 $attrs->{collapse} = $collapse;
2262 if ($attrs->{page}) {
2263 $attrs->{offset} ||= 0;
2264 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
2267 return $self->{_attrs} = $attrs;
2271 my ($self, $attr) = @_;
2273 if (ref $attr eq 'HASH') {
2274 return $self->_rollout_hash($attr);
2275 } elsif (ref $attr eq 'ARRAY') {
2276 return $self->_rollout_array($attr);
2282 sub _rollout_array {
2283 my ($self, $attr) = @_;
2286 foreach my $element (@{$attr}) {
2287 if (ref $element eq 'HASH') {
2288 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2289 } elsif (ref $element eq 'ARRAY') {
2290 # XXX - should probably recurse here
2291 push( @rolled_array, @{$self->_rollout_array($element)} );
2293 push( @rolled_array, $element );
2296 return \@rolled_array;
2300 my ($self, $attr) = @_;
2303 foreach my $key (keys %{$attr}) {
2304 push( @rolled_array, { $key => $attr->{$key} } );
2306 return \@rolled_array;
2309 sub _calculate_score {
2310 my ($self, $a, $b) = @_;
2312 if (ref $b eq 'HASH') {
2313 my ($b_key) = keys %{$b};
2314 if (ref $a eq 'HASH') {
2315 my ($a_key) = keys %{$a};
2316 if ($a_key eq $b_key) {
2317 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2322 return ($a eq $b_key) ? 1 : 0;
2325 if (ref $a eq 'HASH') {
2326 my ($a_key) = keys %{$a};
2327 return ($b eq $a_key) ? 1 : 0;
2329 return ($b eq $a) ? 1 : 0;
2335 my ($self, $orig, $import) = @_;
2337 return $import unless defined($orig);
2338 return $orig unless defined($import);
2340 $orig = $self->_rollout_attr($orig);
2341 $import = $self->_rollout_attr($import);
2344 foreach my $import_element ( @{$import} ) {
2345 # find best candidate from $orig to merge $b_element into
2346 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2347 foreach my $orig_element ( @{$orig} ) {
2348 my $score = $self->_calculate_score( $orig_element, $import_element );
2349 if ($score > $best_candidate->{score}) {
2350 $best_candidate->{position} = $position;
2351 $best_candidate->{score} = $score;
2355 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
2357 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
2358 push( @{$orig}, $import_element );
2360 my $orig_best = $orig->[$best_candidate->{position}];
2361 # merge orig_best and b_element together and replace original with merged
2362 if (ref $orig_best ne 'HASH') {
2363 $orig->[$best_candidate->{position}] = $import_element;
2364 } elsif (ref $import_element eq 'HASH') {
2365 my ($key) = keys %{$orig_best};
2366 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
2369 $seen_keys->{$import_key} = 1; # don't merge the same key twice
2379 $self->_source_handle($_[0]->handle);
2381 $self->_source_handle->resolve;
2385 =head2 throw_exception
2387 See L<DBIx::Class::Schema/throw_exception> for details.
2391 sub throw_exception {
2393 if (ref $self && $self->_source_handle->schema) {
2394 $self->_source_handle->schema->throw_exception(@_)
2401 # XXX: FIXME: Attributes docs need clearing up
2405 Attributes are used to refine a ResultSet in various ways when
2406 searching for data. They can be passed to any method which takes an
2407 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
2410 These are in no particular order:
2416 =item Value: ($order_by | \@order_by)
2420 Which column(s) to order the results by. This is currently passed
2421 through directly to SQL, so you can give e.g. C<year DESC> for a
2422 descending order on the column `year'.
2424 Please note that if you have C<quote_char> enabled (see
2425 L<DBIx::Class::Storage::DBI/connect_info>) you will need to do C<\'year DESC' > to
2426 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
2427 so you will need to manually quote things as appropriate.)
2429 If your L<SQL::Abstract> version supports it (>=1.50), you can also use
2430 C<{-desc => 'year'}>, which takes care of the quoting for you. This is the
2437 =item Value: \@columns
2441 Shortcut to request a particular set of columns to be retrieved. Adds
2442 C<me.> onto the start of any column without a C<.> in it and sets C<select>
2443 from that, then auto-populates C<as> from C<select> as normal. (You may also
2444 use the C<cols> attribute, as in earlier versions of DBIC.)
2446 =head2 include_columns
2450 =item Value: \@columns
2454 Shortcut to include additional columns in the returned results - for example
2456 $schema->resultset('CD')->search(undef, {
2457 include_columns => ['artist.name'],
2461 would return all CDs and include a 'name' column to the information
2462 passed to object inflation. Note that the 'artist' is the name of the
2463 column (or relationship) accessor, and 'name' is the name of the column
2464 accessor in the related table.
2470 =item Value: \@select_columns
2474 Indicates which columns should be selected from the storage. You can use
2475 column names, or in the case of RDBMS back ends, function or stored procedure
2478 $rs = $schema->resultset('Employee')->search(undef, {
2481 { count => 'employeeid' },
2486 When you use function/stored procedure names and do not supply an C<as>
2487 attribute, the column names returned are storage-dependent. E.g. MySQL would
2488 return a column named C<count(employeeid)> in the above example.
2494 Indicates additional columns to be selected from storage. Works the same as
2495 L</select> but adds columns to the selection.
2503 Indicates additional column names for those added via L</+select>. See L</as>.
2511 =item Value: \@inflation_names
2515 Indicates column names for object inflation. That is, C<as>
2516 indicates the name that the column can be accessed as via the
2517 C<get_column> method (or via the object accessor, B<if one already
2518 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
2520 The C<as> attribute is used in conjunction with C<select>,
2521 usually when C<select> contains one or more function or stored
2524 $rs = $schema->resultset('Employee')->search(undef, {
2527 { count => 'employeeid' }
2529 as => ['name', 'employee_count'],
2532 my $employee = $rs->first(); # get the first Employee
2534 If the object against which the search is performed already has an accessor
2535 matching a column name specified in C<as>, the value can be retrieved using
2536 the accessor as normal:
2538 my $name = $employee->name();
2540 If on the other hand an accessor does not exist in the object, you need to
2541 use C<get_column> instead:
2543 my $employee_count = $employee->get_column('employee_count');
2545 You can create your own accessors if required - see
2546 L<DBIx::Class::Manual::Cookbook> for details.
2548 Please note: This will NOT insert an C<AS employee_count> into the SQL
2549 statement produced, it is used for internal access only. Thus
2550 attempting to use the accessor in an C<order_by> clause or similar
2551 will fail miserably.
2553 To get around this limitation, you can supply literal SQL to your
2554 C<select> attibute that contains the C<AS alias> text, eg:
2556 select => [\'myfield AS alias']
2562 =item Value: ($rel_name | \@rel_names | \%rel_names)
2566 Contains a list of relationships that should be joined for this query. For
2569 # Get CDs by Nine Inch Nails
2570 my $rs = $schema->resultset('CD')->search(
2571 { 'artist.name' => 'Nine Inch Nails' },
2572 { join => 'artist' }
2575 Can also contain a hash reference to refer to the other relation's relations.
2578 package MyApp::Schema::Track;
2579 use base qw/DBIx::Class/;
2580 __PACKAGE__->table('track');
2581 __PACKAGE__->add_columns(qw/trackid cd position title/);
2582 __PACKAGE__->set_primary_key('trackid');
2583 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
2586 # In your application
2587 my $rs = $schema->resultset('Artist')->search(
2588 { 'track.title' => 'Teardrop' },
2590 join => { cd => 'track' },
2591 order_by => 'artist.name',
2595 You need to use the relationship (not the table) name in conditions,
2596 because they are aliased as such. The current table is aliased as "me", so
2597 you need to use me.column_name in order to avoid ambiguity. For example:
2599 # Get CDs from 1984 with a 'Foo' track
2600 my $rs = $schema->resultset('CD')->search(
2603 'tracks.name' => 'Foo'
2605 { join => 'tracks' }
2608 If the same join is supplied twice, it will be aliased to <rel>_2 (and
2609 similarly for a third time). For e.g.
2611 my $rs = $schema->resultset('Artist')->search({
2612 'cds.title' => 'Down to Earth',
2613 'cds_2.title' => 'Popular',
2615 join => [ qw/cds cds/ ],
2618 will return a set of all artists that have both a cd with title 'Down
2619 to Earth' and a cd with title 'Popular'.
2621 If you want to fetch related objects from other tables as well, see C<prefetch>
2624 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
2630 =item Value: ($rel_name | \@rel_names | \%rel_names)
2634 Contains one or more relationships that should be fetched along with
2635 the main query (when they are accessed afterwards the data will
2636 already be available, without extra queries to the database). This is
2637 useful for when you know you will need the related objects, because it
2638 saves at least one query:
2640 my $rs = $schema->resultset('Tag')->search(
2649 The initial search results in SQL like the following:
2651 SELECT tag.*, cd.*, artist.* FROM tag
2652 JOIN cd ON tag.cd = cd.cdid
2653 JOIN artist ON cd.artist = artist.artistid
2655 L<DBIx::Class> has no need to go back to the database when we access the
2656 C<cd> or C<artist> relationships, which saves us two SQL statements in this
2659 Simple prefetches will be joined automatically, so there is no need
2660 for a C<join> attribute in the above search.
2662 C<prefetch> can be used with the following relationship types: C<belongs_to>,
2663 C<has_one> (or if you're using C<add_relationship>, any relationship declared
2664 with an accessor type of 'single' or 'filter'). A more complex example that
2665 prefetches an artists cds, the tracks on those cds, and the tags associted
2666 with that artist is given below (assuming many-to-many from artists to tags):
2668 my $rs = $schema->resultset('Artist')->search(
2672 { cds => 'tracks' },
2673 { artist_tags => 'tags' }
2679 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
2680 attributes will be ignored.
2690 Makes the resultset paged and specifies the page to retrieve. Effectively
2691 identical to creating a non-pages resultset and then calling ->page($page)
2694 If L<rows> attribute is not specified it defualts to 10 rows per page.
2704 Specifes the maximum number of rows for direct retrieval or the number of
2705 rows per page if the page attribute or method is used.
2711 =item Value: $offset
2715 Specifies the (zero-based) row number for the first row to be returned, or the
2716 of the first row of the first page if paging is used.
2722 =item Value: \@columns
2726 A arrayref of columns to group by. Can include columns of joined tables.
2728 group_by => [qw/ column1 column2 ... /]
2734 =item Value: $condition
2738 HAVING is a select statement attribute that is applied between GROUP BY and
2739 ORDER BY. It is applied to the after the grouping calculations have been
2742 having => { 'count(employee)' => { '>=', 100 } }
2748 =item Value: (0 | 1)
2752 Set to 1 to group by all columns.
2758 Adds to the WHERE clause.
2760 # only return rows WHERE deleted IS NULL for all searches
2761 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
2763 Can be overridden by passing C<{ where => undef }> as an attribute
2770 Set to 1 to cache search results. This prevents extra SQL queries if you
2771 revisit rows in your ResultSet:
2773 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
2775 while( my $artist = $resultset->next ) {
2779 $rs->first; # without cache, this would issue a query
2781 By default, searches are not cached.
2783 For more examples of using these attributes, see
2784 L<DBIx::Class::Manual::Cookbook>.
2790 =item Value: \@from_clause
2794 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
2795 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
2798 NOTE: Use this on your own risk. This allows you to shoot off your foot!
2800 C<join> will usually do what you need and it is strongly recommended that you
2801 avoid using C<from> unless you cannot achieve the desired result using C<join>.
2802 And we really do mean "cannot", not just tried and failed. Attempting to use
2803 this because you're having problems with C<join> is like trying to use x86
2804 ASM because you've got a syntax error in your C. Trust us on this.
2806 Now, if you're still really, really sure you need to use this (and if you're
2807 not 100% sure, ask the mailing list first), here's an explanation of how this
2810 The syntax is as follows -
2813 { <alias1> => <table1> },
2815 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2816 [], # nested JOIN (optional)
2817 { <table1.column1> => <table2.column2>, ... (more conditions) },
2819 # More of the above [ ] may follow for additional joins
2826 ON <table1.column1> = <table2.column2>
2827 <more joins may follow>
2829 An easy way to follow the examples below is to remember the following:
2831 Anything inside "[]" is a JOIN
2832 Anything inside "{}" is a condition for the enclosing JOIN
2834 The following examples utilize a "person" table in a family tree application.
2835 In order to express parent->child relationships, this table is self-joined:
2837 # Person->belongs_to('father' => 'Person');
2838 # Person->belongs_to('mother' => 'Person');
2840 C<from> can be used to nest joins. Here we return all children with a father,
2841 then search against all mothers of those children:
2843 $rs = $schema->resultset('Person')->search(
2846 alias => 'mother', # alias columns in accordance with "from"
2848 { mother => 'person' },
2851 { child => 'person' },
2853 { father => 'person' },
2854 { 'father.person_id' => 'child.father_id' }
2857 { 'mother.person_id' => 'child.mother_id' }
2864 # SELECT mother.* FROM person mother
2867 # JOIN person father
2868 # ON ( father.person_id = child.father_id )
2870 # ON ( mother.person_id = child.mother_id )
2872 The type of any join can be controlled manually. To search against only people
2873 with a father in the person table, we could explicitly use C<INNER JOIN>:
2875 $rs = $schema->resultset('Person')->search(
2878 alias => 'child', # alias columns in accordance with "from"
2880 { child => 'person' },
2882 { father => 'person', -join_type => 'inner' },
2883 { 'father.id' => 'child.father_id' }
2890 # SELECT child.* FROM person child
2891 # INNER JOIN person father ON child.father_id = father.id
2893 If you need to express really complex joins or you need a subselect, you
2894 can supply literal SQL to C<from> via a scalar reference. In this case
2895 the contents of the scalar will replace the table name asscoiated with the
2898 WARNING: This technique might very well not work as expected on chained
2899 searches - you have been warned.
2901 # Assuming the Event resultsource is defined as:
2903 MySchema::Event->add_columns (
2906 is_auto_increment => 1,
2915 MySchema::Event->set_primary_key ('sequence');
2917 # This will get back the latest event for every location. The column
2918 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
2919 # combo to limit the resultset
2921 $rs = $schema->resultset('Event');
2922 $table = $rs->result_source->name;
2923 $latest = $rs->search (
2926 (SELECT e1.* FROM $table e1
2928 ON e1.location = e2.location
2929 AND e1.sequence < e2.sequence
2930 WHERE e2.sequence is NULL
2935 # Equivalent SQL (with the DBIC chunks added):
2937 SELECT me.sequence, me.location, me.type FROM
2938 (SELECT e1.* FROM events e1
2940 ON e1.location = e2.location
2941 AND e1.sequence < e2.sequence
2942 WHERE e2.sequence is NULL
2949 =item Value: ( 'update' | 'shared' )
2953 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT