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');
55 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.
63 =item Arguments: $source, \%$attrs
65 =item Return Value: $rs
69 The resultset constructor. Takes a source object (usually a
70 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
71 L</ATTRIBUTES> below). Does not perform any queries -- these are
72 executed as needed by the other methods.
74 Generally you won't need to construct a resultset manually. You'll
75 automatically get one from e.g. a L</search> called in scalar context:
77 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
79 IMPORTANT: If called on an object, proxies to new_result instead so
81 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
83 will return a CD object, not a ResultSet.
89 return $class->new_result(@_) if ref $class;
91 my ($source, $attrs) = @_;
92 $source = $source->handle
93 unless $source->isa('DBIx::Class::ResultSourceHandle');
94 $attrs = { %{$attrs||{}} };
97 $attrs->{rows} ||= 10;
100 $attrs->{alias} ||= 'me';
102 # Creation of {} and bless separated to mitigate RH perl bug
103 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
105 _source_handle => $source,
106 result_class => $attrs->{result_class} || $source->resolve->result_class,
107 cond => $attrs->{where},
122 =item Arguments: $cond, \%attrs?
124 =item Return Value: $resultset (scalar context), @row_objs (list context)
128 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
129 my $new_rs = $cd_rs->search({ year => 2005 });
131 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
132 # year = 2005 OR year = 2004
134 If you need to pass in additional attributes but no additional condition,
135 call it as C<search(undef, \%attrs)>.
137 # "SELECT name, artistid FROM $artist_table"
138 my @all_artists = $schema->resultset('Artist')->search(undef, {
139 columns => [qw/name artistid/],
142 For a list of attributes that can be passed to C<search>, see
143 L</ATTRIBUTES>. For more examples of using this function, see
144 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
145 documentation for the first argument, see L<SQL::Abstract>.
147 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
153 my $rs = $self->search_rs( @_ );
154 return (wantarray ? $rs->all : $rs);
161 =item Arguments: $cond, \%attrs?
163 =item Return Value: $resultset
167 This method does the same exact thing as search() except it will
168 always return a resultset, even in list context.
177 unless (@_) { # no search, effectively just a clone
178 $rows = $self->get_cache;
182 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
183 my $our_attrs = { %{$self->{attrs}} };
184 my $having = delete $our_attrs->{having};
185 my $where = delete $our_attrs->{where};
187 my $new_attrs = { %{$our_attrs}, %{$attrs} };
189 # merge new attrs into inherited
190 foreach my $key (qw/join prefetch/) {
191 next unless exists $attrs->{$key};
192 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
197 (@_ == 1 || ref $_[0] eq "HASH")
199 (ref $_[0] eq 'HASH')
201 (keys %{ $_[0] } > 0)
209 ? $self->throw_exception("Odd number of arguments to search")
216 if (defined $where) {
217 $new_attrs->{where} = (
218 defined $new_attrs->{where}
221 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
222 } $where, $new_attrs->{where}
229 $new_attrs->{where} = (
230 defined $new_attrs->{where}
233 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
234 } $cond, $new_attrs->{where}
240 if (defined $having) {
241 $new_attrs->{having} = (
242 defined $new_attrs->{having}
245 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
246 } $having, $new_attrs->{having}
252 my $rs = (ref $self)->new($self->result_source, $new_attrs);
254 $rs->set_cache($rows);
259 =head2 search_literal
263 =item Arguments: $sql_fragment, @bind_values
265 =item Return Value: $resultset (scalar context), @row_objs (list context)
269 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
270 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
272 Pass a literal chunk of SQL to be added to the conditional part of the
275 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
276 only be used in that context. There are known problems using C<search_literal>
277 in chained queries; it can result in bind values in the wrong order. See
278 L<DBIx::Class::Manual::Cookbook/Searching> and
279 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
280 require C<search_literal>.
285 my ($self, $cond, @vals) = @_;
286 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
287 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
288 return $self->search(\$cond, $attrs);
295 =item Arguments: @values | \%cols, \%attrs?
297 =item Return Value: $row_object
301 Finds a row based on its primary key or unique constraint. For example, to find
302 a row by its primary key:
304 my $cd = $schema->resultset('CD')->find(5);
306 You can also find a row by a specific unique constraint using the C<key>
307 attribute. For example:
309 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
310 key => 'cd_artist_title'
313 Additionally, you can specify the columns explicitly by name:
315 my $cd = $schema->resultset('CD')->find(
317 artist => 'Massive Attack',
318 title => 'Mezzanine',
320 { key => 'cd_artist_title' }
323 If the C<key> is specified as C<primary>, it searches only on the primary key.
325 If no C<key> is specified, it searches on all unique constraints defined on the
326 source, including the primary key.
328 If your table does not have a primary key, you B<must> provide a value for the
329 C<key> attribute matching one of the unique constraints on the source.
331 See also L</find_or_create> and L</update_or_create>. For information on how to
332 declare unique constraints, see
333 L<DBIx::Class::ResultSource/add_unique_constraint>.
339 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
341 # Default to the primary key, but allow a specific key
342 my @cols = exists $attrs->{key}
343 ? $self->result_source->unique_constraint_columns($attrs->{key})
344 : $self->result_source->primary_columns;
345 $self->throw_exception(
346 "Can't find unless a primary key is defined or unique constraint is specified"
349 # Parse out a hashref from input
351 if (ref $_[0] eq 'HASH') {
352 $input_query = { %{$_[0]} };
354 elsif (@_ == @cols) {
356 @{$input_query}{@cols} = @_;
359 # Compatibility: Allow e.g. find(id => $value)
360 carp "Find by key => value deprecated; please use a hashref instead";
364 my (%related, $info);
366 KEY: foreach my $key (keys %$input_query) {
367 if (ref($input_query->{$key})
368 && ($info = $self->result_source->relationship_info($key))) {
369 my $val = delete $input_query->{$key};
370 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
371 my $rel_q = $self->result_source->resolve_condition(
372 $info->{cond}, $val, $key
374 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
375 @related{keys %$rel_q} = values %$rel_q;
378 if (my @keys = keys %related) {
379 @{$input_query}{@keys} = values %related;
382 my @unique_queries = $self->_unique_queries($input_query, $attrs);
384 # Build the final query: Default to the disjunction of the unique queries,
385 # but allow the input query in case the ResultSet defines the query or the
386 # user is abusing find
387 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
388 my $query = @unique_queries
389 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
390 : $self->_add_alias($input_query, $alias);
394 my $rs = $self->search($query, $attrs);
395 return keys %{$rs->_resolved_attrs->{collapse}} ? $rs->next : $rs->single;
398 return keys %{$self->_resolved_attrs->{collapse}}
399 ? $self->search($query)->next
400 : $self->single($query);
406 # Add the specified alias to the specified query hash. A copy is made so the
407 # original query is not modified.
410 my ($self, $query, $alias) = @_;
412 my %aliased = %$query;
413 foreach my $col (grep { ! m/\./ } keys %aliased) {
414 $aliased{"$alias.$col"} = delete $aliased{$col};
422 # Build a list of queries which satisfy unique constraints.
424 sub _unique_queries {
425 my ($self, $query, $attrs) = @_;
427 my @constraint_names = exists $attrs->{key}
429 : $self->result_source->unique_constraint_names;
431 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
432 my $num_where = scalar keys %$where;
435 foreach my $name (@constraint_names) {
436 my @unique_cols = $self->result_source->unique_constraint_columns($name);
437 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
439 my $num_cols = scalar @unique_cols;
440 my $num_query = scalar keys %$unique_query;
442 my $total = $num_query + $num_where;
443 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
444 # The query is either unique on its own or is unique in combination with
445 # the existing where clause
446 push @unique_queries, $unique_query;
450 return @unique_queries;
453 # _build_unique_query
455 # Constrain the specified query hash based on the specified column names.
457 sub _build_unique_query {
458 my ($self, $query, $unique_cols) = @_;
461 map { $_ => $query->{$_} }
462 grep { exists $query->{$_} }
467 =head2 search_related
471 =item Arguments: $rel, $cond, \%attrs?
473 =item Return Value: $new_resultset
477 $new_rs = $cd_rs->search_related('artist', {
481 Searches the specified relationship, optionally specifying a condition and
482 attributes for matching records. See L</ATTRIBUTES> for more information.
487 return shift->related_resultset(shift)->search(@_);
494 =item Arguments: none
496 =item Return Value: $cursor
500 Returns a storage-driven cursor to the given resultset. See
501 L<DBIx::Class::Cursor> for more information.
508 my $attrs = { %{$self->_resolved_attrs} };
509 return $self->{cursor}
510 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
511 $attrs->{where},$attrs);
518 =item Arguments: $cond?
520 =item Return Value: $row_object?
524 my $cd = $schema->resultset('CD')->single({ year => 2001 });
526 Inflates the first result without creating a cursor if the resultset has
527 any records in it; if not returns nothing. Used by L</find> as an optimisation.
529 Can optionally take an additional condition *only* - this is a fast-code-path
530 method; if you need to add extra joins or similar call ->search and then
531 ->single without a condition on the $rs returned from that.
536 my ($self, $where) = @_;
537 my $attrs = { %{$self->_resolved_attrs} };
539 if (defined $attrs->{where}) {
542 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
543 $where, delete $attrs->{where} ]
546 $attrs->{where} = $where;
550 # XXX: Disabled since it doesn't infer uniqueness in all cases
551 # unless ($self->_is_unique_query($attrs->{where})) {
552 # carp "Query not guaranteed to return a single row"
553 # . "; please declare your unique constraints or use search instead";
556 my @data = $self->result_source->storage->select_single(
557 $attrs->{from}, $attrs->{select},
558 $attrs->{where}, $attrs
561 return (@data ? ($self->_construct_object(@data))[0] : undef);
566 # Try to determine if the specified query is guaranteed to be unique, based on
567 # the declared unique constraints.
569 sub _is_unique_query {
570 my ($self, $query) = @_;
572 my $collapsed = $self->_collapse_query($query);
573 my $alias = $self->{attrs}{alias};
575 foreach my $name ($self->result_source->unique_constraint_names) {
576 my @unique_cols = map {
578 } $self->result_source->unique_constraint_columns($name);
580 # Count the values for each unique column
581 my %seen = map { $_ => 0 } @unique_cols;
583 foreach my $key (keys %$collapsed) {
584 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
585 next unless exists $seen{$aliased}; # Additional constraints are okay
586 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
589 # If we get 0 or more than 1 value for a column, it's not necessarily unique
590 return 1 unless grep { $_ != 1 } values %seen;
598 # Recursively collapse the query, accumulating values for each column.
600 sub _collapse_query {
601 my ($self, $query, $collapsed) = @_;
605 if (ref $query eq 'ARRAY') {
606 foreach my $subquery (@$query) {
607 next unless ref $subquery; # -or
608 # warn "ARRAY: " . Dumper $subquery;
609 $collapsed = $self->_collapse_query($subquery, $collapsed);
612 elsif (ref $query eq 'HASH') {
613 if (keys %$query and (keys %$query)[0] eq '-and') {
614 foreach my $subquery (@{$query->{-and}}) {
615 # warn "HASH: " . Dumper $subquery;
616 $collapsed = $self->_collapse_query($subquery, $collapsed);
620 # warn "LEAF: " . Dumper $query;
621 foreach my $col (keys %$query) {
622 my $value = $query->{$col};
623 $collapsed->{$col}{$value}++;
635 =item Arguments: $cond?
637 =item Return Value: $resultsetcolumn
641 my $max_length = $rs->get_column('length')->max;
643 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
648 my ($self, $column) = @_;
649 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
657 =item Arguments: $cond, \%attrs?
659 =item Return Value: $resultset (scalar context), @row_objs (list context)
663 # WHERE title LIKE '%blue%'
664 $cd_rs = $rs->search_like({ title => '%blue%'});
666 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
667 that this is simply a convenience method. You most likely want to use
668 L</search> with specific operators.
670 For more information, see L<DBIx::Class::Manual::Cookbook>.
676 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
677 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
678 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
679 return $class->search($query, { %$attrs });
686 =item Arguments: $first, $last
688 =item Return Value: $resultset (scalar context), @row_objs (list context)
692 Returns a resultset or object list representing a subset of elements from the
693 resultset slice is called on. Indexes are from 0, i.e., to get the first
696 my ($one, $two, $three) = $rs->slice(0, 2);
701 my ($self, $min, $max) = @_;
702 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
703 $attrs->{offset} = $self->{attrs}{offset} || 0;
704 $attrs->{offset} += $min;
705 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
706 return $self->search(undef(), $attrs);
707 #my $slice = (ref $self)->new($self->result_source, $attrs);
708 #return (wantarray ? $slice->all : $slice);
715 =item Arguments: none
717 =item Return Value: $result?
721 Returns the next element in the resultset (C<undef> is there is none).
723 Can be used to efficiently iterate over records in the resultset:
725 my $rs = $schema->resultset('CD')->search;
726 while (my $cd = $rs->next) {
730 Note that you need to store the resultset object, and call C<next> on it.
731 Calling C<< resultset('Table')->next >> repeatedly will always return the
732 first record from the resultset.
738 if (my $cache = $self->get_cache) {
739 $self->{all_cache_position} ||= 0;
740 return $cache->[$self->{all_cache_position}++];
742 if ($self->{attrs}{cache}) {
743 $self->{all_cache_position} = 1;
744 return ($self->all)[0];
746 if ($self->{stashed_objects}) {
747 my $obj = shift(@{$self->{stashed_objects}});
748 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
752 exists $self->{stashed_row}
753 ? @{delete $self->{stashed_row}}
754 : $self->cursor->next
756 return undef unless (@row);
757 my ($row, @more) = $self->_construct_object(@row);
758 $self->{stashed_objects} = \@more if @more;
762 sub _construct_object {
763 my ($self, @row) = @_;
764 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
765 my @new = $self->result_class->inflate_result($self->result_source, @$info);
766 @new = $self->{_attrs}{record_filter}->(@new)
767 if exists $self->{_attrs}{record_filter};
771 sub _collapse_result {
772 my ($self, $as_proto, $row) = @_;
776 # 'foo' => [ undef, 'foo' ]
777 # 'foo.bar' => [ 'foo', 'bar' ]
778 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
780 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
782 my %collapse = %{$self->{_attrs}{collapse}||{}};
786 # if we're doing collapsing (has_many prefetch) we need to grab records
787 # until the PK changes, so fill @pri_index. if not, we leave it empty so
788 # we know we don't have to bother.
790 # the reason for not using the collapse stuff directly is because if you
791 # had for e.g. two artists in a row with no cds, the collapse info for
792 # both would be NULL (undef) so you'd lose the second artist
794 # store just the index so we can check the array positions from the row
795 # without having to contruct the full hash
797 if (keys %collapse) {
798 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
799 foreach my $i (0 .. $#construct_as) {
800 next if defined($construct_as[$i][0]); # only self table
801 if (delete $pri{$construct_as[$i][1]}) {
802 push(@pri_index, $i);
804 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
808 # no need to do an if, it'll be empty if @pri_index is empty anyway
810 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
814 do { # no need to check anything at the front, we always want the first row
818 foreach my $this_as (@construct_as) {
819 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
822 push(@const_rows, \%const);
824 } until ( # no pri_index => no collapse => drop straight out
827 do { # get another row, stash it, drop out if different PK
829 @copy = $self->cursor->next;
830 $self->{stashed_row} = \@copy;
832 # last thing in do block, counts as true if anything doesn't match
834 # check xor defined first for NULL vs. NOT NULL then if one is
835 # defined the other must be so check string equality
838 (defined $pri_vals{$_} ^ defined $copy[$_])
839 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
844 my $alias = $self->{attrs}{alias};
851 foreach my $const (@const_rows) {
852 scalar @const_keys or do {
853 @const_keys = sort { length($a) <=> length($b) } keys %$const;
855 foreach my $key (@const_keys) {
858 my @parts = split(/\./, $key);
860 my $data = $const->{$key};
861 foreach my $p (@parts) {
862 $target = $target->[1]->{$p} ||= [];
864 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
865 # collapsing at this point and on final part
866 my $pos = $collapse_pos{$cur};
867 CK: foreach my $ck (@ckey) {
868 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
869 $collapse_pos{$cur} = $data;
870 delete @collapse_pos{ # clear all positioning for sub-entries
871 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
878 if (exists $collapse{$cur}) {
879 $target = $target->[-1];
882 $target->[0] = $data;
884 $info->[0] = $const->{$key};
896 =item Arguments: $result_source?
898 =item Return Value: $result_source
902 An accessor for the primary ResultSource object from which this ResultSet
909 =item Arguments: $result_class?
911 =item Return Value: $result_class
915 An accessor for the class to use when creating row objects. Defaults to
916 C<< result_source->result_class >> - which in most cases is the name of the
917 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
926 =item Arguments: $cond, \%attrs??
928 =item Return Value: $count
932 Performs an SQL C<COUNT> with the same query as the resultset was built
933 with to find the number of elements. If passed arguments, does a search
934 on the resultset and counts the results of that.
936 Note: When using C<count> with C<group_by>, L<DBIx::Class> emulates C<GROUP BY>
937 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
938 not support C<DISTINCT> with multiple columns. If you are using such a
939 database, you should only use columns from the main table in your C<group_by>
946 return $self->search(@_)->count if @_ and defined $_[0];
947 return scalar @{ $self->get_cache } if $self->get_cache;
948 my $count = $self->_count;
949 return 0 unless $count;
951 # need to take offset from resolved attrs
953 $count -= $self->{_attrs}{offset} if $self->{_attrs}{offset};
954 $count = $self->{attrs}{rows} if
955 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
956 $count = 0 if ($count < 0);
960 sub _count { # Separated out so pager can get the full count
962 my $select = { count => '*' };
964 my $attrs = { %{$self->_resolved_attrs} };
965 if (my $group_by = delete $attrs->{group_by}) {
966 delete $attrs->{having};
967 my @distinct = (ref $group_by ? @$group_by : ($group_by));
968 # todo: try CONCAT for multi-column pk
969 my @pk = $self->result_source->primary_columns;
971 my $alias = $attrs->{alias};
972 foreach my $column (@distinct) {
973 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
974 @distinct = ($column);
980 $select = { count => { distinct => \@distinct } };
983 $attrs->{select} = $select;
984 $attrs->{as} = [qw/count/];
986 # offset, order by and page are not needed to count. record_filter is cdbi
987 delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
989 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
990 my ($count) = $tmp_rs->cursor->next;
1002 =item Arguments: $sql_fragment, @bind_values
1004 =item Return Value: $count
1008 Counts the results in a literal query. Equivalent to calling L</search_literal>
1009 with the passed arguments, then L</count>.
1013 sub count_literal { shift->search_literal(@_)->count; }
1019 =item Arguments: none
1021 =item Return Value: @objects
1025 Returns all elements in the resultset. Called implicitly if the resultset
1026 is returned in list context.
1032 return @{ $self->get_cache } if $self->get_cache;
1036 # TODO: don't call resolve here
1037 if (keys %{$self->_resolved_attrs->{collapse}}) {
1038 # if ($self->{attrs}{prefetch}) {
1039 # Using $self->cursor->all is really just an optimisation.
1040 # If we're collapsing has_many prefetches it probably makes
1041 # very little difference, and this is cleaner than hacking
1042 # _construct_object to survive the approach
1043 my @row = $self->cursor->next;
1045 push(@obj, $self->_construct_object(@row));
1046 @row = (exists $self->{stashed_row}
1047 ? @{delete $self->{stashed_row}}
1048 : $self->cursor->next);
1051 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1054 $self->set_cache(\@obj) if $self->{attrs}{cache};
1062 =item Arguments: none
1064 =item Return Value: $self
1068 Resets the resultset's cursor, so you can iterate through the elements again.
1074 delete $self->{_attrs} if exists $self->{_attrs};
1075 $self->{all_cache_position} = 0;
1076 $self->cursor->reset;
1084 =item Arguments: none
1086 =item Return Value: $object?
1090 Resets the resultset and returns an object for the first result (if the
1091 resultset returns anything).
1096 return $_[0]->reset->next;
1099 # _cond_for_update_delete
1101 # update/delete require the condition to be modified to handle
1102 # the differing SQL syntax available. This transforms the $self->{cond}
1103 # appropriately, returning the new condition.
1105 sub _cond_for_update_delete {
1106 my ($self, $full_cond) = @_;
1109 $full_cond ||= $self->{cond};
1110 # No-op. No condition, we're updating/deleting everything
1111 return $cond unless ref $full_cond;
1113 if (ref $full_cond eq 'ARRAY') {
1117 foreach my $key (keys %{$_}) {
1119 $hash{$1} = $_->{$key};
1125 elsif (ref $full_cond eq 'HASH') {
1126 if ((keys %{$full_cond})[0] eq '-and') {
1129 my @cond = @{$full_cond->{-and}};
1130 for (my $i = 0; $i < @cond; $i++) {
1131 my $entry = $cond[$i];
1134 if (ref $entry eq 'HASH') {
1135 $hash = $self->_cond_for_update_delete($entry);
1138 $entry =~ /([^.]+)$/;
1139 $hash->{$1} = $cond[++$i];
1142 push @{$cond->{-and}}, $hash;
1146 foreach my $key (keys %{$full_cond}) {
1148 $cond->{$1} = $full_cond->{$key};
1153 $self->throw_exception(
1154 "Can't update/delete on resultset with condition unless hash or array"
1166 =item Arguments: \%values
1168 =item Return Value: $storage_rv
1172 Sets the specified columns in the resultset to the supplied values in a
1173 single query. Return value will be true if the update succeeded or false
1174 if no records were updated; exact type of success value is storage-dependent.
1179 my ($self, $values) = @_;
1180 $self->throw_exception("Values for update must be a hash")
1181 unless ref $values eq 'HASH';
1183 my $cond = $self->_cond_for_update_delete;
1185 return $self->result_source->storage->update(
1186 $self->result_source, $values, $cond
1194 =item Arguments: \%values
1196 =item Return Value: 1
1200 Fetches all objects and updates them one at a time. Note that C<update_all>
1201 will run DBIC cascade triggers, while L</update> will not.
1206 my ($self, $values) = @_;
1207 $self->throw_exception("Values for update must be a hash")
1208 unless ref $values eq 'HASH';
1209 foreach my $obj ($self->all) {
1210 $obj->set_columns($values)->update;
1219 =item Arguments: none
1221 =item Return Value: 1
1225 Deletes the contents of the resultset from its result source. Note that this
1226 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1227 to run. See also L<DBIx::Class::Row/delete>.
1234 my $cond = $self->_cond_for_update_delete;
1236 $self->result_source->storage->delete($self->result_source, $cond);
1244 =item Arguments: none
1246 =item Return Value: 1
1250 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1251 will run DBIC cascade triggers, while L</delete> will not.
1257 $_->delete for $self->all;
1265 =item Arguments: \@data;
1269 Pass an arrayref of hashrefs. Each hashref should be a structure suitable for
1270 submitting to a $resultset->create(...) method.
1272 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1273 to insert the data, as this is a faster method.
1275 Otherwise, each set of data is inserted into the database using
1276 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
1277 objects is returned.
1279 Example: Assuming an Artist Class that has many CDs Classes relating:
1281 my $Artist_rs = $schema->resultset("Artist");
1283 ## Void Context Example
1284 $Artist_rs->populate([
1285 { artistid => 4, name => 'Manufactured Crap', cds => [
1286 { title => 'My First CD', year => 2006 },
1287 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1290 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1291 { title => 'My parents sold me to a record company' ,year => 2005 },
1292 { title => 'Why Am I So Ugly?', year => 2006 },
1293 { title => 'I Got Surgery and am now Popular', year => 2007 }
1298 ## Array Context Example
1299 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1300 { name => "Artist One"},
1301 { name => "Artist Two"},
1302 { name => "Artist Three", cds=> [
1303 { title => "First CD", year => 2007},
1304 { title => "Second CD", year => 2008},
1308 print $ArtistOne->name; ## response is 'Artist One'
1309 print $ArtistThree->cds->count ## reponse is '2'
1311 Please note an important effect on your data when choosing between void and
1312 wantarray context. Since void context goes straight to C<insert_bulk> in
1313 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1314 c<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1315 create primary keys for you, you will find that your PKs are empty. In this
1316 case you will have to use the wantarray context in order to create those
1322 my ($self, $data) = @_;
1324 if(defined wantarray) {
1326 foreach my $item (@$data) {
1327 push(@created, $self->create($item));
1331 my ($first, @rest) = @$data;
1333 my @names = grep {!ref $first->{$_}} keys %$first;
1334 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1335 my @pks = $self->result_source->primary_columns;
1337 ## do the belongs_to relationships
1338 foreach my $index (0..$#$data) {
1339 if( grep { !defined $data->[$index]->{$_} } @pks ) {
1340 my @ret = $self->populate($data);
1344 foreach my $rel (@rels) {
1345 next unless $data->[$index]->{$rel} && ref $data->[$index]->{$rel} eq "HASH";
1346 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1347 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1348 my $related = $result->result_source->resolve_condition(
1349 $result->result_source->relationship_info($reverse)->{cond},
1354 delete $data->[$index]->{$rel};
1355 $data->[$index] = {%{$data->[$index]}, %$related};
1357 push @names, keys %$related if $index == 0;
1361 ## do bulk insert on current row
1362 my @values = map { [ @$_{@names} ] } @$data;
1364 $self->result_source->storage->insert_bulk(
1365 $self->result_source,
1370 ## do the has_many relationships
1371 foreach my $item (@$data) {
1373 foreach my $rel (@rels) {
1374 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1376 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1377 || $self->throw_exception('Cannot find the relating object.');
1379 my $child = $parent->$rel;
1381 my $related = $child->result_source->resolve_condition(
1382 $parent->result_source->relationship_info($rel)->{cond},
1387 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1388 my @populate = map { {%$_, %$related} } @rows_to_add;
1390 $child->populate( \@populate );
1400 =item Arguments: none
1402 =item Return Value: $pager
1406 Return Value a L<Data::Page> object for the current resultset. Only makes
1407 sense for queries with a C<page> attribute.
1413 my $attrs = $self->{attrs};
1414 $self->throw_exception("Can't create pager for non-paged rs")
1415 unless $self->{attrs}{page};
1416 $attrs->{rows} ||= 10;
1417 return $self->{pager} ||= Data::Page->new(
1418 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1425 =item Arguments: $page_number
1427 =item Return Value: $rs
1431 Returns a resultset for the $page_number page of the resultset on which page
1432 is called, where each page contains a number of rows equal to the 'rows'
1433 attribute set on the resultset (10 by default).
1438 my ($self, $page) = @_;
1439 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1446 =item Arguments: \%vals
1448 =item Return Value: $object
1452 Creates a new row object in the resultset's result class and returns
1453 it. The row is not inserted into the database at this point, call
1454 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1455 will tell you whether the row object has been inserted or not.
1457 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1462 my ($self, $values) = @_;
1463 $self->throw_exception( "new_result needs a hash" )
1464 unless (ref $values eq 'HASH');
1465 $self->throw_exception(
1466 "Can't abstract implicit construct, condition not a hash"
1467 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1469 my $alias = $self->{attrs}{alias};
1470 my $collapsed_cond = $self->{cond} ? $self->_collapse_cond($self->{cond}) : {};
1472 # precendence must be given to passed values over values inherited from the cond,
1473 # so the order here is important.
1475 %{ $self->_remove_alias($collapsed_cond, $alias) },
1476 %{ $self->_remove_alias($values, $alias) },
1477 -source_handle => $self->_source_handle,
1478 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1481 return $self->result_class->new(\%new);
1486 # Recursively collapse the condition.
1488 sub _collapse_cond {
1489 my ($self, $cond, $collapsed) = @_;
1493 if (ref $cond eq 'ARRAY') {
1494 foreach my $subcond (@$cond) {
1495 next unless ref $subcond; # -or
1496 # warn "ARRAY: " . Dumper $subcond;
1497 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1500 elsif (ref $cond eq 'HASH') {
1501 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1502 foreach my $subcond (@{$cond->{-and}}) {
1503 # warn "HASH: " . Dumper $subcond;
1504 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1508 # warn "LEAF: " . Dumper $cond;
1509 foreach my $col (keys %$cond) {
1510 my $value = $cond->{$col};
1511 $collapsed->{$col} = $value;
1521 # Remove the specified alias from the specified query hash. A copy is made so
1522 # the original query is not modified.
1525 my ($self, $query, $alias) = @_;
1527 my %orig = %{ $query || {} };
1530 foreach my $key (keys %orig) {
1532 $unaliased{$key} = $orig{$key};
1535 $unaliased{$1} = $orig{$key}
1536 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
1546 =item Arguments: \%vals, \%attrs?
1548 =item Return Value: $object
1552 Find an existing record from this resultset. If none exists, instantiate a new
1553 result object and return it. The object will not be saved into your storage
1554 until you call L<DBIx::Class::Row/insert> on it.
1556 If you want objects to be saved immediately, use L</find_or_create> instead.
1562 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1563 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1564 my $exists = $self->find($hash, $attrs);
1565 return defined $exists ? $exists : $self->new_result($hash);
1572 =item Arguments: \%vals
1574 =item Return Value: a L<DBIx::Class::Row> $object
1578 Attempt to create a single new row or a row with multiple related rows
1579 in the table represented by the resultset (and related tables). This
1580 will not check for duplicate rows before inserting, use
1581 L</find_or_create> to do that.
1583 To create one row for this resultset, pass a hashref of key/value
1584 pairs representing the columns of the table and the values you wish to
1585 store. If the appropriate relationships are set up, foreign key fields
1586 can also be passed an object representing the foreign row, and the
1587 value will be set to it's primary key.
1589 To create related objects, pass a hashref for the value if the related
1590 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
1591 and use the name of the relationship as the key. (NOT the name of the field,
1592 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
1593 of hashrefs containing the data for each of the rows to create in the foreign
1594 tables, again using the relationship name as the key.
1596 Instead of hashrefs of plain related data (key/value pairs), you may
1597 also pass new or inserted objects. New objects (not inserted yet, see
1598 L</new>), will be inserted into their appropriate tables.
1600 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1602 Example of creating a new row.
1604 $person_rs->create({
1605 name=>"Some Person",
1606 email=>"somebody@someplace.com"
1609 Example of creating a new row and also creating rows in a related C<has_many>
1610 or C<has_one> resultset. Note Arrayref.
1613 { artistid => 4, name => 'Manufactured Crap', cds => [
1614 { title => 'My First CD', year => 2006 },
1615 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1620 Example of creating a new row and also creating a row in a related
1621 C<belongs_to>resultset. Note Hashref.
1624 title=>"Music for Silly Walks",
1627 name=>"Silly Musician",
1634 my ($self, $attrs) = @_;
1635 $self->throw_exception( "create needs a hashref" )
1636 unless ref $attrs eq 'HASH';
1637 return $self->new_result($attrs)->insert;
1640 =head2 find_or_create
1644 =item Arguments: \%vals, \%attrs?
1646 =item Return Value: $object
1650 $class->find_or_create({ key => $val, ... });
1652 Tries to find a record based on its primary key or unique constraint; if none
1653 is found, creates one and returns that instead.
1655 my $cd = $schema->resultset('CD')->find_or_create({
1657 artist => 'Massive Attack',
1658 title => 'Mezzanine',
1662 Also takes an optional C<key> attribute, to search by a specific key or unique
1663 constraint. For example:
1665 my $cd = $schema->resultset('CD')->find_or_create(
1667 artist => 'Massive Attack',
1668 title => 'Mezzanine',
1670 { key => 'cd_artist_title' }
1673 See also L</find> and L</update_or_create>. For information on how to declare
1674 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1678 sub find_or_create {
1680 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1681 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1682 my $exists = $self->find($hash, $attrs);
1683 return defined $exists ? $exists : $self->create($hash);
1686 =head2 update_or_create
1690 =item Arguments: \%col_values, { key => $unique_constraint }?
1692 =item Return Value: $object
1696 $class->update_or_create({ col => $val, ... });
1698 First, searches for an existing row matching one of the unique constraints
1699 (including the primary key) on the source of this resultset. If a row is
1700 found, updates it with the other given column values. Otherwise, creates a new
1703 Takes an optional C<key> attribute to search on a specific unique constraint.
1706 # In your application
1707 my $cd = $schema->resultset('CD')->update_or_create(
1709 artist => 'Massive Attack',
1710 title => 'Mezzanine',
1713 { key => 'cd_artist_title' }
1716 If no C<key> is specified, it searches on all unique constraints defined on the
1717 source, including the primary key.
1719 If the C<key> is specified as C<primary>, it searches only on the primary key.
1721 See also L</find> and L</find_or_create>. For information on how to declare
1722 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1726 sub update_or_create {
1728 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1729 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1731 my $row = $self->find($cond, $attrs);
1733 $row->update($cond);
1737 return $self->create($cond);
1744 =item Arguments: none
1746 =item Return Value: \@cache_objects?
1750 Gets the contents of the cache for the resultset, if the cache is set.
1762 =item Arguments: \@cache_objects
1764 =item Return Value: \@cache_objects
1768 Sets the contents of the cache for the resultset. Expects an arrayref
1769 of objects of the same class as those produced by the resultset. Note that
1770 if the cache is set the resultset will return the cached objects rather
1771 than re-querying the database even if the cache attr is not set.
1776 my ( $self, $data ) = @_;
1777 $self->throw_exception("set_cache requires an arrayref")
1778 if defined($data) && (ref $data ne 'ARRAY');
1779 $self->{all_cache} = $data;
1786 =item Arguments: none
1788 =item Return Value: []
1792 Clears the cache for the resultset.
1797 shift->set_cache(undef);
1800 =head2 related_resultset
1804 =item Arguments: $relationship_name
1806 =item Return Value: $resultset
1810 Returns a related resultset for the supplied relationship name.
1812 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1816 sub related_resultset {
1817 my ($self, $rel) = @_;
1819 $self->{related_resultsets} ||= {};
1820 return $self->{related_resultsets}{$rel} ||= do {
1821 my $rel_obj = $self->result_source->relationship_info($rel);
1823 $self->throw_exception(
1824 "search_related: result source '" . $self->result_source->source_name .
1825 "' has no such relationship $rel")
1828 my ($from,$seen) = $self->_resolve_from($rel);
1830 my $join_count = $seen->{$rel};
1831 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
1833 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
1834 my %attrs = %{$self->{attrs}||{}};
1835 delete @attrs{qw(result_class alias)};
1839 if (my $cache = $self->get_cache) {
1840 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
1841 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
1846 my $rel_source = $self->result_source->related_source($rel);
1850 # The reason we do this now instead of passing the alias to the
1851 # search_rs below is that if you wrap/overload resultset on the
1852 # source you need to know what alias it's -going- to have for things
1853 # to work sanely (e.g. RestrictWithObject wants to be able to add
1854 # extra query restrictions, and these may need to be $alias.)
1856 my $attrs = $rel_source->resultset_attributes;
1857 local $attrs->{alias} = $alias;
1859 $rel_source->resultset
1867 where => $self->{cond},
1872 $new->set_cache($new_cache) if $new_cache;
1878 my ($self, $extra_join) = @_;
1879 my $source = $self->result_source;
1880 my $attrs = $self->{attrs};
1882 my $from = $attrs->{from}
1883 || [ { $attrs->{alias} => $source->from } ];
1885 my $seen = { %{$attrs->{seen_join}||{}} };
1887 my $join = ($attrs->{join}
1888 ? [ $attrs->{join}, $extra_join ]
1891 # we need to take the prefetch the attrs into account before we
1892 # ->resolve_join as otherwise they get lost - captainL
1893 my $merged = $self->_merge_attr( $join, $attrs->{prefetch} );
1897 ($join ? $source->resolve_join($merged, $attrs->{alias}, $seen) : ()),
1900 return ($from,$seen);
1903 sub _resolved_attrs {
1905 return $self->{_attrs} if $self->{_attrs};
1907 my $attrs = { %{$self->{attrs}||{}} };
1908 my $source = $self->result_source;
1909 my $alias = $attrs->{alias};
1911 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
1912 if ($attrs->{columns}) {
1913 delete $attrs->{as};
1914 } elsif (!$attrs->{select}) {
1915 $attrs->{columns} = [ $source->columns ];
1920 ? (ref $attrs->{select} eq 'ARRAY'
1921 ? [ @{$attrs->{select}} ]
1922 : [ $attrs->{select} ])
1923 : [ map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}} ]
1927 ? (ref $attrs->{as} eq 'ARRAY'
1928 ? [ @{$attrs->{as}} ]
1930 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}} ]
1934 if ($adds = delete $attrs->{include_columns}) {
1935 $adds = [$adds] unless ref $adds eq 'ARRAY';
1936 push(@{$attrs->{select}}, @$adds);
1937 push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
1939 if ($adds = delete $attrs->{'+select'}) {
1940 $adds = [$adds] unless ref $adds eq 'ARRAY';
1941 push(@{$attrs->{select}},
1942 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
1944 if (my $adds = delete $attrs->{'+as'}) {
1945 $adds = [$adds] unless ref $adds eq 'ARRAY';
1946 push(@{$attrs->{as}}, @$adds);
1949 $attrs->{from} ||= [ { 'me' => $source->from } ];
1951 if (exists $attrs->{join} || exists $attrs->{prefetch}) {
1952 my $join = delete $attrs->{join} || {};
1954 if (defined $attrs->{prefetch}) {
1955 $join = $self->_merge_attr(
1956 $join, $attrs->{prefetch}
1961 $attrs->{from} = # have to copy here to avoid corrupting the original
1964 $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} })
1969 $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
1970 if ($attrs->{order_by}) {
1971 $attrs->{order_by} = (ref($attrs->{order_by}) eq 'ARRAY'
1972 ? [ @{$attrs->{order_by}} ]
1973 : [ $attrs->{order_by} ]);
1975 $attrs->{order_by} = [];
1978 my $collapse = $attrs->{collapse} || {};
1979 if (my $prefetch = delete $attrs->{prefetch}) {
1980 $prefetch = $self->_merge_attr({}, $prefetch);
1982 my $seen = $attrs->{seen_join} || {};
1983 foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
1984 # bring joins back to level of current class
1985 my @prefetch = $source->resolve_prefetch(
1986 $p, $alias, $seen, \@pre_order, $collapse
1988 push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
1989 push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
1991 push(@{$attrs->{order_by}}, @pre_order);
1993 $attrs->{collapse} = $collapse;
1995 if ($attrs->{page}) {
1996 $attrs->{offset} ||= 0;
1997 $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
2000 return $self->{_attrs} = $attrs;
2004 my ($self, $attr) = @_;
2006 if (ref $attr eq 'HASH') {
2007 return $self->_rollout_hash($attr);
2008 } elsif (ref $attr eq 'ARRAY') {
2009 return $self->_rollout_array($attr);
2015 sub _rollout_array {
2016 my ($self, $attr) = @_;
2019 foreach my $element (@{$attr}) {
2020 if (ref $element eq 'HASH') {
2021 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2022 } elsif (ref $element eq 'ARRAY') {
2023 # XXX - should probably recurse here
2024 push( @rolled_array, @{$self->_rollout_array($element)} );
2026 push( @rolled_array, $element );
2029 return \@rolled_array;
2033 my ($self, $attr) = @_;
2036 foreach my $key (keys %{$attr}) {
2037 push( @rolled_array, { $key => $attr->{$key} } );
2039 return \@rolled_array;
2042 sub _calculate_score {
2043 my ($self, $a, $b) = @_;
2045 if (ref $b eq 'HASH') {
2046 my ($b_key) = keys %{$b};
2047 if (ref $a eq 'HASH') {
2048 my ($a_key) = keys %{$a};
2049 if ($a_key eq $b_key) {
2050 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2055 return ($a eq $b_key) ? 1 : 0;
2058 if (ref $a eq 'HASH') {
2059 my ($a_key) = keys %{$a};
2060 return ($b eq $a_key) ? 1 : 0;
2062 return ($b eq $a) ? 1 : 0;
2068 my ($self, $a, $b) = @_;
2070 return $b unless defined($a);
2071 return $a unless defined($b);
2073 $a = $self->_rollout_attr($a);
2074 $b = $self->_rollout_attr($b);
2077 foreach my $b_element ( @{$b} ) {
2078 # find best candidate from $a to merge $b_element into
2079 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2080 foreach my $a_element ( @{$a} ) {
2081 my $score = $self->_calculate_score( $a_element, $b_element );
2082 if ($score > $best_candidate->{score}) {
2083 $best_candidate->{position} = $position;
2084 $best_candidate->{score} = $score;
2088 my ($b_key) = ( ref $b_element eq 'HASH' ) ? keys %{$b_element} : ($b_element);
2090 if ($best_candidate->{score} == 0 || exists $seen_keys->{$b_key}) {
2091 push( @{$a}, $b_element );
2093 my $a_best = $a->[$best_candidate->{position}];
2094 # merge a_best and b_element together and replace original with merged
2095 if (ref $a_best ne 'HASH') {
2096 $a->[$best_candidate->{position}] = $b_element;
2097 } elsif (ref $b_element eq 'HASH') {
2098 my ($key) = keys %{$a_best};
2099 $a->[$best_candidate->{position}] = { $key => $self->_merge_attr($a_best->{$key}, $b_element->{$key}) };
2102 $seen_keys->{$b_key} = 1; # don't merge the same key twice
2112 $self->_source_handle($_[0]->handle);
2114 $self->_source_handle->resolve;
2118 =head2 throw_exception
2120 See L<DBIx::Class::Schema/throw_exception> for details.
2124 sub throw_exception {
2126 $self->_source_handle->schema->throw_exception(@_);
2129 # XXX: FIXME: Attributes docs need clearing up
2133 The resultset takes various attributes that modify its behavior. Here's an
2140 =item Value: ($order_by | \@order_by)
2144 Which column(s) to order the results by. This is currently passed
2145 through directly to SQL, so you can give e.g. C<year DESC> for a
2146 descending order on the column `year'.
2148 Please note that if you have C<quote_char> enabled (see
2149 L<DBIx::Class::Storage::DBI/connect_info>) you will need to do C<\'year DESC' > to
2150 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
2151 so you will need to manually quote things as appropriate.)
2157 =item Value: \@columns
2161 Shortcut to request a particular set of columns to be retrieved. Adds
2162 C<me.> onto the start of any column without a C<.> in it and sets C<select>
2163 from that, then auto-populates C<as> from C<select> as normal. (You may also
2164 use the C<cols> attribute, as in earlier versions of DBIC.)
2166 =head2 include_columns
2170 =item Value: \@columns
2174 Shortcut to include additional columns in the returned results - for example
2176 $schema->resultset('CD')->search(undef, {
2177 include_columns => ['artist.name'],
2181 would return all CDs and include a 'name' column to the information
2182 passed to object inflation. Note that the 'artist' is the name of the
2183 column (or relationship) accessor, and 'name' is the name of the column
2184 accessor in the related table.
2190 =item Value: \@select_columns
2194 Indicates which columns should be selected from the storage. You can use
2195 column names, or in the case of RDBMS back ends, function or stored procedure
2198 $rs = $schema->resultset('Employee')->search(undef, {
2201 { count => 'employeeid' },
2206 When you use function/stored procedure names and do not supply an C<as>
2207 attribute, the column names returned are storage-dependent. E.g. MySQL would
2208 return a column named C<count(employeeid)> in the above example.
2214 Indicates additional columns to be selected from storage. Works the same as
2215 L</select> but adds columns to the selection.
2223 Indicates additional column names for those added via L</+select>.
2231 =item Value: \@inflation_names
2235 Indicates column names for object inflation. That is, C<as>
2236 indicates the name that the column can be accessed as via the
2237 C<get_column> method (or via the object accessor, B<if one already
2238 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
2240 The C<as> attribute is used in conjunction with C<select>,
2241 usually when C<select> contains one or more function or stored
2244 $rs = $schema->resultset('Employee')->search(undef, {
2247 { count => 'employeeid' }
2249 as => ['name', 'employee_count'],
2252 my $employee = $rs->first(); # get the first Employee
2254 If the object against which the search is performed already has an accessor
2255 matching a column name specified in C<as>, the value can be retrieved using
2256 the accessor as normal:
2258 my $name = $employee->name();
2260 If on the other hand an accessor does not exist in the object, you need to
2261 use C<get_column> instead:
2263 my $employee_count = $employee->get_column('employee_count');
2265 You can create your own accessors if required - see
2266 L<DBIx::Class::Manual::Cookbook> for details.
2268 Please note: This will NOT insert an C<AS employee_count> into the SQL
2269 statement produced, it is used for internal access only. Thus
2270 attempting to use the accessor in an C<order_by> clause or similar
2271 will fail miserably.
2273 To get around this limitation, you can supply literal SQL to your
2274 C<select> attibute that contains the C<AS alias> text, eg:
2276 select => [\'myfield AS alias']
2282 =item Value: ($rel_name | \@rel_names | \%rel_names)
2286 Contains a list of relationships that should be joined for this query. For
2289 # Get CDs by Nine Inch Nails
2290 my $rs = $schema->resultset('CD')->search(
2291 { 'artist.name' => 'Nine Inch Nails' },
2292 { join => 'artist' }
2295 Can also contain a hash reference to refer to the other relation's relations.
2298 package MyApp::Schema::Track;
2299 use base qw/DBIx::Class/;
2300 __PACKAGE__->table('track');
2301 __PACKAGE__->add_columns(qw/trackid cd position title/);
2302 __PACKAGE__->set_primary_key('trackid');
2303 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
2306 # In your application
2307 my $rs = $schema->resultset('Artist')->search(
2308 { 'track.title' => 'Teardrop' },
2310 join => { cd => 'track' },
2311 order_by => 'artist.name',
2315 You need to use the relationship (not the table) name in conditions,
2316 because they are aliased as such. The current table is aliased as "me", so
2317 you need to use me.column_name in order to avoid ambiguity. For example:
2319 # Get CDs from 1984 with a 'Foo' track
2320 my $rs = $schema->resultset('CD')->search(
2323 'tracks.name' => 'Foo'
2325 { join => 'tracks' }
2328 If the same join is supplied twice, it will be aliased to <rel>_2 (and
2329 similarly for a third time). For e.g.
2331 my $rs = $schema->resultset('Artist')->search({
2332 'cds.title' => 'Down to Earth',
2333 'cds_2.title' => 'Popular',
2335 join => [ qw/cds cds/ ],
2338 will return a set of all artists that have both a cd with title 'Down
2339 to Earth' and a cd with title 'Popular'.
2341 If you want to fetch related objects from other tables as well, see C<prefetch>
2344 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
2350 =item Value: ($rel_name | \@rel_names | \%rel_names)
2354 Contains one or more relationships that should be fetched along with
2355 the main query (when they are accessed afterwards the data will
2356 already be available, without extra queries to the database). This is
2357 useful for when you know you will need the related objects, because it
2358 saves at least one query:
2360 my $rs = $schema->resultset('Tag')->search(
2369 The initial search results in SQL like the following:
2371 SELECT tag.*, cd.*, artist.* FROM tag
2372 JOIN cd ON tag.cd = cd.cdid
2373 JOIN artist ON cd.artist = artist.artistid
2375 L<DBIx::Class> has no need to go back to the database when we access the
2376 C<cd> or C<artist> relationships, which saves us two SQL statements in this
2379 Simple prefetches will be joined automatically, so there is no need
2380 for a C<join> attribute in the above search. If you're prefetching to
2381 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
2382 specify the join as well.
2384 C<prefetch> can be used with the following relationship types: C<belongs_to>,
2385 C<has_one> (or if you're using C<add_relationship>, any relationship declared
2386 with an accessor type of 'single' or 'filter').
2396 Makes the resultset paged and specifies the page to retrieve. Effectively
2397 identical to creating a non-pages resultset and then calling ->page($page)
2400 If L<rows> attribute is not specified it defualts to 10 rows per page.
2410 Specifes the maximum number of rows for direct retrieval or the number of
2411 rows per page if the page attribute or method is used.
2417 =item Value: $offset
2421 Specifies the (zero-based) row number for the first row to be returned, or the
2422 of the first row of the first page if paging is used.
2428 =item Value: \@columns
2432 A arrayref of columns to group by. Can include columns of joined tables.
2434 group_by => [qw/ column1 column2 ... /]
2440 =item Value: $condition
2444 HAVING is a select statement attribute that is applied between GROUP BY and
2445 ORDER BY. It is applied to the after the grouping calculations have been
2448 having => { 'count(employee)' => { '>=', 100 } }
2454 =item Value: (0 | 1)
2458 Set to 1 to group by all columns.
2464 Adds to the WHERE clause.
2466 # only return rows WHERE deleted IS NULL for all searches
2467 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
2469 Can be overridden by passing C<{ where => undef }> as an attribute
2476 Set to 1 to cache search results. This prevents extra SQL queries if you
2477 revisit rows in your ResultSet:
2479 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
2481 while( my $artist = $resultset->next ) {
2485 $rs->first; # without cache, this would issue a query
2487 By default, searches are not cached.
2489 For more examples of using these attributes, see
2490 L<DBIx::Class::Manual::Cookbook>.
2496 =item Value: \@from_clause
2500 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
2501 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
2504 NOTE: Use this on your own risk. This allows you to shoot off your foot!
2506 C<join> will usually do what you need and it is strongly recommended that you
2507 avoid using C<from> unless you cannot achieve the desired result using C<join>.
2508 And we really do mean "cannot", not just tried and failed. Attempting to use
2509 this because you're having problems with C<join> is like trying to use x86
2510 ASM because you've got a syntax error in your C. Trust us on this.
2512 Now, if you're still really, really sure you need to use this (and if you're
2513 not 100% sure, ask the mailing list first), here's an explanation of how this
2516 The syntax is as follows -
2519 { <alias1> => <table1> },
2521 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2522 [], # nested JOIN (optional)
2523 { <table1.column1> => <table2.column2>, ... (more conditions) },
2525 # More of the above [ ] may follow for additional joins
2532 ON <table1.column1> = <table2.column2>
2533 <more joins may follow>
2535 An easy way to follow the examples below is to remember the following:
2537 Anything inside "[]" is a JOIN
2538 Anything inside "{}" is a condition for the enclosing JOIN
2540 The following examples utilize a "person" table in a family tree application.
2541 In order to express parent->child relationships, this table is self-joined:
2543 # Person->belongs_to('father' => 'Person');
2544 # Person->belongs_to('mother' => 'Person');
2546 C<from> can be used to nest joins. Here we return all children with a father,
2547 then search against all mothers of those children:
2549 $rs = $schema->resultset('Person')->search(
2552 alias => 'mother', # alias columns in accordance with "from"
2554 { mother => 'person' },
2557 { child => 'person' },
2559 { father => 'person' },
2560 { 'father.person_id' => 'child.father_id' }
2563 { 'mother.person_id' => 'child.mother_id' }
2570 # SELECT mother.* FROM person mother
2573 # JOIN person father
2574 # ON ( father.person_id = child.father_id )
2576 # ON ( mother.person_id = child.mother_id )
2578 The type of any join can be controlled manually. To search against only people
2579 with a father in the person table, we could explicitly use C<INNER JOIN>:
2581 $rs = $schema->resultset('Person')->search(
2584 alias => 'child', # alias columns in accordance with "from"
2586 { child => 'person' },
2588 { father => 'person', -join_type => 'inner' },
2589 { 'father.id' => 'child.father_id' }
2596 # SELECT child.* FROM person child
2597 # INNER JOIN person father ON child.father_id = father.id