1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::ResultSetColumn;
13 use DBIx::Class::ResultSourceHandle;
15 use base qw/DBIx::Class/;
17 __PACKAGE__->mk_group_accessors('simple' => qw/result_class _source_handle/);
21 DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
25 my $rs = $schema->resultset('User')->search(registered => 1);
26 my @rows = $schema->resultset('CD')->search(year => 2005);
30 The resultset is also known as an iterator. It is responsible for handling
31 queries that may return an arbitrary number of rows, e.g. via L</search>
32 or a C<has_many> relationship.
34 In the examples below, the following table classes are used:
36 package MyApp::Schema::Artist;
37 use base qw/DBIx::Class/;
38 __PACKAGE__->load_components(qw/Core/);
39 __PACKAGE__->table('artist');
40 __PACKAGE__->add_columns(qw/artistid name/);
41 __PACKAGE__->set_primary_key('artistid');
42 __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
45 package MyApp::Schema::CD;
46 use base qw/DBIx::Class/;
47 __PACKAGE__->load_components(qw/Core/);
48 __PACKAGE__->table('cd');
49 __PACKAGE__->add_columns(qw/cdid artist title year/);
50 __PACKAGE__->set_primary_key('cdid');
51 __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
56 If a resultset is used as a number it returns the C<count()>. However, if it is used as a boolean it is always true. So if you want to check if a result set has any results use C<if $rs != 0>. C<if $rs> will always be true.
64 =item Arguments: $source, \%$attrs
66 =item Return Value: $rs
70 The resultset constructor. Takes a source object (usually a
71 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
72 L</ATTRIBUTES> below). Does not perform any queries -- these are
73 executed as needed by the other methods.
75 Generally you won't need to construct a resultset manually. You'll
76 automatically get one from e.g. a L</search> called in scalar context:
78 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
80 IMPORTANT: If called on an object, proxies to new_result instead so
82 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
84 will return a CD object, not a ResultSet.
90 return $class->new_result(@_) if ref $class;
92 my ($source, $attrs) = @_;
93 $source = $source->handle
94 unless $source->isa('DBIx::Class::ResultSourceHandle');
95 $attrs = { %{$attrs||{}} };
98 $attrs->{rows} ||= 10;
101 $attrs->{alias} ||= 'me';
103 # Creation of {} and bless separated to mitigate RH perl bug
104 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
106 _source_handle => $source,
107 result_class => $attrs->{result_class} || $source->resolve->result_class,
108 cond => $attrs->{where},
123 =item Arguments: $cond, \%attrs?
125 =item Return Value: $resultset (scalar context), @row_objs (list context)
129 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
130 my $new_rs = $cd_rs->search({ year => 2005 });
132 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
133 # year = 2005 OR year = 2004
135 If you need to pass in additional attributes but no additional condition,
136 call it as C<search(undef, \%attrs)>.
138 # "SELECT name, artistid FROM $artist_table"
139 my @all_artists = $schema->resultset('Artist')->search(undef, {
140 columns => [qw/name artistid/],
143 For a list of attributes that can be passed to C<search>, see
144 L</ATTRIBUTES>. For more examples of using this function, see
145 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
146 documentation for the first argument, see L<SQL::Abstract>.
148 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
154 my $rs = $self->search_rs( @_ );
155 return (wantarray ? $rs->all : $rs);
162 =item Arguments: $cond, \%attrs?
164 =item Return Value: $resultset
168 This method does the same exact thing as search() except it will
169 always return a resultset, even in list context.
177 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
178 my $our_attrs = { %{$self->{attrs}} };
179 my $having = delete $our_attrs->{having};
180 my $where = delete $our_attrs->{where};
184 my %safe = (alias => 1, cache => 1);
187 (@_ && defined($_[0])) # @_ == () or (undef)
189 (keys %$attrs # empty attrs or only 'safe' attrs
190 && List::Util::first { !$safe{$_} } keys %$attrs)
192 # no search, effectively just a clone
193 $rows = $self->get_cache;
196 my $new_attrs = { %{$our_attrs}, %{$attrs} };
198 # merge new attrs into inherited
199 foreach my $key (qw/join prefetch/) {
200 next unless exists $attrs->{$key};
201 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
206 (@_ == 1 || ref $_[0] eq "HASH")
208 (ref $_[0] eq 'HASH')
210 (keys %{ $_[0] } > 0)
218 ? $self->throw_exception("Odd number of arguments to search")
225 if (defined $where) {
226 $new_attrs->{where} = (
227 defined $new_attrs->{where}
230 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
231 } $where, $new_attrs->{where}
238 $new_attrs->{where} = (
239 defined $new_attrs->{where}
242 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
243 } $cond, $new_attrs->{where}
249 if (defined $having) {
250 $new_attrs->{having} = (
251 defined $new_attrs->{having}
254 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
255 } $having, $new_attrs->{having}
261 my $rs = (ref $self)->new($self->result_source, $new_attrs);
263 $rs->set_cache($rows);
268 =head2 search_literal
272 =item Arguments: $sql_fragment, @bind_values
274 =item Return Value: $resultset (scalar context), @row_objs (list context)
278 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
279 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
281 Pass a literal chunk of SQL to be added to the conditional part of the
284 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
285 only be used in that context. There are known problems using C<search_literal>
286 in chained queries; it can result in bind values in the wrong order. See
287 L<DBIx::Class::Manual::Cookbook/Searching> and
288 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
289 require C<search_literal>.
294 my ($self, $cond, @vals) = @_;
295 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
296 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
297 return $self->search(\$cond, $attrs);
304 =item Arguments: @values | \%cols, \%attrs?
306 =item Return Value: $row_object
310 Finds a row based on its primary key or unique constraint. For example, to find
311 a row by its primary key:
313 my $cd = $schema->resultset('CD')->find(5);
315 You can also find a row by a specific unique constraint using the C<key>
316 attribute. For example:
318 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
319 key => 'cd_artist_title'
322 Additionally, you can specify the columns explicitly by name:
324 my $cd = $schema->resultset('CD')->find(
326 artist => 'Massive Attack',
327 title => 'Mezzanine',
329 { key => 'cd_artist_title' }
332 If the C<key> is specified as C<primary>, it searches only on the primary key.
334 If no C<key> is specified, it searches on all unique constraints defined on the
335 source for which column data is provided, including the primary key.
337 If your table does not have a primary key, you B<must> provide a value for the
338 C<key> attribute matching one of the unique constraints on the source.
340 Note: If your query does not return only one row, a warning is generated:
342 Query returned more than one row
344 See also L</find_or_create> and L</update_or_create>. For information on how to
345 declare unique constraints, see
346 L<DBIx::Class::ResultSource/add_unique_constraint>.
352 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
354 # Default to the primary key, but allow a specific key
355 my @cols = exists $attrs->{key}
356 ? $self->result_source->unique_constraint_columns($attrs->{key})
357 : $self->result_source->primary_columns;
358 $self->throw_exception(
359 "Can't find unless a primary key is defined or unique constraint is specified"
362 # Parse out a hashref from input
364 if (ref $_[0] eq 'HASH') {
365 $input_query = { %{$_[0]} };
367 elsif (@_ == @cols) {
369 @{$input_query}{@cols} = @_;
372 # Compatibility: Allow e.g. find(id => $value)
373 carp "Find by key => value deprecated; please use a hashref instead";
377 my (%related, $info);
379 KEY: foreach my $key (keys %$input_query) {
380 if (ref($input_query->{$key})
381 && ($info = $self->result_source->relationship_info($key))) {
382 my $val = delete $input_query->{$key};
383 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
384 my $rel_q = $self->result_source->resolve_condition(
385 $info->{cond}, $val, $key
387 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
388 @related{keys %$rel_q} = values %$rel_q;
391 if (my @keys = keys %related) {
392 @{$input_query}{@keys} = values %related;
396 # Build the final query: Default to the disjunction of the unique queries,
397 # but allow the input query in case the ResultSet defines the query or the
398 # user is abusing find
399 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
401 if (exists $attrs->{key}) {
402 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
403 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
404 $query = $self->_add_alias($unique_query, $alias);
407 my @unique_queries = $self->_unique_queries($input_query, $attrs);
408 $query = @unique_queries
409 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
410 : $self->_add_alias($input_query, $alias);
415 my $rs = $self->search($query, $attrs);
416 if (keys %{$rs->_resolved_attrs->{collapse}}) {
418 carp "Query returned more than one row" if $rs->next;
426 if (keys %{$self->_resolved_attrs->{collapse}}) {
427 my $rs = $self->search($query);
429 carp "Query returned more than one row" if $rs->next;
433 return $self->single($query);
440 # Add the specified alias to the specified query hash. A copy is made so the
441 # original query is not modified.
444 my ($self, $query, $alias) = @_;
446 my %aliased = %$query;
447 foreach my $col (grep { ! m/\./ } keys %aliased) {
448 $aliased{"$alias.$col"} = delete $aliased{$col};
456 # Build a list of queries which satisfy unique constraints.
458 sub _unique_queries {
459 my ($self, $query, $attrs) = @_;
461 my @constraint_names = exists $attrs->{key}
463 : $self->result_source->unique_constraint_names;
465 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
466 my $num_where = scalar keys %$where;
469 foreach my $name (@constraint_names) {
470 my @unique_cols = $self->result_source->unique_constraint_columns($name);
471 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
473 my $num_cols = scalar @unique_cols;
474 my $num_query = scalar keys %$unique_query;
476 my $total = $num_query + $num_where;
477 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
478 # The query is either unique on its own or is unique in combination with
479 # the existing where clause
480 push @unique_queries, $unique_query;
484 return @unique_queries;
487 # _build_unique_query
489 # Constrain the specified query hash based on the specified column names.
491 sub _build_unique_query {
492 my ($self, $query, $unique_cols) = @_;
495 map { $_ => $query->{$_} }
496 grep { exists $query->{$_} }
501 =head2 search_related
505 =item Arguments: $rel, $cond, \%attrs?
507 =item Return Value: $new_resultset
511 $new_rs = $cd_rs->search_related('artist', {
515 Searches the specified relationship, optionally specifying a condition and
516 attributes for matching records. See L</ATTRIBUTES> for more information.
521 return shift->related_resultset(shift)->search(@_);
524 =head2 search_related_rs
526 This method works exactly the same as search_related, except that
527 it guarantees a restultset, even in list context.
531 sub search_related_rs {
532 return shift->related_resultset(shift)->search_rs(@_);
539 =item Arguments: none
541 =item Return Value: $cursor
545 Returns a storage-driven cursor to the given resultset. See
546 L<DBIx::Class::Cursor> for more information.
553 my $attrs = { %{$self->_resolved_attrs} };
554 return $self->{cursor}
555 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
556 $attrs->{where},$attrs);
563 =item Arguments: $cond?
565 =item Return Value: $row_object?
569 my $cd = $schema->resultset('CD')->single({ year => 2001 });
571 Inflates the first result without creating a cursor if the resultset has
572 any records in it; if not returns nothing. Used by L</find> as an optimisation.
574 Can optionally take an additional condition *only* - this is a fast-code-path
575 method; if you need to add extra joins or similar call ->search and then
576 ->single without a condition on the $rs returned from that.
581 my ($self, $where) = @_;
582 my $attrs = { %{$self->_resolved_attrs} };
584 if (defined $attrs->{where}) {
587 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
588 $where, delete $attrs->{where} ]
591 $attrs->{where} = $where;
595 # XXX: Disabled since it doesn't infer uniqueness in all cases
596 # unless ($self->_is_unique_query($attrs->{where})) {
597 # carp "Query not guaranteed to return a single row"
598 # . "; please declare your unique constraints or use search instead";
601 my @data = $self->result_source->storage->select_single(
602 $attrs->{from}, $attrs->{select},
603 $attrs->{where}, $attrs
606 return (@data ? ($self->_construct_object(@data))[0] : undef);
611 # Try to determine if the specified query is guaranteed to be unique, based on
612 # the declared unique constraints.
614 sub _is_unique_query {
615 my ($self, $query) = @_;
617 my $collapsed = $self->_collapse_query($query);
618 my $alias = $self->{attrs}{alias};
620 foreach my $name ($self->result_source->unique_constraint_names) {
621 my @unique_cols = map {
623 } $self->result_source->unique_constraint_columns($name);
625 # Count the values for each unique column
626 my %seen = map { $_ => 0 } @unique_cols;
628 foreach my $key (keys %$collapsed) {
629 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
630 next unless exists $seen{$aliased}; # Additional constraints are okay
631 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
634 # If we get 0 or more than 1 value for a column, it's not necessarily unique
635 return 1 unless grep { $_ != 1 } values %seen;
643 # Recursively collapse the query, accumulating values for each column.
645 sub _collapse_query {
646 my ($self, $query, $collapsed) = @_;
650 if (ref $query eq 'ARRAY') {
651 foreach my $subquery (@$query) {
652 next unless ref $subquery; # -or
653 # warn "ARRAY: " . Dumper $subquery;
654 $collapsed = $self->_collapse_query($subquery, $collapsed);
657 elsif (ref $query eq 'HASH') {
658 if (keys %$query and (keys %$query)[0] eq '-and') {
659 foreach my $subquery (@{$query->{-and}}) {
660 # warn "HASH: " . Dumper $subquery;
661 $collapsed = $self->_collapse_query($subquery, $collapsed);
665 # warn "LEAF: " . Dumper $query;
666 foreach my $col (keys %$query) {
667 my $value = $query->{$col};
668 $collapsed->{$col}{$value}++;
680 =item Arguments: $cond?
682 =item Return Value: $resultsetcolumn
686 my $max_length = $rs->get_column('length')->max;
688 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
693 my ($self, $column) = @_;
694 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
702 =item Arguments: $cond, \%attrs?
704 =item Return Value: $resultset (scalar context), @row_objs (list context)
708 # WHERE title LIKE '%blue%'
709 $cd_rs = $rs->search_like({ title => '%blue%'});
711 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
712 that this is simply a convenience method. You most likely want to use
713 L</search> with specific operators.
715 For more information, see L<DBIx::Class::Manual::Cookbook>.
721 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
722 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
723 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
724 return $class->search($query, { %$attrs });
731 =item Arguments: $first, $last
733 =item Return Value: $resultset (scalar context), @row_objs (list context)
737 Returns a resultset or object list representing a subset of elements from the
738 resultset slice is called on. Indexes are from 0, i.e., to get the first
741 my ($one, $two, $three) = $rs->slice(0, 2);
746 my ($self, $min, $max) = @_;
747 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
748 $attrs->{offset} = $self->{attrs}{offset} || 0;
749 $attrs->{offset} += $min;
750 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
751 return $self->search(undef(), $attrs);
752 #my $slice = (ref $self)->new($self->result_source, $attrs);
753 #return (wantarray ? $slice->all : $slice);
760 =item Arguments: none
762 =item Return Value: $result?
766 Returns the next element in the resultset (C<undef> is there is none).
768 Can be used to efficiently iterate over records in the resultset:
770 my $rs = $schema->resultset('CD')->search;
771 while (my $cd = $rs->next) {
775 Note that you need to store the resultset object, and call C<next> on it.
776 Calling C<< resultset('Table')->next >> repeatedly will always return the
777 first record from the resultset.
783 if (my $cache = $self->get_cache) {
784 $self->{all_cache_position} ||= 0;
785 return $cache->[$self->{all_cache_position}++];
787 if ($self->{attrs}{cache}) {
788 $self->{all_cache_position} = 1;
789 return ($self->all)[0];
791 if ($self->{stashed_objects}) {
792 my $obj = shift(@{$self->{stashed_objects}});
793 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
797 exists $self->{stashed_row}
798 ? @{delete $self->{stashed_row}}
799 : $self->cursor->next
801 return undef unless (@row);
802 my ($row, @more) = $self->_construct_object(@row);
803 $self->{stashed_objects} = \@more if @more;
807 sub _construct_object {
808 my ($self, @row) = @_;
809 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
810 my @new = $self->result_class->inflate_result($self->result_source, @$info);
811 @new = $self->{_attrs}{record_filter}->(@new)
812 if exists $self->{_attrs}{record_filter};
816 sub _collapse_result {
817 my ($self, $as_proto, $row) = @_;
821 # 'foo' => [ undef, 'foo' ]
822 # 'foo.bar' => [ 'foo', 'bar' ]
823 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
825 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
827 my %collapse = %{$self->{_attrs}{collapse}||{}};
831 # if we're doing collapsing (has_many prefetch) we need to grab records
832 # until the PK changes, so fill @pri_index. if not, we leave it empty so
833 # we know we don't have to bother.
835 # the reason for not using the collapse stuff directly is because if you
836 # had for e.g. two artists in a row with no cds, the collapse info for
837 # both would be NULL (undef) so you'd lose the second artist
839 # store just the index so we can check the array positions from the row
840 # without having to contruct the full hash
842 if (keys %collapse) {
843 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
844 foreach my $i (0 .. $#construct_as) {
845 next if defined($construct_as[$i][0]); # only self table
846 if (delete $pri{$construct_as[$i][1]}) {
847 push(@pri_index, $i);
849 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
853 # no need to do an if, it'll be empty if @pri_index is empty anyway
855 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
859 do { # no need to check anything at the front, we always want the first row
863 foreach my $this_as (@construct_as) {
864 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
867 push(@const_rows, \%const);
869 } until ( # no pri_index => no collapse => drop straight out
872 do { # get another row, stash it, drop out if different PK
874 @copy = $self->cursor->next;
875 $self->{stashed_row} = \@copy;
877 # last thing in do block, counts as true if anything doesn't match
879 # check xor defined first for NULL vs. NOT NULL then if one is
880 # defined the other must be so check string equality
883 (defined $pri_vals{$_} ^ defined $copy[$_])
884 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
889 my $alias = $self->{attrs}{alias};
896 foreach my $const (@const_rows) {
897 scalar @const_keys or do {
898 @const_keys = sort { length($a) <=> length($b) } keys %$const;
900 foreach my $key (@const_keys) {
903 my @parts = split(/\./, $key);
905 my $data = $const->{$key};
906 foreach my $p (@parts) {
907 $target = $target->[1]->{$p} ||= [];
909 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
910 # collapsing at this point and on final part
911 my $pos = $collapse_pos{$cur};
912 CK: foreach my $ck (@ckey) {
913 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
914 $collapse_pos{$cur} = $data;
915 delete @collapse_pos{ # clear all positioning for sub-entries
916 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
923 if (exists $collapse{$cur}) {
924 $target = $target->[-1];
927 $target->[0] = $data;
929 $info->[0] = $const->{$key};
941 =item Arguments: $result_source?
943 =item Return Value: $result_source
947 An accessor for the primary ResultSource object from which this ResultSet
954 =item Arguments: $result_class?
956 =item Return Value: $result_class
960 An accessor for the class to use when creating row objects. Defaults to
961 C<< result_source->result_class >> - which in most cases is the name of the
962 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
971 =item Arguments: $cond, \%attrs??
973 =item Return Value: $count
977 Performs an SQL C<COUNT> with the same query as the resultset was built
978 with to find the number of elements. If passed arguments, does a search
979 on the resultset and counts the results of that.
981 Note: When using C<count> with C<group_by>, L<DBIx::Class> emulates C<GROUP BY>
982 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
983 not support C<DISTINCT> with multiple columns. If you are using such a
984 database, you should only use columns from the main table in your C<group_by>
991 return $self->search(@_)->count if @_ and defined $_[0];
992 return scalar @{ $self->get_cache } if $self->get_cache;
993 my $count = $self->_count;
994 return 0 unless $count;
996 # need to take offset from resolved attrs
998 $count -= $self->{_attrs}{offset} if $self->{_attrs}{offset};
999 $count = $self->{attrs}{rows} if
1000 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
1001 $count = 0 if ($count < 0);
1005 sub _count { # Separated out so pager can get the full count
1007 my $select = { count => '*' };
1009 my $attrs = { %{$self->_resolved_attrs} };
1010 if (my $group_by = delete $attrs->{group_by}) {
1011 delete $attrs->{having};
1012 my @distinct = (ref $group_by ? @$group_by : ($group_by));
1013 # todo: try CONCAT for multi-column pk
1014 my @pk = $self->result_source->primary_columns;
1016 my $alias = $attrs->{alias};
1017 foreach my $column (@distinct) {
1018 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
1019 @distinct = ($column);
1025 $select = { count => { distinct => \@distinct } };
1028 $attrs->{select} = $select;
1029 $attrs->{as} = [qw/count/];
1031 # offset, order by and page are not needed to count. record_filter is cdbi
1032 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
1034 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
1035 my ($count) = $tmp_rs->cursor->next;
1043 =head2 count_literal
1047 =item Arguments: $sql_fragment, @bind_values
1049 =item Return Value: $count
1053 Counts the results in a literal query. Equivalent to calling L</search_literal>
1054 with the passed arguments, then L</count>.
1058 sub count_literal { shift->search_literal(@_)->count; }
1064 =item Arguments: none
1066 =item Return Value: @objects
1070 Returns all elements in the resultset. Called implicitly if the resultset
1071 is returned in list context.
1077 return @{ $self->get_cache } if $self->get_cache;
1081 # TODO: don't call resolve here
1082 if (keys %{$self->_resolved_attrs->{collapse}}) {
1083 # if ($self->{attrs}{prefetch}) {
1084 # Using $self->cursor->all is really just an optimisation.
1085 # If we're collapsing has_many prefetches it probably makes
1086 # very little difference, and this is cleaner than hacking
1087 # _construct_object to survive the approach
1088 my @row = $self->cursor->next;
1090 push(@obj, $self->_construct_object(@row));
1091 @row = (exists $self->{stashed_row}
1092 ? @{delete $self->{stashed_row}}
1093 : $self->cursor->next);
1096 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1099 $self->set_cache(\@obj) if $self->{attrs}{cache};
1107 =item Arguments: none
1109 =item Return Value: $self
1113 Resets the resultset's cursor, so you can iterate through the elements again.
1119 delete $self->{_attrs} if exists $self->{_attrs};
1120 $self->{all_cache_position} = 0;
1121 $self->cursor->reset;
1129 =item Arguments: none
1131 =item Return Value: $object?
1135 Resets the resultset and returns an object for the first result (if the
1136 resultset returns anything).
1141 return $_[0]->reset->next;
1144 # _cond_for_update_delete
1146 # update/delete require the condition to be modified to handle
1147 # the differing SQL syntax available. This transforms the $self->{cond}
1148 # appropriately, returning the new condition.
1150 sub _cond_for_update_delete {
1151 my ($self, $full_cond) = @_;
1154 $full_cond ||= $self->{cond};
1155 # No-op. No condition, we're updating/deleting everything
1156 return $cond unless ref $full_cond;
1158 if (ref $full_cond eq 'ARRAY') {
1162 foreach my $key (keys %{$_}) {
1164 $hash{$1} = $_->{$key};
1170 elsif (ref $full_cond eq 'HASH') {
1171 if ((keys %{$full_cond})[0] eq '-and') {
1174 my @cond = @{$full_cond->{-and}};
1175 for (my $i = 0; $i < @cond; $i++) {
1176 my $entry = $cond[$i];
1179 if (ref $entry eq 'HASH') {
1180 $hash = $self->_cond_for_update_delete($entry);
1183 $entry =~ /([^.]+)$/;
1184 $hash->{$1} = $cond[++$i];
1187 push @{$cond->{-and}}, $hash;
1191 foreach my $key (keys %{$full_cond}) {
1193 $cond->{$1} = $full_cond->{$key};
1198 $self->throw_exception(
1199 "Can't update/delete on resultset with condition unless hash or array"
1211 =item Arguments: \%values
1213 =item Return Value: $storage_rv
1217 Sets the specified columns in the resultset to the supplied values in a
1218 single query. Return value will be true if the update succeeded or false
1219 if no records were updated; exact type of success value is storage-dependent.
1224 my ($self, $values) = @_;
1225 $self->throw_exception("Values for update must be a hash")
1226 unless ref $values eq 'HASH';
1228 my $cond = $self->_cond_for_update_delete;
1230 return $self->result_source->storage->update(
1231 $self->result_source, $values, $cond
1239 =item Arguments: \%values
1241 =item Return Value: 1
1245 Fetches all objects and updates them one at a time. Note that C<update_all>
1246 will run DBIC cascade triggers, while L</update> will not.
1251 my ($self, $values) = @_;
1252 $self->throw_exception("Values for update must be a hash")
1253 unless ref $values eq 'HASH';
1254 foreach my $obj ($self->all) {
1255 $obj->set_columns($values)->update;
1264 =item Arguments: none
1266 =item Return Value: 1
1270 Deletes the contents of the resultset from its result source. Note that this
1271 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1272 to run. See also L<DBIx::Class::Row/delete>.
1279 my $cond = $self->_cond_for_update_delete;
1281 $self->result_source->storage->delete($self->result_source, $cond);
1289 =item Arguments: none
1291 =item Return Value: 1
1295 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1296 will run DBIC cascade triggers, while L</delete> will not.
1302 $_->delete for $self->all;
1310 =item Arguments: \@data;
1314 Pass an arrayref of hashrefs. Each hashref should be a structure suitable for
1315 submitting to a $resultset->create(...) method.
1317 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1318 to insert the data, as this is a faster method.
1320 Otherwise, each set of data is inserted into the database using
1321 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
1322 objects is returned.
1324 Example: Assuming an Artist Class that has many CDs Classes relating:
1326 my $Artist_rs = $schema->resultset("Artist");
1328 ## Void Context Example
1329 $Artist_rs->populate([
1330 { artistid => 4, name => 'Manufactured Crap', cds => [
1331 { title => 'My First CD', year => 2006 },
1332 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1335 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1336 { title => 'My parents sold me to a record company' ,year => 2005 },
1337 { title => 'Why Am I So Ugly?', year => 2006 },
1338 { title => 'I Got Surgery and am now Popular', year => 2007 }
1343 ## Array Context Example
1344 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1345 { name => "Artist One"},
1346 { name => "Artist Two"},
1347 { name => "Artist Three", cds=> [
1348 { title => "First CD", year => 2007},
1349 { title => "Second CD", year => 2008},
1353 print $ArtistOne->name; ## response is 'Artist One'
1354 print $ArtistThree->cds->count ## reponse is '2'
1356 Please note an important effect on your data when choosing between void and
1357 wantarray context. Since void context goes straight to C<insert_bulk> in
1358 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1359 c<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1360 create primary keys for you, you will find that your PKs are empty. In this
1361 case you will have to use the wantarray context in order to create those
1367 my ($self, $data) = @_;
1369 if(defined wantarray) {
1371 foreach my $item (@$data) {
1372 push(@created, $self->create($item));
1376 my ($first, @rest) = @$data;
1378 my @names = grep {!ref $first->{$_}} keys %$first;
1379 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1380 my @pks = $self->result_source->primary_columns;
1382 ## do the belongs_to relationships
1383 foreach my $index (0..$#$data) {
1384 if( grep { !defined $data->[$index]->{$_} } @pks ) {
1385 my @ret = $self->populate($data);
1389 foreach my $rel (@rels) {
1390 next unless $data->[$index]->{$rel} && ref $data->[$index]->{$rel} eq "HASH";
1391 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1392 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1393 my $related = $result->result_source->resolve_condition(
1394 $result->result_source->relationship_info($reverse)->{cond},
1399 delete $data->[$index]->{$rel};
1400 $data->[$index] = {%{$data->[$index]}, %$related};
1402 push @names, keys %$related if $index == 0;
1406 ## do bulk insert on current row
1407 my @values = map { [ @$_{@names} ] } @$data;
1409 $self->result_source->storage->insert_bulk(
1410 $self->result_source,
1415 ## do the has_many relationships
1416 foreach my $item (@$data) {
1418 foreach my $rel (@rels) {
1419 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1421 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1422 || $self->throw_exception('Cannot find the relating object.');
1424 my $child = $parent->$rel;
1426 my $related = $child->result_source->resolve_condition(
1427 $parent->result_source->relationship_info($rel)->{cond},
1432 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1433 my @populate = map { {%$_, %$related} } @rows_to_add;
1435 $child->populate( \@populate );
1445 =item Arguments: none
1447 =item Return Value: $pager
1451 Return Value a L<Data::Page> object for the current resultset. Only makes
1452 sense for queries with a C<page> attribute.
1458 my $attrs = $self->{attrs};
1459 $self->throw_exception("Can't create pager for non-paged rs")
1460 unless $self->{attrs}{page};
1461 $attrs->{rows} ||= 10;
1462 return $self->{pager} ||= Data::Page->new(
1463 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1470 =item Arguments: $page_number
1472 =item Return Value: $rs
1476 Returns a resultset for the $page_number page of the resultset on which page
1477 is called, where each page contains a number of rows equal to the 'rows'
1478 attribute set on the resultset (10 by default).
1483 my ($self, $page) = @_;
1484 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1491 =item Arguments: \%vals
1493 =item Return Value: $object
1497 Creates a new row object in the resultset's result class and returns
1498 it. The row is not inserted into the database at this point, call
1499 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1500 will tell you whether the row object has been inserted or not.
1502 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1507 my ($self, $values) = @_;
1508 $self->throw_exception( "new_result needs a hash" )
1509 unless (ref $values eq 'HASH');
1510 $self->throw_exception(
1511 "Can't abstract implicit construct, condition not a hash"
1512 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1514 my $alias = $self->{attrs}{alias};
1515 my $collapsed_cond = $self->{cond} ? $self->_collapse_cond($self->{cond}) : {};
1517 # precendence must be given to passed values over values inherited from the cond,
1518 # so the order here is important.
1520 %{ $self->_remove_alias($collapsed_cond, $alias) },
1521 %{ $self->_remove_alias($values, $alias) },
1522 -source_handle => $self->_source_handle,
1523 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1526 return $self->result_class->new(\%new);
1531 # Recursively collapse the condition.
1533 sub _collapse_cond {
1534 my ($self, $cond, $collapsed) = @_;
1538 if (ref $cond eq 'ARRAY') {
1539 foreach my $subcond (@$cond) {
1540 next unless ref $subcond; # -or
1541 # warn "ARRAY: " . Dumper $subcond;
1542 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1545 elsif (ref $cond eq 'HASH') {
1546 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1547 foreach my $subcond (@{$cond->{-and}}) {
1548 # warn "HASH: " . Dumper $subcond;
1549 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1553 # warn "LEAF: " . Dumper $cond;
1554 foreach my $col (keys %$cond) {
1555 my $value = $cond->{$col};
1556 $collapsed->{$col} = $value;
1566 # Remove the specified alias from the specified query hash. A copy is made so
1567 # the original query is not modified.
1570 my ($self, $query, $alias) = @_;
1572 my %orig = %{ $query || {} };
1575 foreach my $key (keys %orig) {
1577 $unaliased{$key} = $orig{$key};
1580 $unaliased{$1} = $orig{$key}
1581 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
1591 =item Arguments: \%vals, \%attrs?
1593 =item Return Value: $object
1597 Find an existing record from this resultset. If none exists, instantiate a new
1598 result object and return it. The object will not be saved into your storage
1599 until you call L<DBIx::Class::Row/insert> on it.
1601 If you want objects to be saved immediately, use L</find_or_create> instead.
1607 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1608 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1609 my $exists = $self->find($hash, $attrs);
1610 return defined $exists ? $exists : $self->new_result($hash);
1617 =item Arguments: \%vals
1619 =item Return Value: a L<DBIx::Class::Row> $object
1623 Attempt to create a single new row or a row with multiple related rows
1624 in the table represented by the resultset (and related tables). This
1625 will not check for duplicate rows before inserting, use
1626 L</find_or_create> to do that.
1628 To create one row for this resultset, pass a hashref of key/value
1629 pairs representing the columns of the table and the values you wish to
1630 store. If the appropriate relationships are set up, foreign key fields
1631 can also be passed an object representing the foreign row, and the
1632 value will be set to it's primary key.
1634 To create related objects, pass a hashref for the value if the related
1635 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
1636 and use the name of the relationship as the key. (NOT the name of the field,
1637 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
1638 of hashrefs containing the data for each of the rows to create in the foreign
1639 tables, again using the relationship name as the key.
1641 Instead of hashrefs of plain related data (key/value pairs), you may
1642 also pass new or inserted objects. New objects (not inserted yet, see
1643 L</new>), will be inserted into their appropriate tables.
1645 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1647 Example of creating a new row.
1649 $person_rs->create({
1650 name=>"Some Person",
1651 email=>"somebody@someplace.com"
1654 Example of creating a new row and also creating rows in a related C<has_many>
1655 or C<has_one> resultset. Note Arrayref.
1658 { artistid => 4, name => 'Manufactured Crap', cds => [
1659 { title => 'My First CD', year => 2006 },
1660 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1665 Example of creating a new row and also creating a row in a related
1666 C<belongs_to>resultset. Note Hashref.
1669 title=>"Music for Silly Walks",
1672 name=>"Silly Musician",
1679 my ($self, $attrs) = @_;
1680 $self->throw_exception( "create needs a hashref" )
1681 unless ref $attrs eq 'HASH';
1682 return $self->new_result($attrs)->insert;
1685 =head2 find_or_create
1689 =item Arguments: \%vals, \%attrs?
1691 =item Return Value: $object
1695 $class->find_or_create({ key => $val, ... });
1697 Tries to find a record based on its primary key or unique constraint; if none
1698 is found, creates one and returns that instead.
1700 my $cd = $schema->resultset('CD')->find_or_create({
1702 artist => 'Massive Attack',
1703 title => 'Mezzanine',
1707 Also takes an optional C<key> attribute, to search by a specific key or unique
1708 constraint. For example:
1710 my $cd = $schema->resultset('CD')->find_or_create(
1712 artist => 'Massive Attack',
1713 title => 'Mezzanine',
1715 { key => 'cd_artist_title' }
1718 See also L</find> and L</update_or_create>. For information on how to declare
1719 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1723 sub find_or_create {
1725 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1726 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1727 my $exists = $self->find($hash, $attrs);
1728 return defined $exists ? $exists : $self->create($hash);
1731 =head2 update_or_create
1735 =item Arguments: \%col_values, { key => $unique_constraint }?
1737 =item Return Value: $object
1741 $class->update_or_create({ col => $val, ... });
1743 First, searches for an existing row matching one of the unique constraints
1744 (including the primary key) on the source of this resultset. If a row is
1745 found, updates it with the other given column values. Otherwise, creates a new
1748 Takes an optional C<key> attribute to search on a specific unique constraint.
1751 # In your application
1752 my $cd = $schema->resultset('CD')->update_or_create(
1754 artist => 'Massive Attack',
1755 title => 'Mezzanine',
1758 { key => 'cd_artist_title' }
1761 If no C<key> is specified, it searches on all unique constraints defined on the
1762 source, including the primary key.
1764 If the C<key> is specified as C<primary>, it searches only on the primary key.
1766 See also L</find> and L</find_or_create>. For information on how to declare
1767 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1771 sub update_or_create {
1773 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1774 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1776 my $row = $self->find($cond, $attrs);
1778 $row->update($cond);
1782 return $self->create($cond);
1789 =item Arguments: none
1791 =item Return Value: \@cache_objects?
1795 Gets the contents of the cache for the resultset, if the cache is set.
1807 =item Arguments: \@cache_objects
1809 =item Return Value: \@cache_objects
1813 Sets the contents of the cache for the resultset. Expects an arrayref
1814 of objects of the same class as those produced by the resultset. Note that
1815 if the cache is set the resultset will return the cached objects rather
1816 than re-querying the database even if the cache attr is not set.
1821 my ( $self, $data ) = @_;
1822 $self->throw_exception("set_cache requires an arrayref")
1823 if defined($data) && (ref $data ne 'ARRAY');
1824 $self->{all_cache} = $data;
1831 =item Arguments: none
1833 =item Return Value: []
1837 Clears the cache for the resultset.
1842 shift->set_cache(undef);
1845 =head2 related_resultset
1849 =item Arguments: $relationship_name
1851 =item Return Value: $resultset
1855 Returns a related resultset for the supplied relationship name.
1857 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1861 sub related_resultset {
1862 my ($self, $rel) = @_;
1864 $self->{related_resultsets} ||= {};
1865 return $self->{related_resultsets}{$rel} ||= do {
1866 my $rel_obj = $self->result_source->relationship_info($rel);
1868 $self->throw_exception(
1869 "search_related: result source '" . $self->result_source->source_name .
1870 "' has no such relationship $rel")
1873 my ($from,$seen) = $self->_resolve_from($rel);
1875 my $join_count = $seen->{$rel};
1876 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
1878 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
1879 my %attrs = %{$self->{attrs}||{}};
1880 delete @attrs{qw(result_class alias)};
1884 if (my $cache = $self->get_cache) {
1885 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
1886 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
1891 my $rel_source = $self->result_source->related_source($rel);
1895 # The reason we do this now instead of passing the alias to the
1896 # search_rs below is that if you wrap/overload resultset on the
1897 # source you need to know what alias it's -going- to have for things
1898 # to work sanely (e.g. RestrictWithObject wants to be able to add
1899 # extra query restrictions, and these may need to be $alias.)
1901 my $attrs = $rel_source->resultset_attributes;
1902 local $attrs->{alias} = $alias;
1904 $rel_source->resultset
1912 where => $self->{cond},
1917 $new->set_cache($new_cache) if $new_cache;
1923 my ($self, $extra_join) = @_;
1924 my $source = $self->result_source;
1925 my $attrs = $self->{attrs};
1927 my $from = $attrs->{from}
1928 || [ { $attrs->{alias} => $source->from } ];
1930 my $seen = { %{$attrs->{seen_join}||{}} };
1932 my $join = ($attrs->{join}
1933 ? [ $attrs->{join}, $extra_join ]
1936 # we need to take the prefetch the attrs into account before we
1937 # ->resolve_join as otherwise they get lost - captainL
1938 my $merged = $self->_merge_attr( $join, $attrs->{prefetch} );
1942 ($join ? $source->resolve_join($merged, $attrs->{alias}, $seen) : ()),
1945 return ($from,$seen);
1948 sub _resolved_attrs {
1950 return $self->{_attrs} if $self->{_attrs};
1952 my $attrs = { %{$self->{attrs}||{}} };
1953 my $source = $self->result_source;
1954 my $alias = $attrs->{alias};
1956 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
1957 if ($attrs->{columns}) {
1958 delete $attrs->{as};
1959 } elsif (!$attrs->{select}) {
1960 $attrs->{columns} = [ $source->columns ];
1965 ? (ref $attrs->{select} eq 'ARRAY'
1966 ? [ @{$attrs->{select}} ]
1967 : [ $attrs->{select} ])
1968 : [ map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} ]
1972 ? (ref $attrs->{as} eq 'ARRAY'
1973 ? [ @{$attrs->{as}} ]
1975 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} ]
1979 if ($adds = delete $attrs->{include_columns}) {
1980 $adds = [$adds] unless ref $adds eq 'ARRAY';
1981 push(@{$attrs->{select}}, @$adds);
1982 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
1984 if ($adds = delete $attrs->{'+select'}) {
1985 $adds = [$adds] unless ref $adds eq 'ARRAY';
1986 push(@{$attrs->{select}},
1987 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
1989 if (my $adds = delete $attrs->{'+as'}) {
1990 $adds = [$adds] unless ref $adds eq 'ARRAY';
1991 push(@{$attrs->{as}}, @$adds);
1994 $attrs->{from} ||= [ { 'me' => $source->from } ];
1996 if (exists $attrs->{join} || exists $attrs->{prefetch}) {
1997 my $join = delete $attrs->{join} || {};
1999 if (defined $attrs->{prefetch}) {
2000 $join = $self->_merge_attr(
2001 $join, $attrs->{prefetch}
2006 $attrs->{from} = # have to copy here to avoid corrupting the original
2009 $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} })
2014 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
2015 if ($attrs->{order_by}) {
2016 $attrs->{order_by} = (ref($attrs->{order_by}) eq 'ARRAY'
2017 ? [ @{$attrs->{order_by}} ]
2018 : [ $attrs->{order_by} ]);
2020 $attrs->{order_by} = [];
2023 my $collapse = $attrs->{collapse} || {};
2024 if (my $prefetch = delete $attrs->{prefetch}) {
2025 $prefetch = $self->_merge_attr({}, $prefetch);
2027 my $seen = $attrs->{seen_join} || {};
2028 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
2029 # bring joins back to level of current class
2030 my @prefetch = $source->resolve_prefetch(
2031 $p, $alias, $seen, \@pre_order, $collapse
2033 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
2034 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
2036 push(@{$attrs->{order_by}}, @pre_order);
2038 $attrs->{collapse} = $collapse;
2040 if ($attrs->{page}) {
2041 $attrs->{offset} ||= 0;
2042 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
2045 return $self->{_attrs} = $attrs;
2049 my ($self, $attr) = @_;
2051 if (ref $attr eq 'HASH') {
2052 return $self->_rollout_hash($attr);
2053 } elsif (ref $attr eq 'ARRAY') {
2054 return $self->_rollout_array($attr);
2060 sub _rollout_array {
2061 my ($self, $attr) = @_;
2064 foreach my $element (@{$attr}) {
2065 if (ref $element eq 'HASH') {
2066 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2067 } elsif (ref $element eq 'ARRAY') {
2068 # XXX - should probably recurse here
2069 push( @rolled_array, @{$self->_rollout_array($element)} );
2071 push( @rolled_array, $element );
2074 return \@rolled_array;
2078 my ($self, $attr) = @_;
2081 foreach my $key (keys %{$attr}) {
2082 push( @rolled_array, { $key => $attr->{$key} } );
2084 return \@rolled_array;
2087 sub _calculate_score {
2088 my ($self, $a, $b) = @_;
2090 if (ref $b eq 'HASH') {
2091 my ($b_key) = keys %{$b};
2092 if (ref $a eq 'HASH') {
2093 my ($a_key) = keys %{$a};
2094 if ($a_key eq $b_key) {
2095 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2100 return ($a eq $b_key) ? 1 : 0;
2103 if (ref $a eq 'HASH') {
2104 my ($a_key) = keys %{$a};
2105 return ($b eq $a_key) ? 1 : 0;
2107 return ($b eq $a) ? 1 : 0;
2113 my ($self, $a, $b) = @_;
2115 return $b unless defined($a);
2116 return $a unless defined($b);
2118 $a = $self->_rollout_attr($a);
2119 $b = $self->_rollout_attr($b);
2122 foreach my $b_element ( @{$b} ) {
2123 # find best candidate from $a to merge $b_element into
2124 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2125 foreach my $a_element ( @{$a} ) {
2126 my $score = $self->_calculate_score( $a_element, $b_element );
2127 if ($score > $best_candidate->{score}) {
2128 $best_candidate->{position} = $position;
2129 $best_candidate->{score} = $score;
2133 my ($b_key) = ( ref $b_element eq 'HASH' ) ? keys %{$b_element} : ($b_element);
2135 if ($best_candidate->{score} == 0 || exists $seen_keys->{$b_key}) {
2136 push( @{$a}, $b_element );
2138 my $a_best = $a->[$best_candidate->{position}];
2139 # merge a_best and b_element together and replace original with merged
2140 if (ref $a_best ne 'HASH') {
2141 $a->[$best_candidate->{position}] = $b_element;
2142 } elsif (ref $b_element eq 'HASH') {
2143 my ($key) = keys %{$a_best};
2144 $a->[$best_candidate->{position}] = { $key => $self->_merge_attr($a_best->{$key}, $b_element->{$key}) };
2147 $seen_keys->{$b_key} = 1; # don't merge the same key twice
2157 $self->_source_handle($_[0]->handle);
2159 $self->_source_handle->resolve;
2163 =head2 throw_exception
2165 See L<DBIx::Class::Schema/throw_exception> for details.
2169 sub throw_exception {
2171 if (ref $self && $self->_source_handle->schema) {
2172 $self->_source_handle->schema->throw_exception(@_)
2179 # XXX: FIXME: Attributes docs need clearing up
2183 The resultset takes various attributes that modify its behavior. Here's an
2190 =item Value: ($order_by | \@order_by)
2194 Which column(s) to order the results by. This is currently passed
2195 through directly to SQL, so you can give e.g. C<year DESC> for a
2196 descending order on the column `year'.
2198 Please note that if you have C<quote_char> enabled (see
2199 L<DBIx::Class::Storage::DBI/connect_info>) you will need to do C<\'year DESC' > to
2200 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
2201 so you will need to manually quote things as appropriate.)
2207 =item Value: \@columns
2211 Shortcut to request a particular set of columns to be retrieved. Adds
2212 C<me.> onto the start of any column without a C<.> in it and sets C<select>
2213 from that, then auto-populates C<as> from C<select> as normal. (You may also
2214 use the C<cols> attribute, as in earlier versions of DBIC.)
2216 =head2 include_columns
2220 =item Value: \@columns
2224 Shortcut to include additional columns in the returned results - for example
2226 $schema->resultset('CD')->search(undef, {
2227 include_columns => ['artist.name'],
2231 would return all CDs and include a 'name' column to the information
2232 passed to object inflation. Note that the 'artist' is the name of the
2233 column (or relationship) accessor, and 'name' is the name of the column
2234 accessor in the related table.
2240 =item Value: \@select_columns
2244 Indicates which columns should be selected from the storage. You can use
2245 column names, or in the case of RDBMS back ends, function or stored procedure
2248 $rs = $schema->resultset('Employee')->search(undef, {
2251 { count => 'employeeid' },
2256 When you use function/stored procedure names and do not supply an C<as>
2257 attribute, the column names returned are storage-dependent. E.g. MySQL would
2258 return a column named C<count(employeeid)> in the above example.
2264 Indicates additional columns to be selected from storage. Works the same as
2265 L</select> but adds columns to the selection.
2273 Indicates additional column names for those added via L</+select>.
2281 =item Value: \@inflation_names
2285 Indicates column names for object inflation. That is, C<as>
2286 indicates the name that the column can be accessed as via the
2287 C<get_column> method (or via the object accessor, B<if one already
2288 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
2290 The C<as> attribute is used in conjunction with C<select>,
2291 usually when C<select> contains one or more function or stored
2294 $rs = $schema->resultset('Employee')->search(undef, {
2297 { count => 'employeeid' }
2299 as => ['name', 'employee_count'],
2302 my $employee = $rs->first(); # get the first Employee
2304 If the object against which the search is performed already has an accessor
2305 matching a column name specified in C<as>, the value can be retrieved using
2306 the accessor as normal:
2308 my $name = $employee->name();
2310 If on the other hand an accessor does not exist in the object, you need to
2311 use C<get_column> instead:
2313 my $employee_count = $employee->get_column('employee_count');
2315 You can create your own accessors if required - see
2316 L<DBIx::Class::Manual::Cookbook> for details.
2318 Please note: This will NOT insert an C<AS employee_count> into the SQL
2319 statement produced, it is used for internal access only. Thus
2320 attempting to use the accessor in an C<order_by> clause or similar
2321 will fail miserably.
2323 To get around this limitation, you can supply literal SQL to your
2324 C<select> attibute that contains the C<AS alias> text, eg:
2326 select => [\'myfield AS alias']
2332 =item Value: ($rel_name | \@rel_names | \%rel_names)
2336 Contains a list of relationships that should be joined for this query. For
2339 # Get CDs by Nine Inch Nails
2340 my $rs = $schema->resultset('CD')->search(
2341 { 'artist.name' => 'Nine Inch Nails' },
2342 { join => 'artist' }
2345 Can also contain a hash reference to refer to the other relation's relations.
2348 package MyApp::Schema::Track;
2349 use base qw/DBIx::Class/;
2350 __PACKAGE__->table('track');
2351 __PACKAGE__->add_columns(qw/trackid cd position title/);
2352 __PACKAGE__->set_primary_key('trackid');
2353 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
2356 # In your application
2357 my $rs = $schema->resultset('Artist')->search(
2358 { 'track.title' => 'Teardrop' },
2360 join => { cd => 'track' },
2361 order_by => 'artist.name',
2365 You need to use the relationship (not the table) name in conditions,
2366 because they are aliased as such. The current table is aliased as "me", so
2367 you need to use me.column_name in order to avoid ambiguity. For example:
2369 # Get CDs from 1984 with a 'Foo' track
2370 my $rs = $schema->resultset('CD')->search(
2373 'tracks.name' => 'Foo'
2375 { join => 'tracks' }
2378 If the same join is supplied twice, it will be aliased to <rel>_2 (and
2379 similarly for a third time). For e.g.
2381 my $rs = $schema->resultset('Artist')->search({
2382 'cds.title' => 'Down to Earth',
2383 'cds_2.title' => 'Popular',
2385 join => [ qw/cds cds/ ],
2388 will return a set of all artists that have both a cd with title 'Down
2389 to Earth' and a cd with title 'Popular'.
2391 If you want to fetch related objects from other tables as well, see C<prefetch>
2394 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
2400 =item Value: ($rel_name | \@rel_names | \%rel_names)
2404 Contains one or more relationships that should be fetched along with
2405 the main query (when they are accessed afterwards the data will
2406 already be available, without extra queries to the database). This is
2407 useful for when you know you will need the related objects, because it
2408 saves at least one query:
2410 my $rs = $schema->resultset('Tag')->search(
2419 The initial search results in SQL like the following:
2421 SELECT tag.*, cd.*, artist.* FROM tag
2422 JOIN cd ON tag.cd = cd.cdid
2423 JOIN artist ON cd.artist = artist.artistid
2425 L<DBIx::Class> has no need to go back to the database when we access the
2426 C<cd> or C<artist> relationships, which saves us two SQL statements in this
2429 Simple prefetches will be joined automatically, so there is no need
2430 for a C<join> attribute in the above search. If you're prefetching to
2431 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
2432 specify the join as well.
2434 C<prefetch> can be used with the following relationship types: C<belongs_to>,
2435 C<has_one> (or if you're using C<add_relationship>, any relationship declared
2436 with an accessor type of 'single' or 'filter').
2446 Makes the resultset paged and specifies the page to retrieve. Effectively
2447 identical to creating a non-pages resultset and then calling ->page($page)
2450 If L<rows> attribute is not specified it defualts to 10 rows per page.
2460 Specifes the maximum number of rows for direct retrieval or the number of
2461 rows per page if the page attribute or method is used.
2467 =item Value: $offset
2471 Specifies the (zero-based) row number for the first row to be returned, or the
2472 of the first row of the first page if paging is used.
2478 =item Value: \@columns
2482 A arrayref of columns to group by. Can include columns of joined tables.
2484 group_by => [qw/ column1 column2 ... /]
2490 =item Value: $condition
2494 HAVING is a select statement attribute that is applied between GROUP BY and
2495 ORDER BY. It is applied to the after the grouping calculations have been
2498 having => { 'count(employee)' => { '>=', 100 } }
2504 =item Value: (0 | 1)
2508 Set to 1 to group by all columns.
2514 Adds to the WHERE clause.
2516 # only return rows WHERE deleted IS NULL for all searches
2517 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
2519 Can be overridden by passing C<{ where => undef }> as an attribute
2526 Set to 1 to cache search results. This prevents extra SQL queries if you
2527 revisit rows in your ResultSet:
2529 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
2531 while( my $artist = $resultset->next ) {
2535 $rs->first; # without cache, this would issue a query
2537 By default, searches are not cached.
2539 For more examples of using these attributes, see
2540 L<DBIx::Class::Manual::Cookbook>.
2546 =item Value: \@from_clause
2550 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
2551 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
2554 NOTE: Use this on your own risk. This allows you to shoot off your foot!
2556 C<join> will usually do what you need and it is strongly recommended that you
2557 avoid using C<from> unless you cannot achieve the desired result using C<join>.
2558 And we really do mean "cannot", not just tried and failed. Attempting to use
2559 this because you're having problems with C<join> is like trying to use x86
2560 ASM because you've got a syntax error in your C. Trust us on this.
2562 Now, if you're still really, really sure you need to use this (and if you're
2563 not 100% sure, ask the mailing list first), here's an explanation of how this
2566 The syntax is as follows -
2569 { <alias1> => <table1> },
2571 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2572 [], # nested JOIN (optional)
2573 { <table1.column1> => <table2.column2>, ... (more conditions) },
2575 # More of the above [ ] may follow for additional joins
2582 ON <table1.column1> = <table2.column2>
2583 <more joins may follow>
2585 An easy way to follow the examples below is to remember the following:
2587 Anything inside "[]" is a JOIN
2588 Anything inside "{}" is a condition for the enclosing JOIN
2590 The following examples utilize a "person" table in a family tree application.
2591 In order to express parent->child relationships, this table is self-joined:
2593 # Person->belongs_to('father' => 'Person');
2594 # Person->belongs_to('mother' => 'Person');
2596 C<from> can be used to nest joins. Here we return all children with a father,
2597 then search against all mothers of those children:
2599 $rs = $schema->resultset('Person')->search(
2602 alias => 'mother', # alias columns in accordance with "from"
2604 { mother => 'person' },
2607 { child => 'person' },
2609 { father => 'person' },
2610 { 'father.person_id' => 'child.father_id' }
2613 { 'mother.person_id' => 'child.mother_id' }
2620 # SELECT mother.* FROM person mother
2623 # JOIN person father
2624 # ON ( father.person_id = child.father_id )
2626 # ON ( mother.person_id = child.mother_id )
2628 The type of any join can be controlled manually. To search against only people
2629 with a father in the person table, we could explicitly use C<INNER JOIN>:
2631 $rs = $schema->resultset('Person')->search(
2634 alias => 'child', # alias columns in accordance with "from"
2636 { child => 'person' },
2638 { father => 'person', -join_type => 'inner' },
2639 { 'father.id' => 'child.father_id' }
2646 # SELECT child.* FROM person child
2647 # INNER JOIN person father ON child.father_id = father.id