1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::ResultSetColumn;
13 use DBIx::Class::ResultSourceHandle;
14 use base qw/DBIx::Class/;
16 __PACKAGE__->mk_group_accessors('simple' => qw/result_class _source_handle/);
20 DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
24 my $rs = $schema->resultset('User')->search(registered => 1);
25 my @rows = $schema->resultset('CD')->search(year => 2005);
29 The resultset is also known as an iterator. It is responsible for handling
30 queries that may return an arbitrary number of rows, e.g. via L</search>
31 or a C<has_many> relationship.
33 In the examples below, the following table classes are used:
35 package MyApp::Schema::Artist;
36 use base qw/DBIx::Class/;
37 __PACKAGE__->load_components(qw/Core/);
38 __PACKAGE__->table('artist');
39 __PACKAGE__->add_columns(qw/artistid name/);
40 __PACKAGE__->set_primary_key('artistid');
41 __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
44 package MyApp::Schema::CD;
45 use base qw/DBIx::Class/;
46 __PACKAGE__->load_components(qw/Core/);
47 __PACKAGE__->table('cd');
48 __PACKAGE__->add_columns(qw/cdid artist title year/);
49 __PACKAGE__->set_primary_key('cdid');
50 __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
59 =item Arguments: $source, \%$attrs
61 =item Return Value: $rs
65 The resultset constructor. Takes a source object (usually a
66 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
67 L</ATTRIBUTES> below). Does not perform any queries -- these are
68 executed as needed by the other methods.
70 Generally you won't need to construct a resultset manually. You'll
71 automatically get one from e.g. a L</search> called in scalar context:
73 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
75 IMPORTANT: If called on an object, proxies to new_result instead so
77 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
79 will return a CD object, not a ResultSet.
85 return $class->new_result(@_) if ref $class;
87 my ($source, $attrs) = @_;
88 $source = $source->handle
89 unless $source->isa('DBIx::Class::ResultSourceHandle');
90 $attrs = { %{$attrs||{}} };
93 $attrs->{rows} ||= 10;
96 $attrs->{alias} ||= 'me';
98 # Creation of {} and bless separated to mitigate RH perl bug
99 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
101 _source_handle => $source,
102 result_class => $attrs->{result_class} || $source->resolve->result_class,
103 cond => $attrs->{where},
118 =item Arguments: $cond, \%attrs?
120 =item Return Value: $resultset (scalar context), @row_objs (list context)
124 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
125 my $new_rs = $cd_rs->search({ year => 2005 });
127 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
128 # year = 2005 OR year = 2004
130 If you need to pass in additional attributes but no additional condition,
131 call it as C<search(undef, \%attrs)>.
133 # "SELECT name, artistid FROM $artist_table"
134 my @all_artists = $schema->resultset('Artist')->search(undef, {
135 columns => [qw/name artistid/],
138 For a list of attributes that can be passed to C<search>, see
139 L</ATTRIBUTES>. For more examples of using this function, see
140 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
141 documentation for the first argument, see L<SQL::Abstract>.
143 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
149 my $rs = $self->search_rs( @_ );
150 return (wantarray ? $rs->all : $rs);
157 =item Arguments: $cond, \%attrs?
159 =item Return Value: $resultset
163 This method does the same exact thing as search() except it will
164 always return a resultset, even in list context.
173 unless (@_) { # no search, effectively just a clone
174 $rows = $self->get_cache;
178 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
179 my $our_attrs = { %{$self->{attrs}} };
180 my $having = delete $our_attrs->{having};
181 my $where = delete $our_attrs->{where};
183 my $new_attrs = { %{$our_attrs}, %{$attrs} };
185 # merge new attrs into inherited
186 foreach my $key (qw/join prefetch/) {
187 next unless exists $attrs->{$key};
188 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
193 (@_ == 1 || ref $_[0] eq "HASH")
195 (ref $_[0] eq 'HASH')
197 (keys %{ $_[0] } > 0)
205 ? $self->throw_exception("Odd number of arguments to search")
212 if (defined $where) {
213 $new_attrs->{where} = (
214 defined $new_attrs->{where}
217 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
218 } $where, $new_attrs->{where}
225 $new_attrs->{where} = (
226 defined $new_attrs->{where}
229 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
230 } $cond, $new_attrs->{where}
236 if (defined $having) {
237 $new_attrs->{having} = (
238 defined $new_attrs->{having}
241 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
242 } $having, $new_attrs->{having}
248 my $rs = (ref $self)->new($self->result_source, $new_attrs);
250 $rs->set_cache($rows);
255 =head2 search_literal
259 =item Arguments: $sql_fragment, @bind_values
261 =item Return Value: $resultset (scalar context), @row_objs (list context)
265 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
266 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
268 Pass a literal chunk of SQL to be added to the conditional part of the
271 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
272 only be used in that context. There are known problems using C<search_literal>
273 in chained queries; it can result in bind values in the wrong order. See
274 L<DBIx::Class::Manual::Cookbook/Searching> and
275 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
276 require C<search_literal>.
281 my ($self, $cond, @vals) = @_;
282 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
283 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
284 return $self->search(\$cond, $attrs);
291 =item Arguments: @values | \%cols, \%attrs?
293 =item Return Value: $row_object
297 Finds a row based on its primary key or unique constraint. For example, to find
298 a row by its primary key:
300 my $cd = $schema->resultset('CD')->find(5);
302 You can also find a row by a specific unique constraint using the C<key>
303 attribute. For example:
305 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
306 key => 'cd_artist_title'
309 Additionally, you can specify the columns explicitly by name:
311 my $cd = $schema->resultset('CD')->find(
313 artist => 'Massive Attack',
314 title => 'Mezzanine',
316 { key => 'cd_artist_title' }
319 If the C<key> is specified as C<primary>, it searches only on the primary key.
321 If no C<key> is specified, it searches on all unique constraints defined on the
322 source, including the primary key.
324 If your table does not have a primary key, you B<must> provide a value for the
325 C<key> attribute matching one of the unique constraints on the source.
327 See also L</find_or_create> and L</update_or_create>. For information on how to
328 declare unique constraints, see
329 L<DBIx::Class::ResultSource/add_unique_constraint>.
335 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
337 # Default to the primary key, but allow a specific key
338 my @cols = exists $attrs->{key}
339 ? $self->result_source->unique_constraint_columns($attrs->{key})
340 : $self->result_source->primary_columns;
341 $self->throw_exception(
342 "Can't find unless a primary key is defined or unique constraint is specified"
345 # Parse out a hashref from input
347 if (ref $_[0] eq 'HASH') {
348 $input_query = { %{$_[0]} };
350 elsif (@_ == @cols) {
352 @{$input_query}{@cols} = @_;
355 # Compatibility: Allow e.g. find(id => $value)
356 carp "Find by key => value deprecated; please use a hashref instead";
360 my (%related, $info);
362 KEY: foreach my $key (keys %$input_query) {
363 if (ref($input_query->{$key})
364 && ($info = $self->result_source->relationship_info($key))) {
365 my $val = delete $input_query->{$key};
366 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
367 my $rel_q = $self->result_source->resolve_condition(
368 $info->{cond}, $val, $key
370 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
371 @related{keys %$rel_q} = values %$rel_q;
374 if (my @keys = keys %related) {
375 @{$input_query}{@keys} = values %related;
378 my @unique_queries = $self->_unique_queries($input_query, $attrs);
380 # Build the final query: Default to the disjunction of the unique queries,
381 # but allow the input query in case the ResultSet defines the query or the
382 # user is abusing find
383 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
384 my $query = @unique_queries
385 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
386 : $self->_add_alias($input_query, $alias);
390 my $rs = $self->search($query, $attrs);
391 return keys %{$rs->_resolved_attrs->{collapse}} ? $rs->next : $rs->single;
394 return keys %{$self->_resolved_attrs->{collapse}}
395 ? $self->search($query)->next
396 : $self->single($query);
402 # Add the specified alias to the specified query hash. A copy is made so the
403 # original query is not modified.
406 my ($self, $query, $alias) = @_;
408 my %aliased = %$query;
409 foreach my $col (grep { ! m/\./ } keys %aliased) {
410 $aliased{"$alias.$col"} = delete $aliased{$col};
418 # Build a list of queries which satisfy unique constraints.
420 sub _unique_queries {
421 my ($self, $query, $attrs) = @_;
423 my @constraint_names = exists $attrs->{key}
425 : $self->result_source->unique_constraint_names;
427 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
428 my $num_where = scalar keys %$where;
431 foreach my $name (@constraint_names) {
432 my @unique_cols = $self->result_source->unique_constraint_columns($name);
433 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
435 my $num_cols = scalar @unique_cols;
436 my $num_query = scalar keys %$unique_query;
438 my $total = $num_query + $num_where;
439 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
440 # The query is either unique on its own or is unique in combination with
441 # the existing where clause
442 push @unique_queries, $unique_query;
446 return @unique_queries;
449 # _build_unique_query
451 # Constrain the specified query hash based on the specified column names.
453 sub _build_unique_query {
454 my ($self, $query, $unique_cols) = @_;
457 map { $_ => $query->{$_} }
458 grep { exists $query->{$_} }
463 =head2 search_related
467 =item Arguments: $rel, $cond, \%attrs?
469 =item Return Value: $new_resultset
473 $new_rs = $cd_rs->search_related('artist', {
477 Searches the specified relationship, optionally specifying a condition and
478 attributes for matching records. See L</ATTRIBUTES> for more information.
483 return shift->related_resultset(shift)->search(@_);
490 =item Arguments: none
492 =item Return Value: $cursor
496 Returns a storage-driven cursor to the given resultset. See
497 L<DBIx::Class::Cursor> for more information.
504 my $attrs = { %{$self->_resolved_attrs} };
505 return $self->{cursor}
506 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
507 $attrs->{where},$attrs);
514 =item Arguments: $cond?
516 =item Return Value: $row_object?
520 my $cd = $schema->resultset('CD')->single({ year => 2001 });
522 Inflates the first result without creating a cursor if the resultset has
523 any records in it; if not returns nothing. Used by L</find> as an optimisation.
525 Can optionally take an additional condition *only* - this is a fast-code-path
526 method; if you need to add extra joins or similar call ->search and then
527 ->single without a condition on the $rs returned from that.
532 my ($self, $where) = @_;
533 my $attrs = { %{$self->_resolved_attrs} };
535 if (defined $attrs->{where}) {
538 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
539 $where, delete $attrs->{where} ]
542 $attrs->{where} = $where;
546 # XXX: Disabled since it doesn't infer uniqueness in all cases
547 # unless ($self->_is_unique_query($attrs->{where})) {
548 # carp "Query not guaranteed to return a single row"
549 # . "; please declare your unique constraints or use search instead";
552 my @data = $self->result_source->storage->select_single(
553 $attrs->{from}, $attrs->{select},
554 $attrs->{where}, $attrs
557 return (@data ? ($self->_construct_object(@data))[0] : undef);
562 # Try to determine if the specified query is guaranteed to be unique, based on
563 # the declared unique constraints.
565 sub _is_unique_query {
566 my ($self, $query) = @_;
568 my $collapsed = $self->_collapse_query($query);
569 my $alias = $self->{attrs}{alias};
571 foreach my $name ($self->result_source->unique_constraint_names) {
572 my @unique_cols = map {
574 } $self->result_source->unique_constraint_columns($name);
576 # Count the values for each unique column
577 my %seen = map { $_ => 0 } @unique_cols;
579 foreach my $key (keys %$collapsed) {
580 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
581 next unless exists $seen{$aliased}; # Additional constraints are okay
582 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
585 # If we get 0 or more than 1 value for a column, it's not necessarily unique
586 return 1 unless grep { $_ != 1 } values %seen;
594 # Recursively collapse the query, accumulating values for each column.
596 sub _collapse_query {
597 my ($self, $query, $collapsed) = @_;
601 if (ref $query eq 'ARRAY') {
602 foreach my $subquery (@$query) {
603 next unless ref $subquery; # -or
604 # warn "ARRAY: " . Dumper $subquery;
605 $collapsed = $self->_collapse_query($subquery, $collapsed);
608 elsif (ref $query eq 'HASH') {
609 if (keys %$query and (keys %$query)[0] eq '-and') {
610 foreach my $subquery (@{$query->{-and}}) {
611 # warn "HASH: " . Dumper $subquery;
612 $collapsed = $self->_collapse_query($subquery, $collapsed);
616 # warn "LEAF: " . Dumper $query;
617 foreach my $col (keys %$query) {
618 my $value = $query->{$col};
619 $collapsed->{$col}{$value}++;
631 =item Arguments: $cond?
633 =item Return Value: $resultsetcolumn
637 my $max_length = $rs->get_column('length')->max;
639 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
644 my ($self, $column) = @_;
645 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
653 =item Arguments: $cond, \%attrs?
655 =item Return Value: $resultset (scalar context), @row_objs (list context)
659 # WHERE title LIKE '%blue%'
660 $cd_rs = $rs->search_like({ title => '%blue%'});
662 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
663 that this is simply a convenience method. You most likely want to use
664 L</search> with specific operators.
666 For more information, see L<DBIx::Class::Manual::Cookbook>.
672 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
673 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
674 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
675 return $class->search($query, { %$attrs });
682 =item Arguments: $first, $last
684 =item Return Value: $resultset (scalar context), @row_objs (list context)
688 Returns a resultset or object list representing a subset of elements from the
689 resultset slice is called on. Indexes are from 0, i.e., to get the first
692 my ($one, $two, $three) = $rs->slice(0, 2);
697 my ($self, $min, $max) = @_;
698 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
699 $attrs->{offset} = $self->{attrs}{offset} || 0;
700 $attrs->{offset} += $min;
701 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
702 return $self->search(undef(), $attrs);
703 #my $slice = (ref $self)->new($self->result_source, $attrs);
704 #return (wantarray ? $slice->all : $slice);
711 =item Arguments: none
713 =item Return Value: $result?
717 Returns the next element in the resultset (C<undef> is there is none).
719 Can be used to efficiently iterate over records in the resultset:
721 my $rs = $schema->resultset('CD')->search;
722 while (my $cd = $rs->next) {
726 Note that you need to store the resultset object, and call C<next> on it.
727 Calling C<< resultset('Table')->next >> repeatedly will always return the
728 first record from the resultset.
734 if (my $cache = $self->get_cache) {
735 $self->{all_cache_position} ||= 0;
736 return $cache->[$self->{all_cache_position}++];
738 if ($self->{attrs}{cache}) {
739 $self->{all_cache_position} = 1;
740 return ($self->all)[0];
742 if ($self->{stashed_objects}) {
743 my $obj = shift(@{$self->{stashed_objects}});
744 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
748 exists $self->{stashed_row}
749 ? @{delete $self->{stashed_row}}
750 : $self->cursor->next
752 return undef unless (@row);
753 my ($row, @more) = $self->_construct_object(@row);
754 $self->{stashed_objects} = \@more if @more;
758 sub _construct_object {
759 my ($self, @row) = @_;
760 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
761 my @new = $self->result_class->inflate_result($self->result_source, @$info);
762 @new = $self->{_attrs}{record_filter}->(@new)
763 if exists $self->{_attrs}{record_filter};
767 sub _collapse_result {
768 my ($self, $as_proto, $row) = @_;
772 # 'foo' => [ undef, 'foo' ]
773 # 'foo.bar' => [ 'foo', 'bar' ]
774 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
776 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
778 my %collapse = %{$self->{_attrs}{collapse}||{}};
782 # if we're doing collapsing (has_many prefetch) we need to grab records
783 # until the PK changes, so fill @pri_index. if not, we leave it empty so
784 # we know we don't have to bother.
786 # the reason for not using the collapse stuff directly is because if you
787 # had for e.g. two artists in a row with no cds, the collapse info for
788 # both would be NULL (undef) so you'd lose the second artist
790 # store just the index so we can check the array positions from the row
791 # without having to contruct the full hash
793 if (keys %collapse) {
794 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
795 foreach my $i (0 .. $#construct_as) {
796 next if defined($construct_as[$i][0]); # only self table
797 if (delete $pri{$construct_as[$i][1]}) {
798 push(@pri_index, $i);
800 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
804 # no need to do an if, it'll be empty if @pri_index is empty anyway
806 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
810 do { # no need to check anything at the front, we always want the first row
814 foreach my $this_as (@construct_as) {
815 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
818 push(@const_rows, \%const);
820 } until ( # no pri_index => no collapse => drop straight out
823 do { # get another row, stash it, drop out if different PK
825 @copy = $self->cursor->next;
826 $self->{stashed_row} = \@copy;
828 # last thing in do block, counts as true if anything doesn't match
830 # check xor defined first for NULL vs. NOT NULL then if one is
831 # defined the other must be so check string equality
834 (defined $pri_vals{$_} ^ defined $copy[$_])
835 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
840 my $alias = $self->{attrs}{alias};
847 foreach my $const (@const_rows) {
848 scalar @const_keys or do {
849 @const_keys = sort { length($a) <=> length($b) } keys %$const;
851 foreach my $key (@const_keys) {
854 my @parts = split(/\./, $key);
856 my $data = $const->{$key};
857 foreach my $p (@parts) {
858 $target = $target->[1]->{$p} ||= [];
860 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
861 # collapsing at this point and on final part
862 my $pos = $collapse_pos{$cur};
863 CK: foreach my $ck (@ckey) {
864 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
865 $collapse_pos{$cur} = $data;
866 delete @collapse_pos{ # clear all positioning for sub-entries
867 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
874 if (exists $collapse{$cur}) {
875 $target = $target->[-1];
878 $target->[0] = $data;
880 $info->[0] = $const->{$key};
892 =item Arguments: $result_source?
894 =item Return Value: $result_source
898 An accessor for the primary ResultSource object from which this ResultSet
905 =item Arguments: $result_class?
907 =item Return Value: $result_class
911 An accessor for the class to use when creating row objects. Defaults to
912 C<< result_source->result_class >> - which in most cases is the name of the
913 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
922 =item Arguments: $cond, \%attrs??
924 =item Return Value: $count
928 Performs an SQL C<COUNT> with the same query as the resultset was built
929 with to find the number of elements. If passed arguments, does a search
930 on the resultset and counts the results of that.
932 Note: When using C<count> with C<group_by>, L<DBIx::Class> emulates C<GROUP BY>
933 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
934 not support C<DISTINCT> with multiple columns. If you are using such a
935 database, you should only use columns from the main table in your C<group_by>
942 return $self->search(@_)->count if @_ and defined $_[0];
943 return scalar @{ $self->get_cache } if $self->get_cache;
944 my $count = $self->_count;
945 return 0 unless $count;
947 # need to take offset from resolved attrs
949 $count -= $self->{_attrs}{offset} if $self->{_attrs}{offset};
950 $count = $self->{attrs}{rows} if
951 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
952 $count = 0 if ($count < 0);
956 sub _count { # Separated out so pager can get the full count
958 my $select = { count => '*' };
960 my $attrs = { %{$self->_resolved_attrs} };
961 if (my $group_by = delete $attrs->{group_by}) {
962 delete $attrs->{having};
963 my @distinct = (ref $group_by ? @$group_by : ($group_by));
964 # todo: try CONCAT for multi-column pk
965 my @pk = $self->result_source->primary_columns;
967 my $alias = $attrs->{alias};
968 foreach my $column (@distinct) {
969 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
970 @distinct = ($column);
976 $select = { count => { distinct => \@distinct } };
979 $attrs->{select} = $select;
980 $attrs->{as} = [qw/count/];
982 # offset, order by and page are not needed to count. record_filter is cdbi
983 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
985 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
986 my ($count) = $tmp_rs->cursor->next;
994 =item Arguments: $sql_fragment, @bind_values
996 =item Return Value: $count
1000 Counts the results in a literal query. Equivalent to calling L</search_literal>
1001 with the passed arguments, then L</count>.
1005 sub count_literal { shift->search_literal(@_)->count; }
1011 =item Arguments: none
1013 =item Return Value: @objects
1017 Returns all elements in the resultset. Called implicitly if the resultset
1018 is returned in list context.
1024 return @{ $self->get_cache } if $self->get_cache;
1028 # TODO: don't call resolve here
1029 if (keys %{$self->_resolved_attrs->{collapse}}) {
1030 # if ($self->{attrs}{prefetch}) {
1031 # Using $self->cursor->all is really just an optimisation.
1032 # If we're collapsing has_many prefetches it probably makes
1033 # very little difference, and this is cleaner than hacking
1034 # _construct_object to survive the approach
1035 my @row = $self->cursor->next;
1037 push(@obj, $self->_construct_object(@row));
1038 @row = (exists $self->{stashed_row}
1039 ? @{delete $self->{stashed_row}}
1040 : $self->cursor->next);
1043 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1046 $self->set_cache(\@obj) if $self->{attrs}{cache};
1054 =item Arguments: none
1056 =item Return Value: $self
1060 Resets the resultset's cursor, so you can iterate through the elements again.
1066 delete $self->{_attrs} if exists $self->{_attrs};
1067 $self->{all_cache_position} = 0;
1068 $self->cursor->reset;
1076 =item Arguments: none
1078 =item Return Value: $object?
1082 Resets the resultset and returns an object for the first result (if the
1083 resultset returns anything).
1088 return $_[0]->reset->next;
1091 # _cond_for_update_delete
1093 # update/delete require the condition to be modified to handle
1094 # the differing SQL syntax available. This transforms the $self->{cond}
1095 # appropriately, returning the new condition.
1097 sub _cond_for_update_delete {
1098 my ($self, $full_cond) = @_;
1101 $full_cond ||= $self->{cond};
1102 # No-op. No condition, we're updating/deleting everything
1103 return $cond unless ref $full_cond;
1105 if (ref $full_cond eq 'ARRAY') {
1109 foreach my $key (keys %{$_}) {
1111 $hash{$1} = $_->{$key};
1117 elsif (ref $full_cond eq 'HASH') {
1118 if ((keys %{$full_cond})[0] eq '-and') {
1121 my @cond = @{$full_cond->{-and}};
1122 for (my $i = 0; $i < @cond; $i++) {
1123 my $entry = $cond[$i];
1126 if (ref $entry eq 'HASH') {
1127 $hash = $self->_cond_for_update_delete($entry);
1130 $entry =~ /([^.]+)$/;
1131 $hash->{$1} = $cond[++$i];
1134 push @{$cond->{-and}}, $hash;
1138 foreach my $key (keys %{$full_cond}) {
1140 $cond->{$1} = $full_cond->{$key};
1145 $self->throw_exception(
1146 "Can't update/delete on resultset with condition unless hash or array"
1158 =item Arguments: \%values
1160 =item Return Value: $storage_rv
1164 Sets the specified columns in the resultset to the supplied values in a
1165 single query. Return value will be true if the update succeeded or false
1166 if no records were updated; exact type of success value is storage-dependent.
1171 my ($self, $values) = @_;
1172 $self->throw_exception("Values for update must be a hash")
1173 unless ref $values eq 'HASH';
1175 my $cond = $self->_cond_for_update_delete;
1177 return $self->result_source->storage->update(
1178 $self->result_source, $values, $cond
1186 =item Arguments: \%values
1188 =item Return Value: 1
1192 Fetches all objects and updates them one at a time. Note that C<update_all>
1193 will run DBIC cascade triggers, while L</update> will not.
1198 my ($self, $values) = @_;
1199 $self->throw_exception("Values for update must be a hash")
1200 unless ref $values eq 'HASH';
1201 foreach my $obj ($self->all) {
1202 $obj->set_columns($values)->update;
1211 =item Arguments: none
1213 =item Return Value: 1
1217 Deletes the contents of the resultset from its result source. Note that this
1218 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1219 to run. See also L<DBIx::Class::Row/delete>.
1226 my $cond = $self->_cond_for_update_delete;
1228 $self->result_source->storage->delete($self->result_source, $cond);
1236 =item Arguments: none
1238 =item Return Value: 1
1242 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1243 will run DBIC cascade triggers, while L</delete> will not.
1249 $_->delete for $self->all;
1257 =item Arguments: \@data;
1261 Pass an arrayref of hashrefs. Each hashref should be a structure suitable for
1262 submitting to a $resultset->create(...) method.
1264 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1265 to insert the data, as this is a faster method.
1267 Otherwise, each set of data is inserted into the database using
1268 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
1269 objects is returned.
1271 Example: Assuming an Artist Class that has many CDs Classes relating:
1273 my $Artist_rs = $schema->resultset("Artist");
1275 ## Void Context Example
1276 $Artist_rs->populate([
1277 { artistid => 4, name => 'Manufactured Crap', cds => [
1278 { title => 'My First CD', year => 2006 },
1279 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1282 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1283 { title => 'My parents sold me to a record company' ,year => 2005 },
1284 { title => 'Why Am I So Ugly?', year => 2006 },
1285 { title => 'I Got Surgery and am now Popular', year => 2007 }
1290 ## Array Context Example
1291 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1292 { name => "Artist One"},
1293 { name => "Artist Two"},
1294 { name => "Artist Three", cds=> [
1295 { title => "First CD", year => 2007},
1296 { title => "Second CD", year => 2008},
1300 print $ArtistOne->name; ## response is 'Artist One'
1301 print $ArtistThree->cds->count ## reponse is '2'
1303 Please note an important effect on your data when choosing between void and
1304 wantarray context. Since void context goes straight to C<insert_bulk> in
1305 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1306 c<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1307 create primary keys for you, you will find that your PKs are empty. In this
1308 case you will have to use the wantarray context in order to create those
1314 my ($self, $data) = @_;
1316 if(defined wantarray) {
1318 foreach my $item (@$data) {
1319 push(@created, $self->create($item));
1323 my ($first, @rest) = @$data;
1325 my @names = grep {!ref $first->{$_}} keys %$first;
1326 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1327 my @pks = $self->result_source->primary_columns;
1329 ## do the belongs_to relationships
1330 foreach my $index (0..$#$data) {
1331 if( grep { !defined $data->[$index]->{$_} } @pks ) {
1332 my @ret = $self->populate($data);
1336 foreach my $rel (@rels) {
1337 next unless $data->[$index]->{$rel} && ref $data->[$index]->{$rel} eq "HASH";
1338 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1339 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1340 my $related = $result->result_source->resolve_condition(
1341 $result->result_source->relationship_info($reverse)->{cond},
1346 delete $data->[$index]->{$rel};
1347 $data->[$index] = {%{$data->[$index]}, %$related};
1349 push @names, keys %$related if $index == 0;
1353 ## do bulk insert on current row
1354 my @values = map { [ @$_{@names} ] } @$data;
1356 $self->result_source->storage->insert_bulk(
1357 $self->result_source,
1362 ## do the has_many relationships
1363 foreach my $item (@$data) {
1365 foreach my $rel (@rels) {
1366 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1368 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1369 || $self->throw_exception('Cannot find the relating object.');
1371 my $child = $parent->$rel;
1373 my $related = $child->result_source->resolve_condition(
1374 $parent->result_source->relationship_info($rel)->{cond},
1379 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1380 my @populate = map { {%$_, %$related} } @rows_to_add;
1382 $child->populate( \@populate );
1392 =item Arguments: none
1394 =item Return Value: $pager
1398 Return Value a L<Data::Page> object for the current resultset. Only makes
1399 sense for queries with a C<page> attribute.
1405 my $attrs = $self->{attrs};
1406 $self->throw_exception("Can't create pager for non-paged rs")
1407 unless $self->{attrs}{page};
1408 $attrs->{rows} ||= 10;
1409 return $self->{pager} ||= Data::Page->new(
1410 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1417 =item Arguments: $page_number
1419 =item Return Value: $rs
1423 Returns a resultset for the $page_number page of the resultset on which page
1424 is called, where each page contains a number of rows equal to the 'rows'
1425 attribute set on the resultset (10 by default).
1430 my ($self, $page) = @_;
1431 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1438 =item Arguments: \%vals
1440 =item Return Value: $object
1444 Creates a new row object in the resultset's result class and returns
1445 it. The row is not inserted into the database at this point, call
1446 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1447 will tell you whether the row object has been inserted or not.
1449 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1454 my ($self, $values) = @_;
1455 $self->throw_exception( "new_result needs a hash" )
1456 unless (ref $values eq 'HASH');
1457 $self->throw_exception(
1458 "Can't abstract implicit construct, condition not a hash"
1459 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1461 my $alias = $self->{attrs}{alias};
1462 my $collapsed_cond = $self->{cond} ? $self->_collapse_cond($self->{cond}) : {};
1464 # precendence must be given to passed values over values inherited from the cond,
1465 # so the order here is important.
1467 %{ $self->_remove_alias($collapsed_cond, $alias) },
1468 %{ $self->_remove_alias($values, $alias) },
1469 -source_handle => $self->_source_handle,
1470 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1473 return $self->result_class->new(\%new);
1478 # Recursively collapse the condition.
1480 sub _collapse_cond {
1481 my ($self, $cond, $collapsed) = @_;
1485 if (ref $cond eq 'ARRAY') {
1486 foreach my $subcond (@$cond) {
1487 next unless ref $subcond; # -or
1488 # warn "ARRAY: " . Dumper $subcond;
1489 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1492 elsif (ref $cond eq 'HASH') {
1493 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1494 foreach my $subcond (@{$cond->{-and}}) {
1495 # warn "HASH: " . Dumper $subcond;
1496 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1500 # warn "LEAF: " . Dumper $cond;
1501 foreach my $col (keys %$cond) {
1502 my $value = $cond->{$col};
1503 $collapsed->{$col} = $value;
1513 # Remove the specified alias from the specified query hash. A copy is made so
1514 # the original query is not modified.
1517 my ($self, $query, $alias) = @_;
1519 my %orig = %{ $query || {} };
1522 foreach my $key (keys %orig) {
1524 $unaliased{$key} = $orig{$key};
1527 $unaliased{$1} = $orig{$key}
1528 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
1538 =item Arguments: \%vals, \%attrs?
1540 =item Return Value: $object
1544 Find an existing record from this resultset. If none exists, instantiate a new
1545 result object and return it. The object will not be saved into your storage
1546 until you call L<DBIx::Class::Row/insert> on it.
1548 If you want objects to be saved immediately, use L</find_or_create> instead.
1554 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1555 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1556 my $exists = $self->find($hash, $attrs);
1557 return defined $exists ? $exists : $self->new_result($hash);
1564 =item Arguments: \%vals
1566 =item Return Value: a L<DBIx::Class::Row> $object
1570 Attempt to create a single new row or a row with multiple related rows
1571 in the table represented by the resultset (and related tables). This
1572 will not check for duplicate rows before inserting, use
1573 L</find_or_create> to do that.
1575 To create one row for this resultset, pass a hashref of key/value
1576 pairs representing the columns of the table and the values you wish to
1577 store. If the appropriate relationships are set up, foreign key fields
1578 can also be passed an object representing the foreign row, and the
1579 value will be set to it's primary key.
1581 To create related objects, pass a hashref for the value if the related
1582 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
1583 and use the name of the relationship as the key. (NOT the name of the field,
1584 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
1585 of hashrefs containing the data for each of the rows to create in the foreign
1586 tables, again using the relationship name as the key.
1588 Instead of hashrefs of plain related data (key/value pairs), you may
1589 also pass new or inserted objects. New objects (not inserted yet, see
1590 L</new>), will be inserted into their appropriate tables.
1592 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1594 Example of creating a new row.
1596 $person_rs->create({
1597 name=>"Some Person",
1598 email=>"somebody@someplace.com"
1601 Example of creating a new row and also creating rows in a related C<has_many>
1602 or C<has_one> resultset. Note Arrayref.
1605 { artistid => 4, name => 'Manufactured Crap', cds => [
1606 { title => 'My First CD', year => 2006 },
1607 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1612 Example of creating a new row and also creating a row in a related
1613 C<belongs_to>resultset. Note Hashref.
1616 title=>"Music for Silly Walks",
1619 name=>"Silly Musician",
1626 my ($self, $attrs) = @_;
1627 $self->throw_exception( "create needs a hashref" )
1628 unless ref $attrs eq 'HASH';
1629 return $self->new_result($attrs)->insert;
1632 =head2 find_or_create
1636 =item Arguments: \%vals, \%attrs?
1638 =item Return Value: $object
1642 $class->find_or_create({ key => $val, ... });
1644 Tries to find a record based on its primary key or unique constraint; if none
1645 is found, creates one and returns that instead.
1647 my $cd = $schema->resultset('CD')->find_or_create({
1649 artist => 'Massive Attack',
1650 title => 'Mezzanine',
1654 Also takes an optional C<key> attribute, to search by a specific key or unique
1655 constraint. For example:
1657 my $cd = $schema->resultset('CD')->find_or_create(
1659 artist => 'Massive Attack',
1660 title => 'Mezzanine',
1662 { key => 'cd_artist_title' }
1665 See also L</find> and L</update_or_create>. For information on how to declare
1666 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1670 sub find_or_create {
1672 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1673 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1674 my $exists = $self->find($hash, $attrs);
1675 return defined $exists ? $exists : $self->create($hash);
1678 =head2 update_or_create
1682 =item Arguments: \%col_values, { key => $unique_constraint }?
1684 =item Return Value: $object
1688 $class->update_or_create({ col => $val, ... });
1690 First, searches for an existing row matching one of the unique constraints
1691 (including the primary key) on the source of this resultset. If a row is
1692 found, updates it with the other given column values. Otherwise, creates a new
1695 Takes an optional C<key> attribute to search on a specific unique constraint.
1698 # In your application
1699 my $cd = $schema->resultset('CD')->update_or_create(
1701 artist => 'Massive Attack',
1702 title => 'Mezzanine',
1705 { key => 'cd_artist_title' }
1708 If no C<key> is specified, it searches on all unique constraints defined on the
1709 source, including the primary key.
1711 If the C<key> is specified as C<primary>, it searches only on the primary key.
1713 See also L</find> and L</find_or_create>. For information on how to declare
1714 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1718 sub update_or_create {
1720 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1721 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1723 my $row = $self->find($cond, $attrs);
1725 $row->update($cond);
1729 return $self->create($cond);
1736 =item Arguments: none
1738 =item Return Value: \@cache_objects?
1742 Gets the contents of the cache for the resultset, if the cache is set.
1754 =item Arguments: \@cache_objects
1756 =item Return Value: \@cache_objects
1760 Sets the contents of the cache for the resultset. Expects an arrayref
1761 of objects of the same class as those produced by the resultset. Note that
1762 if the cache is set the resultset will return the cached objects rather
1763 than re-querying the database even if the cache attr is not set.
1768 my ( $self, $data ) = @_;
1769 $self->throw_exception("set_cache requires an arrayref")
1770 if defined($data) && (ref $data ne 'ARRAY');
1771 $self->{all_cache} = $data;
1778 =item Arguments: none
1780 =item Return Value: []
1784 Clears the cache for the resultset.
1789 shift->set_cache(undef);
1792 =head2 related_resultset
1796 =item Arguments: $relationship_name
1798 =item Return Value: $resultset
1802 Returns a related resultset for the supplied relationship name.
1804 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1808 sub related_resultset {
1809 my ($self, $rel) = @_;
1811 $self->{related_resultsets} ||= {};
1812 return $self->{related_resultsets}{$rel} ||= do {
1813 my $rel_obj = $self->result_source->relationship_info($rel);
1815 $self->throw_exception(
1816 "search_related: result source '" . $self->result_source->source_name .
1817 "' has no such relationship $rel")
1820 my ($from,$seen) = $self->_resolve_from($rel);
1822 my $join_count = $seen->{$rel};
1823 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
1825 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
1826 my %attrs = %{$self->{attrs}||{}};
1827 delete @attrs{qw(result_class alias)};
1831 if (my $cache = $self->get_cache) {
1832 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
1833 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
1838 my $rel_source = $self->result_source->related_source($rel);
1842 # The reason we do this now instead of passing the alias to the
1843 # search_rs below is that if you wrap/overload resultset on the
1844 # source you need to know what alias it's -going- to have for things
1845 # to work sanely (e.g. RestrictWithObject wants to be able to add
1846 # extra query restrictions, and these may need to be $alias.)
1848 my $attrs = $rel_source->resultset_attributes;
1849 local $attrs->{alias} = $alias;
1851 $rel_source->resultset
1859 where => $self->{cond},
1864 $new->set_cache($new_cache) if $new_cache;
1870 my ($self, $extra_join) = @_;
1871 my $source = $self->result_source;
1872 my $attrs = $self->{attrs};
1874 my $from = $attrs->{from}
1875 || [ { $attrs->{alias} => $source->from } ];
1877 my $seen = { %{$attrs->{seen_join}||{}} };
1879 my $join = ($attrs->{join}
1880 ? [ $attrs->{join}, $extra_join ]
1883 # we need to take the prefetch the attrs into account before we
1884 # ->resolve_join as otherwise they get lost - captainL
1885 my $merged = $self->_merge_attr( $join, $attrs->{prefetch} );
1889 ($join ? $source->resolve_join($merged, $attrs->{alias}, $seen) : ()),
1892 return ($from,$seen);
1895 sub _resolved_attrs {
1897 return $self->{_attrs} if $self->{_attrs};
1899 my $attrs = { %{$self->{attrs}||{}} };
1900 my $source = $self->result_source;
1901 my $alias = $attrs->{alias};
1903 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
1904 if ($attrs->{columns}) {
1905 delete $attrs->{as};
1906 } elsif (!$attrs->{select}) {
1907 $attrs->{columns} = [ $source->columns ];
1912 ? (ref $attrs->{select} eq 'ARRAY'
1913 ? [ @{$attrs->{select}} ]
1914 : [ $attrs->{select} ])
1915 : [ map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} ]
1919 ? (ref $attrs->{as} eq 'ARRAY'
1920 ? [ @{$attrs->{as}} ]
1922 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} ]
1926 if ($adds = delete $attrs->{include_columns}) {
1927 $adds = [$adds] unless ref $adds eq 'ARRAY';
1928 push(@{$attrs->{select}}, @$adds);
1929 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
1931 if ($adds = delete $attrs->{'+select'}) {
1932 $adds = [$adds] unless ref $adds eq 'ARRAY';
1933 push(@{$attrs->{select}},
1934 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
1936 if (my $adds = delete $attrs->{'+as'}) {
1937 $adds = [$adds] unless ref $adds eq 'ARRAY';
1938 push(@{$attrs->{as}}, @$adds);
1941 $attrs->{from} ||= [ { 'me' => $source->from } ];
1943 if (exists $attrs->{join} || exists $attrs->{prefetch}) {
1944 my $join = delete $attrs->{join} || {};
1946 if (defined $attrs->{prefetch}) {
1947 $join = $self->_merge_attr(
1948 $join, $attrs->{prefetch}
1953 $attrs->{from} = # have to copy here to avoid corrupting the original
1956 $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} })
1961 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
1962 if ($attrs->{order_by}) {
1963 $attrs->{order_by} = (ref($attrs->{order_by}) eq 'ARRAY'
1964 ? [ @{$attrs->{order_by}} ]
1965 : [ $attrs->{order_by} ]);
1967 $attrs->{order_by} = [];
1970 my $collapse = $attrs->{collapse} || {};
1971 if (my $prefetch = delete $attrs->{prefetch}) {
1972 $prefetch = $self->_merge_attr({}, $prefetch);
1974 my $seen = $attrs->{seen_join} || {};
1975 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
1976 # bring joins back to level of current class
1977 my @prefetch = $source->resolve_prefetch(
1978 $p, $alias, $seen, \@pre_order, $collapse
1980 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
1981 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
1983 push(@{$attrs->{order_by}}, @pre_order);
1985 $attrs->{collapse} = $collapse;
1987 if ($attrs->{page}) {
1988 $attrs->{offset} ||= 0;
1989 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
1992 return $self->{_attrs} = $attrs;
1996 my ($self, $attr) = @_;
1998 if (ref $attr eq 'HASH') {
1999 return $self->_rollout_hash($attr);
2000 } elsif (ref $attr eq 'ARRAY') {
2001 return $self->_rollout_array($attr);
2007 sub _rollout_array {
2008 my ($self, $attr) = @_;
2011 foreach my $element (@{$attr}) {
2012 if (ref $element eq 'HASH') {
2013 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2014 } elsif (ref $element eq 'ARRAY') {
2015 # XXX - should probably recurse here
2016 push( @rolled_array, @{$self->_rollout_array($element)} );
2018 push( @rolled_array, $element );
2021 return \@rolled_array;
2025 my ($self, $attr) = @_;
2028 foreach my $key (keys %{$attr}) {
2029 push( @rolled_array, { $key => $attr->{$key} } );
2031 return \@rolled_array;
2034 sub _calculate_score {
2035 my ($self, $a, $b) = @_;
2037 if (ref $b eq 'HASH') {
2038 my ($b_key) = keys %{$b};
2039 if (ref $a eq 'HASH') {
2040 my ($a_key) = keys %{$a};
2041 if ($a_key eq $b_key) {
2042 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2047 return ($a eq $b_key) ? 1 : 0;
2050 if (ref $a eq 'HASH') {
2051 my ($a_key) = keys %{$a};
2052 return ($b eq $a_key) ? 1 : 0;
2054 return ($b eq $a) ? 1 : 0;
2060 my ($self, $a, $b) = @_;
2062 return $b unless defined($a);
2063 return $a unless defined($b);
2065 $a = $self->_rollout_attr($a);
2066 $b = $self->_rollout_attr($b);
2069 foreach my $b_element ( @{$b} ) {
2070 # find best candidate from $a to merge $b_element into
2071 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2072 foreach my $a_element ( @{$a} ) {
2073 my $score = $self->_calculate_score( $a_element, $b_element );
2074 if ($score > $best_candidate->{score}) {
2075 $best_candidate->{position} = $position;
2076 $best_candidate->{score} = $score;
2080 my ($b_key) = ( ref $b_element eq 'HASH' ) ? keys %{$b_element} : ($b_element);
2082 if ($best_candidate->{score} == 0 || exists $seen_keys->{$b_key}) {
2083 push( @{$a}, $b_element );
2085 my $a_best = $a->[$best_candidate->{position}];
2086 # merge a_best and b_element together and replace original with merged
2087 if (ref $a_best ne 'HASH') {
2088 $a->[$best_candidate->{position}] = $b_element;
2089 } elsif (ref $b_element eq 'HASH') {
2090 my ($key) = keys %{$a_best};
2091 $a->[$best_candidate->{position}] = { $key => $self->_merge_attr($a_best->{$key}, $b_element->{$key}) };
2094 $seen_keys->{$b_key} = 1; # don't merge the same key twice
2104 $self->_source_handle($_[0]->handle);
2106 $self->_source_handle->resolve;
2110 =head2 throw_exception
2112 See L<DBIx::Class::Schema/throw_exception> for details.
2116 sub throw_exception {
2118 $self->_source_handle->schema->throw_exception(@_);
2121 # XXX: FIXME: Attributes docs need clearing up
2125 The resultset takes various attributes that modify its behavior. Here's an
2132 =item Value: ($order_by | \@order_by)
2136 Which column(s) to order the results by. This is currently passed
2137 through directly to SQL, so you can give e.g. C<year DESC> for a
2138 descending order on the column `year'.
2140 Please note that if you have C<quote_char> enabled (see
2141 L<DBIx::Class::Storage::DBI/connect_info>) you will need to do C<\'year DESC' > to
2142 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
2143 so you will need to manually quote things as appropriate.)
2149 =item Value: \@columns
2153 Shortcut to request a particular set of columns to be retrieved. Adds
2154 C<me.> onto the start of any column without a C<.> in it and sets C<select>
2155 from that, then auto-populates C<as> from C<select> as normal. (You may also
2156 use the C<cols> attribute, as in earlier versions of DBIC.)
2158 =head2 include_columns
2162 =item Value: \@columns
2166 Shortcut to include additional columns in the returned results - for example
2168 $schema->resultset('CD')->search(undef, {
2169 include_columns => ['artist.name'],
2173 would return all CDs and include a 'name' column to the information
2174 passed to object inflation. Note that the 'artist' is the name of the
2175 column (or relationship) accessor, and 'name' is the name of the column
2176 accessor in the related table.
2182 =item Value: \@select_columns
2186 Indicates which columns should be selected from the storage. You can use
2187 column names, or in the case of RDBMS back ends, function or stored procedure
2190 $rs = $schema->resultset('Employee')->search(undef, {
2193 { count => 'employeeid' },
2198 When you use function/stored procedure names and do not supply an C<as>
2199 attribute, the column names returned are storage-dependent. E.g. MySQL would
2200 return a column named C<count(employeeid)> in the above example.
2206 Indicates additional columns to be selected from storage. Works the same as
2207 L</select> but adds columns to the selection.
2215 Indicates additional column names for those added via L</+select>.
2223 =item Value: \@inflation_names
2227 Indicates column names for object inflation. That is, C<as>
2228 indicates the name that the column can be accessed as via the
2229 C<get_column> method (or via the object accessor, B<if one already
2230 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
2232 The C<as> attribute is used in conjunction with C<select>,
2233 usually when C<select> contains one or more function or stored
2236 $rs = $schema->resultset('Employee')->search(undef, {
2239 { count => 'employeeid' }
2241 as => ['name', 'employee_count'],
2244 my $employee = $rs->first(); # get the first Employee
2246 If the object against which the search is performed already has an accessor
2247 matching a column name specified in C<as>, the value can be retrieved using
2248 the accessor as normal:
2250 my $name = $employee->name();
2252 If on the other hand an accessor does not exist in the object, you need to
2253 use C<get_column> instead:
2255 my $employee_count = $employee->get_column('employee_count');
2257 You can create your own accessors if required - see
2258 L<DBIx::Class::Manual::Cookbook> for details.
2260 Please note: This will NOT insert an C<AS employee_count> into the SQL
2261 statement produced, it is used for internal access only. Thus
2262 attempting to use the accessor in an C<order_by> clause or similar
2263 will fail miserably.
2265 To get around this limitation, you can supply literal SQL to your
2266 C<select> attibute that contains the C<AS alias> text, eg:
2268 select => [\'myfield AS alias']
2274 =item Value: ($rel_name | \@rel_names | \%rel_names)
2278 Contains a list of relationships that should be joined for this query. For
2281 # Get CDs by Nine Inch Nails
2282 my $rs = $schema->resultset('CD')->search(
2283 { 'artist.name' => 'Nine Inch Nails' },
2284 { join => 'artist' }
2287 Can also contain a hash reference to refer to the other relation's relations.
2290 package MyApp::Schema::Track;
2291 use base qw/DBIx::Class/;
2292 __PACKAGE__->table('track');
2293 __PACKAGE__->add_columns(qw/trackid cd position title/);
2294 __PACKAGE__->set_primary_key('trackid');
2295 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
2298 # In your application
2299 my $rs = $schema->resultset('Artist')->search(
2300 { 'track.title' => 'Teardrop' },
2302 join => { cd => 'track' },
2303 order_by => 'artist.name',
2307 You need to use the relationship (not the table) name in conditions,
2308 because they are aliased as such. The current table is aliased as "me", so
2309 you need to use me.column_name in order to avoid ambiguity. For example:
2311 # Get CDs from 1984 with a 'Foo' track
2312 my $rs = $schema->resultset('CD')->search(
2315 'tracks.name' => 'Foo'
2317 { join => 'tracks' }
2320 If the same join is supplied twice, it will be aliased to <rel>_2 (and
2321 similarly for a third time). For e.g.
2323 my $rs = $schema->resultset('Artist')->search({
2324 'cds.title' => 'Down to Earth',
2325 'cds_2.title' => 'Popular',
2327 join => [ qw/cds cds/ ],
2330 will return a set of all artists that have both a cd with title 'Down
2331 to Earth' and a cd with title 'Popular'.
2333 If you want to fetch related objects from other tables as well, see C<prefetch>
2336 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
2342 =item Value: ($rel_name | \@rel_names | \%rel_names)
2346 Contains one or more relationships that should be fetched along with
2347 the main query (when they are accessed afterwards the data will
2348 already be available, without extra queries to the database). This is
2349 useful for when you know you will need the related objects, because it
2350 saves at least one query:
2352 my $rs = $schema->resultset('Tag')->search(
2361 The initial search results in SQL like the following:
2363 SELECT tag.*, cd.*, artist.* FROM tag
2364 JOIN cd ON tag.cd = cd.cdid
2365 JOIN artist ON cd.artist = artist.artistid
2367 L<DBIx::Class> has no need to go back to the database when we access the
2368 C<cd> or C<artist> relationships, which saves us two SQL statements in this
2371 Simple prefetches will be joined automatically, so there is no need
2372 for a C<join> attribute in the above search. If you're prefetching to
2373 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
2374 specify the join as well.
2376 C<prefetch> can be used with the following relationship types: C<belongs_to>,
2377 C<has_one> (or if you're using C<add_relationship>, any relationship declared
2378 with an accessor type of 'single' or 'filter').
2388 Makes the resultset paged and specifies the page to retrieve. Effectively
2389 identical to creating a non-pages resultset and then calling ->page($page)
2392 If L<rows> attribute is not specified it defualts to 10 rows per page.
2402 Specifes the maximum number of rows for direct retrieval or the number of
2403 rows per page if the page attribute or method is used.
2409 =item Value: $offset
2413 Specifies the (zero-based) row number for the first row to be returned, or the
2414 of the first row of the first page if paging is used.
2420 =item Value: \@columns
2424 A arrayref of columns to group by. Can include columns of joined tables.
2426 group_by => [qw/ column1 column2 ... /]
2432 =item Value: $condition
2436 HAVING is a select statement attribute that is applied between GROUP BY and
2437 ORDER BY. It is applied to the after the grouping calculations have been
2440 having => { 'count(employee)' => { '>=', 100 } }
2446 =item Value: (0 | 1)
2450 Set to 1 to group by all columns.
2456 Adds to the WHERE clause.
2458 # only return rows WHERE deleted IS NULL for all searches
2459 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
2461 Can be overridden by passing C<{ where => undef }> as an attribute
2468 Set to 1 to cache search results. This prevents extra SQL queries if you
2469 revisit rows in your ResultSet:
2471 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
2473 while( my $artist = $resultset->next ) {
2477 $rs->first; # without cache, this would issue a query
2479 By default, searches are not cached.
2481 For more examples of using these attributes, see
2482 L<DBIx::Class::Manual::Cookbook>.
2488 =item Value: \@from_clause
2492 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
2493 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
2496 NOTE: Use this on your own risk. This allows you to shoot off your foot!
2498 C<join> will usually do what you need and it is strongly recommended that you
2499 avoid using C<from> unless you cannot achieve the desired result using C<join>.
2500 And we really do mean "cannot", not just tried and failed. Attempting to use
2501 this because you're having problems with C<join> is like trying to use x86
2502 ASM because you've got a syntax error in your C. Trust us on this.
2504 Now, if you're still really, really sure you need to use this (and if you're
2505 not 100% sure, ask the mailing list first), here's an explanation of how this
2508 The syntax is as follows -
2511 { <alias1> => <table1> },
2513 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2514 [], # nested JOIN (optional)
2515 { <table1.column1> => <table2.column2>, ... (more conditions) },
2517 # More of the above [ ] may follow for additional joins
2524 ON <table1.column1> = <table2.column2>
2525 <more joins may follow>
2527 An easy way to follow the examples below is to remember the following:
2529 Anything inside "[]" is a JOIN
2530 Anything inside "{}" is a condition for the enclosing JOIN
2532 The following examples utilize a "person" table in a family tree application.
2533 In order to express parent->child relationships, this table is self-joined:
2535 # Person->belongs_to('father' => 'Person');
2536 # Person->belongs_to('mother' => 'Person');
2538 C<from> can be used to nest joins. Here we return all children with a father,
2539 then search against all mothers of those children:
2541 $rs = $schema->resultset('Person')->search(
2544 alias => 'mother', # alias columns in accordance with "from"
2546 { mother => 'person' },
2549 { child => 'person' },
2551 { father => 'person' },
2552 { 'father.person_id' => 'child.father_id' }
2555 { 'mother.person_id' => 'child.mother_id' }
2562 # SELECT mother.* FROM person mother
2565 # JOIN person father
2566 # ON ( father.person_id = child.father_id )
2568 # ON ( mother.person_id = child.mother_id )
2570 The type of any join can be controlled manually. To search against only people
2571 with a father in the person table, we could explicitly use C<INNER JOIN>:
2573 $rs = $schema->resultset('Person')->search(
2576 alias => 'child', # alias columns in accordance with "from"
2578 { child => 'person' },
2580 { father => 'person', -join_type => 'inner' },
2581 { 'father.id' => 'child.father_id' }
2588 # SELECT child.* FROM person child
2589 # INNER JOIN person father ON child.father_id = father.id