1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Exception;
13 use DBIx::Class::ResultSetColumn;
14 use DBIx::Class::ResultSourceHandle;
17 use base qw/DBIx::Class/;
19 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
23 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
27 my $users_rs = $schema->resultset('User');
28 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
29 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
33 A ResultSet is an object which stores a set of conditions representing
34 a query. It is the backbone of DBIx::Class (i.e. the really
35 important/useful bit).
37 No SQL is executed on the database when a ResultSet is created, it
38 just stores all the conditions needed to create the query.
40 A basic ResultSet representing the data of an entire table is returned
41 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
42 L<Source|DBIx::Class::Manual::Glossary/Source> name.
44 my $users_rs = $schema->resultset('User');
46 A new ResultSet is returned from calling L</search> on an existing
47 ResultSet. The new one will contain all the conditions of the
48 original, plus any new conditions added in the C<search> call.
50 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
51 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
54 The query that the ResultSet represents is B<only> executed against
55 the database when these methods are called:
56 L</find> L</next> L</all> L</first> L</single> L</count>
60 =head2 Chaining resultsets
62 Let's say you've got a query that needs to be run to return some data
63 to the user. But, you have an authorization system in place that
64 prevents certain users from seeing certain information. So, you want
65 to construct the basic query in one method, but add constraints to it in
70 my $request = $self->get_request; # Get a request object somehow.
71 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
73 my $cd_rs = $schema->resultset('CD')->search({
74 title => $request->param('title'),
75 year => $request->param('year'),
78 $self->apply_security_policy( $cd_rs );
83 sub apply_security_policy {
92 =head3 Resolving conditions and attributes
94 When a resultset is chained from another resultset, conditions and
95 attributes with the same keys need resolving.
97 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
98 into the existing ones from the original resultset.
100 The L</where>, L</having> attribute, and any search conditions are
101 merged with an SQL C<AND> to the existing condition from the original
104 All other attributes are overridden by any new ones supplied in the
107 =head2 Multiple queries
109 Since a resultset just defines a query, you can do all sorts of
110 things with it with the same object.
112 # Don't hit the DB yet.
113 my $cd_rs = $schema->resultset('CD')->search({
114 title => 'something',
118 # Each of these hits the DB individually.
119 my $count = $cd_rs->count;
120 my $most_recent = $cd_rs->get_column('date_released')->max();
121 my @records = $cd_rs->all;
123 And it's not just limited to SELECT statements.
129 $cd_rs->create({ artist => 'Fred' });
131 Which is the same as:
133 $schema->resultset('CD')->create({
134 title => 'something',
139 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
143 If a resultset is used in a numeric context it returns the L</count>.
144 However, if it is used in a booleand context it is always true. So if
145 you want to check if a resultset has any results use C<if $rs != 0>.
146 C<if $rs> will always be true.
154 =item Arguments: $source, \%$attrs
156 =item Return Value: $rs
160 The resultset constructor. Takes a source object (usually a
161 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
162 L</ATTRIBUTES> below). Does not perform any queries -- these are
163 executed as needed by the other methods.
165 Generally you won't need to construct a resultset manually. You'll
166 automatically get one from e.g. a L</search> called in scalar context:
168 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
170 IMPORTANT: If called on an object, proxies to new_result instead so
172 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
174 will return a CD object, not a ResultSet.
180 return $class->new_result(@_) if ref $class;
182 my ($source, $attrs) = @_;
183 $source = $source->handle
184 unless $source->isa('DBIx::Class::ResultSourceHandle');
185 $attrs = { %{$attrs||{}} };
187 if ($attrs->{page}) {
188 $attrs->{rows} ||= 10;
191 $attrs->{alias} ||= 'me';
193 # Creation of {} and bless separated to mitigate RH perl bug
194 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
196 _source_handle => $source,
197 cond => $attrs->{where},
206 $attrs->{result_class} || $source->resolve->result_class
216 =item Arguments: $cond, \%attrs?
218 =item Return Value: $resultset (scalar context), @row_objs (list context)
222 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
223 my $new_rs = $cd_rs->search({ year => 2005 });
225 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
226 # year = 2005 OR year = 2004
228 If you need to pass in additional attributes but no additional condition,
229 call it as C<search(undef, \%attrs)>.
231 # "SELECT name, artistid FROM $artist_table"
232 my @all_artists = $schema->resultset('Artist')->search(undef, {
233 columns => [qw/name artistid/],
236 For a list of attributes that can be passed to C<search>, see
237 L</ATTRIBUTES>. For more examples of using this function, see
238 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
239 documentation for the first argument, see L<SQL::Abstract>.
241 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
247 my $rs = $self->search_rs( @_ );
248 return (wantarray ? $rs->all : $rs);
255 =item Arguments: $cond, \%attrs?
257 =item Return Value: $resultset
261 This method does the same exact thing as search() except it will
262 always return a resultset, even in list context.
269 # Special-case handling for (undef, undef).
270 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
275 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
276 my $our_attrs = { %{$self->{attrs}} };
277 my $having = delete $our_attrs->{having};
278 my $where = delete $our_attrs->{where};
282 my %safe = (alias => 1, cache => 1);
285 (@_ && defined($_[0])) # @_ == () or (undef)
287 (keys %$attrs # empty attrs or only 'safe' attrs
288 && List::Util::first { !$safe{$_} } keys %$attrs)
290 # no search, effectively just a clone
291 $rows = $self->get_cache;
294 my $new_attrs = { %{$our_attrs}, %{$attrs} };
296 # merge new attrs into inherited
297 foreach my $key (qw/join prefetch +select +as bind/) {
298 next unless exists $attrs->{$key};
299 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
304 (@_ == 1 || ref $_[0] eq "HASH")
306 (ref $_[0] eq 'HASH')
308 (keys %{ $_[0] } > 0)
316 ? $self->throw_exception("Odd number of arguments to search")
323 if (defined $where) {
324 $new_attrs->{where} = (
325 defined $new_attrs->{where}
328 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
329 } $where, $new_attrs->{where}
336 $new_attrs->{where} = (
337 defined $new_attrs->{where}
340 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
341 } $cond, $new_attrs->{where}
347 if (defined $having) {
348 $new_attrs->{having} = (
349 defined $new_attrs->{having}
352 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
353 } $having, $new_attrs->{having}
359 my $rs = (ref $self)->new($self->result_source, $new_attrs);
361 $rs->set_cache($rows) if ($rows);
366 =head2 search_literal
370 =item Arguments: $sql_fragment, @bind_values
372 =item Return Value: $resultset (scalar context), @row_objs (list context)
376 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
377 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
379 Pass a literal chunk of SQL to be added to the conditional part of the
382 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
383 only be used in that context. C<search_literal> is a convenience method.
384 It is equivalent to calling $schema->search(\[]), but if you want to ensure
385 columns are bound correctly, use C<search>.
387 Example of how to use C<search> instead of C<search_literal>
389 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
390 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
393 See L<DBIx::Class::Manual::Cookbook/Searching> and
394 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
395 require C<search_literal>.
400 my ($self, $sql, @bind) = @_;
402 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
405 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
412 =item Arguments: @values | \%cols, \%attrs?
414 =item Return Value: $row_object | undef
418 Finds a row based on its primary key or unique constraint. For example, to find
419 a row by its primary key:
421 my $cd = $schema->resultset('CD')->find(5);
423 You can also find a row by a specific unique constraint using the C<key>
424 attribute. For example:
426 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
427 key => 'cd_artist_title'
430 Additionally, you can specify the columns explicitly by name:
432 my $cd = $schema->resultset('CD')->find(
434 artist => 'Massive Attack',
435 title => 'Mezzanine',
437 { key => 'cd_artist_title' }
440 If the C<key> is specified as C<primary>, it searches only on the primary key.
442 If no C<key> is specified, it searches on all unique constraints defined on the
443 source for which column data is provided, including the primary key.
445 If your table does not have a primary key, you B<must> provide a value for the
446 C<key> attribute matching one of the unique constraints on the source.
448 In addition to C<key>, L</find> recognizes and applies standard
449 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
451 Note: If your query does not return only one row, a warning is generated:
453 Query returned more than one row
455 See also L</find_or_create> and L</update_or_create>. For information on how to
456 declare unique constraints, see
457 L<DBIx::Class::ResultSource/add_unique_constraint>.
463 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
465 # Default to the primary key, but allow a specific key
466 my @cols = exists $attrs->{key}
467 ? $self->result_source->unique_constraint_columns($attrs->{key})
468 : $self->result_source->primary_columns;
469 $self->throw_exception(
470 "Can't find unless a primary key is defined or unique constraint is specified"
473 # Parse out a hashref from input
475 if (ref $_[0] eq 'HASH') {
476 $input_query = { %{$_[0]} };
478 elsif (@_ == @cols) {
480 @{$input_query}{@cols} = @_;
483 # Compatibility: Allow e.g. find(id => $value)
484 carp "Find by key => value deprecated; please use a hashref instead";
488 my (%related, $info);
490 KEY: foreach my $key (keys %$input_query) {
491 if (ref($input_query->{$key})
492 && ($info = $self->result_source->relationship_info($key))) {
493 my $val = delete $input_query->{$key};
494 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
495 my $rel_q = $self->result_source->_resolve_condition(
496 $info->{cond}, $val, $key
498 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
499 @related{keys %$rel_q} = values %$rel_q;
502 if (my @keys = keys %related) {
503 @{$input_query}{@keys} = values %related;
507 # Build the final query: Default to the disjunction of the unique queries,
508 # but allow the input query in case the ResultSet defines the query or the
509 # user is abusing find
510 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
512 if (exists $attrs->{key}) {
513 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
514 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
515 $query = $self->_add_alias($unique_query, $alias);
517 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
518 # This means that we got here after a merger of relationship conditions
519 # in ::Relationship::Base::search_related (the row method), and furthermore
520 # the relationship is of the 'single' type. This means that the condition
521 # provided by the relationship (already attached to $self) is sufficient,
522 # as there can be only one row in the databse that would satisfy the
526 my @unique_queries = $self->_unique_queries($input_query, $attrs);
527 $query = @unique_queries
528 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
529 : $self->_add_alias($input_query, $alias);
533 my $rs = $self->search ($query, {result_class => $self->result_class, %$attrs});
534 if (keys %{$rs->_resolved_attrs->{collapse}}) {
536 carp "Query returned more than one row" if $rs->next;
546 # Add the specified alias to the specified query hash. A copy is made so the
547 # original query is not modified.
550 my ($self, $query, $alias) = @_;
552 my %aliased = %$query;
553 foreach my $col (grep { ! m/\./ } keys %aliased) {
554 $aliased{"$alias.$col"} = delete $aliased{$col};
562 # Build a list of queries which satisfy unique constraints.
564 sub _unique_queries {
565 my ($self, $query, $attrs) = @_;
567 my @constraint_names = exists $attrs->{key}
569 : $self->result_source->unique_constraint_names;
571 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
572 my $num_where = scalar keys %$where;
574 my (@unique_queries, %seen_column_combinations);
575 foreach my $name (@constraint_names) {
576 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
578 my $constraint_sig = join "\x00", sort @constraint_cols;
579 next if $seen_column_combinations{$constraint_sig}++;
581 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
583 my $num_cols = scalar @constraint_cols;
584 my $num_query = scalar keys %$unique_query;
586 my $total = $num_query + $num_where;
587 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
588 # The query is either unique on its own or is unique in combination with
589 # the existing where clause
590 push @unique_queries, $unique_query;
594 return @unique_queries;
597 # _build_unique_query
599 # Constrain the specified query hash based on the specified column names.
601 sub _build_unique_query {
602 my ($self, $query, $unique_cols) = @_;
605 map { $_ => $query->{$_} }
606 grep { exists $query->{$_} }
611 =head2 search_related
615 =item Arguments: $rel, $cond, \%attrs?
617 =item Return Value: $new_resultset
621 $new_rs = $cd_rs->search_related('artist', {
625 Searches the specified relationship, optionally specifying a condition and
626 attributes for matching records. See L</ATTRIBUTES> for more information.
631 return shift->related_resultset(shift)->search(@_);
634 =head2 search_related_rs
636 This method works exactly the same as search_related, except that
637 it guarantees a restultset, even in list context.
641 sub search_related_rs {
642 return shift->related_resultset(shift)->search_rs(@_);
649 =item Arguments: none
651 =item Return Value: $cursor
655 Returns a storage-driven cursor to the given resultset. See
656 L<DBIx::Class::Cursor> for more information.
663 my $attrs = $self->_resolved_attrs_copy;
665 return $self->{cursor}
666 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
667 $attrs->{where},$attrs);
674 =item Arguments: $cond?
676 =item Return Value: $row_object?
680 my $cd = $schema->resultset('CD')->single({ year => 2001 });
682 Inflates the first result without creating a cursor if the resultset has
683 any records in it; if not returns nothing. Used by L</find> as a lean version of
686 While this method can take an optional search condition (just like L</search>)
687 being a fast-code-path it does not recognize search attributes. If you need to
688 add extra joins or similar, call L</search> and then chain-call L</single> on the
689 L<DBIx::Class::ResultSet> returned.
695 As of 0.08100, this method enforces the assumption that the preceeding
696 query returns only one row. If more than one row is returned, you will receive
699 Query returned more than one row
701 In this case, you should be using L</next> or L</find> instead, or if you really
702 know what you are doing, use the L</rows> attribute to explicitly limit the size
705 This method will also throw an exception if it is called on a resultset prefetching
706 has_many, as such a prefetch implies fetching multiple rows from the database in
707 order to assemble the resulting object.
714 my ($self, $where) = @_;
716 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
719 my $attrs = $self->_resolved_attrs_copy;
721 if (keys %{$attrs->{collapse}}) {
722 $self->throw_exception(
723 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
728 if (defined $attrs->{where}) {
731 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
732 $where, delete $attrs->{where} ]
735 $attrs->{where} = $where;
739 # XXX: Disabled since it doesn't infer uniqueness in all cases
740 # unless ($self->_is_unique_query($attrs->{where})) {
741 # carp "Query not guaranteed to return a single row"
742 # . "; please declare your unique constraints or use search instead";
745 my @data = $self->result_source->storage->select_single(
746 $attrs->{from}, $attrs->{select},
747 $attrs->{where}, $attrs
750 return (@data ? ($self->_construct_object(@data))[0] : undef);
756 # Try to determine if the specified query is guaranteed to be unique, based on
757 # the declared unique constraints.
759 sub _is_unique_query {
760 my ($self, $query) = @_;
762 my $collapsed = $self->_collapse_query($query);
763 my $alias = $self->{attrs}{alias};
765 foreach my $name ($self->result_source->unique_constraint_names) {
766 my @unique_cols = map {
768 } $self->result_source->unique_constraint_columns($name);
770 # Count the values for each unique column
771 my %seen = map { $_ => 0 } @unique_cols;
773 foreach my $key (keys %$collapsed) {
774 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
775 next unless exists $seen{$aliased}; # Additional constraints are okay
776 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
779 # If we get 0 or more than 1 value for a column, it's not necessarily unique
780 return 1 unless grep { $_ != 1 } values %seen;
788 # Recursively collapse the query, accumulating values for each column.
790 sub _collapse_query {
791 my ($self, $query, $collapsed) = @_;
795 if (ref $query eq 'ARRAY') {
796 foreach my $subquery (@$query) {
797 next unless ref $subquery; # -or
798 $collapsed = $self->_collapse_query($subquery, $collapsed);
801 elsif (ref $query eq 'HASH') {
802 if (keys %$query and (keys %$query)[0] eq '-and') {
803 foreach my $subquery (@{$query->{-and}}) {
804 $collapsed = $self->_collapse_query($subquery, $collapsed);
808 foreach my $col (keys %$query) {
809 my $value = $query->{$col};
810 $collapsed->{$col}{$value}++;
822 =item Arguments: $cond?
824 =item Return Value: $resultsetcolumn
828 my $max_length = $rs->get_column('length')->max;
830 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
835 my ($self, $column) = @_;
836 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
844 =item Arguments: $cond, \%attrs?
846 =item Return Value: $resultset (scalar context), @row_objs (list context)
850 # WHERE title LIKE '%blue%'
851 $cd_rs = $rs->search_like({ title => '%blue%'});
853 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
854 that this is simply a convenience method retained for ex Class::DBI users.
855 You most likely want to use L</search> with specific operators.
857 For more information, see L<DBIx::Class::Manual::Cookbook>.
859 This method is deprecated and will be removed in 0.09. Use L</search()>
860 instead. An example conversion is:
862 ->search_like({ foo => 'bar' });
866 ->search({ foo => { like => 'bar' } });
873 'search_like() is deprecated and will be removed in DBIC version 0.09.'
874 .' Instead use ->search({ x => { -like => "y%" } })'
875 .' (note the outer pair of {}s - they are important!)'
877 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
878 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
879 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
880 return $class->search($query, { %$attrs });
887 =item Arguments: $first, $last
889 =item Return Value: $resultset (scalar context), @row_objs (list context)
893 Returns a resultset or object list representing a subset of elements from the
894 resultset slice is called on. Indexes are from 0, i.e., to get the first
897 my ($one, $two, $three) = $rs->slice(0, 2);
902 my ($self, $min, $max) = @_;
903 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
904 $attrs->{offset} = $self->{attrs}{offset} || 0;
905 $attrs->{offset} += $min;
906 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
907 return $self->search(undef(), $attrs);
908 #my $slice = (ref $self)->new($self->result_source, $attrs);
909 #return (wantarray ? $slice->all : $slice);
916 =item Arguments: none
918 =item Return Value: $result?
922 Returns the next element in the resultset (C<undef> is there is none).
924 Can be used to efficiently iterate over records in the resultset:
926 my $rs = $schema->resultset('CD')->search;
927 while (my $cd = $rs->next) {
931 Note that you need to store the resultset object, and call C<next> on it.
932 Calling C<< resultset('Table')->next >> repeatedly will always return the
933 first record from the resultset.
939 if (my $cache = $self->get_cache) {
940 $self->{all_cache_position} ||= 0;
941 return $cache->[$self->{all_cache_position}++];
943 if ($self->{attrs}{cache}) {
944 $self->{all_cache_position} = 1;
945 return ($self->all)[0];
947 if ($self->{stashed_objects}) {
948 my $obj = shift(@{$self->{stashed_objects}});
949 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
953 exists $self->{stashed_row}
954 ? @{delete $self->{stashed_row}}
955 : $self->cursor->next
957 return undef unless (@row);
958 my ($row, @more) = $self->_construct_object(@row);
959 $self->{stashed_objects} = \@more if @more;
963 sub _construct_object {
964 my ($self, @row) = @_;
966 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
968 my @new = $self->result_class->inflate_result($self->result_source, @$info);
969 @new = $self->{_attrs}{record_filter}->(@new)
970 if exists $self->{_attrs}{record_filter};
974 sub _collapse_result {
975 my ($self, $as_proto, $row) = @_;
977 # if the first row that ever came in is totally empty - this means we got
978 # hit by a smooth^Wempty left-joined resultset. Just noop in that case
979 # instead of producing a {}
988 return undef unless $has_def;
992 # 'foo' => [ undef, 'foo' ]
993 # 'foo.bar' => [ 'foo', 'bar' ]
994 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
996 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
998 my %collapse = %{$self->{_attrs}{collapse}||{}};
1002 # if we're doing collapsing (has_many prefetch) we need to grab records
1003 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1004 # we know we don't have to bother.
1006 # the reason for not using the collapse stuff directly is because if you
1007 # had for e.g. two artists in a row with no cds, the collapse info for
1008 # both would be NULL (undef) so you'd lose the second artist
1010 # store just the index so we can check the array positions from the row
1011 # without having to contruct the full hash
1013 if (keys %collapse) {
1014 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
1015 foreach my $i (0 .. $#construct_as) {
1016 next if defined($construct_as[$i][0]); # only self table
1017 if (delete $pri{$construct_as[$i][1]}) {
1018 push(@pri_index, $i);
1020 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1024 # no need to do an if, it'll be empty if @pri_index is empty anyway
1026 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1030 do { # no need to check anything at the front, we always want the first row
1034 foreach my $this_as (@construct_as) {
1035 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1038 push(@const_rows, \%const);
1040 } until ( # no pri_index => no collapse => drop straight out
1043 do { # get another row, stash it, drop out if different PK
1045 @copy = $self->cursor->next;
1046 $self->{stashed_row} = \@copy;
1048 # last thing in do block, counts as true if anything doesn't match
1050 # check xor defined first for NULL vs. NOT NULL then if one is
1051 # defined the other must be so check string equality
1054 (defined $pri_vals{$_} ^ defined $copy[$_])
1055 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1060 my $alias = $self->{attrs}{alias};
1067 foreach my $const (@const_rows) {
1068 scalar @const_keys or do {
1069 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1071 foreach my $key (@const_keys) {
1074 my @parts = split(/\./, $key);
1076 my $data = $const->{$key};
1077 foreach my $p (@parts) {
1078 $target = $target->[1]->{$p} ||= [];
1080 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1081 # collapsing at this point and on final part
1082 my $pos = $collapse_pos{$cur};
1083 CK: foreach my $ck (@ckey) {
1084 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1085 $collapse_pos{$cur} = $data;
1086 delete @collapse_pos{ # clear all positioning for sub-entries
1087 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1094 if (exists $collapse{$cur}) {
1095 $target = $target->[-1];
1098 $target->[0] = $data;
1100 $info->[0] = $const->{$key};
1108 =head2 result_source
1112 =item Arguments: $result_source?
1114 =item Return Value: $result_source
1118 An accessor for the primary ResultSource object from which this ResultSet
1125 =item Arguments: $result_class?
1127 =item Return Value: $result_class
1131 An accessor for the class to use when creating row objects. Defaults to
1132 C<< result_source->result_class >> - which in most cases is the name of the
1133 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1135 Note that changing the result_class will also remove any components
1136 that were originally loaded in the source class via
1137 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1138 in the original source class will not run.
1143 my ($self, $result_class) = @_;
1144 if ($result_class) {
1145 $self->ensure_class_loaded($result_class);
1146 $self->_result_class($result_class);
1148 $self->_result_class;
1155 =item Arguments: $cond, \%attrs??
1157 =item Return Value: $count
1161 Performs an SQL C<COUNT> with the same query as the resultset was built
1162 with to find the number of elements. Passing arguments is equivalent to
1163 C<< $rs->search ($cond, \%attrs)->count >>
1169 return $self->search(@_)->count if @_ and defined $_[0];
1170 return scalar @{ $self->get_cache } if $self->get_cache;
1172 my $attrs = $self->_resolved_attrs_copy;
1174 # this is a little optimization - it is faster to do the limit
1175 # adjustments in software, instead of a subquery
1176 my $rows = delete $attrs->{rows};
1177 my $offset = delete $attrs->{offset};
1180 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1181 $crs = $self->_count_subq_rs ($attrs);
1184 $crs = $self->_count_rs ($attrs);
1186 my $count = $crs->next;
1188 $count -= $offset if $offset;
1189 $count = $rows if $rows and $rows < $count;
1190 $count = 0 if ($count < 0);
1199 =item Arguments: $cond, \%attrs??
1201 =item Return Value: $count_rs
1205 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1206 This can be very handy for subqueries:
1208 ->search( { amount => $some_rs->count_rs->as_query } )
1210 As with regular resultsets the SQL query will be executed only after
1211 the resultset is accessed via L</next> or L</all>. That would return
1212 the same single value obtainable via L</count>.
1218 return $self->search(@_)->count_rs if @_;
1220 # this may look like a lack of abstraction (count() does about the same)
1221 # but in fact an _rs *must* use a subquery for the limits, as the
1222 # software based limiting can not be ported if this $rs is to be used
1223 # in a subquery itself (i.e. ->as_query)
1224 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1225 return $self->_count_subq_rs;
1228 return $self->_count_rs;
1233 # returns a ResultSetColumn object tied to the count query
1236 my ($self, $attrs) = @_;
1238 my $rsrc = $self->result_source;
1239 $attrs ||= $self->_resolved_attrs;
1241 my $tmp_attrs = { %$attrs };
1243 # take off any limits, record_filter is cdbi, and no point of ordering a count
1244 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1246 # overwrite the selector (supplied by the storage)
1247 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1248 $tmp_attrs->{as} = 'count';
1250 # read the comment on top of the actual function to see what this does
1251 $tmp_attrs->{from} = $self->result_source->schema->storage->_straight_join_to_node (
1252 $tmp_attrs->{from}, $tmp_attrs->{alias}
1255 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1261 # same as above but uses a subquery
1263 sub _count_subq_rs {
1264 my ($self, $attrs) = @_;
1266 my $rsrc = $self->result_source;
1267 $attrs ||= $self->_resolved_attrs_copy;
1269 my $sub_attrs = { %$attrs };
1271 # extra selectors do not go in the subquery and there is no point of ordering it
1272 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1274 # if we prefetch, we group_by primary keys only as this is what we would get out
1275 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1276 if ( keys %{$attrs->{collapse}} ) {
1277 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1280 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1282 # read the comment on top of the actual function to see what this does
1283 $sub_attrs->{from} = $self->result_source->schema->storage->_straight_join_to_node (
1284 $sub_attrs->{from}, $sub_attrs->{alias}
1287 # this is so that the query can be simplified e.g.
1288 # * non-limiting joins can be pruned
1289 # * ordering can be thrown away in things like Top limit
1290 $sub_attrs->{-for_count_only} = 1;
1292 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1295 -alias => 'count_subq',
1296 -source_handle => $rsrc->handle,
1297 count_subq => $sub_rs->as_query,
1300 # the subquery replaces this
1301 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1303 return $self->_count_rs ($attrs);
1310 =head2 count_literal
1314 =item Arguments: $sql_fragment, @bind_values
1316 =item Return Value: $count
1320 Counts the results in a literal query. Equivalent to calling L</search_literal>
1321 with the passed arguments, then L</count>.
1325 sub count_literal { shift->search_literal(@_)->count; }
1331 =item Arguments: none
1333 =item Return Value: @objects
1337 Returns all elements in the resultset. Called implicitly if the resultset
1338 is returned in list context.
1345 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1348 return @{ $self->get_cache } if $self->get_cache;
1352 if (keys %{$self->_resolved_attrs->{collapse}}) {
1353 # Using $self->cursor->all is really just an optimisation.
1354 # If we're collapsing has_many prefetches it probably makes
1355 # very little difference, and this is cleaner than hacking
1356 # _construct_object to survive the approach
1357 $self->cursor->reset;
1358 my @row = $self->cursor->next;
1360 push(@obj, $self->_construct_object(@row));
1361 @row = (exists $self->{stashed_row}
1362 ? @{delete $self->{stashed_row}}
1363 : $self->cursor->next);
1366 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1369 $self->set_cache(\@obj) if $self->{attrs}{cache};
1378 =item Arguments: none
1380 =item Return Value: $self
1384 Resets the resultset's cursor, so you can iterate through the elements again.
1385 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1392 delete $self->{_attrs} if exists $self->{_attrs};
1393 $self->{all_cache_position} = 0;
1394 $self->cursor->reset;
1402 =item Arguments: none
1404 =item Return Value: $object?
1408 Resets the resultset and returns an object for the first result (if the
1409 resultset returns anything).
1414 return $_[0]->reset->next;
1420 # Determines whether and what type of subquery is required for the $rs operation.
1421 # If grouping is necessary either supplies its own, or verifies the current one
1422 # After all is done delegates to the proper storage method.
1424 sub _rs_update_delete {
1425 my ($self, $op, $values) = @_;
1427 my $rsrc = $self->result_source;
1429 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1430 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1432 if ($needs_group_by_subq or $needs_subq) {
1434 # make a new $rs selecting only the PKs (that's all we really need)
1435 my $attrs = $self->_resolved_attrs_copy;
1437 delete $attrs->{$_} for qw/collapse select as/;
1438 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1440 if ($needs_group_by_subq) {
1441 # make sure no group_by was supplied, or if there is one - make sure it matches
1442 # the columns compiled above perfectly. Anything else can not be sanely executed
1443 # on most databases so croak right then and there
1445 if (my $g = $attrs->{group_by}) {
1446 my @current_group_by = map
1447 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1452 join ("\x00", sort @current_group_by)
1454 join ("\x00", sort @{$attrs->{columns}} )
1456 $self->throw_exception (
1457 "You have just attempted a $op operation on a resultset which does group_by"
1458 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1459 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1460 . ' kind of queries. Please retry the operation with a modified group_by or'
1461 . ' without using one at all.'
1466 $attrs->{group_by} = $attrs->{columns};
1470 my $subrs = (ref $self)->new($rsrc, $attrs);
1472 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1475 return $rsrc->storage->$op(
1477 $op eq 'update' ? $values : (),
1478 $self->_cond_for_update_delete,
1484 # _cond_for_update_delete
1486 # update/delete require the condition to be modified to handle
1487 # the differing SQL syntax available. This transforms the $self->{cond}
1488 # appropriately, returning the new condition.
1490 sub _cond_for_update_delete {
1491 my ($self, $full_cond) = @_;
1494 $full_cond ||= $self->{cond};
1495 # No-op. No condition, we're updating/deleting everything
1496 return $cond unless ref $full_cond;
1498 if (ref $full_cond eq 'ARRAY') {
1502 foreach my $key (keys %{$_}) {
1504 $hash{$1} = $_->{$key};
1510 elsif (ref $full_cond eq 'HASH') {
1511 if ((keys %{$full_cond})[0] eq '-and') {
1513 my @cond = @{$full_cond->{-and}};
1514 for (my $i = 0; $i < @cond; $i++) {
1515 my $entry = $cond[$i];
1517 if (ref $entry eq 'HASH') {
1518 $hash = $self->_cond_for_update_delete($entry);
1521 $entry =~ /([^.]+)$/;
1522 $hash->{$1} = $cond[++$i];
1524 push @{$cond->{-and}}, $hash;
1528 foreach my $key (keys %{$full_cond}) {
1530 $cond->{$1} = $full_cond->{$key};
1535 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1546 =item Arguments: \%values
1548 =item Return Value: $storage_rv
1552 Sets the specified columns in the resultset to the supplied values in a
1553 single query. Return value will be true if the update succeeded or false
1554 if no records were updated; exact type of success value is storage-dependent.
1559 my ($self, $values) = @_;
1560 $self->throw_exception('Values for update must be a hash')
1561 unless ref $values eq 'HASH';
1563 return $self->_rs_update_delete ('update', $values);
1570 =item Arguments: \%values
1572 =item Return Value: 1
1576 Fetches all objects and updates them one at a time. Note that C<update_all>
1577 will run DBIC cascade triggers, while L</update> will not.
1582 my ($self, $values) = @_;
1583 $self->throw_exception('Values for update_all must be a hash')
1584 unless ref $values eq 'HASH';
1585 foreach my $obj ($self->all) {
1586 $obj->set_columns($values)->update;
1595 =item Arguments: none
1597 =item Return Value: $storage_rv
1601 Deletes the contents of the resultset from its result source. Note that this
1602 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1603 to run. See also L<DBIx::Class::Row/delete>.
1605 Return value will be the amount of rows deleted; exact type of return value
1606 is storage-dependent.
1612 $self->throw_exception('delete does not accept any arguments')
1615 return $self->_rs_update_delete ('delete');
1622 =item Arguments: none
1624 =item Return Value: 1
1628 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1629 will run DBIC cascade triggers, while L</delete> will not.
1635 $self->throw_exception('delete_all does not accept any arguments')
1638 $_->delete for $self->all;
1646 =item Arguments: \@data;
1650 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1651 For the arrayref of hashrefs style each hashref should be a structure suitable
1652 forsubmitting to a $resultset->create(...) method.
1654 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1655 to insert the data, as this is a faster method.
1657 Otherwise, each set of data is inserted into the database using
1658 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1659 accumulated into an array. The array itself, or an array reference
1660 is returned depending on scalar or list context.
1662 Example: Assuming an Artist Class that has many CDs Classes relating:
1664 my $Artist_rs = $schema->resultset("Artist");
1666 ## Void Context Example
1667 $Artist_rs->populate([
1668 { artistid => 4, name => 'Manufactured Crap', cds => [
1669 { title => 'My First CD', year => 2006 },
1670 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1673 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1674 { title => 'My parents sold me to a record company' ,year => 2005 },
1675 { title => 'Why Am I So Ugly?', year => 2006 },
1676 { title => 'I Got Surgery and am now Popular', year => 2007 }
1681 ## Array Context Example
1682 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1683 { name => "Artist One"},
1684 { name => "Artist Two"},
1685 { name => "Artist Three", cds=> [
1686 { title => "First CD", year => 2007},
1687 { title => "Second CD", year => 2008},
1691 print $ArtistOne->name; ## response is 'Artist One'
1692 print $ArtistThree->cds->count ## reponse is '2'
1694 For the arrayref of arrayrefs style, the first element should be a list of the
1695 fieldsnames to which the remaining elements are rows being inserted. For
1698 $Arstist_rs->populate([
1699 [qw/artistid name/],
1700 [100, 'A Formally Unknown Singer'],
1701 [101, 'A singer that jumped the shark two albums ago'],
1702 [102, 'An actually cool singer.'],
1705 Please note an important effect on your data when choosing between void and
1706 wantarray context. Since void context goes straight to C<insert_bulk> in
1707 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1708 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1709 create primary keys for you, you will find that your PKs are empty. In this
1710 case you will have to use the wantarray context in order to create those
1716 my $self = shift @_;
1717 my $data = ref $_[0][0] eq 'HASH'
1718 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1719 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1721 if(defined wantarray) {
1723 foreach my $item (@$data) {
1724 push(@created, $self->create($item));
1726 return wantarray ? @created : \@created;
1728 my $first = $data->[0];
1730 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1731 # it relationship data
1732 my (@rels, @columns);
1733 for (keys %$first) {
1734 my $ref = ref $first->{$_};
1735 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1741 my @pks = $self->result_source->primary_columns;
1743 ## do the belongs_to relationships
1744 foreach my $index (0..$#$data) {
1746 # delegate to create() for any dataset without primary keys with specified relationships
1747 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1749 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1750 my @ret = $self->populate($data);
1756 foreach my $rel (@rels) {
1757 next unless ref $data->[$index]->{$rel} eq "HASH";
1758 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1759 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1760 my $related = $result->result_source->_resolve_condition(
1761 $result->result_source->relationship_info($reverse)->{cond},
1766 delete $data->[$index]->{$rel};
1767 $data->[$index] = {%{$data->[$index]}, %$related};
1769 push @columns, keys %$related if $index == 0;
1773 ## do bulk insert on current row
1774 $self->result_source->storage->insert_bulk(
1775 $self->result_source,
1777 [ map { [ @$_{@columns} ] } @$data ],
1780 ## do the has_many relationships
1781 foreach my $item (@$data) {
1783 foreach my $rel (@rels) {
1784 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1786 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1787 || $self->throw_exception('Cannot find the relating object.');
1789 my $child = $parent->$rel;
1791 my $related = $child->result_source->_resolve_condition(
1792 $parent->result_source->relationship_info($rel)->{cond},
1797 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1798 my @populate = map { {%$_, %$related} } @rows_to_add;
1800 $child->populate( \@populate );
1806 =head2 _normalize_populate_args ($args)
1808 Private method used by L</populate> to normalize its incoming arguments. Factored
1809 out in case you want to subclass and accept new argument structures to the
1810 L</populate> method.
1814 sub _normalize_populate_args {
1815 my ($self, $data) = @_;
1816 my @names = @{shift(@$data)};
1817 my @results_to_create;
1818 foreach my $datum (@$data) {
1819 my %result_to_create;
1820 foreach my $index (0..$#names) {
1821 $result_to_create{$names[$index]} = $$datum[$index];
1823 push @results_to_create, \%result_to_create;
1825 return \@results_to_create;
1832 =item Arguments: none
1834 =item Return Value: $pager
1838 Return Value a L<Data::Page> object for the current resultset. Only makes
1839 sense for queries with a C<page> attribute.
1841 To get the full count of entries for a paged resultset, call
1842 C<total_entries> on the L<Data::Page> object.
1849 return $self->{pager} if $self->{pager};
1851 my $attrs = $self->{attrs};
1852 $self->throw_exception("Can't create pager for non-paged rs")
1853 unless $self->{attrs}{page};
1854 $attrs->{rows} ||= 10;
1856 # throw away the paging flags and re-run the count (possibly
1857 # with a subselect) to get the real total count
1858 my $count_attrs = { %$attrs };
1859 delete $count_attrs->{$_} for qw/rows offset page pager/;
1860 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1862 return $self->{pager} = Data::Page->new(
1865 $self->{attrs}{page}
1873 =item Arguments: $page_number
1875 =item Return Value: $rs
1879 Returns a resultset for the $page_number page of the resultset on which page
1880 is called, where each page contains a number of rows equal to the 'rows'
1881 attribute set on the resultset (10 by default).
1886 my ($self, $page) = @_;
1887 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1894 =item Arguments: \%vals
1896 =item Return Value: $rowobject
1900 Creates a new row object in the resultset's result class and returns
1901 it. The row is not inserted into the database at this point, call
1902 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1903 will tell you whether the row object has been inserted or not.
1905 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1910 my ($self, $values) = @_;
1911 $self->throw_exception( "new_result needs a hash" )
1912 unless (ref $values eq 'HASH');
1915 my $alias = $self->{attrs}{alias};
1918 defined $self->{cond}
1919 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1921 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1922 $new{-from_resultset} = [ keys %new ] if keys %new;
1924 $self->throw_exception(
1925 "Can't abstract implicit construct, condition not a hash"
1926 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1928 my $collapsed_cond = (
1930 ? $self->_collapse_cond($self->{cond})
1934 # precendence must be given to passed values over values inherited from
1935 # the cond, so the order here is important.
1936 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1937 while( my($col,$value) = each %implied ){
1938 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1939 $new{$col} = $value->{'='};
1942 $new{$col} = $value if $self->_is_deterministic_value($value);
1948 %{ $self->_remove_alias($values, $alias) },
1949 -source_handle => $self->_source_handle,
1950 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1953 return $self->result_class->new(\%new);
1956 # _is_deterministic_value
1958 # Make an effor to strip non-deterministic values from the condition,
1959 # to make sure new_result chokes less
1961 sub _is_deterministic_value {
1964 my $ref_type = ref $value;
1965 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1966 return 1 if Scalar::Util::blessed($value);
1970 # _has_resolved_attr
1972 # determines if the resultset defines at least one
1973 # of the attributes supplied
1975 # used to determine if a subquery is neccessary
1977 # supports some virtual attributes:
1979 # This will scan for any joins being present on the resultset.
1980 # It is not a mere key-search but a deep inspection of {from}
1983 sub _has_resolved_attr {
1984 my ($self, @attr_names) = @_;
1986 my $attrs = $self->_resolved_attrs;
1990 for my $n (@attr_names) {
1991 if (grep { $n eq $_ } (qw/-join/) ) {
1992 $extra_checks{$n}++;
1996 my $attr = $attrs->{$n};
1998 next if not defined $attr;
2000 if (ref $attr eq 'HASH') {
2001 return 1 if keys %$attr;
2003 elsif (ref $attr eq 'ARRAY') {
2011 # a resolved join is expressed as a multi-level from
2013 $extra_checks{-join}
2015 ref $attrs->{from} eq 'ARRAY'
2017 @{$attrs->{from}} > 1
2025 # Recursively collapse the condition.
2027 sub _collapse_cond {
2028 my ($self, $cond, $collapsed) = @_;
2032 if (ref $cond eq 'ARRAY') {
2033 foreach my $subcond (@$cond) {
2034 next unless ref $subcond; # -or
2035 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2038 elsif (ref $cond eq 'HASH') {
2039 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2040 foreach my $subcond (@{$cond->{-and}}) {
2041 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2045 foreach my $col (keys %$cond) {
2046 my $value = $cond->{$col};
2047 $collapsed->{$col} = $value;
2057 # Remove the specified alias from the specified query hash. A copy is made so
2058 # the original query is not modified.
2061 my ($self, $query, $alias) = @_;
2063 my %orig = %{ $query || {} };
2066 foreach my $key (keys %orig) {
2068 $unaliased{$key} = $orig{$key};
2071 $unaliased{$1} = $orig{$key}
2072 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2078 =head2 as_query (EXPERIMENTAL)
2082 =item Arguments: none
2084 =item Return Value: \[ $sql, @bind ]
2088 Returns the SQL query and bind vars associated with the invocant.
2090 This is generally used as the RHS for a subquery.
2092 B<NOTE>: This feature is still experimental.
2099 my $attrs = $self->_resolved_attrs_copy;
2104 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2105 # $sql also has no wrapping parenthesis in list ctx
2107 my $sqlbind = $self->result_source->storage
2108 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2117 =item Arguments: \%vals, \%attrs?
2119 =item Return Value: $rowobject
2123 my $artist = $schema->resultset('Artist')->find_or_new(
2124 { artist => 'fred' }, { key => 'artists' });
2126 $cd->cd_to_producer->find_or_new({ producer => $producer },
2127 { key => 'primary });
2129 Find an existing record from this resultset, based on its primary
2130 key, or a unique constraint. If none exists, instantiate a new result
2131 object and return it. The object will not be saved into your storage
2132 until you call L<DBIx::Class::Row/insert> on it.
2134 You most likely want this method when looking for existing rows using
2135 a unique constraint that is not the primary key, or looking for
2138 If you want objects to be saved immediately, use L</find_or_create>
2141 B<Note>: Take care when using C<find_or_new> with a table having
2142 columns with default values that you intend to be automatically
2143 supplied by the database (e.g. an auto_increment primary key column).
2144 In normal usage, the value of such columns should NOT be included at
2145 all in the call to C<find_or_new>, even when set to C<undef>.
2151 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2152 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2153 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2156 return $self->new_result($hash);
2163 =item Arguments: \%vals
2165 =item Return Value: a L<DBIx::Class::Row> $object
2169 Attempt to create a single new row or a row with multiple related rows
2170 in the table represented by the resultset (and related tables). This
2171 will not check for duplicate rows before inserting, use
2172 L</find_or_create> to do that.
2174 To create one row for this resultset, pass a hashref of key/value
2175 pairs representing the columns of the table and the values you wish to
2176 store. If the appropriate relationships are set up, foreign key fields
2177 can also be passed an object representing the foreign row, and the
2178 value will be set to its primary key.
2180 To create related objects, pass a hashref of related-object column values
2181 B<keyed on the relationship name>. If the relationship is of type C<multi>
2182 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2183 The process will correctly identify columns holding foreign keys, and will
2184 transparrently populate them from the keys of the corresponding relation.
2185 This can be applied recursively, and will work correctly for a structure
2186 with an arbitrary depth and width, as long as the relationships actually
2187 exists and the correct column data has been supplied.
2190 Instead of hashrefs of plain related data (key/value pairs), you may
2191 also pass new or inserted objects. New objects (not inserted yet, see
2192 L</new>), will be inserted into their appropriate tables.
2194 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2196 Example of creating a new row.
2198 $person_rs->create({
2199 name=>"Some Person",
2200 email=>"somebody@someplace.com"
2203 Example of creating a new row and also creating rows in a related C<has_many>
2204 or C<has_one> resultset. Note Arrayref.
2207 { artistid => 4, name => 'Manufactured Crap', cds => [
2208 { title => 'My First CD', year => 2006 },
2209 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2214 Example of creating a new row and also creating a row in a related
2215 C<belongs_to>resultset. Note Hashref.
2218 title=>"Music for Silly Walks",
2221 name=>"Silly Musician",
2229 When subclassing ResultSet never attempt to override this method. Since
2230 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2231 lot of the internals simply never call it, so your override will be
2232 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2233 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2234 L</create> process you need to intervene.
2241 my ($self, $attrs) = @_;
2242 $self->throw_exception( "create needs a hashref" )
2243 unless ref $attrs eq 'HASH';
2244 return $self->new_result($attrs)->insert;
2247 =head2 find_or_create
2251 =item Arguments: \%vals, \%attrs?
2253 =item Return Value: $rowobject
2257 $cd->cd_to_producer->find_or_create({ producer => $producer },
2258 { key => 'primary' });
2260 Tries to find a record based on its primary key or unique constraints; if none
2261 is found, creates one and returns that instead.
2263 my $cd = $schema->resultset('CD')->find_or_create({
2265 artist => 'Massive Attack',
2266 title => 'Mezzanine',
2270 Also takes an optional C<key> attribute, to search by a specific key or unique
2271 constraint. For example:
2273 my $cd = $schema->resultset('CD')->find_or_create(
2275 artist => 'Massive Attack',
2276 title => 'Mezzanine',
2278 { key => 'cd_artist_title' }
2281 B<Note>: Because find_or_create() reads from the database and then
2282 possibly inserts based on the result, this method is subject to a race
2283 condition. Another process could create a record in the table after
2284 the find has completed and before the create has started. To avoid
2285 this problem, use find_or_create() inside a transaction.
2287 B<Note>: Take care when using C<find_or_create> with a table having
2288 columns with default values that you intend to be automatically
2289 supplied by the database (e.g. an auto_increment primary key column).
2290 In normal usage, the value of such columns should NOT be included at
2291 all in the call to C<find_or_create>, even when set to C<undef>.
2293 See also L</find> and L</update_or_create>. For information on how to declare
2294 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2298 sub find_or_create {
2300 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2301 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2302 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2305 return $self->create($hash);
2308 =head2 update_or_create
2312 =item Arguments: \%col_values, { key => $unique_constraint }?
2314 =item Return Value: $rowobject
2318 $resultset->update_or_create({ col => $val, ... });
2320 First, searches for an existing row matching one of the unique constraints
2321 (including the primary key) on the source of this resultset. If a row is
2322 found, updates it with the other given column values. Otherwise, creates a new
2325 Takes an optional C<key> attribute to search on a specific unique constraint.
2328 # In your application
2329 my $cd = $schema->resultset('CD')->update_or_create(
2331 artist => 'Massive Attack',
2332 title => 'Mezzanine',
2335 { key => 'cd_artist_title' }
2338 $cd->cd_to_producer->update_or_create({
2339 producer => $producer,
2346 If no C<key> is specified, it searches on all unique constraints defined on the
2347 source, including the primary key.
2349 If the C<key> is specified as C<primary>, it searches only on the primary key.
2351 See also L</find> and L</find_or_create>. For information on how to declare
2352 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2354 B<Note>: Take care when using C<update_or_create> with a table having
2355 columns with default values that you intend to be automatically
2356 supplied by the database (e.g. an auto_increment primary key column).
2357 In normal usage, the value of such columns should NOT be included at
2358 all in the call to C<update_or_create>, even when set to C<undef>.
2362 sub update_or_create {
2364 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2365 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2367 my $row = $self->find($cond, $attrs);
2369 $row->update($cond);
2373 return $self->create($cond);
2376 =head2 update_or_new
2380 =item Arguments: \%col_values, { key => $unique_constraint }?
2382 =item Return Value: $rowobject
2386 $resultset->update_or_new({ col => $val, ... });
2388 First, searches for an existing row matching one of the unique constraints
2389 (including the primary key) on the source of this resultset. If a row is
2390 found, updates it with the other given column values. Otherwise, instantiate
2391 a new result object and return it. The object will not be saved into your storage
2392 until you call L<DBIx::Class::Row/insert> on it.
2394 Takes an optional C<key> attribute to search on a specific unique constraint.
2397 # In your application
2398 my $cd = $schema->resultset('CD')->update_or_new(
2400 artist => 'Massive Attack',
2401 title => 'Mezzanine',
2404 { key => 'cd_artist_title' }
2407 if ($cd->in_storage) {
2408 # the cd was updated
2411 # the cd is not yet in the database, let's insert it
2415 B<Note>: Take care when using C<update_or_new> with a table having
2416 columns with default values that you intend to be automatically
2417 supplied by the database (e.g. an auto_increment primary key column).
2418 In normal usage, the value of such columns should NOT be included at
2419 all in the call to C<update_or_new>, even when set to C<undef>.
2421 See also L</find>, L</find_or_create> and L</find_or_new>.
2427 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2428 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2430 my $row = $self->find( $cond, $attrs );
2431 if ( defined $row ) {
2432 $row->update($cond);
2436 return $self->new_result($cond);
2443 =item Arguments: none
2445 =item Return Value: \@cache_objects?
2449 Gets the contents of the cache for the resultset, if the cache is set.
2451 The cache is populated either by using the L</prefetch> attribute to
2452 L</search> or by calling L</set_cache>.
2464 =item Arguments: \@cache_objects
2466 =item Return Value: \@cache_objects
2470 Sets the contents of the cache for the resultset. Expects an arrayref
2471 of objects of the same class as those produced by the resultset. Note that
2472 if the cache is set the resultset will return the cached objects rather
2473 than re-querying the database even if the cache attr is not set.
2475 The contents of the cache can also be populated by using the
2476 L</prefetch> attribute to L</search>.
2481 my ( $self, $data ) = @_;
2482 $self->throw_exception("set_cache requires an arrayref")
2483 if defined($data) && (ref $data ne 'ARRAY');
2484 $self->{all_cache} = $data;
2491 =item Arguments: none
2493 =item Return Value: []
2497 Clears the cache for the resultset.
2502 shift->set_cache(undef);
2509 =item Arguments: none
2511 =item Return Value: true, if the resultset has been paginated
2519 return !!$self->{attrs}{page};
2522 =head2 related_resultset
2526 =item Arguments: $relationship_name
2528 =item Return Value: $resultset
2532 Returns a related resultset for the supplied relationship name.
2534 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2538 sub related_resultset {
2539 my ($self, $rel) = @_;
2541 $self->{related_resultsets} ||= {};
2542 return $self->{related_resultsets}{$rel} ||= do {
2543 my $rel_info = $self->result_source->relationship_info($rel);
2545 $self->throw_exception(
2546 "search_related: result source '" . $self->result_source->source_name .
2547 "' has no such relationship $rel")
2550 my ($from,$seen) = $self->_chain_relationship($rel);
2552 my $join_count = $seen->{$rel};
2553 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2555 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2556 my %attrs = %{$self->{attrs}||{}};
2557 delete @attrs{qw(result_class alias)};
2561 if (my $cache = $self->get_cache) {
2562 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2563 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2568 my $rel_source = $self->result_source->related_source($rel);
2572 # The reason we do this now instead of passing the alias to the
2573 # search_rs below is that if you wrap/overload resultset on the
2574 # source you need to know what alias it's -going- to have for things
2575 # to work sanely (e.g. RestrictWithObject wants to be able to add
2576 # extra query restrictions, and these may need to be $alias.)
2578 my $attrs = $rel_source->resultset_attributes;
2579 local $attrs->{alias} = $alias;
2581 $rel_source->resultset
2589 where => $self->{cond},
2594 $new->set_cache($new_cache) if $new_cache;
2599 =head2 current_source_alias
2603 =item Arguments: none
2605 =item Return Value: $source_alias
2609 Returns the current table alias for the result source this resultset is built
2610 on, that will be used in the SQL query. Usually it is C<me>.
2612 Currently the source alias that refers to the result set returned by a
2613 L</search>/L</find> family method depends on how you got to the resultset: it's
2614 C<me> by default, but eg. L</search_related> aliases it to the related result
2615 source name (and keeps C<me> referring to the original result set). The long
2616 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2617 (and make this method unnecessary).
2619 Thus it's currently necessary to use this method in predefined queries (see
2620 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2621 source alias of the current result set:
2623 # in a result set class
2625 my ($self, $user) = @_;
2627 my $me = $self->current_source_alias;
2629 return $self->search(
2630 "$me.modified" => $user->id,
2636 sub current_source_alias {
2639 return ($self->{attrs} || {})->{alias} || 'me';
2642 # This code is called by search_related, and makes sure there
2643 # is clear separation between the joins before, during, and
2644 # after the relationship. This information is needed later
2645 # in order to properly resolve prefetch aliases (any alias
2646 # with a relation_chain_depth less than the depth of the
2647 # current prefetch is not considered)
2649 # The increments happen in 1/2s to make it easier to correlate the
2650 # join depth with the join path. An integer means a relationship
2651 # specified via a search_related, whereas a fraction means an added
2652 # join/prefetch via attributes
2653 sub _chain_relationship {
2654 my ($self, $rel) = @_;
2655 my $source = $self->result_source;
2656 my $attrs = $self->{attrs};
2662 -source_handle => $source->handle,
2663 -alias => $attrs->{alias},
2664 $attrs->{alias} => $source->from,
2668 my $seen = { %{$attrs->{seen_join} || {} } };
2669 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2670 ? $from->[-1][0]{-join_path}
2674 # we need to take the prefetch the attrs into account before we
2675 # ->_resolve_join as otherwise they get lost - captainL
2676 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2678 my @requested_joins = $source->_resolve_join(
2685 push @$from, @requested_joins;
2687 $seen->{-relation_chain_depth} += 0.5;
2689 # if $self already had a join/prefetch specified on it, the requested
2690 # $rel might very well be already included. What we do in this case
2691 # is effectively a no-op (except that we bump up the chain_depth on
2692 # the join in question so we could tell it *is* the search_related)
2696 # we consider the last one thus reverse
2697 for my $j (reverse @requested_joins) {
2698 if ($rel eq $j->[0]{-join_path}[-1]) {
2699 $j->[0]{-relation_chain_depth} += 0.5;
2705 # alternative way to scan the entire chain - not backwards compatible
2706 # for my $j (reverse @$from) {
2707 # next unless ref $j eq 'ARRAY';
2708 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2709 # $j->[0]{-relation_chain_depth} += 0.5;
2710 # $already_joined++;
2715 unless ($already_joined) {
2716 push @$from, $source->_resolve_join(
2724 $seen->{-relation_chain_depth} += 0.5;
2726 return ($from,$seen);
2729 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2730 sub _resolved_attrs_copy {
2732 return { %{$self->_resolved_attrs (@_)} };
2735 sub _resolved_attrs {
2737 return $self->{_attrs} if $self->{_attrs};
2739 my $attrs = { %{ $self->{attrs} || {} } };
2740 my $source = $self->result_source;
2741 my $alias = $attrs->{alias};
2743 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2746 # build columns (as long as select isn't set) into a set of as/select hashes
2747 unless ( $attrs->{select} ) {
2749 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2750 ? @{ delete $attrs->{columns}}
2752 ( delete $attrs->{columns} )
2759 ( ref($_) eq 'HASH' )
2763 /^\Q${alias}.\E(.+)$/
2777 # add the additional columns on
2778 foreach ( 'include_columns', '+columns' ) {
2779 push @colbits, map {
2780 ( ref($_) eq 'HASH' )
2782 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2783 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2786 # start with initial select items
2787 if ( $attrs->{select} ) {
2789 ( ref $attrs->{select} eq 'ARRAY' )
2790 ? [ @{ $attrs->{select} } ]
2791 : [ $attrs->{select} ];
2795 ref $attrs->{as} eq 'ARRAY'
2796 ? [ @{ $attrs->{as} } ]
2799 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2804 # otherwise we intialise select & as to empty
2805 $attrs->{select} = [];
2809 # now add colbits to select/as
2810 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2811 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2814 if ( $adds = delete $attrs->{'+select'} ) {
2815 $adds = [$adds] unless ref $adds eq 'ARRAY';
2817 @{ $attrs->{select} },
2818 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2821 if ( $adds = delete $attrs->{'+as'} ) {
2822 $adds = [$adds] unless ref $adds eq 'ARRAY';
2823 push( @{ $attrs->{as} }, @$adds );
2826 $attrs->{from} ||= [ {
2827 -source_handle => $source->handle,
2828 -alias => $self->{attrs}{alias},
2829 $self->{attrs}{alias} => $source->from,
2832 if ( $attrs->{join} || $attrs->{prefetch} ) {
2834 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2835 if ref $attrs->{from} ne 'ARRAY';
2837 my $join = delete $attrs->{join} || {};
2839 if ( defined $attrs->{prefetch} ) {
2840 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2843 $attrs->{from} = # have to copy here to avoid corrupting the original
2845 @{ $attrs->{from} },
2846 $source->_resolve_join(
2849 { %{ $attrs->{seen_join} || {} } },
2850 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2851 ? $attrs->{from}[-1][0]{-join_path}
2858 if ( defined $attrs->{order_by} ) {
2859 $attrs->{order_by} = (
2860 ref( $attrs->{order_by} ) eq 'ARRAY'
2861 ? [ @{ $attrs->{order_by} } ]
2862 : [ $attrs->{order_by} || () ]
2866 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2867 $attrs->{group_by} = [ $attrs->{group_by} ];
2870 # generate the distinct induced group_by early, as prefetch will be carried via a
2871 # subquery (since a group_by is present)
2872 if (delete $attrs->{distinct}) {
2873 if ($attrs->{group_by}) {
2874 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2877 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2881 $attrs->{collapse} ||= {};
2882 if ( my $prefetch = delete $attrs->{prefetch} ) {
2883 $prefetch = $self->_merge_attr( {}, $prefetch );
2885 my $prefetch_ordering = [];
2887 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2890 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2892 # we need to somehow mark which columns came from prefetch
2893 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2895 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2896 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2898 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2899 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2902 # if both page and offset are specified, produce a combined offset
2903 # even though it doesn't make much sense, this is what pre 081xx has
2905 if (my $page = delete $attrs->{page}) {
2907 ($attrs->{rows} * ($page - 1))
2909 ($attrs->{offset} || 0)
2913 return $self->{_attrs} = $attrs;
2916 sub _joinpath_aliases {
2917 my ($self, $fromspec, $seen) = @_;
2920 return $paths unless ref $fromspec eq 'ARRAY';
2922 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2924 if (int ($cur_depth) != $cur_depth) {
2925 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2928 for my $j (@$fromspec) {
2930 next if ref $j ne 'ARRAY';
2931 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2933 my $jpath = $j->[0]{-join_path};
2936 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2937 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2944 my ($self, $attr) = @_;
2946 if (ref $attr eq 'HASH') {
2947 return $self->_rollout_hash($attr);
2948 } elsif (ref $attr eq 'ARRAY') {
2949 return $self->_rollout_array($attr);
2955 sub _rollout_array {
2956 my ($self, $attr) = @_;
2959 foreach my $element (@{$attr}) {
2960 if (ref $element eq 'HASH') {
2961 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2962 } elsif (ref $element eq 'ARRAY') {
2963 # XXX - should probably recurse here
2964 push( @rolled_array, @{$self->_rollout_array($element)} );
2966 push( @rolled_array, $element );
2969 return \@rolled_array;
2973 my ($self, $attr) = @_;
2976 foreach my $key (keys %{$attr}) {
2977 push( @rolled_array, { $key => $attr->{$key} } );
2979 return \@rolled_array;
2982 sub _calculate_score {
2983 my ($self, $a, $b) = @_;
2985 if (defined $a xor defined $b) {
2988 elsif (not defined $a) {
2992 if (ref $b eq 'HASH') {
2993 my ($b_key) = keys %{$b};
2994 if (ref $a eq 'HASH') {
2995 my ($a_key) = keys %{$a};
2996 if ($a_key eq $b_key) {
2997 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3002 return ($a eq $b_key) ? 1 : 0;
3005 if (ref $a eq 'HASH') {
3006 my ($a_key) = keys %{$a};
3007 return ($b eq $a_key) ? 1 : 0;
3009 return ($b eq $a) ? 1 : 0;
3015 my ($self, $orig, $import) = @_;
3017 return $import unless defined($orig);
3018 return $orig unless defined($import);
3020 $orig = $self->_rollout_attr($orig);
3021 $import = $self->_rollout_attr($import);
3024 foreach my $import_element ( @{$import} ) {
3025 # find best candidate from $orig to merge $b_element into
3026 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3027 foreach my $orig_element ( @{$orig} ) {
3028 my $score = $self->_calculate_score( $orig_element, $import_element );
3029 if ($score > $best_candidate->{score}) {
3030 $best_candidate->{position} = $position;
3031 $best_candidate->{score} = $score;
3035 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3037 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3038 push( @{$orig}, $import_element );
3040 my $orig_best = $orig->[$best_candidate->{position}];
3041 # merge orig_best and b_element together and replace original with merged
3042 if (ref $orig_best ne 'HASH') {
3043 $orig->[$best_candidate->{position}] = $import_element;
3044 } elsif (ref $import_element eq 'HASH') {
3045 my ($key) = keys %{$orig_best};
3046 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3049 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3059 $self->_source_handle($_[0]->handle);
3061 $self->_source_handle->resolve;
3065 =head2 throw_exception
3067 See L<DBIx::Class::Schema/throw_exception> for details.
3071 sub throw_exception {
3074 if (ref $self && $self->_source_handle->schema) {
3075 $self->_source_handle->schema->throw_exception(@_)
3078 DBIx::Class::Exception->throw(@_);
3082 # XXX: FIXME: Attributes docs need clearing up
3086 Attributes are used to refine a ResultSet in various ways when
3087 searching for data. They can be passed to any method which takes an
3088 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3091 These are in no particular order:
3097 =item Value: ( $order_by | \@order_by | \%order_by )
3101 Which column(s) to order the results by.
3103 [The full list of suitable values is documented in
3104 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3107 If a single column name, or an arrayref of names is supplied, the
3108 argument is passed through directly to SQL. The hashref syntax allows
3109 for connection-agnostic specification of ordering direction:
3111 For descending order:
3113 order_by => { -desc => [qw/col1 col2 col3/] }
3115 For explicit ascending order:
3117 order_by => { -asc => 'col' }
3119 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3120 supported, although you are strongly encouraged to use the hashref
3121 syntax as outlined above.
3127 =item Value: \@columns
3131 Shortcut to request a particular set of columns to be retrieved. Each
3132 column spec may be a string (a table column name), or a hash (in which
3133 case the key is the C<as> value, and the value is used as the C<select>
3134 expression). Adds C<me.> onto the start of any column without a C<.> in
3135 it and sets C<select> from that, then auto-populates C<as> from
3136 C<select> as normal. (You may also use the C<cols> attribute, as in
3137 earlier versions of DBIC.)
3143 =item Value: \@columns
3147 Indicates additional columns to be selected from storage. Works the same
3148 as L</columns> but adds columns to the selection. (You may also use the
3149 C<include_columns> attribute, as in earlier versions of DBIC). For
3152 $schema->resultset('CD')->search(undef, {
3153 '+columns' => ['artist.name'],
3157 would return all CDs and include a 'name' column to the information
3158 passed to object inflation. Note that the 'artist' is the name of the
3159 column (or relationship) accessor, and 'name' is the name of the column
3160 accessor in the related table.
3162 =head2 include_columns
3166 =item Value: \@columns
3170 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3176 =item Value: \@select_columns
3180 Indicates which columns should be selected from the storage. You can use
3181 column names, or in the case of RDBMS back ends, function or stored procedure
3184 $rs = $schema->resultset('Employee')->search(undef, {
3187 { count => 'employeeid' },
3192 When you use function/stored procedure names and do not supply an C<as>
3193 attribute, the column names returned are storage-dependent. E.g. MySQL would
3194 return a column named C<count(employeeid)> in the above example.
3196 B<NOTE:> You will almost always need a corresponding 'as' entry when you use
3203 Indicates additional columns to be selected from storage. Works the same as
3204 L</select> but adds columns to the selection.
3212 Indicates additional column names for those added via L</+select>. See L</as>.
3220 =item Value: \@inflation_names
3224 Indicates column names for object inflation. That is, C<as>
3225 indicates the name that the column can be accessed as via the
3226 C<get_column> method (or via the object accessor, B<if one already
3227 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3229 The C<as> attribute is used in conjunction with C<select>,
3230 usually when C<select> contains one or more function or stored
3233 $rs = $schema->resultset('Employee')->search(undef, {
3236 { count => 'employeeid' }
3238 as => ['name', 'employee_count'],
3241 my $employee = $rs->first(); # get the first Employee
3243 If the object against which the search is performed already has an accessor
3244 matching a column name specified in C<as>, the value can be retrieved using
3245 the accessor as normal:
3247 my $name = $employee->name();
3249 If on the other hand an accessor does not exist in the object, you need to
3250 use C<get_column> instead:
3252 my $employee_count = $employee->get_column('employee_count');
3254 You can create your own accessors if required - see
3255 L<DBIx::Class::Manual::Cookbook> for details.
3257 Please note: This will NOT insert an C<AS employee_count> into the SQL
3258 statement produced, it is used for internal access only. Thus
3259 attempting to use the accessor in an C<order_by> clause or similar
3260 will fail miserably.
3262 To get around this limitation, you can supply literal SQL to your
3263 C<select> attibute that contains the C<AS alias> text, eg:
3265 select => [\'myfield AS alias']
3271 =item Value: ($rel_name | \@rel_names | \%rel_names)
3275 Contains a list of relationships that should be joined for this query. For
3278 # Get CDs by Nine Inch Nails
3279 my $rs = $schema->resultset('CD')->search(
3280 { 'artist.name' => 'Nine Inch Nails' },
3281 { join => 'artist' }
3284 Can also contain a hash reference to refer to the other relation's relations.
3287 package MyApp::Schema::Track;
3288 use base qw/DBIx::Class/;
3289 __PACKAGE__->table('track');
3290 __PACKAGE__->add_columns(qw/trackid cd position title/);
3291 __PACKAGE__->set_primary_key('trackid');
3292 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3295 # In your application
3296 my $rs = $schema->resultset('Artist')->search(
3297 { 'track.title' => 'Teardrop' },
3299 join => { cd => 'track' },
3300 order_by => 'artist.name',
3304 You need to use the relationship (not the table) name in conditions,
3305 because they are aliased as such. The current table is aliased as "me", so
3306 you need to use me.column_name in order to avoid ambiguity. For example:
3308 # Get CDs from 1984 with a 'Foo' track
3309 my $rs = $schema->resultset('CD')->search(
3312 'tracks.name' => 'Foo'
3314 { join => 'tracks' }
3317 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3318 similarly for a third time). For e.g.
3320 my $rs = $schema->resultset('Artist')->search({
3321 'cds.title' => 'Down to Earth',
3322 'cds_2.title' => 'Popular',
3324 join => [ qw/cds cds/ ],
3327 will return a set of all artists that have both a cd with title 'Down
3328 to Earth' and a cd with title 'Popular'.
3330 If you want to fetch related objects from other tables as well, see C<prefetch>
3333 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3339 =item Value: ($rel_name | \@rel_names | \%rel_names)
3343 Contains one or more relationships that should be fetched along with
3344 the main query (when they are accessed afterwards the data will
3345 already be available, without extra queries to the database). This is
3346 useful for when you know you will need the related objects, because it
3347 saves at least one query:
3349 my $rs = $schema->resultset('Tag')->search(
3358 The initial search results in SQL like the following:
3360 SELECT tag.*, cd.*, artist.* FROM tag
3361 JOIN cd ON tag.cd = cd.cdid
3362 JOIN artist ON cd.artist = artist.artistid
3364 L<DBIx::Class> has no need to go back to the database when we access the
3365 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3368 Simple prefetches will be joined automatically, so there is no need
3369 for a C<join> attribute in the above search.
3371 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3372 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3373 with an accessor type of 'single' or 'filter'). A more complex example that
3374 prefetches an artists cds, the tracks on those cds, and the tags associted
3375 with that artist is given below (assuming many-to-many from artists to tags):
3377 my $rs = $schema->resultset('Artist')->search(
3381 { cds => 'tracks' },
3382 { artist_tags => 'tags' }
3388 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3389 attributes will be ignored.
3391 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3392 exactly as you might expect.
3398 Prefetch uses the L</cache> to populate the prefetched relationships. This
3399 may or may not be what you want.
3403 If you specify a condition on a prefetched relationship, ONLY those
3404 rows that match the prefetched condition will be fetched into that relationship.
3405 This means that adding prefetch to a search() B<may alter> what is returned by
3406 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3408 my $artist_rs = $schema->resultset('Artist')->search({
3414 my $count = $artist_rs->first->cds->count;
3416 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3418 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3420 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3422 that cmp_ok() may or may not pass depending on the datasets involved. This
3423 behavior may or may not survive the 0.09 transition.
3435 Makes the resultset paged and specifies the page to retrieve. Effectively
3436 identical to creating a non-pages resultset and then calling ->page($page)
3439 If L<rows> attribute is not specified it defaults to 10 rows per page.
3441 When you have a paged resultset, L</count> will only return the number
3442 of rows in the page. To get the total, use the L</pager> and call
3443 C<total_entries> on it.
3453 Specifes the maximum number of rows for direct retrieval or the number of
3454 rows per page if the page attribute or method is used.
3460 =item Value: $offset
3464 Specifies the (zero-based) row number for the first row to be returned, or the
3465 of the first row of the first page if paging is used.
3471 =item Value: \@columns
3475 A arrayref of columns to group by. Can include columns of joined tables.
3477 group_by => [qw/ column1 column2 ... /]
3483 =item Value: $condition
3487 HAVING is a select statement attribute that is applied between GROUP BY and
3488 ORDER BY. It is applied to the after the grouping calculations have been
3491 having => { 'count(employee)' => { '>=', 100 } }
3497 =item Value: (0 | 1)
3501 Set to 1 to group by all columns. If the resultset already has a group_by
3502 attribute, this setting is ignored and an appropriate warning is issued.
3508 Adds to the WHERE clause.
3510 # only return rows WHERE deleted IS NULL for all searches
3511 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3513 Can be overridden by passing C<< { where => undef } >> as an attribute
3520 Set to 1 to cache search results. This prevents extra SQL queries if you
3521 revisit rows in your ResultSet:
3523 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3525 while( my $artist = $resultset->next ) {
3529 $rs->first; # without cache, this would issue a query
3531 By default, searches are not cached.
3533 For more examples of using these attributes, see
3534 L<DBIx::Class::Manual::Cookbook>.
3540 =item Value: ( 'update' | 'shared' )
3544 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT