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 while( $user = $users_rs->next) {
29 print $user->username;
32 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
33 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
37 A ResultSet is an object which stores a set of conditions representing
38 a query. It is the backbone of DBIx::Class (i.e. the really
39 important/useful bit).
41 No SQL is executed on the database when a ResultSet is created, it
42 just stores all the conditions needed to create the query.
44 A basic ResultSet representing the data of an entire table is returned
45 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
46 L<Source|DBIx::Class::Manual::Glossary/Source> name.
48 my $users_rs = $schema->resultset('User');
50 A new ResultSet is returned from calling L</search> on an existing
51 ResultSet. The new one will contain all the conditions of the
52 original, plus any new conditions added in the C<search> call.
54 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
55 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
58 The query that the ResultSet represents is B<only> executed against
59 the database when these methods are called:
60 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
62 If a resultset is used in a numeric context it returns the L</count>.
63 However, if it is used in a boolean context it is B<always> true. So if
64 you want to check if a resultset has any results, you must use C<if $rs
69 =head2 Chaining resultsets
71 Let's say you've got a query that needs to be run to return some data
72 to the user. But, you have an authorization system in place that
73 prevents certain users from seeing certain information. So, you want
74 to construct the basic query in one method, but add constraints to it in
79 my $request = $self->get_request; # Get a request object somehow.
80 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
82 my $cd_rs = $schema->resultset('CD')->search({
83 title => $request->param('title'),
84 year => $request->param('year'),
87 $self->apply_security_policy( $cd_rs );
92 sub apply_security_policy {
101 =head3 Resolving conditions and attributes
103 When a resultset is chained from another resultset, conditions and
104 attributes with the same keys need resolving.
106 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
107 into the existing ones from the original resultset.
109 The L</where> and L</having> attributes, and any search conditions, are
110 merged with an SQL C<AND> to the existing condition from the original
113 All other attributes are overridden by any new ones supplied in the
116 =head2 Multiple queries
118 Since a resultset just defines a query, you can do all sorts of
119 things with it with the same object.
121 # Don't hit the DB yet.
122 my $cd_rs = $schema->resultset('CD')->search({
123 title => 'something',
127 # Each of these hits the DB individually.
128 my $count = $cd_rs->count;
129 my $most_recent = $cd_rs->get_column('date_released')->max();
130 my @records = $cd_rs->all;
132 And it's not just limited to SELECT statements.
138 $cd_rs->create({ artist => 'Fred' });
140 Which is the same as:
142 $schema->resultset('CD')->create({
143 title => 'something',
148 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
156 =item Arguments: $source, \%$attrs
158 =item Return Value: $rs
162 The resultset constructor. Takes a source object (usually a
163 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
164 L</ATTRIBUTES> below). Does not perform any queries -- these are
165 executed as needed by the other methods.
167 Generally you won't need to construct a resultset manually. You'll
168 automatically get one from e.g. a L</search> called in scalar context:
170 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
172 IMPORTANT: If called on an object, proxies to new_result instead so
174 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
176 will return a CD object, not a ResultSet.
182 return $class->new_result(@_) if ref $class;
184 my ($source, $attrs) = @_;
185 $source = $source->handle
186 unless $source->isa('DBIx::Class::ResultSourceHandle');
187 $attrs = { %{$attrs||{}} };
189 if ($attrs->{page}) {
190 $attrs->{rows} ||= 10;
193 $attrs->{alias} ||= 'me';
195 # Creation of {} and bless separated to mitigate RH perl bug
196 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
198 _source_handle => $source,
199 cond => $attrs->{where},
208 $attrs->{result_class} || $source->resolve->result_class
218 =item Arguments: $cond, \%attrs?
220 =item Return Value: $resultset (scalar context), @row_objs (list context)
224 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
225 my $new_rs = $cd_rs->search({ year => 2005 });
227 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
228 # year = 2005 OR year = 2004
230 If you need to pass in additional attributes but no additional condition,
231 call it as C<search(undef, \%attrs)>.
233 # "SELECT name, artistid FROM $artist_table"
234 my @all_artists = $schema->resultset('Artist')->search(undef, {
235 columns => [qw/name artistid/],
238 For a list of attributes that can be passed to C<search>, see
239 L</ATTRIBUTES>. For more examples of using this function, see
240 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
241 documentation for the first argument, see L<SQL::Abstract>.
243 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
249 my $rs = $self->search_rs( @_ );
250 return (wantarray ? $rs->all : $rs);
257 =item Arguments: $cond, \%attrs?
259 =item Return Value: $resultset
263 This method does the same exact thing as search() except it will
264 always return a resultset, even in list context.
271 # Special-case handling for (undef, undef).
272 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
277 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
278 my $our_attrs = { %{$self->{attrs}} };
279 my $having = delete $our_attrs->{having};
280 my $where = delete $our_attrs->{where};
284 my %safe = (alias => 1, cache => 1);
287 (@_ && defined($_[0])) # @_ == () or (undef)
289 (keys %$attrs # empty attrs or only 'safe' attrs
290 && List::Util::first { !$safe{$_} } keys %$attrs)
292 # no search, effectively just a clone
293 $rows = $self->get_cache;
296 # reset the selector list
297 if (List::Util::first { exists $attrs->{$_} } qw{columns select as}) {
298 delete @{$our_attrs}{qw{select as columns +select +as +columns include_columns}};
301 my $new_attrs = { %{$our_attrs}, %{$attrs} };
303 # merge new attrs into inherited
304 foreach my $key (qw/join prefetch +select +as +columns include_columns bind/) {
305 next unless exists $attrs->{$key};
306 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
311 (@_ == 1 || ref $_[0] eq "HASH")
313 (ref $_[0] eq 'HASH')
315 (keys %{ $_[0] } > 0)
323 ? $self->throw_exception("Odd number of arguments to search")
330 if (defined $where) {
331 $new_attrs->{where} = (
332 defined $new_attrs->{where}
335 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
336 } $where, $new_attrs->{where}
343 $new_attrs->{where} = (
344 defined $new_attrs->{where}
347 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
348 } $cond, $new_attrs->{where}
354 if (defined $having) {
355 $new_attrs->{having} = (
356 defined $new_attrs->{having}
359 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
360 } $having, $new_attrs->{having}
366 my $rs = (ref $self)->new($self->result_source, $new_attrs);
368 $rs->set_cache($rows) if ($rows);
373 =head2 search_literal
377 =item Arguments: $sql_fragment, @bind_values
379 =item Return Value: $resultset (scalar context), @row_objs (list context)
383 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
384 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
386 Pass a literal chunk of SQL to be added to the conditional part of the
389 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
390 only be used in that context. C<search_literal> is a convenience method.
391 It is equivalent to calling $schema->search(\[]), but if you want to ensure
392 columns are bound correctly, use C<search>.
394 Example of how to use C<search> instead of C<search_literal>
396 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
397 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
400 See L<DBIx::Class::Manual::Cookbook/Searching> and
401 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
402 require C<search_literal>.
407 my ($self, $sql, @bind) = @_;
409 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
412 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
419 =item Arguments: @values | \%cols, \%attrs?
421 =item Return Value: $row_object | undef
425 Finds a row based on its primary key or unique constraint. For example, to find
426 a row by its primary key:
428 my $cd = $schema->resultset('CD')->find(5);
430 You can also find a row by a specific unique constraint using the C<key>
431 attribute. For example:
433 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
434 key => 'cd_artist_title'
437 Additionally, you can specify the columns explicitly by name:
439 my $cd = $schema->resultset('CD')->find(
441 artist => 'Massive Attack',
442 title => 'Mezzanine',
444 { key => 'cd_artist_title' }
447 If the C<key> is specified as C<primary>, it searches only on the primary key.
449 If no C<key> is specified, it searches on all unique constraints defined on the
450 source for which column data is provided, including the primary key.
452 If your table does not have a primary key, you B<must> provide a value for the
453 C<key> attribute matching one of the unique constraints on the source.
455 In addition to C<key>, L</find> recognizes and applies standard
456 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
458 Note: If your query does not return only one row, a warning is generated:
460 Query returned more than one row
462 See also L</find_or_create> and L</update_or_create>. For information on how to
463 declare unique constraints, see
464 L<DBIx::Class::ResultSource/add_unique_constraint>.
470 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
472 # Default to the primary key, but allow a specific key
473 my @cols = exists $attrs->{key}
474 ? $self->result_source->unique_constraint_columns($attrs->{key})
475 : $self->result_source->primary_columns;
476 $self->throw_exception(
477 "Can't find unless a primary key is defined or unique constraint is specified"
480 # Parse out a hashref from input
482 if (ref $_[0] eq 'HASH') {
483 $input_query = { %{$_[0]} };
485 elsif (@_ == @cols) {
487 @{$input_query}{@cols} = @_;
490 # Compatibility: Allow e.g. find(id => $value)
491 carp "Find by key => value deprecated; please use a hashref instead";
495 my (%related, $info);
497 KEY: foreach my $key (keys %$input_query) {
498 if (ref($input_query->{$key})
499 && ($info = $self->result_source->relationship_info($key))) {
500 my $val = delete $input_query->{$key};
501 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
502 my $rel_q = $self->result_source->_resolve_condition(
503 $info->{cond}, $val, $key
505 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
506 @related{keys %$rel_q} = values %$rel_q;
509 if (my @keys = keys %related) {
510 @{$input_query}{@keys} = values %related;
514 # Build the final query: Default to the disjunction of the unique queries,
515 # but allow the input query in case the ResultSet defines the query or the
516 # user is abusing find
517 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
519 if (exists $attrs->{key}) {
520 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
521 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
522 $query = $self->_add_alias($unique_query, $alias);
524 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
525 # This means that we got here after a merger of relationship conditions
526 # in ::Relationship::Base::search_related (the row method), and furthermore
527 # the relationship is of the 'single' type. This means that the condition
528 # provided by the relationship (already attached to $self) is sufficient,
529 # as there can be only one row in the database that would satisfy the
533 my @unique_queries = $self->_unique_queries($input_query, $attrs);
534 $query = @unique_queries
535 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
536 : $self->_add_alias($input_query, $alias);
539 # Run the query, passing the result_class since it should propagate for find
540 my $rs = $self->search ($query, {result_class => $self->result_class, %$attrs});
541 if (keys %{$rs->_resolved_attrs->{collapse}}) {
543 carp "Query returned more than one row" if $rs->next;
553 # Add the specified alias to the specified query hash. A copy is made so the
554 # original query is not modified.
557 my ($self, $query, $alias) = @_;
559 my %aliased = %$query;
560 foreach my $col (grep { ! m/\./ } keys %aliased) {
561 $aliased{"$alias.$col"} = delete $aliased{$col};
569 # Build a list of queries which satisfy unique constraints.
571 sub _unique_queries {
572 my ($self, $query, $attrs) = @_;
574 my @constraint_names = exists $attrs->{key}
576 : $self->result_source->unique_constraint_names;
578 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
579 my $num_where = scalar keys %$where;
581 my (@unique_queries, %seen_column_combinations);
582 foreach my $name (@constraint_names) {
583 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
585 my $constraint_sig = join "\x00", sort @constraint_cols;
586 next if $seen_column_combinations{$constraint_sig}++;
588 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
590 my $num_cols = scalar @constraint_cols;
591 my $num_query = scalar keys %$unique_query;
593 my $total = $num_query + $num_where;
594 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
595 # The query is either unique on its own or is unique in combination with
596 # the existing where clause
597 push @unique_queries, $unique_query;
601 return @unique_queries;
604 # _build_unique_query
606 # Constrain the specified query hash based on the specified column names.
608 sub _build_unique_query {
609 my ($self, $query, $unique_cols) = @_;
612 map { $_ => $query->{$_} }
613 grep { exists $query->{$_} }
618 =head2 search_related
622 =item Arguments: $rel, $cond, \%attrs?
624 =item Return Value: $new_resultset
628 $new_rs = $cd_rs->search_related('artist', {
632 Searches the specified relationship, optionally specifying a condition and
633 attributes for matching records. See L</ATTRIBUTES> for more information.
638 return shift->related_resultset(shift)->search(@_);
641 =head2 search_related_rs
643 This method works exactly the same as search_related, except that
644 it guarantees a resultset, even in list context.
648 sub search_related_rs {
649 return shift->related_resultset(shift)->search_rs(@_);
656 =item Arguments: none
658 =item Return Value: $cursor
662 Returns a storage-driven cursor to the given resultset. See
663 L<DBIx::Class::Cursor> for more information.
670 my $attrs = $self->_resolved_attrs_copy;
672 return $self->{cursor}
673 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
674 $attrs->{where},$attrs);
681 =item Arguments: $cond?
683 =item Return Value: $row_object?
687 my $cd = $schema->resultset('CD')->single({ year => 2001 });
689 Inflates the first result without creating a cursor if the resultset has
690 any records in it; if not returns nothing. Used by L</find> as a lean version of
693 While this method can take an optional search condition (just like L</search>)
694 being a fast-code-path it does not recognize search attributes. If you need to
695 add extra joins or similar, call L</search> and then chain-call L</single> on the
696 L<DBIx::Class::ResultSet> returned.
702 As of 0.08100, this method enforces the assumption that the preceding
703 query returns only one row. If more than one row is returned, you will receive
706 Query returned more than one row
708 In this case, you should be using L</next> or L</find> instead, or if you really
709 know what you are doing, use the L</rows> attribute to explicitly limit the size
712 This method will also throw an exception if it is called on a resultset prefetching
713 has_many, as such a prefetch implies fetching multiple rows from the database in
714 order to assemble the resulting object.
721 my ($self, $where) = @_;
723 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
726 my $attrs = $self->_resolved_attrs_copy;
728 if (keys %{$attrs->{collapse}}) {
729 $self->throw_exception(
730 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
735 if (defined $attrs->{where}) {
738 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
739 $where, delete $attrs->{where} ]
742 $attrs->{where} = $where;
746 # XXX: Disabled since it doesn't infer uniqueness in all cases
747 # unless ($self->_is_unique_query($attrs->{where})) {
748 # carp "Query not guaranteed to return a single row"
749 # . "; please declare your unique constraints or use search instead";
752 my @data = $self->result_source->storage->select_single(
753 $attrs->{from}, $attrs->{select},
754 $attrs->{where}, $attrs
757 return (@data ? ($self->_construct_object(@data))[0] : undef);
763 # Try to determine if the specified query is guaranteed to be unique, based on
764 # the declared unique constraints.
766 sub _is_unique_query {
767 my ($self, $query) = @_;
769 my $collapsed = $self->_collapse_query($query);
770 my $alias = $self->{attrs}{alias};
772 foreach my $name ($self->result_source->unique_constraint_names) {
773 my @unique_cols = map {
775 } $self->result_source->unique_constraint_columns($name);
777 # Count the values for each unique column
778 my %seen = map { $_ => 0 } @unique_cols;
780 foreach my $key (keys %$collapsed) {
781 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
782 next unless exists $seen{$aliased}; # Additional constraints are okay
783 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
786 # If we get 0 or more than 1 value for a column, it's not necessarily unique
787 return 1 unless grep { $_ != 1 } values %seen;
795 # Recursively collapse the query, accumulating values for each column.
797 sub _collapse_query {
798 my ($self, $query, $collapsed) = @_;
802 if (ref $query eq 'ARRAY') {
803 foreach my $subquery (@$query) {
804 next unless ref $subquery; # -or
805 $collapsed = $self->_collapse_query($subquery, $collapsed);
808 elsif (ref $query eq 'HASH') {
809 if (keys %$query and (keys %$query)[0] eq '-and') {
810 foreach my $subquery (@{$query->{-and}}) {
811 $collapsed = $self->_collapse_query($subquery, $collapsed);
815 foreach my $col (keys %$query) {
816 my $value = $query->{$col};
817 $collapsed->{$col}{$value}++;
829 =item Arguments: $cond?
831 =item Return Value: $resultsetcolumn
835 my $max_length = $rs->get_column('length')->max;
837 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
842 my ($self, $column) = @_;
843 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
851 =item Arguments: $cond, \%attrs?
853 =item Return Value: $resultset (scalar context), @row_objs (list context)
857 # WHERE title LIKE '%blue%'
858 $cd_rs = $rs->search_like({ title => '%blue%'});
860 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
861 that this is simply a convenience method retained for ex Class::DBI users.
862 You most likely want to use L</search> with specific operators.
864 For more information, see L<DBIx::Class::Manual::Cookbook>.
866 This method is deprecated and will be removed in 0.09. Use L</search()>
867 instead. An example conversion is:
869 ->search_like({ foo => 'bar' });
873 ->search({ foo => { like => 'bar' } });
880 'search_like() is deprecated and will be removed in DBIC version 0.09.'
881 .' Instead use ->search({ x => { -like => "y%" } })'
882 .' (note the outer pair of {}s - they are important!)'
884 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
885 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
886 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
887 return $class->search($query, { %$attrs });
894 =item Arguments: $first, $last
896 =item Return Value: $resultset (scalar context), @row_objs (list context)
900 Returns a resultset or object list representing a subset of elements from the
901 resultset slice is called on. Indexes are from 0, i.e., to get the first
904 my ($one, $two, $three) = $rs->slice(0, 2);
909 my ($self, $min, $max) = @_;
910 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
911 $attrs->{offset} = $self->{attrs}{offset} || 0;
912 $attrs->{offset} += $min;
913 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
914 return $self->search(undef(), $attrs);
915 #my $slice = (ref $self)->new($self->result_source, $attrs);
916 #return (wantarray ? $slice->all : $slice);
923 =item Arguments: none
925 =item Return Value: $result?
929 Returns the next element in the resultset (C<undef> is there is none).
931 Can be used to efficiently iterate over records in the resultset:
933 my $rs = $schema->resultset('CD')->search;
934 while (my $cd = $rs->next) {
938 Note that you need to store the resultset object, and call C<next> on it.
939 Calling C<< resultset('Table')->next >> repeatedly will always return the
940 first record from the resultset.
946 if (my $cache = $self->get_cache) {
947 $self->{all_cache_position} ||= 0;
948 return $cache->[$self->{all_cache_position}++];
950 if ($self->{attrs}{cache}) {
951 $self->{all_cache_position} = 1;
952 return ($self->all)[0];
954 if ($self->{stashed_objects}) {
955 my $obj = shift(@{$self->{stashed_objects}});
956 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
960 exists $self->{stashed_row}
961 ? @{delete $self->{stashed_row}}
962 : $self->cursor->next
964 return undef unless (@row);
965 my ($row, @more) = $self->_construct_object(@row);
966 $self->{stashed_objects} = \@more if @more;
970 sub _construct_object {
971 my ($self, @row) = @_;
973 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
975 my @new = $self->result_class->inflate_result($self->result_source, @$info);
976 @new = $self->{_attrs}{record_filter}->(@new)
977 if exists $self->{_attrs}{record_filter};
981 sub _collapse_result {
982 my ($self, $as_proto, $row) = @_;
986 # 'foo' => [ undef, 'foo' ]
987 # 'foo.bar' => [ 'foo', 'bar' ]
988 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
990 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
992 my %collapse = %{$self->{_attrs}{collapse}||{}};
996 # if we're doing collapsing (has_many prefetch) we need to grab records
997 # until the PK changes, so fill @pri_index. if not, we leave it empty so
998 # we know we don't have to bother.
1000 # the reason for not using the collapse stuff directly is because if you
1001 # had for e.g. two artists in a row with no cds, the collapse info for
1002 # both would be NULL (undef) so you'd lose the second artist
1004 # store just the index so we can check the array positions from the row
1005 # without having to contruct the full hash
1007 if (keys %collapse) {
1008 my %pri = map { ($_ => 1) } $self->result_source->_pri_cols;
1009 foreach my $i (0 .. $#construct_as) {
1010 next if defined($construct_as[$i][0]); # only self table
1011 if (delete $pri{$construct_as[$i][1]}) {
1012 push(@pri_index, $i);
1014 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1018 # no need to do an if, it'll be empty if @pri_index is empty anyway
1020 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1024 do { # no need to check anything at the front, we always want the first row
1028 foreach my $this_as (@construct_as) {
1029 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1032 push(@const_rows, \%const);
1034 } until ( # no pri_index => no collapse => drop straight out
1037 do { # get another row, stash it, drop out if different PK
1039 @copy = $self->cursor->next;
1040 $self->{stashed_row} = \@copy;
1042 # last thing in do block, counts as true if anything doesn't match
1044 # check xor defined first for NULL vs. NOT NULL then if one is
1045 # defined the other must be so check string equality
1048 (defined $pri_vals{$_} ^ defined $copy[$_])
1049 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1054 my $alias = $self->{attrs}{alias};
1061 foreach my $const (@const_rows) {
1062 scalar @const_keys or do {
1063 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1065 foreach my $key (@const_keys) {
1068 my @parts = split(/\./, $key);
1070 my $data = $const->{$key};
1071 foreach my $p (@parts) {
1072 $target = $target->[1]->{$p} ||= [];
1074 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1075 # collapsing at this point and on final part
1076 my $pos = $collapse_pos{$cur};
1077 CK: foreach my $ck (@ckey) {
1078 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1079 $collapse_pos{$cur} = $data;
1080 delete @collapse_pos{ # clear all positioning for sub-entries
1081 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1088 if (exists $collapse{$cur}) {
1089 $target = $target->[-1];
1092 $target->[0] = $data;
1094 $info->[0] = $const->{$key};
1102 =head2 result_source
1106 =item Arguments: $result_source?
1108 =item Return Value: $result_source
1112 An accessor for the primary ResultSource object from which this ResultSet
1119 =item Arguments: $result_class?
1121 =item Return Value: $result_class
1125 An accessor for the class to use when creating row objects. Defaults to
1126 C<< result_source->result_class >> - which in most cases is the name of the
1127 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1129 Note that changing the result_class will also remove any components
1130 that were originally loaded in the source class via
1131 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1132 in the original source class will not run.
1137 my ($self, $result_class) = @_;
1138 if ($result_class) {
1139 unless (ref $result_class) { # don't fire this for an object
1140 $self->ensure_class_loaded($result_class);
1142 $self->_result_class($result_class);
1143 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1144 # permit the user to set result class on one result set only; it only
1145 # chains if provided to search()
1146 #$self->{attrs}{result_class} = $result_class if ref $self;
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 # only take pieces we need for a simple count
1242 my $tmp_attrs = { map
1243 { $_ => $attrs->{$_} }
1244 qw/ alias from where bind join /
1247 # overwrite the selector (supplied by the storage)
1248 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1249 $tmp_attrs->{as} = 'count';
1251 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1257 # same as above but uses a subquery
1259 sub _count_subq_rs {
1260 my ($self, $attrs) = @_;
1262 my $rsrc = $self->result_source;
1263 $attrs ||= $self->_resolved_attrs;
1265 my $sub_attrs = { map
1266 { $_ => $attrs->{$_} }
1267 qw/ alias from where bind join group_by having rows offset /
1270 # if we multi-prefetch we group_by primary keys only as this is what we would
1271 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1272 if ( keys %{$attrs->{collapse}} ) {
1273 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->_pri_cols) ]
1276 # Calculate subquery selector
1277 if (my $g = $sub_attrs->{group_by}) {
1279 # necessary as the group_by may refer to aliased functions
1281 for my $sel (@{$attrs->{select}}) {
1282 $sel_index->{$sel->{-as}} = $sel
1283 if (ref $sel eq 'HASH' and $sel->{-as});
1286 for my $g_part (@$g) {
1287 push @{$sub_attrs->{select}}, $sel_index->{$g_part} || $g_part;
1291 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1292 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1295 return $rsrc->resultset_class
1296 ->new ($rsrc, $sub_attrs)
1298 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1299 -> get_column ('count');
1306 =head2 count_literal
1310 =item Arguments: $sql_fragment, @bind_values
1312 =item Return Value: $count
1316 Counts the results in a literal query. Equivalent to calling L</search_literal>
1317 with the passed arguments, then L</count>.
1321 sub count_literal { shift->search_literal(@_)->count; }
1327 =item Arguments: none
1329 =item Return Value: @objects
1333 Returns all elements in the resultset. Called implicitly if the resultset
1334 is returned in list context.
1341 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1344 return @{ $self->get_cache } if $self->get_cache;
1348 if (keys %{$self->_resolved_attrs->{collapse}}) {
1349 # Using $self->cursor->all is really just an optimisation.
1350 # If we're collapsing has_many prefetches it probably makes
1351 # very little difference, and this is cleaner than hacking
1352 # _construct_object to survive the approach
1353 $self->cursor->reset;
1354 my @row = $self->cursor->next;
1356 push(@obj, $self->_construct_object(@row));
1357 @row = (exists $self->{stashed_row}
1358 ? @{delete $self->{stashed_row}}
1359 : $self->cursor->next);
1362 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1365 $self->set_cache(\@obj) if $self->{attrs}{cache};
1374 =item Arguments: none
1376 =item Return Value: $self
1380 Resets the resultset's cursor, so you can iterate through the elements again.
1381 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1388 delete $self->{_attrs} if exists $self->{_attrs};
1389 $self->{all_cache_position} = 0;
1390 $self->cursor->reset;
1398 =item Arguments: none
1400 =item Return Value: $object?
1404 Resets the resultset and returns an object for the first result (if the
1405 resultset returns anything).
1410 return $_[0]->reset->next;
1416 # Determines whether and what type of subquery is required for the $rs operation.
1417 # If grouping is necessary either supplies its own, or verifies the current one
1418 # After all is done delegates to the proper storage method.
1420 sub _rs_update_delete {
1421 my ($self, $op, $values) = @_;
1423 my $rsrc = $self->result_source;
1425 # if a condition exists we need to strip all table qualifiers
1426 # if this is not possible we'll force a subquery below
1427 my $cond = $rsrc->schema->storage->_strip_cond_qualifiers ($self->{cond});
1429 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1430 my $needs_subq = $needs_group_by_subq || (not defined $cond) || $self->_has_resolved_attr(qw/rows 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->_pri_cols) ];
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 : (),
1487 =item Arguments: \%values
1489 =item Return Value: $storage_rv
1493 Sets the specified columns in the resultset to the supplied values in a
1494 single query. Return value will be true if the update succeeded or false
1495 if no records were updated; exact type of success value is storage-dependent.
1500 my ($self, $values) = @_;
1501 $self->throw_exception('Values for update must be a hash')
1502 unless ref $values eq 'HASH';
1504 return $self->_rs_update_delete ('update', $values);
1511 =item Arguments: \%values
1513 =item Return Value: 1
1517 Fetches all objects and updates them one at a time. Note that C<update_all>
1518 will run DBIC cascade triggers, while L</update> will not.
1523 my ($self, $values) = @_;
1524 $self->throw_exception('Values for update_all must be a hash')
1525 unless ref $values eq 'HASH';
1527 my $guard = $self->result_source->schema->txn_scope_guard;
1528 $_->update($values) for $self->all;
1537 =item Arguments: none
1539 =item Return Value: $storage_rv
1543 Deletes the contents of the resultset from its result source. Note that this
1544 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1545 to run. See also L<DBIx::Class::Row/delete>.
1547 Return value will be the number of rows deleted; exact type of return value
1548 is storage-dependent.
1554 $self->throw_exception('delete does not accept any arguments')
1557 return $self->_rs_update_delete ('delete');
1564 =item Arguments: none
1566 =item Return Value: 1
1570 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1571 will run DBIC cascade triggers, while L</delete> will not.
1577 $self->throw_exception('delete_all does not accept any arguments')
1580 my $guard = $self->result_source->schema->txn_scope_guard;
1581 $_->delete for $self->all;
1590 =item Arguments: \@data;
1594 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1595 For the arrayref of hashrefs style each hashref should be a structure suitable
1596 forsubmitting to a $resultset->create(...) method.
1598 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1599 to insert the data, as this is a faster method.
1601 Otherwise, each set of data is inserted into the database using
1602 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1603 accumulated into an array. The array itself, or an array reference
1604 is returned depending on scalar or list context.
1606 Example: Assuming an Artist Class that has many CDs Classes relating:
1608 my $Artist_rs = $schema->resultset("Artist");
1610 ## Void Context Example
1611 $Artist_rs->populate([
1612 { artistid => 4, name => 'Manufactured Crap', cds => [
1613 { title => 'My First CD', year => 2006 },
1614 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1617 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1618 { title => 'My parents sold me to a record company', year => 2005 },
1619 { title => 'Why Am I So Ugly?', year => 2006 },
1620 { title => 'I Got Surgery and am now Popular', year => 2007 }
1625 ## Array Context Example
1626 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1627 { name => "Artist One"},
1628 { name => "Artist Two"},
1629 { name => "Artist Three", cds=> [
1630 { title => "First CD", year => 2007},
1631 { title => "Second CD", year => 2008},
1635 print $ArtistOne->name; ## response is 'Artist One'
1636 print $ArtistThree->cds->count ## reponse is '2'
1638 For the arrayref of arrayrefs style, the first element should be a list of the
1639 fieldsnames to which the remaining elements are rows being inserted. For
1642 $Arstist_rs->populate([
1643 [qw/artistid name/],
1644 [100, 'A Formally Unknown Singer'],
1645 [101, 'A singer that jumped the shark two albums ago'],
1646 [102, 'An actually cool singer'],
1649 Please note an important effect on your data when choosing between void and
1650 wantarray context. Since void context goes straight to C<insert_bulk> in
1651 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1652 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1653 create primary keys for you, you will find that your PKs are empty. In this
1654 case you will have to use the wantarray context in order to create those
1662 # cruft placed in standalone method
1663 my $data = $self->_normalize_populate_args(@_);
1665 if(defined wantarray) {
1667 foreach my $item (@$data) {
1668 push(@created, $self->create($item));
1670 return wantarray ? @created : \@created;
1672 my $first = $data->[0];
1674 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1675 # it relationship data
1676 my (@rels, @columns);
1677 for (keys %$first) {
1678 my $ref = ref $first->{$_};
1679 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1685 my @pks = $self->result_source->primary_columns;
1687 ## do the belongs_to relationships
1688 foreach my $index (0..$#$data) {
1690 # delegate to create() for any dataset without primary keys with specified relationships
1691 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1693 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1694 my @ret = $self->populate($data);
1700 foreach my $rel (@rels) {
1701 next unless ref $data->[$index]->{$rel} eq "HASH";
1702 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1703 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1704 my $related = $result->result_source->_resolve_condition(
1705 $result->result_source->relationship_info($reverse)->{cond},
1710 delete $data->[$index]->{$rel};
1711 $data->[$index] = {%{$data->[$index]}, %$related};
1713 push @columns, keys %$related if $index == 0;
1717 ## inherit the data locked in the conditions of the resultset
1718 my ($rs_data) = $self->_merge_cond_with_data({});
1719 delete @{$rs_data}{@columns};
1720 my @inherit_cols = keys %$rs_data;
1721 my @inherit_data = values %$rs_data;
1723 ## do bulk insert on current row
1724 $self->result_source->storage->insert_bulk(
1725 $self->result_source,
1726 [@columns, @inherit_cols],
1727 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
1730 ## do the has_many relationships
1731 foreach my $item (@$data) {
1733 foreach my $rel (@rels) {
1734 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1736 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1737 || $self->throw_exception('Cannot find the relating object.');
1739 my $child = $parent->$rel;
1741 my $related = $child->result_source->_resolve_condition(
1742 $parent->result_source->relationship_info($rel)->{cond},
1747 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1748 my @populate = map { {%$_, %$related} } @rows_to_add;
1750 $child->populate( \@populate );
1757 # populate() argumnets went over several incarnations
1758 # What we ultimately support is AoH
1759 sub _normalize_populate_args {
1760 my ($self, $arg) = @_;
1762 if (ref $arg eq 'ARRAY') {
1763 if (ref $arg->[0] eq 'HASH') {
1766 elsif (ref $arg->[0] eq 'ARRAY') {
1768 my @colnames = @{$arg->[0]};
1769 foreach my $values (@{$arg}[1 .. $#$arg]) {
1770 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
1776 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
1783 =item Arguments: none
1785 =item Return Value: $pager
1789 Return Value a L<Data::Page> object for the current resultset. Only makes
1790 sense for queries with a C<page> attribute.
1792 To get the full count of entries for a paged resultset, call
1793 C<total_entries> on the L<Data::Page> object.
1800 return $self->{pager} if $self->{pager};
1802 my $attrs = $self->{attrs};
1803 $self->throw_exception("Can't create pager for non-paged rs")
1804 unless $self->{attrs}{page};
1805 $attrs->{rows} ||= 10;
1807 # throw away the paging flags and re-run the count (possibly
1808 # with a subselect) to get the real total count
1809 my $count_attrs = { %$attrs };
1810 delete $count_attrs->{$_} for qw/rows offset page pager/;
1811 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1813 return $self->{pager} = Data::Page->new(
1816 $self->{attrs}{page}
1824 =item Arguments: $page_number
1826 =item Return Value: $rs
1830 Returns a resultset for the $page_number page of the resultset on which page
1831 is called, where each page contains a number of rows equal to the 'rows'
1832 attribute set on the resultset (10 by default).
1837 my ($self, $page) = @_;
1838 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1845 =item Arguments: \%vals
1847 =item Return Value: $rowobject
1851 Creates a new row object in the resultset's result class and returns
1852 it. The row is not inserted into the database at this point, call
1853 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1854 will tell you whether the row object has been inserted or not.
1856 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1861 my ($self, $values) = @_;
1862 $self->throw_exception( "new_result needs a hash" )
1863 unless (ref $values eq 'HASH');
1865 my ($merged_cond, $cols_from_relations) = $self->_merge_cond_with_data($values);
1869 @$cols_from_relations
1870 ? (-cols_from_relations => $cols_from_relations)
1872 -source_handle => $self->_source_handle,
1873 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1876 return $self->result_class->new(\%new);
1879 # _merge_cond_with_data
1881 # Takes a simple hash of K/V data and returns its copy merged with the
1882 # condition already present on the resultset. Additionally returns an
1883 # arrayref of value/condition names, which were inferred from related
1884 # objects (this is needed for in-memory related objects)
1885 sub _merge_cond_with_data {
1886 my ($self, $data) = @_;
1888 my (%new_data, @cols_from_relations);
1890 my $alias = $self->{attrs}{alias};
1892 if (! defined $self->{cond}) {
1893 # just massage $data below
1895 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
1896 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1897 @cols_from_relations = keys %new_data;
1899 elsif (ref $self->{cond} ne 'HASH') {
1900 $self->throw_exception(
1901 "Can't abstract implicit construct, resultset condition not a hash"
1905 # precendence must be given to passed values over values inherited from
1906 # the cond, so the order here is important.
1907 my $collapsed_cond = $self->_collapse_cond($self->{cond});
1908 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1910 while ( my($col, $value) = each %implied ) {
1911 if (ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '=') {
1912 $new_data{$col} = $value->{'='};
1915 $new_data{$col} = $value if $self->_is_deterministic_value($value);
1921 %{ $self->_remove_alias($data, $alias) },
1924 return (\%new_data, \@cols_from_relations);
1927 # _is_deterministic_value
1929 # Make an effor to strip non-deterministic values from the condition,
1930 # to make sure new_result chokes less
1932 sub _is_deterministic_value {
1935 my $ref_type = ref $value;
1936 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1937 return 1 if Scalar::Util::blessed($value);
1941 # _has_resolved_attr
1943 # determines if the resultset defines at least one
1944 # of the attributes supplied
1946 # used to determine if a subquery is neccessary
1948 # supports some virtual attributes:
1950 # This will scan for any joins being present on the resultset.
1951 # It is not a mere key-search but a deep inspection of {from}
1954 sub _has_resolved_attr {
1955 my ($self, @attr_names) = @_;
1957 my $attrs = $self->_resolved_attrs;
1961 for my $n (@attr_names) {
1962 if (grep { $n eq $_ } (qw/-join/) ) {
1963 $extra_checks{$n}++;
1967 my $attr = $attrs->{$n};
1969 next if not defined $attr;
1971 if (ref $attr eq 'HASH') {
1972 return 1 if keys %$attr;
1974 elsif (ref $attr eq 'ARRAY') {
1982 # a resolved join is expressed as a multi-level from
1984 $extra_checks{-join}
1986 ref $attrs->{from} eq 'ARRAY'
1988 @{$attrs->{from}} > 1
1996 # Recursively collapse the condition.
1998 sub _collapse_cond {
1999 my ($self, $cond, $collapsed) = @_;
2003 if (ref $cond eq 'ARRAY') {
2004 foreach my $subcond (@$cond) {
2005 next unless ref $subcond; # -or
2006 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2009 elsif (ref $cond eq 'HASH') {
2010 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2011 foreach my $subcond (@{$cond->{-and}}) {
2012 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2016 foreach my $col (keys %$cond) {
2017 my $value = $cond->{$col};
2018 $collapsed->{$col} = $value;
2028 # Remove the specified alias from the specified query hash. A copy is made so
2029 # the original query is not modified.
2032 my ($self, $query, $alias) = @_;
2034 my %orig = %{ $query || {} };
2037 foreach my $key (keys %orig) {
2039 $unaliased{$key} = $orig{$key};
2042 $unaliased{$1} = $orig{$key}
2043 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2053 =item Arguments: none
2055 =item Return Value: \[ $sql, @bind ]
2059 Returns the SQL query and bind vars associated with the invocant.
2061 This is generally used as the RHS for a subquery.
2068 my $attrs = $self->_resolved_attrs_copy;
2073 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2074 # $sql also has no wrapping parenthesis in list ctx
2076 my $sqlbind = $self->result_source->storage
2077 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2086 =item Arguments: \%vals, \%attrs?
2088 =item Return Value: $rowobject
2092 my $artist = $schema->resultset('Artist')->find_or_new(
2093 { artist => 'fred' }, { key => 'artists' });
2095 $cd->cd_to_producer->find_or_new({ producer => $producer },
2096 { key => 'primary });
2098 Find an existing record from this resultset, based on its primary
2099 key, or a unique constraint. If none exists, instantiate a new result
2100 object and return it. The object will not be saved into your storage
2101 until you call L<DBIx::Class::Row/insert> on it.
2103 You most likely want this method when looking for existing rows using
2104 a unique constraint that is not the primary key, or looking for
2107 If you want objects to be saved immediately, use L</find_or_create>
2110 B<Note>: Take care when using C<find_or_new> with a table having
2111 columns with default values that you intend to be automatically
2112 supplied by the database (e.g. an auto_increment primary key column).
2113 In normal usage, the value of such columns should NOT be included at
2114 all in the call to C<find_or_new>, even when set to C<undef>.
2120 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2121 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2122 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2125 return $self->new_result($hash);
2132 =item Arguments: \%vals
2134 =item Return Value: a L<DBIx::Class::Row> $object
2138 Attempt to create a single new row or a row with multiple related rows
2139 in the table represented by the resultset (and related tables). This
2140 will not check for duplicate rows before inserting, use
2141 L</find_or_create> to do that.
2143 To create one row for this resultset, pass a hashref of key/value
2144 pairs representing the columns of the table and the values you wish to
2145 store. If the appropriate relationships are set up, foreign key fields
2146 can also be passed an object representing the foreign row, and the
2147 value will be set to its primary key.
2149 To create related objects, pass a hashref of related-object column values
2150 B<keyed on the relationship name>. If the relationship is of type C<multi>
2151 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2152 The process will correctly identify columns holding foreign keys, and will
2153 transparently populate them from the keys of the corresponding relation.
2154 This can be applied recursively, and will work correctly for a structure
2155 with an arbitrary depth and width, as long as the relationships actually
2156 exists and the correct column data has been supplied.
2159 Instead of hashrefs of plain related data (key/value pairs), you may
2160 also pass new or inserted objects. New objects (not inserted yet, see
2161 L</new>), will be inserted into their appropriate tables.
2163 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2165 Example of creating a new row.
2167 $person_rs->create({
2168 name=>"Some Person",
2169 email=>"somebody@someplace.com"
2172 Example of creating a new row and also creating rows in a related C<has_many>
2173 or C<has_one> resultset. Note Arrayref.
2176 { artistid => 4, name => 'Manufactured Crap', cds => [
2177 { title => 'My First CD', year => 2006 },
2178 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2183 Example of creating a new row and also creating a row in a related
2184 C<belongs_to>resultset. Note Hashref.
2187 title=>"Music for Silly Walks",
2190 name=>"Silly Musician",
2198 When subclassing ResultSet never attempt to override this method. Since
2199 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2200 lot of the internals simply never call it, so your override will be
2201 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2202 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2203 L</create> process you need to intervene.
2210 my ($self, $attrs) = @_;
2211 $self->throw_exception( "create needs a hashref" )
2212 unless ref $attrs eq 'HASH';
2213 return $self->new_result($attrs)->insert;
2216 =head2 find_or_create
2220 =item Arguments: \%vals, \%attrs?
2222 =item Return Value: $rowobject
2226 $cd->cd_to_producer->find_or_create({ producer => $producer },
2227 { key => 'primary' });
2229 Tries to find a record based on its primary key or unique constraints; if none
2230 is found, creates one and returns that instead.
2232 my $cd = $schema->resultset('CD')->find_or_create({
2234 artist => 'Massive Attack',
2235 title => 'Mezzanine',
2239 Also takes an optional C<key> attribute, to search by a specific key or unique
2240 constraint. For example:
2242 my $cd = $schema->resultset('CD')->find_or_create(
2244 artist => 'Massive Attack',
2245 title => 'Mezzanine',
2247 { key => 'cd_artist_title' }
2250 B<Note>: Because find_or_create() reads from the database and then
2251 possibly inserts based on the result, this method is subject to a race
2252 condition. Another process could create a record in the table after
2253 the find has completed and before the create has started. To avoid
2254 this problem, use find_or_create() inside a transaction.
2256 B<Note>: Take care when using C<find_or_create> with a table having
2257 columns with default values that you intend to be automatically
2258 supplied by the database (e.g. an auto_increment primary key column).
2259 In normal usage, the value of such columns should NOT be included at
2260 all in the call to C<find_or_create>, even when set to C<undef>.
2262 See also L</find> and L</update_or_create>. For information on how to declare
2263 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2267 sub find_or_create {
2269 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2270 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2271 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2274 return $self->create($hash);
2277 =head2 update_or_create
2281 =item Arguments: \%col_values, { key => $unique_constraint }?
2283 =item Return Value: $rowobject
2287 $resultset->update_or_create({ col => $val, ... });
2289 First, searches for an existing row matching one of the unique constraints
2290 (including the primary key) on the source of this resultset. If a row is
2291 found, updates it with the other given column values. Otherwise, creates a new
2294 Takes an optional C<key> attribute to search on a specific unique constraint.
2297 # In your application
2298 my $cd = $schema->resultset('CD')->update_or_create(
2300 artist => 'Massive Attack',
2301 title => 'Mezzanine',
2304 { key => 'cd_artist_title' }
2307 $cd->cd_to_producer->update_or_create({
2308 producer => $producer,
2315 If no C<key> is specified, it searches on all unique constraints defined on the
2316 source, including the primary key.
2318 If the C<key> is specified as C<primary>, it searches only on the primary key.
2320 See also L</find> and L</find_or_create>. For information on how to declare
2321 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2323 B<Note>: Take care when using C<update_or_create> with a table having
2324 columns with default values that you intend to be automatically
2325 supplied by the database (e.g. an auto_increment primary key column).
2326 In normal usage, the value of such columns should NOT be included at
2327 all in the call to C<update_or_create>, even when set to C<undef>.
2331 sub update_or_create {
2333 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2334 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2336 my $row = $self->find($cond, $attrs);
2338 $row->update($cond);
2342 return $self->create($cond);
2345 =head2 update_or_new
2349 =item Arguments: \%col_values, { key => $unique_constraint }?
2351 =item Return Value: $rowobject
2355 $resultset->update_or_new({ col => $val, ... });
2357 First, searches for an existing row matching one of the unique constraints
2358 (including the primary key) on the source of this resultset. If a row is
2359 found, updates it with the other given column values. Otherwise, instantiate
2360 a new result object and return it. The object will not be saved into your storage
2361 until you call L<DBIx::Class::Row/insert> on it.
2363 Takes an optional C<key> attribute to search on a specific unique constraint.
2366 # In your application
2367 my $cd = $schema->resultset('CD')->update_or_new(
2369 artist => 'Massive Attack',
2370 title => 'Mezzanine',
2373 { key => 'cd_artist_title' }
2376 if ($cd->in_storage) {
2377 # the cd was updated
2380 # the cd is not yet in the database, let's insert it
2384 B<Note>: Take care when using C<update_or_new> with a table having
2385 columns with default values that you intend to be automatically
2386 supplied by the database (e.g. an auto_increment primary key column).
2387 In normal usage, the value of such columns should NOT be included at
2388 all in the call to C<update_or_new>, even when set to C<undef>.
2390 See also L</find>, L</find_or_create> and L</find_or_new>.
2396 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2397 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2399 my $row = $self->find( $cond, $attrs );
2400 if ( defined $row ) {
2401 $row->update($cond);
2405 return $self->new_result($cond);
2412 =item Arguments: none
2414 =item Return Value: \@cache_objects?
2418 Gets the contents of the cache for the resultset, if the cache is set.
2420 The cache is populated either by using the L</prefetch> attribute to
2421 L</search> or by calling L</set_cache>.
2433 =item Arguments: \@cache_objects
2435 =item Return Value: \@cache_objects
2439 Sets the contents of the cache for the resultset. Expects an arrayref
2440 of objects of the same class as those produced by the resultset. Note that
2441 if the cache is set the resultset will return the cached objects rather
2442 than re-querying the database even if the cache attr is not set.
2444 The contents of the cache can also be populated by using the
2445 L</prefetch> attribute to L</search>.
2450 my ( $self, $data ) = @_;
2451 $self->throw_exception("set_cache requires an arrayref")
2452 if defined($data) && (ref $data ne 'ARRAY');
2453 $self->{all_cache} = $data;
2460 =item Arguments: none
2462 =item Return Value: []
2466 Clears the cache for the resultset.
2471 shift->set_cache(undef);
2478 =item Arguments: none
2480 =item Return Value: true, if the resultset has been paginated
2488 return !!$self->{attrs}{page};
2495 =item Arguments: none
2497 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2505 return scalar $self->result_source->storage->_parse_order_by($self->{attrs}{order_by});
2508 =head2 related_resultset
2512 =item Arguments: $relationship_name
2514 =item Return Value: $resultset
2518 Returns a related resultset for the supplied relationship name.
2520 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2524 sub related_resultset {
2525 my ($self, $rel) = @_;
2527 $self->{related_resultsets} ||= {};
2528 return $self->{related_resultsets}{$rel} ||= do {
2529 my $rsrc = $self->result_source;
2530 my $rel_info = $rsrc->relationship_info($rel);
2532 $self->throw_exception(
2533 "search_related: result source '" . $rsrc->source_name .
2534 "' has no such relationship $rel")
2537 my $attrs = $self->_chain_relationship($rel);
2539 my $join_count = $attrs->{seen_join}{$rel};
2541 my $alias = $self->result_source->storage
2542 ->relname_to_table_alias($rel, $join_count);
2544 # since this is search_related, and we already slid the select window inwards
2545 # (the select/as attrs were deleted in the beginning), we need to flip all
2546 # left joins to inner, so we get the expected results
2547 # read the comment on top of the actual function to see what this does
2548 $attrs->{from} = $rsrc->schema->storage->_straight_join_to_node ($attrs->{from}, $alias);
2551 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2552 delete @{$attrs}{qw(result_class alias)};
2556 if (my $cache = $self->get_cache) {
2557 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2558 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2563 my $rel_source = $rsrc->related_source($rel);
2567 # The reason we do this now instead of passing the alias to the
2568 # search_rs below is that if you wrap/overload resultset on the
2569 # source you need to know what alias it's -going- to have for things
2570 # to work sanely (e.g. RestrictWithObject wants to be able to add
2571 # extra query restrictions, and these may need to be $alias.)
2573 my $rel_attrs = $rel_source->resultset_attributes;
2574 local $rel_attrs->{alias} = $alias;
2576 $rel_source->resultset
2580 where => $attrs->{where},
2583 $new->set_cache($new_cache) if $new_cache;
2588 =head2 current_source_alias
2592 =item Arguments: none
2594 =item Return Value: $source_alias
2598 Returns the current table alias for the result source this resultset is built
2599 on, that will be used in the SQL query. Usually it is C<me>.
2601 Currently the source alias that refers to the result set returned by a
2602 L</search>/L</find> family method depends on how you got to the resultset: it's
2603 C<me> by default, but eg. L</search_related> aliases it to the related result
2604 source name (and keeps C<me> referring to the original result set). The long
2605 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2606 (and make this method unnecessary).
2608 Thus it's currently necessary to use this method in predefined queries (see
2609 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2610 source alias of the current result set:
2612 # in a result set class
2614 my ($self, $user) = @_;
2616 my $me = $self->current_source_alias;
2618 return $self->search(
2619 "$me.modified" => $user->id,
2625 sub current_source_alias {
2628 return ($self->{attrs} || {})->{alias} || 'me';
2631 =head2 as_subselect_rs
2635 =item Arguments: none
2637 =item Return Value: $resultset
2641 Act as a barrier to SQL symbols. The resultset provided will be made into a
2642 "virtual view" by including it as a subquery within the from clause. From this
2643 point on, any joined tables are inaccessible to ->search on the resultset (as if
2644 it were simply where-filtered without joins). For example:
2646 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
2648 # 'x' now pollutes the query namespace
2650 # So the following works as expected
2651 my $ok_rs = $rs->search({'x.other' => 1});
2653 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
2654 # def) we look for one row with contradictory terms and join in another table
2655 # (aliased 'x_2') which we never use
2656 my $broken_rs = $rs->search({'x.name' => 'def'});
2658 my $rs2 = $rs->as_subselect_rs;
2660 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
2661 my $not_joined_rs = $rs2->search({'x.other' => 1});
2663 # works as expected: finds a 'table' row related to two x rows (abc and def)
2664 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
2666 Another example of when one might use this would be to select a subset of
2667 columns in a group by clause:
2669 my $rs = $schema->resultset('Bar')->search(undef, {
2670 group_by => [qw{ id foo_id baz_id }],
2671 })->as_subselect_rs->search(undef, {
2672 columns => [qw{ id foo_id }]
2675 In the above example normally columns would have to be equal to the group by,
2676 but because we isolated the group by into a subselect the above works.
2680 sub as_subselect_rs {
2683 my $attrs = $self->_resolved_attrs;
2685 my $fresh_rs = (ref $self)->new (
2686 $self->result_source
2689 # these pieces will be locked in the subquery
2690 delete $fresh_rs->{cond};
2691 delete @{$fresh_rs->{attrs}}{qw/where bind/};
2693 return $fresh_rs->search( {}, {
2695 $attrs->{alias} => $self->as_query,
2696 -alias => $attrs->{alias},
2697 -source_handle => $self->result_source->handle,
2699 alias => $attrs->{alias},
2703 # This code is called by search_related, and makes sure there
2704 # is clear separation between the joins before, during, and
2705 # after the relationship. This information is needed later
2706 # in order to properly resolve prefetch aliases (any alias
2707 # with a relation_chain_depth less than the depth of the
2708 # current prefetch is not considered)
2710 # The increments happen twice per join. An even number means a
2711 # relationship specified via a search_related, whereas an odd
2712 # number indicates a join/prefetch added via attributes
2714 # Also this code will wrap the current resultset (the one we
2715 # chain to) in a subselect IFF it contains limiting attributes
2716 sub _chain_relationship {
2717 my ($self, $rel) = @_;
2718 my $source = $self->result_source;
2719 my $attrs = { %{$self->{attrs}||{}} };
2721 # we need to take the prefetch the attrs into account before we
2722 # ->_resolve_join as otherwise they get lost - captainL
2723 my $join = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2725 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
2727 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
2730 my @force_subq_attrs = qw/offset rows group_by having/;
2733 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
2735 $self->_has_resolved_attr (@force_subq_attrs)
2737 # Nuke the prefetch (if any) before the new $rs attrs
2738 # are resolved (prefetch is useless - we are wrapping
2739 # a subquery anyway).
2740 my $rs_copy = $self->search;
2741 $rs_copy->{attrs}{join} = $self->_merge_attr (
2742 $rs_copy->{attrs}{join},
2743 delete $rs_copy->{attrs}{prefetch},
2747 -source_handle => $source->handle,
2748 -alias => $attrs->{alias},
2749 $attrs->{alias} => $rs_copy->as_query,
2751 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
2752 $seen->{-relation_chain_depth} = 0;
2754 elsif ($attrs->{from}) { #shallow copy suffices
2755 $from = [ @{$attrs->{from}} ];
2759 -source_handle => $source->handle,
2760 -alias => $attrs->{alias},
2761 $attrs->{alias} => $source->from,
2765 my $jpath = ($seen->{-relation_chain_depth})
2766 ? $from->[-1][0]{-join_path}
2769 my @requested_joins = $source->_resolve_join(
2776 push @$from, @requested_joins;
2778 $seen->{-relation_chain_depth}++;
2780 # if $self already had a join/prefetch specified on it, the requested
2781 # $rel might very well be already included. What we do in this case
2782 # is effectively a no-op (except that we bump up the chain_depth on
2783 # the join in question so we could tell it *is* the search_related)
2786 # we consider the last one thus reverse
2787 for my $j (reverse @requested_joins) {
2788 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
2789 if ($rel eq $last_j) {
2790 $j->[0]{-relation_chain_depth}++;
2796 unless ($already_joined) {
2797 push @$from, $source->_resolve_join(
2805 $seen->{-relation_chain_depth}++;
2807 return {%$attrs, from => $from, seen_join => $seen};
2810 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2811 sub _resolved_attrs_copy {
2813 return { %{$self->_resolved_attrs (@_)} };
2816 sub _resolved_attrs {
2818 return $self->{_attrs} if $self->{_attrs};
2820 my $attrs = { %{ $self->{attrs} || {} } };
2821 my $source = $self->result_source;
2822 my $alias = $attrs->{alias};
2824 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2827 # build columns (as long as select isn't set) into a set of as/select hashes
2828 unless ( $attrs->{select} ) {
2831 if ( ref $attrs->{columns} eq 'ARRAY' ) {
2832 @cols = @{ delete $attrs->{columns}}
2833 } elsif ( defined $attrs->{columns} ) {
2834 @cols = delete $attrs->{columns}
2836 @cols = $source->columns
2840 if ( ref $_ eq 'HASH' ) {
2843 my $key = /^\Q${alias}.\E(.+)$/
2849 push @colbits, { $key => $value };
2854 # add the additional columns on
2855 foreach (qw{include_columns +columns}) {
2856 if ( $attrs->{$_} ) {
2857 my @list = ( ref($attrs->{$_}) eq 'ARRAY' )
2858 ? @{ delete $attrs->{$_} }
2859 : delete $attrs->{$_};
2861 if ( ref($_) eq 'HASH' ) {
2864 my $key = ( split /\./, $_ )[-1];
2865 my $value = ( /\./ ? $_ : "$alias.$_" );
2866 push @colbits, { $key => $value };
2872 # start with initial select items
2873 if ( $attrs->{select} ) {
2875 ( ref $attrs->{select} eq 'ARRAY' )
2876 ? [ @{ $attrs->{select} } ]
2877 : [ $attrs->{select} ];
2879 if ( $attrs->{as} ) {
2882 ref $attrs->{as} eq 'ARRAY'
2883 ? [ @{ $attrs->{as} } ]
2887 $attrs->{as} = [ map {
2888 m/^\Q${alias}.\E(.+)$/
2891 } @{ $attrs->{select} }
2897 # otherwise we intialise select & as to empty
2898 $attrs->{select} = [];
2902 # now add colbits to select/as
2903 push @{ $attrs->{select} }, map values %{$_}, @colbits;
2904 push @{ $attrs->{as} }, map keys %{$_}, @colbits;
2906 if ( my $adds = delete $attrs->{'+select'} ) {
2907 $adds = [$adds] unless ref $adds eq 'ARRAY';
2908 push @{ $attrs->{select} },
2909 map { /\./ || ref $_ ? $_ : "$alias.$_" } @$adds;
2911 if ( my $adds = delete $attrs->{'+as'} ) {
2912 $adds = [$adds] unless ref $adds eq 'ARRAY';
2913 push @{ $attrs->{as} }, @$adds;
2916 $attrs->{from} ||= [{
2917 -source_handle => $source->handle,
2918 -alias => $self->{attrs}{alias},
2919 $self->{attrs}{alias} => $source->from,
2922 if ( $attrs->{join} || $attrs->{prefetch} ) {
2924 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2925 if ref $attrs->{from} ne 'ARRAY';
2927 my $join = delete $attrs->{join} || {};
2929 if ( defined $attrs->{prefetch} ) {
2930 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2933 $attrs->{from} = # have to copy here to avoid corrupting the original
2935 @{ $attrs->{from} },
2936 $source->_resolve_join(
2939 { %{ $attrs->{seen_join} || {} } },
2940 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
2941 ? $attrs->{from}[-1][0]{-join_path}
2948 if ( defined $attrs->{order_by} ) {
2949 $attrs->{order_by} = (
2950 ref( $attrs->{order_by} ) eq 'ARRAY'
2951 ? [ @{ $attrs->{order_by} } ]
2952 : [ $attrs->{order_by} || () ]
2956 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2957 $attrs->{group_by} = [ $attrs->{group_by} ];
2960 # generate the distinct induced group_by early, as prefetch will be carried via a
2961 # subquery (since a group_by is present)
2962 if (delete $attrs->{distinct}) {
2963 if ($attrs->{group_by}) {
2964 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2967 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2969 # add any order_by parts that are not already present in the group_by
2970 # we need to be careful not to add any named functions/aggregates
2971 # i.e. select => [ ... { count => 'foo', -as 'foocount' } ... ]
2972 my %already_grouped = map { $_ => 1 } (@{$attrs->{group_by}});
2974 my $storage = $self->result_source->schema->storage;
2976 my $rs_column_list = $storage->_resolve_column_info ($attrs->{from});
2978 for my $chunk ($storage->_parse_order_by($attrs->{order_by})) {
2979 if ($rs_column_list->{$chunk} && not $already_grouped{$chunk}++) {
2980 push @{$attrs->{group_by}}, $chunk;
2986 $attrs->{collapse} ||= {};
2987 if ( my $prefetch = delete $attrs->{prefetch} ) {
2988 $prefetch = $self->_merge_attr( {}, $prefetch );
2990 my $prefetch_ordering = [];
2992 # this is a separate structure (we don't look in {from} directly)
2993 # as the resolver needs to shift things off the lists to work
2994 # properly (identical-prefetches on different branches)
2996 if (ref $attrs->{from} eq 'ARRAY') {
2998 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3000 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3001 next unless $j->[0]{-alias};
3002 next unless $j->[0]{-join_path};
3003 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3005 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3008 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3009 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3014 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
3016 # we need to somehow mark which columns came from prefetch
3017 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
3019 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
3020 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3022 push( @{$attrs->{order_by}}, @$prefetch_ordering );
3023 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
3026 # if both page and offset are specified, produce a combined offset
3027 # even though it doesn't make much sense, this is what pre 081xx has
3029 if (my $page = delete $attrs->{page}) {
3031 ($attrs->{rows} * ($page - 1))
3033 ($attrs->{offset} || 0)
3037 return $self->{_attrs} = $attrs;
3041 my ($self, $attr) = @_;
3043 if (ref $attr eq 'HASH') {
3044 return $self->_rollout_hash($attr);
3045 } elsif (ref $attr eq 'ARRAY') {
3046 return $self->_rollout_array($attr);
3052 sub _rollout_array {
3053 my ($self, $attr) = @_;
3056 foreach my $element (@{$attr}) {
3057 if (ref $element eq 'HASH') {
3058 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3059 } elsif (ref $element eq 'ARRAY') {
3060 # XXX - should probably recurse here
3061 push( @rolled_array, @{$self->_rollout_array($element)} );
3063 push( @rolled_array, $element );
3066 return \@rolled_array;
3070 my ($self, $attr) = @_;
3073 foreach my $key (keys %{$attr}) {
3074 push( @rolled_array, { $key => $attr->{$key} } );
3076 return \@rolled_array;
3079 sub _calculate_score {
3080 my ($self, $a, $b) = @_;
3082 if (defined $a xor defined $b) {
3085 elsif (not defined $a) {
3089 if (ref $b eq 'HASH') {
3090 my ($b_key) = keys %{$b};
3091 if (ref $a eq 'HASH') {
3092 my ($a_key) = keys %{$a};
3093 if ($a_key eq $b_key) {
3094 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3099 return ($a eq $b_key) ? 1 : 0;
3102 if (ref $a eq 'HASH') {
3103 my ($a_key) = keys %{$a};
3104 return ($b eq $a_key) ? 1 : 0;
3106 return ($b eq $a) ? 1 : 0;
3112 my ($self, $orig, $import) = @_;
3114 return $import unless defined($orig);
3115 return $orig unless defined($import);
3117 $orig = $self->_rollout_attr($orig);
3118 $import = $self->_rollout_attr($import);
3121 foreach my $import_element ( @{$import} ) {
3122 # find best candidate from $orig to merge $b_element into
3123 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3124 foreach my $orig_element ( @{$orig} ) {
3125 my $score = $self->_calculate_score( $orig_element, $import_element );
3126 if ($score > $best_candidate->{score}) {
3127 $best_candidate->{position} = $position;
3128 $best_candidate->{score} = $score;
3132 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3134 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3135 push( @{$orig}, $import_element );
3137 my $orig_best = $orig->[$best_candidate->{position}];
3138 # merge orig_best and b_element together and replace original with merged
3139 if (ref $orig_best ne 'HASH') {
3140 $orig->[$best_candidate->{position}] = $import_element;
3141 } elsif (ref $import_element eq 'HASH') {
3142 my ($key) = keys %{$orig_best};
3143 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3146 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3156 $self->_source_handle($_[0]->handle);
3158 $self->_source_handle->resolve;
3162 =head2 throw_exception
3164 See L<DBIx::Class::Schema/throw_exception> for details.
3168 sub throw_exception {
3171 if (ref $self && $self->_source_handle->schema) {
3172 $self->_source_handle->schema->throw_exception(@_)
3175 DBIx::Class::Exception->throw(@_);
3179 # XXX: FIXME: Attributes docs need clearing up
3183 Attributes are used to refine a ResultSet in various ways when
3184 searching for data. They can be passed to any method which takes an
3185 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3188 These are in no particular order:
3194 =item Value: ( $order_by | \@order_by | \%order_by )
3198 Which column(s) to order the results by.
3200 [The full list of suitable values is documented in
3201 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3204 If a single column name, or an arrayref of names is supplied, the
3205 argument is passed through directly to SQL. The hashref syntax allows
3206 for connection-agnostic specification of ordering direction:
3208 For descending order:
3210 order_by => { -desc => [qw/col1 col2 col3/] }
3212 For explicit ascending order:
3214 order_by => { -asc => 'col' }
3216 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3217 supported, although you are strongly encouraged to use the hashref
3218 syntax as outlined above.
3224 =item Value: \@columns
3228 Shortcut to request a particular set of columns to be retrieved. Each
3229 column spec may be a string (a table column name), or a hash (in which
3230 case the key is the C<as> value, and the value is used as the C<select>
3231 expression). Adds C<me.> onto the start of any column without a C<.> in
3232 it and sets C<select> from that, then auto-populates C<as> from
3233 C<select> as normal. (You may also use the C<cols> attribute, as in
3234 earlier versions of DBIC.)
3240 =item Value: \@columns
3244 Indicates additional columns to be selected from storage. Works the same
3245 as L</columns> but adds columns to the selection. (You may also use the
3246 C<include_columns> attribute, as in earlier versions of DBIC). For
3249 $schema->resultset('CD')->search(undef, {
3250 '+columns' => ['artist.name'],
3254 would return all CDs and include a 'name' column to the information
3255 passed to object inflation. Note that the 'artist' is the name of the
3256 column (or relationship) accessor, and 'name' is the name of the column
3257 accessor in the related table.
3259 =head2 include_columns
3263 =item Value: \@columns
3267 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3273 =item Value: \@select_columns
3277 Indicates which columns should be selected from the storage. You can use
3278 column names, or in the case of RDBMS back ends, function or stored procedure
3281 $rs = $schema->resultset('Employee')->search(undef, {
3284 { count => 'employeeid' },
3285 { max => { length => 'name' }, -as => 'longest_name' }
3290 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3292 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3293 use L</select>, to instruct DBIx::Class how to store the result of the column.
3294 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3295 identifier aliasing. You can however alias a function, so you can use it in
3296 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3297 attribute> supplied as shown in the example above.
3303 Indicates additional columns to be selected from storage. Works the same as
3304 L</select> but adds columns to the default selection, instead of specifying
3313 Indicates additional column names for those added via L</+select>. See L</as>.
3321 =item Value: \@inflation_names
3325 Indicates column names for object inflation. That is L</as> indicates the
3326 slot name in which the column value will be stored within the
3327 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3328 identifier by the C<get_column> method (or via the object accessor B<if one
3329 with the same name already exists>) as shown below. The L</as> attribute has
3330 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3332 $rs = $schema->resultset('Employee')->search(undef, {
3335 { count => 'employeeid' },
3336 { max => { length => 'name' }, -as => 'longest_name' }
3345 If the object against which the search is performed already has an accessor
3346 matching a column name specified in C<as>, the value can be retrieved using
3347 the accessor as normal:
3349 my $name = $employee->name();
3351 If on the other hand an accessor does not exist in the object, you need to
3352 use C<get_column> instead:
3354 my $employee_count = $employee->get_column('employee_count');
3356 You can create your own accessors if required - see
3357 L<DBIx::Class::Manual::Cookbook> for details.
3363 =item Value: ($rel_name | \@rel_names | \%rel_names)
3367 Contains a list of relationships that should be joined for this query. For
3370 # Get CDs by Nine Inch Nails
3371 my $rs = $schema->resultset('CD')->search(
3372 { 'artist.name' => 'Nine Inch Nails' },
3373 { join => 'artist' }
3376 Can also contain a hash reference to refer to the other relation's relations.
3379 package MyApp::Schema::Track;
3380 use base qw/DBIx::Class/;
3381 __PACKAGE__->table('track');
3382 __PACKAGE__->add_columns(qw/trackid cd position title/);
3383 __PACKAGE__->set_primary_key('trackid');
3384 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3387 # In your application
3388 my $rs = $schema->resultset('Artist')->search(
3389 { 'track.title' => 'Teardrop' },
3391 join => { cd => 'track' },
3392 order_by => 'artist.name',
3396 You need to use the relationship (not the table) name in conditions,
3397 because they are aliased as such. The current table is aliased as "me", so
3398 you need to use me.column_name in order to avoid ambiguity. For example:
3400 # Get CDs from 1984 with a 'Foo' track
3401 my $rs = $schema->resultset('CD')->search(
3404 'tracks.name' => 'Foo'
3406 { join => 'tracks' }
3409 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3410 similarly for a third time). For e.g.
3412 my $rs = $schema->resultset('Artist')->search({
3413 'cds.title' => 'Down to Earth',
3414 'cds_2.title' => 'Popular',
3416 join => [ qw/cds cds/ ],
3419 will return a set of all artists that have both a cd with title 'Down
3420 to Earth' and a cd with title 'Popular'.
3422 If you want to fetch related objects from other tables as well, see C<prefetch>
3425 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3431 =item Value: ($rel_name | \@rel_names | \%rel_names)
3435 Contains one or more relationships that should be fetched along with
3436 the main query (when they are accessed afterwards the data will
3437 already be available, without extra queries to the database). This is
3438 useful for when you know you will need the related objects, because it
3439 saves at least one query:
3441 my $rs = $schema->resultset('Tag')->search(
3450 The initial search results in SQL like the following:
3452 SELECT tag.*, cd.*, artist.* FROM tag
3453 JOIN cd ON tag.cd = cd.cdid
3454 JOIN artist ON cd.artist = artist.artistid
3456 L<DBIx::Class> has no need to go back to the database when we access the
3457 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3460 Simple prefetches will be joined automatically, so there is no need
3461 for a C<join> attribute in the above search.
3463 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3464 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3465 with an accessor type of 'single' or 'filter'). A more complex example that
3466 prefetches an artists cds, the tracks on those cds, and the tags associated
3467 with that artist is given below (assuming many-to-many from artists to tags):
3469 my $rs = $schema->resultset('Artist')->search(
3473 { cds => 'tracks' },
3474 { artist_tags => 'tags' }
3480 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3481 attributes will be ignored.
3483 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3484 exactly as you might expect.
3490 Prefetch uses the L</cache> to populate the prefetched relationships. This
3491 may or may not be what you want.
3495 If you specify a condition on a prefetched relationship, ONLY those
3496 rows that match the prefetched condition will be fetched into that relationship.
3497 This means that adding prefetch to a search() B<may alter> what is returned by
3498 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3500 my $artist_rs = $schema->resultset('Artist')->search({
3506 my $count = $artist_rs->first->cds->count;
3508 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3510 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3512 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3514 that cmp_ok() may or may not pass depending on the datasets involved. This
3515 behavior may or may not survive the 0.09 transition.
3527 Makes the resultset paged and specifies the page to retrieve. Effectively
3528 identical to creating a non-pages resultset and then calling ->page($page)
3531 If L<rows> attribute is not specified it defaults to 10 rows per page.
3533 When you have a paged resultset, L</count> will only return the number
3534 of rows in the page. To get the total, use the L</pager> and call
3535 C<total_entries> on it.
3545 Specifies the maximum number of rows for direct retrieval or the number of
3546 rows per page if the page attribute or method is used.
3552 =item Value: $offset
3556 Specifies the (zero-based) row number for the first row to be returned, or the
3557 of the first row of the first page if paging is used.
3563 =item Value: \@columns
3567 A arrayref of columns to group by. Can include columns of joined tables.
3569 group_by => [qw/ column1 column2 ... /]
3575 =item Value: $condition
3579 HAVING is a select statement attribute that is applied between GROUP BY and
3580 ORDER BY. It is applied to the after the grouping calculations have been
3583 having => { 'count(employee)' => { '>=', 100 } }
3589 =item Value: (0 | 1)
3593 Set to 1 to group by all columns. If the resultset already has a group_by
3594 attribute, this setting is ignored and an appropriate warning is issued.
3600 Adds to the WHERE clause.
3602 # only return rows WHERE deleted IS NULL for all searches
3603 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3605 Can be overridden by passing C<< { where => undef } >> as an attribute
3612 Set to 1 to cache search results. This prevents extra SQL queries if you
3613 revisit rows in your ResultSet:
3615 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3617 while( my $artist = $resultset->next ) {
3621 $rs->first; # without cache, this would issue a query
3623 By default, searches are not cached.
3625 For more examples of using these attributes, see
3626 L<DBIx::Class::Manual::Cookbook>.
3632 =item Value: ( 'update' | 'shared' )
3636 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT