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});
302 if (List::Util::first { exists $new_attrs->{$_} } qw{select as columns}) {
303 delete $new_attrs->{$_} for (qw{+select +as +columns});
308 (@_ == 1 || ref $_[0] eq "HASH")
310 (ref $_[0] eq 'HASH')
312 (keys %{ $_[0] } > 0)
320 ? $self->throw_exception("Odd number of arguments to search")
327 if (defined $where) {
328 $new_attrs->{where} = (
329 defined $new_attrs->{where}
332 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
333 } $where, $new_attrs->{where}
340 $new_attrs->{where} = (
341 defined $new_attrs->{where}
344 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
345 } $cond, $new_attrs->{where}
351 if (defined $having) {
352 $new_attrs->{having} = (
353 defined $new_attrs->{having}
356 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
357 } $having, $new_attrs->{having}
363 my $rs = (ref $self)->new($self->result_source, $new_attrs);
365 $rs->set_cache($rows) if ($rows);
370 =head2 search_literal
374 =item Arguments: $sql_fragment, @bind_values
376 =item Return Value: $resultset (scalar context), @row_objs (list context)
380 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
381 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
383 Pass a literal chunk of SQL to be added to the conditional part of the
386 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
387 only be used in that context. C<search_literal> is a convenience method.
388 It is equivalent to calling $schema->search(\[]), but if you want to ensure
389 columns are bound correctly, use C<search>.
391 Example of how to use C<search> instead of C<search_literal>
393 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
394 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
397 See L<DBIx::Class::Manual::Cookbook/Searching> and
398 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
399 require C<search_literal>.
404 my ($self, $sql, @bind) = @_;
406 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
409 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
416 =item Arguments: @values | \%cols, \%attrs?
418 =item Return Value: $row_object | undef
422 Finds a row based on its primary key or unique constraint. For example, to find
423 a row by its primary key:
425 my $cd = $schema->resultset('CD')->find(5);
427 You can also find a row by a specific unique constraint using the C<key>
428 attribute. For example:
430 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
431 key => 'cd_artist_title'
434 Additionally, you can specify the columns explicitly by name:
436 my $cd = $schema->resultset('CD')->find(
438 artist => 'Massive Attack',
439 title => 'Mezzanine',
441 { key => 'cd_artist_title' }
444 If the C<key> is specified as C<primary>, it searches only on the primary key.
446 If no C<key> is specified, it searches on all unique constraints defined on the
447 source for which column data is provided, including the primary key.
449 If your table does not have a primary key, you B<must> provide a value for the
450 C<key> attribute matching one of the unique constraints on the source.
452 In addition to C<key>, L</find> recognizes and applies standard
453 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
455 Note: If your query does not return only one row, a warning is generated:
457 Query returned more than one row
459 See also L</find_or_create> and L</update_or_create>. For information on how to
460 declare unique constraints, see
461 L<DBIx::Class::ResultSource/add_unique_constraint>.
467 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
469 # Default to the primary key, but allow a specific key
470 my @cols = exists $attrs->{key}
471 ? $self->result_source->unique_constraint_columns($attrs->{key})
472 : $self->result_source->primary_columns;
473 $self->throw_exception(
474 "Can't find unless a primary key is defined or unique constraint is specified"
477 # Parse out a hashref from input
479 if (ref $_[0] eq 'HASH') {
480 $input_query = { %{$_[0]} };
482 elsif (@_ == @cols) {
484 @{$input_query}{@cols} = @_;
487 # Compatibility: Allow e.g. find(id => $value)
488 carp "Find by key => value deprecated; please use a hashref instead";
492 my (%related, $info);
494 KEY: foreach my $key (keys %$input_query) {
495 if (ref($input_query->{$key})
496 && ($info = $self->result_source->relationship_info($key))) {
497 my $val = delete $input_query->{$key};
498 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
499 my $rel_q = $self->result_source->_resolve_condition(
500 $info->{cond}, $val, $key
502 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
503 @related{keys %$rel_q} = values %$rel_q;
506 if (my @keys = keys %related) {
507 @{$input_query}{@keys} = values %related;
511 # Build the final query: Default to the disjunction of the unique queries,
512 # but allow the input query in case the ResultSet defines the query or the
513 # user is abusing find
514 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
516 if (exists $attrs->{key}) {
517 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
518 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
519 $query = $self->_add_alias($unique_query, $alias);
521 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
522 # This means that we got here after a merger of relationship conditions
523 # in ::Relationship::Base::search_related (the row method), and furthermore
524 # the relationship is of the 'single' type. This means that the condition
525 # provided by the relationship (already attached to $self) is sufficient,
526 # as there can be only one row in the databse that would satisfy the
530 my @unique_queries = $self->_unique_queries($input_query, $attrs);
531 $query = @unique_queries
532 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
533 : $self->_add_alias($input_query, $alias);
537 my $rs = $self->search ($query, {result_class => $self->result_class, %$attrs});
538 if (keys %{$rs->_resolved_attrs->{collapse}}) {
540 carp "Query returned more than one row" if $rs->next;
550 # Add the specified alias to the specified query hash. A copy is made so the
551 # original query is not modified.
554 my ($self, $query, $alias) = @_;
556 my %aliased = %$query;
557 foreach my $col (grep { ! m/\./ } keys %aliased) {
558 $aliased{"$alias.$col"} = delete $aliased{$col};
566 # Build a list of queries which satisfy unique constraints.
568 sub _unique_queries {
569 my ($self, $query, $attrs) = @_;
571 my @constraint_names = exists $attrs->{key}
573 : $self->result_source->unique_constraint_names;
575 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
576 my $num_where = scalar keys %$where;
578 my (@unique_queries, %seen_column_combinations);
579 foreach my $name (@constraint_names) {
580 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
582 my $constraint_sig = join "\x00", sort @constraint_cols;
583 next if $seen_column_combinations{$constraint_sig}++;
585 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
587 my $num_cols = scalar @constraint_cols;
588 my $num_query = scalar keys %$unique_query;
590 my $total = $num_query + $num_where;
591 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
592 # The query is either unique on its own or is unique in combination with
593 # the existing where clause
594 push @unique_queries, $unique_query;
598 return @unique_queries;
601 # _build_unique_query
603 # Constrain the specified query hash based on the specified column names.
605 sub _build_unique_query {
606 my ($self, $query, $unique_cols) = @_;
609 map { $_ => $query->{$_} }
610 grep { exists $query->{$_} }
615 =head2 search_related
619 =item Arguments: $rel, $cond, \%attrs?
621 =item Return Value: $new_resultset
625 $new_rs = $cd_rs->search_related('artist', {
629 Searches the specified relationship, optionally specifying a condition and
630 attributes for matching records. See L</ATTRIBUTES> for more information.
635 return shift->related_resultset(shift)->search(@_);
638 =head2 search_related_rs
640 This method works exactly the same as search_related, except that
641 it guarantees a restultset, even in list context.
645 sub search_related_rs {
646 return shift->related_resultset(shift)->search_rs(@_);
653 =item Arguments: none
655 =item Return Value: $cursor
659 Returns a storage-driven cursor to the given resultset. See
660 L<DBIx::Class::Cursor> for more information.
667 my $attrs = $self->_resolved_attrs_copy;
669 return $self->{cursor}
670 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
671 $attrs->{where},$attrs);
678 =item Arguments: $cond?
680 =item Return Value: $row_object?
684 my $cd = $schema->resultset('CD')->single({ year => 2001 });
686 Inflates the first result without creating a cursor if the resultset has
687 any records in it; if not returns nothing. Used by L</find> as a lean version of
690 While this method can take an optional search condition (just like L</search>)
691 being a fast-code-path it does not recognize search attributes. If you need to
692 add extra joins or similar, call L</search> and then chain-call L</single> on the
693 L<DBIx::Class::ResultSet> returned.
699 As of 0.08100, this method enforces the assumption that the preceeding
700 query returns only one row. If more than one row is returned, you will receive
703 Query returned more than one row
705 In this case, you should be using L</next> or L</find> instead, or if you really
706 know what you are doing, use the L</rows> attribute to explicitly limit the size
709 This method will also throw an exception if it is called on a resultset prefetching
710 has_many, as such a prefetch implies fetching multiple rows from the database in
711 order to assemble the resulting object.
718 my ($self, $where) = @_;
720 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
723 my $attrs = $self->_resolved_attrs_copy;
725 if (keys %{$attrs->{collapse}}) {
726 $self->throw_exception(
727 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
732 if (defined $attrs->{where}) {
735 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
736 $where, delete $attrs->{where} ]
739 $attrs->{where} = $where;
743 # XXX: Disabled since it doesn't infer uniqueness in all cases
744 # unless ($self->_is_unique_query($attrs->{where})) {
745 # carp "Query not guaranteed to return a single row"
746 # . "; please declare your unique constraints or use search instead";
749 my @data = $self->result_source->storage->select_single(
750 $attrs->{from}, $attrs->{select},
751 $attrs->{where}, $attrs
754 return (@data ? ($self->_construct_object(@data))[0] : undef);
760 # Try to determine if the specified query is guaranteed to be unique, based on
761 # the declared unique constraints.
763 sub _is_unique_query {
764 my ($self, $query) = @_;
766 my $collapsed = $self->_collapse_query($query);
767 my $alias = $self->{attrs}{alias};
769 foreach my $name ($self->result_source->unique_constraint_names) {
770 my @unique_cols = map {
772 } $self->result_source->unique_constraint_columns($name);
774 # Count the values for each unique column
775 my %seen = map { $_ => 0 } @unique_cols;
777 foreach my $key (keys %$collapsed) {
778 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
779 next unless exists $seen{$aliased}; # Additional constraints are okay
780 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
783 # If we get 0 or more than 1 value for a column, it's not necessarily unique
784 return 1 unless grep { $_ != 1 } values %seen;
792 # Recursively collapse the query, accumulating values for each column.
794 sub _collapse_query {
795 my ($self, $query, $collapsed) = @_;
799 if (ref $query eq 'ARRAY') {
800 foreach my $subquery (@$query) {
801 next unless ref $subquery; # -or
802 $collapsed = $self->_collapse_query($subquery, $collapsed);
805 elsif (ref $query eq 'HASH') {
806 if (keys %$query and (keys %$query)[0] eq '-and') {
807 foreach my $subquery (@{$query->{-and}}) {
808 $collapsed = $self->_collapse_query($subquery, $collapsed);
812 foreach my $col (keys %$query) {
813 my $value = $query->{$col};
814 $collapsed->{$col}{$value}++;
826 =item Arguments: $cond?
828 =item Return Value: $resultsetcolumn
832 my $max_length = $rs->get_column('length')->max;
834 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
839 my ($self, $column) = @_;
840 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
848 =item Arguments: $cond, \%attrs?
850 =item Return Value: $resultset (scalar context), @row_objs (list context)
854 # WHERE title LIKE '%blue%'
855 $cd_rs = $rs->search_like({ title => '%blue%'});
857 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
858 that this is simply a convenience method retained for ex Class::DBI users.
859 You most likely want to use L</search> with specific operators.
861 For more information, see L<DBIx::Class::Manual::Cookbook>.
863 This method is deprecated and will be removed in 0.09. Use L</search()>
864 instead. An example conversion is:
866 ->search_like({ foo => 'bar' });
870 ->search({ foo => { like => 'bar' } });
877 'search_like() is deprecated and will be removed in DBIC version 0.09.'
878 .' Instead use ->search({ x => { -like => "y%" } })'
879 .' (note the outer pair of {}s - they are important!)'
881 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
882 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
883 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
884 return $class->search($query, { %$attrs });
891 =item Arguments: $first, $last
893 =item Return Value: $resultset (scalar context), @row_objs (list context)
897 Returns a resultset or object list representing a subset of elements from the
898 resultset slice is called on. Indexes are from 0, i.e., to get the first
901 my ($one, $two, $three) = $rs->slice(0, 2);
906 my ($self, $min, $max) = @_;
907 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
908 $attrs->{offset} = $self->{attrs}{offset} || 0;
909 $attrs->{offset} += $min;
910 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
911 return $self->search(undef(), $attrs);
912 #my $slice = (ref $self)->new($self->result_source, $attrs);
913 #return (wantarray ? $slice->all : $slice);
920 =item Arguments: none
922 =item Return Value: $result?
926 Returns the next element in the resultset (C<undef> is there is none).
928 Can be used to efficiently iterate over records in the resultset:
930 my $rs = $schema->resultset('CD')->search;
931 while (my $cd = $rs->next) {
935 Note that you need to store the resultset object, and call C<next> on it.
936 Calling C<< resultset('Table')->next >> repeatedly will always return the
937 first record from the resultset.
943 if (my $cache = $self->get_cache) {
944 $self->{all_cache_position} ||= 0;
945 return $cache->[$self->{all_cache_position}++];
947 if ($self->{attrs}{cache}) {
948 $self->{all_cache_position} = 1;
949 return ($self->all)[0];
951 if ($self->{stashed_objects}) {
952 my $obj = shift(@{$self->{stashed_objects}});
953 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
957 exists $self->{stashed_row}
958 ? @{delete $self->{stashed_row}}
959 : $self->cursor->next
961 return undef unless (@row);
962 my ($row, @more) = $self->_construct_object(@row);
963 $self->{stashed_objects} = \@more if @more;
967 sub _construct_object {
968 my ($self, @row) = @_;
970 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
972 my @new = $self->result_class->inflate_result($self->result_source, @$info);
973 @new = $self->{_attrs}{record_filter}->(@new)
974 if exists $self->{_attrs}{record_filter};
978 sub _collapse_result {
979 my ($self, $as_proto, $row) = @_;
983 # 'foo' => [ undef, 'foo' ]
984 # 'foo.bar' => [ 'foo', 'bar' ]
985 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
987 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
989 my %collapse = %{$self->{_attrs}{collapse}||{}};
993 # if we're doing collapsing (has_many prefetch) we need to grab records
994 # until the PK changes, so fill @pri_index. if not, we leave it empty so
995 # we know we don't have to bother.
997 # the reason for not using the collapse stuff directly is because if you
998 # had for e.g. two artists in a row with no cds, the collapse info for
999 # both would be NULL (undef) so you'd lose the second artist
1001 # store just the index so we can check the array positions from the row
1002 # without having to contruct the full hash
1004 if (keys %collapse) {
1005 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
1006 foreach my $i (0 .. $#construct_as) {
1007 next if defined($construct_as[$i][0]); # only self table
1008 if (delete $pri{$construct_as[$i][1]}) {
1009 push(@pri_index, $i);
1011 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1015 # no need to do an if, it'll be empty if @pri_index is empty anyway
1017 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1021 do { # no need to check anything at the front, we always want the first row
1025 foreach my $this_as (@construct_as) {
1026 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1029 push(@const_rows, \%const);
1031 } until ( # no pri_index => no collapse => drop straight out
1034 do { # get another row, stash it, drop out if different PK
1036 @copy = $self->cursor->next;
1037 $self->{stashed_row} = \@copy;
1039 # last thing in do block, counts as true if anything doesn't match
1041 # check xor defined first for NULL vs. NOT NULL then if one is
1042 # defined the other must be so check string equality
1045 (defined $pri_vals{$_} ^ defined $copy[$_])
1046 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1051 my $alias = $self->{attrs}{alias};
1058 foreach my $const (@const_rows) {
1059 scalar @const_keys or do {
1060 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1062 foreach my $key (@const_keys) {
1065 my @parts = split(/\./, $key);
1067 my $data = $const->{$key};
1068 foreach my $p (@parts) {
1069 $target = $target->[1]->{$p} ||= [];
1071 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1072 # collapsing at this point and on final part
1073 my $pos = $collapse_pos{$cur};
1074 CK: foreach my $ck (@ckey) {
1075 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1076 $collapse_pos{$cur} = $data;
1077 delete @collapse_pos{ # clear all positioning for sub-entries
1078 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1085 if (exists $collapse{$cur}) {
1086 $target = $target->[-1];
1089 $target->[0] = $data;
1091 $info->[0] = $const->{$key};
1099 =head2 result_source
1103 =item Arguments: $result_source?
1105 =item Return Value: $result_source
1109 An accessor for the primary ResultSource object from which this ResultSet
1116 =item Arguments: $result_class?
1118 =item Return Value: $result_class
1122 An accessor for the class to use when creating row objects. Defaults to
1123 C<< result_source->result_class >> - which in most cases is the name of the
1124 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1126 Note that changing the result_class will also remove any components
1127 that were originally loaded in the source class via
1128 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1129 in the original source class will not run.
1134 my ($self, $result_class) = @_;
1135 if ($result_class) {
1136 $self->ensure_class_loaded($result_class);
1137 $self->_result_class($result_class);
1139 $self->_result_class;
1146 =item Arguments: $cond, \%attrs??
1148 =item Return Value: $count
1152 Performs an SQL C<COUNT> with the same query as the resultset was built
1153 with to find the number of elements. Passing arguments is equivalent to
1154 C<< $rs->search ($cond, \%attrs)->count >>
1160 return $self->search(@_)->count if @_ and defined $_[0];
1161 return scalar @{ $self->get_cache } if $self->get_cache;
1163 my $attrs = $self->_resolved_attrs_copy;
1165 # this is a little optimization - it is faster to do the limit
1166 # adjustments in software, instead of a subquery
1167 my $rows = delete $attrs->{rows};
1168 my $offset = delete $attrs->{offset};
1171 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1172 $crs = $self->_count_subq_rs ($attrs);
1175 $crs = $self->_count_rs ($attrs);
1177 my $count = $crs->next;
1179 $count -= $offset if $offset;
1180 $count = $rows if $rows and $rows < $count;
1181 $count = 0 if ($count < 0);
1190 =item Arguments: $cond, \%attrs??
1192 =item Return Value: $count_rs
1196 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1197 This can be very handy for subqueries:
1199 ->search( { amount => $some_rs->count_rs->as_query } )
1201 As with regular resultsets the SQL query will be executed only after
1202 the resultset is accessed via L</next> or L</all>. That would return
1203 the same single value obtainable via L</count>.
1209 return $self->search(@_)->count_rs if @_;
1211 # this may look like a lack of abstraction (count() does about the same)
1212 # but in fact an _rs *must* use a subquery for the limits, as the
1213 # software based limiting can not be ported if this $rs is to be used
1214 # in a subquery itself (i.e. ->as_query)
1215 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1216 return $self->_count_subq_rs;
1219 return $self->_count_rs;
1224 # returns a ResultSetColumn object tied to the count query
1227 my ($self, $attrs) = @_;
1229 my $rsrc = $self->result_source;
1230 $attrs ||= $self->_resolved_attrs;
1232 my $tmp_attrs = { %$attrs };
1234 # take off any limits, record_filter is cdbi, and no point of ordering a count
1235 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1237 # overwrite the selector (supplied by the storage)
1238 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1239 $tmp_attrs->{as} = 'count';
1241 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1247 # same as above but uses a subquery
1249 sub _count_subq_rs {
1250 my ($self, $attrs) = @_;
1252 my $rsrc = $self->result_source;
1253 $attrs ||= $self->_resolved_attrs_copy;
1255 my $sub_attrs = { %$attrs };
1257 # extra selectors do not go in the subquery and there is no point of ordering it
1258 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1260 # if we prefetch, we group_by primary keys only as this is what we would get out
1261 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1262 if ( keys %{$attrs->{collapse}} ) {
1263 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1266 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1268 # this is so that the query can be simplified e.g.
1269 # * non-limiting joins can be pruned
1270 # * ordering can be thrown away in things like Top limit
1271 $sub_attrs->{-for_count_only} = 1;
1273 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1276 -alias => 'count_subq',
1277 -source_handle => $rsrc->handle,
1278 count_subq => $sub_rs->as_query,
1281 # the subquery replaces this
1282 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1284 return $self->_count_rs ($attrs);
1291 =head2 count_literal
1295 =item Arguments: $sql_fragment, @bind_values
1297 =item Return Value: $count
1301 Counts the results in a literal query. Equivalent to calling L</search_literal>
1302 with the passed arguments, then L</count>.
1306 sub count_literal { shift->search_literal(@_)->count; }
1312 =item Arguments: none
1314 =item Return Value: @objects
1318 Returns all elements in the resultset. Called implicitly if the resultset
1319 is returned in list context.
1326 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1329 return @{ $self->get_cache } if $self->get_cache;
1333 if (keys %{$self->_resolved_attrs->{collapse}}) {
1334 # Using $self->cursor->all is really just an optimisation.
1335 # If we're collapsing has_many prefetches it probably makes
1336 # very little difference, and this is cleaner than hacking
1337 # _construct_object to survive the approach
1338 $self->cursor->reset;
1339 my @row = $self->cursor->next;
1341 push(@obj, $self->_construct_object(@row));
1342 @row = (exists $self->{stashed_row}
1343 ? @{delete $self->{stashed_row}}
1344 : $self->cursor->next);
1347 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1350 $self->set_cache(\@obj) if $self->{attrs}{cache};
1359 =item Arguments: none
1361 =item Return Value: $self
1365 Resets the resultset's cursor, so you can iterate through the elements again.
1366 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1373 delete $self->{_attrs} if exists $self->{_attrs};
1374 $self->{all_cache_position} = 0;
1375 $self->cursor->reset;
1383 =item Arguments: none
1385 =item Return Value: $object?
1389 Resets the resultset and returns an object for the first result (if the
1390 resultset returns anything).
1395 return $_[0]->reset->next;
1401 # Determines whether and what type of subquery is required for the $rs operation.
1402 # If grouping is necessary either supplies its own, or verifies the current one
1403 # After all is done delegates to the proper storage method.
1405 sub _rs_update_delete {
1406 my ($self, $op, $values) = @_;
1408 my $rsrc = $self->result_source;
1410 # if a condition exists we need to strip all table qualifiers
1411 # if this is not possible we'll force a subquery below
1412 my $cond = $rsrc->schema->storage->_strip_cond_qualifiers ($self->{cond});
1414 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1415 my $needs_subq = $needs_group_by_subq || (not defined $cond) || $self->_has_resolved_attr(qw/row offset/);
1417 if ($needs_group_by_subq or $needs_subq) {
1419 # make a new $rs selecting only the PKs (that's all we really need)
1420 my $attrs = $self->_resolved_attrs_copy;
1422 delete $attrs->{$_} for qw/collapse select as/;
1423 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1425 if ($needs_group_by_subq) {
1426 # make sure no group_by was supplied, or if there is one - make sure it matches
1427 # the columns compiled above perfectly. Anything else can not be sanely executed
1428 # on most databases so croak right then and there
1430 if (my $g = $attrs->{group_by}) {
1431 my @current_group_by = map
1432 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1437 join ("\x00", sort @current_group_by)
1439 join ("\x00", sort @{$attrs->{columns}} )
1441 $self->throw_exception (
1442 "You have just attempted a $op operation on a resultset which does group_by"
1443 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1444 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1445 . ' kind of queries. Please retry the operation with a modified group_by or'
1446 . ' without using one at all.'
1451 $attrs->{group_by} = $attrs->{columns};
1455 my $subrs = (ref $self)->new($rsrc, $attrs);
1457 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1460 return $rsrc->storage->$op(
1462 $op eq 'update' ? $values : (),
1472 =item Arguments: \%values
1474 =item Return Value: $storage_rv
1478 Sets the specified columns in the resultset to the supplied values in a
1479 single query. Return value will be true if the update succeeded or false
1480 if no records were updated; exact type of success value is storage-dependent.
1485 my ($self, $values) = @_;
1486 $self->throw_exception('Values for update must be a hash')
1487 unless ref $values eq 'HASH';
1489 return $self->_rs_update_delete ('update', $values);
1496 =item Arguments: \%values
1498 =item Return Value: 1
1502 Fetches all objects and updates them one at a time. Note that C<update_all>
1503 will run DBIC cascade triggers, while L</update> will not.
1508 my ($self, $values) = @_;
1509 $self->throw_exception('Values for update_all must be a hash')
1510 unless ref $values eq 'HASH';
1511 foreach my $obj ($self->all) {
1512 $obj->set_columns($values)->update;
1521 =item Arguments: none
1523 =item Return Value: $storage_rv
1527 Deletes the contents of the resultset from its result source. Note that this
1528 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1529 to run. See also L<DBIx::Class::Row/delete>.
1531 Return value will be the amount of rows deleted; exact type of return value
1532 is storage-dependent.
1538 $self->throw_exception('delete does not accept any arguments')
1541 return $self->_rs_update_delete ('delete');
1548 =item Arguments: none
1550 =item Return Value: 1
1554 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1555 will run DBIC cascade triggers, while L</delete> will not.
1561 $self->throw_exception('delete_all does not accept any arguments')
1564 $_->delete for $self->all;
1572 =item Arguments: \@data;
1576 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1577 For the arrayref of hashrefs style each hashref should be a structure suitable
1578 forsubmitting to a $resultset->create(...) method.
1580 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1581 to insert the data, as this is a faster method.
1583 Otherwise, each set of data is inserted into the database using
1584 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1585 accumulated into an array. The array itself, or an array reference
1586 is returned depending on scalar or list context.
1588 Example: Assuming an Artist Class that has many CDs Classes relating:
1590 my $Artist_rs = $schema->resultset("Artist");
1592 ## Void Context Example
1593 $Artist_rs->populate([
1594 { artistid => 4, name => 'Manufactured Crap', cds => [
1595 { title => 'My First CD', year => 2006 },
1596 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1599 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1600 { title => 'My parents sold me to a record company' ,year => 2005 },
1601 { title => 'Why Am I So Ugly?', year => 2006 },
1602 { title => 'I Got Surgery and am now Popular', year => 2007 }
1607 ## Array Context Example
1608 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1609 { name => "Artist One"},
1610 { name => "Artist Two"},
1611 { name => "Artist Three", cds=> [
1612 { title => "First CD", year => 2007},
1613 { title => "Second CD", year => 2008},
1617 print $ArtistOne->name; ## response is 'Artist One'
1618 print $ArtistThree->cds->count ## reponse is '2'
1620 For the arrayref of arrayrefs style, the first element should be a list of the
1621 fieldsnames to which the remaining elements are rows being inserted. For
1624 $Arstist_rs->populate([
1625 [qw/artistid name/],
1626 [100, 'A Formally Unknown Singer'],
1627 [101, 'A singer that jumped the shark two albums ago'],
1628 [102, 'An actually cool singer.'],
1631 Please note an important effect on your data when choosing between void and
1632 wantarray context. Since void context goes straight to C<insert_bulk> in
1633 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1634 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1635 create primary keys for you, you will find that your PKs are empty. In this
1636 case you will have to use the wantarray context in order to create those
1644 # cruft placed in standalone method
1645 my $data = $self->_normalize_populate_args(@_);
1647 if(defined wantarray) {
1649 foreach my $item (@$data) {
1650 push(@created, $self->create($item));
1652 return wantarray ? @created : \@created;
1654 my $first = $data->[0];
1656 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1657 # it relationship data
1658 my (@rels, @columns);
1659 for (keys %$first) {
1660 my $ref = ref $first->{$_};
1661 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1667 my @pks = $self->result_source->primary_columns;
1669 ## do the belongs_to relationships
1670 foreach my $index (0..$#$data) {
1672 # delegate to create() for any dataset without primary keys with specified relationships
1673 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1675 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1676 my @ret = $self->populate($data);
1682 foreach my $rel (@rels) {
1683 next unless ref $data->[$index]->{$rel} eq "HASH";
1684 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1685 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1686 my $related = $result->result_source->_resolve_condition(
1687 $result->result_source->relationship_info($reverse)->{cond},
1692 delete $data->[$index]->{$rel};
1693 $data->[$index] = {%{$data->[$index]}, %$related};
1695 push @columns, keys %$related if $index == 0;
1699 ## inherit the data locked in the conditions of the resultset
1700 my ($rs_data) = $self->_merge_cond_with_data({});
1701 delete @{$rs_data}{@columns};
1702 my @inherit_cols = keys %$rs_data;
1703 my @inherit_data = values %$rs_data;
1705 ## do bulk insert on current row
1706 $self->result_source->storage->insert_bulk(
1707 $self->result_source,
1708 [@columns, @inherit_cols],
1709 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
1712 ## do the has_many relationships
1713 foreach my $item (@$data) {
1715 foreach my $rel (@rels) {
1716 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1718 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1719 || $self->throw_exception('Cannot find the relating object.');
1721 my $child = $parent->$rel;
1723 my $related = $child->result_source->_resolve_condition(
1724 $parent->result_source->relationship_info($rel)->{cond},
1729 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1730 my @populate = map { {%$_, %$related} } @rows_to_add;
1732 $child->populate( \@populate );
1739 # populate() argumnets went over several incarnations
1740 # What we ultimately support is AoH
1741 sub _normalize_populate_args {
1742 my ($self, $arg) = @_;
1744 if (ref $arg eq 'ARRAY') {
1745 if (ref $arg->[0] eq 'HASH') {
1748 elsif (ref $arg->[0] eq 'ARRAY') {
1750 my @colnames = @{$arg->[0]};
1751 foreach my $values (@{$arg}[1 .. $#$arg]) {
1752 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
1758 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
1765 =item Arguments: none
1767 =item Return Value: $pager
1771 Return Value a L<Data::Page> object for the current resultset. Only makes
1772 sense for queries with a C<page> attribute.
1774 To get the full count of entries for a paged resultset, call
1775 C<total_entries> on the L<Data::Page> object.
1782 return $self->{pager} if $self->{pager};
1784 my $attrs = $self->{attrs};
1785 $self->throw_exception("Can't create pager for non-paged rs")
1786 unless $self->{attrs}{page};
1787 $attrs->{rows} ||= 10;
1789 # throw away the paging flags and re-run the count (possibly
1790 # with a subselect) to get the real total count
1791 my $count_attrs = { %$attrs };
1792 delete $count_attrs->{$_} for qw/rows offset page pager/;
1793 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1795 return $self->{pager} = Data::Page->new(
1798 $self->{attrs}{page}
1806 =item Arguments: $page_number
1808 =item Return Value: $rs
1812 Returns a resultset for the $page_number page of the resultset on which page
1813 is called, where each page contains a number of rows equal to the 'rows'
1814 attribute set on the resultset (10 by default).
1819 my ($self, $page) = @_;
1820 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1827 =item Arguments: \%vals
1829 =item Return Value: $rowobject
1833 Creates a new row object in the resultset's result class and returns
1834 it. The row is not inserted into the database at this point, call
1835 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1836 will tell you whether the row object has been inserted or not.
1838 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1843 my ($self, $values) = @_;
1844 $self->throw_exception( "new_result needs a hash" )
1845 unless (ref $values eq 'HASH');
1847 my ($merged_cond, $cols_from_relations) = $self->_merge_cond_with_data($values);
1851 @$cols_from_relations
1852 ? (-cols_from_relations => $cols_from_relations)
1854 -source_handle => $self->_source_handle,
1855 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1858 return $self->result_class->new(\%new);
1861 # _merge_cond_with_data
1863 # Takes a simple hash of K/V data and returns its copy merged with the
1864 # condition already present on the resultset. Additionally returns an
1865 # arrayref of value/condition names, which were inferred from related
1866 # objects (this is needed for in-memory related objects)
1867 sub _merge_cond_with_data {
1868 my ($self, $data) = @_;
1870 my (%new_data, @cols_from_relations);
1872 my $alias = $self->{attrs}{alias};
1874 if (! defined $self->{cond}) {
1875 # just massage $data below
1877 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
1878 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1879 @cols_from_relations = keys %new_data;
1881 elsif (ref $self->{cond} ne 'HASH') {
1882 $self->throw_exception(
1883 "Can't abstract implicit construct, resultset condition not a hash"
1887 # precendence must be given to passed values over values inherited from
1888 # the cond, so the order here is important.
1889 my $collapsed_cond = $self->_collapse_cond($self->{cond});
1890 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1892 while ( my($col, $value) = each %implied ) {
1893 if (ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '=') {
1894 $new_data{$col} = $value->{'='};
1897 $new_data{$col} = $value if $self->_is_deterministic_value($value);
1903 %{ $self->_remove_alias($data, $alias) },
1906 return (\%new_data, \@cols_from_relations);
1909 # _is_deterministic_value
1911 # Make an effor to strip non-deterministic values from the condition,
1912 # to make sure new_result chokes less
1914 sub _is_deterministic_value {
1917 my $ref_type = ref $value;
1918 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1919 return 1 if Scalar::Util::blessed($value);
1923 # _has_resolved_attr
1925 # determines if the resultset defines at least one
1926 # of the attributes supplied
1928 # used to determine if a subquery is neccessary
1930 # supports some virtual attributes:
1932 # This will scan for any joins being present on the resultset.
1933 # It is not a mere key-search but a deep inspection of {from}
1936 sub _has_resolved_attr {
1937 my ($self, @attr_names) = @_;
1939 my $attrs = $self->_resolved_attrs;
1943 for my $n (@attr_names) {
1944 if (grep { $n eq $_ } (qw/-join/) ) {
1945 $extra_checks{$n}++;
1949 my $attr = $attrs->{$n};
1951 next if not defined $attr;
1953 if (ref $attr eq 'HASH') {
1954 return 1 if keys %$attr;
1956 elsif (ref $attr eq 'ARRAY') {
1964 # a resolved join is expressed as a multi-level from
1966 $extra_checks{-join}
1968 ref $attrs->{from} eq 'ARRAY'
1970 @{$attrs->{from}} > 1
1978 # Recursively collapse the condition.
1980 sub _collapse_cond {
1981 my ($self, $cond, $collapsed) = @_;
1985 if (ref $cond eq 'ARRAY') {
1986 foreach my $subcond (@$cond) {
1987 next unless ref $subcond; # -or
1988 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1991 elsif (ref $cond eq 'HASH') {
1992 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1993 foreach my $subcond (@{$cond->{-and}}) {
1994 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1998 foreach my $col (keys %$cond) {
1999 my $value = $cond->{$col};
2000 $collapsed->{$col} = $value;
2010 # Remove the specified alias from the specified query hash. A copy is made so
2011 # the original query is not modified.
2014 my ($self, $query, $alias) = @_;
2016 my %orig = %{ $query || {} };
2019 foreach my $key (keys %orig) {
2021 $unaliased{$key} = $orig{$key};
2024 $unaliased{$1} = $orig{$key}
2025 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2035 =item Arguments: none
2037 =item Return Value: \[ $sql, @bind ]
2041 Returns the SQL query and bind vars associated with the invocant.
2043 This is generally used as the RHS for a subquery.
2050 my $attrs = $self->_resolved_attrs_copy;
2055 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2056 # $sql also has no wrapping parenthesis in list ctx
2058 my $sqlbind = $self->result_source->storage
2059 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2068 =item Arguments: \%vals, \%attrs?
2070 =item Return Value: $rowobject
2074 my $artist = $schema->resultset('Artist')->find_or_new(
2075 { artist => 'fred' }, { key => 'artists' });
2077 $cd->cd_to_producer->find_or_new({ producer => $producer },
2078 { key => 'primary });
2080 Find an existing record from this resultset, based on its primary
2081 key, or a unique constraint. If none exists, instantiate a new result
2082 object and return it. The object will not be saved into your storage
2083 until you call L<DBIx::Class::Row/insert> on it.
2085 You most likely want this method when looking for existing rows using
2086 a unique constraint that is not the primary key, or looking for
2089 If you want objects to be saved immediately, use L</find_or_create>
2092 B<Note>: Take care when using C<find_or_new> with a table having
2093 columns with default values that you intend to be automatically
2094 supplied by the database (e.g. an auto_increment primary key column).
2095 In normal usage, the value of such columns should NOT be included at
2096 all in the call to C<find_or_new>, even when set to C<undef>.
2102 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2103 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2104 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2107 return $self->new_result($hash);
2114 =item Arguments: \%vals
2116 =item Return Value: a L<DBIx::Class::Row> $object
2120 Attempt to create a single new row or a row with multiple related rows
2121 in the table represented by the resultset (and related tables). This
2122 will not check for duplicate rows before inserting, use
2123 L</find_or_create> to do that.
2125 To create one row for this resultset, pass a hashref of key/value
2126 pairs representing the columns of the table and the values you wish to
2127 store. If the appropriate relationships are set up, foreign key fields
2128 can also be passed an object representing the foreign row, and the
2129 value will be set to its primary key.
2131 To create related objects, pass a hashref of related-object column values
2132 B<keyed on the relationship name>. If the relationship is of type C<multi>
2133 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2134 The process will correctly identify columns holding foreign keys, and will
2135 transparrently populate them from the keys of the corresponding relation.
2136 This can be applied recursively, and will work correctly for a structure
2137 with an arbitrary depth and width, as long as the relationships actually
2138 exists and the correct column data has been supplied.
2141 Instead of hashrefs of plain related data (key/value pairs), you may
2142 also pass new or inserted objects. New objects (not inserted yet, see
2143 L</new>), will be inserted into their appropriate tables.
2145 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2147 Example of creating a new row.
2149 $person_rs->create({
2150 name=>"Some Person",
2151 email=>"somebody@someplace.com"
2154 Example of creating a new row and also creating rows in a related C<has_many>
2155 or C<has_one> resultset. Note Arrayref.
2158 { artistid => 4, name => 'Manufactured Crap', cds => [
2159 { title => 'My First CD', year => 2006 },
2160 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2165 Example of creating a new row and also creating a row in a related
2166 C<belongs_to>resultset. Note Hashref.
2169 title=>"Music for Silly Walks",
2172 name=>"Silly Musician",
2180 When subclassing ResultSet never attempt to override this method. Since
2181 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2182 lot of the internals simply never call it, so your override will be
2183 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2184 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2185 L</create> process you need to intervene.
2192 my ($self, $attrs) = @_;
2193 $self->throw_exception( "create needs a hashref" )
2194 unless ref $attrs eq 'HASH';
2195 return $self->new_result($attrs)->insert;
2198 =head2 find_or_create
2202 =item Arguments: \%vals, \%attrs?
2204 =item Return Value: $rowobject
2208 $cd->cd_to_producer->find_or_create({ producer => $producer },
2209 { key => 'primary' });
2211 Tries to find a record based on its primary key or unique constraints; if none
2212 is found, creates one and returns that instead.
2214 my $cd = $schema->resultset('CD')->find_or_create({
2216 artist => 'Massive Attack',
2217 title => 'Mezzanine',
2221 Also takes an optional C<key> attribute, to search by a specific key or unique
2222 constraint. For example:
2224 my $cd = $schema->resultset('CD')->find_or_create(
2226 artist => 'Massive Attack',
2227 title => 'Mezzanine',
2229 { key => 'cd_artist_title' }
2232 B<Note>: Because find_or_create() reads from the database and then
2233 possibly inserts based on the result, this method is subject to a race
2234 condition. Another process could create a record in the table after
2235 the find has completed and before the create has started. To avoid
2236 this problem, use find_or_create() inside a transaction.
2238 B<Note>: Take care when using C<find_or_create> with a table having
2239 columns with default values that you intend to be automatically
2240 supplied by the database (e.g. an auto_increment primary key column).
2241 In normal usage, the value of such columns should NOT be included at
2242 all in the call to C<find_or_create>, even when set to C<undef>.
2244 See also L</find> and L</update_or_create>. For information on how to declare
2245 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2249 sub find_or_create {
2251 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2252 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2253 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2256 return $self->create($hash);
2259 =head2 update_or_create
2263 =item Arguments: \%col_values, { key => $unique_constraint }?
2265 =item Return Value: $rowobject
2269 $resultset->update_or_create({ col => $val, ... });
2271 First, searches for an existing row matching one of the unique constraints
2272 (including the primary key) on the source of this resultset. If a row is
2273 found, updates it with the other given column values. Otherwise, creates a new
2276 Takes an optional C<key> attribute to search on a specific unique constraint.
2279 # In your application
2280 my $cd = $schema->resultset('CD')->update_or_create(
2282 artist => 'Massive Attack',
2283 title => 'Mezzanine',
2286 { key => 'cd_artist_title' }
2289 $cd->cd_to_producer->update_or_create({
2290 producer => $producer,
2297 If no C<key> is specified, it searches on all unique constraints defined on the
2298 source, including the primary key.
2300 If the C<key> is specified as C<primary>, it searches only on the primary key.
2302 See also L</find> and L</find_or_create>. For information on how to declare
2303 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2305 B<Note>: Take care when using C<update_or_create> with a table having
2306 columns with default values that you intend to be automatically
2307 supplied by the database (e.g. an auto_increment primary key column).
2308 In normal usage, the value of such columns should NOT be included at
2309 all in the call to C<update_or_create>, even when set to C<undef>.
2313 sub update_or_create {
2315 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2316 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2318 my $row = $self->find($cond, $attrs);
2320 $row->update($cond);
2324 return $self->create($cond);
2327 =head2 update_or_new
2331 =item Arguments: \%col_values, { key => $unique_constraint }?
2333 =item Return Value: $rowobject
2337 $resultset->update_or_new({ col => $val, ... });
2339 First, searches for an existing row matching one of the unique constraints
2340 (including the primary key) on the source of this resultset. If a row is
2341 found, updates it with the other given column values. Otherwise, instantiate
2342 a new result object and return it. The object will not be saved into your storage
2343 until you call L<DBIx::Class::Row/insert> on it.
2345 Takes an optional C<key> attribute to search on a specific unique constraint.
2348 # In your application
2349 my $cd = $schema->resultset('CD')->update_or_new(
2351 artist => 'Massive Attack',
2352 title => 'Mezzanine',
2355 { key => 'cd_artist_title' }
2358 if ($cd->in_storage) {
2359 # the cd was updated
2362 # the cd is not yet in the database, let's insert it
2366 B<Note>: Take care when using C<update_or_new> with a table having
2367 columns with default values that you intend to be automatically
2368 supplied by the database (e.g. an auto_increment primary key column).
2369 In normal usage, the value of such columns should NOT be included at
2370 all in the call to C<update_or_new>, even when set to C<undef>.
2372 See also L</find>, L</find_or_create> and L</find_or_new>.
2378 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2379 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2381 my $row = $self->find( $cond, $attrs );
2382 if ( defined $row ) {
2383 $row->update($cond);
2387 return $self->new_result($cond);
2394 =item Arguments: none
2396 =item Return Value: \@cache_objects?
2400 Gets the contents of the cache for the resultset, if the cache is set.
2402 The cache is populated either by using the L</prefetch> attribute to
2403 L</search> or by calling L</set_cache>.
2415 =item Arguments: \@cache_objects
2417 =item Return Value: \@cache_objects
2421 Sets the contents of the cache for the resultset. Expects an arrayref
2422 of objects of the same class as those produced by the resultset. Note that
2423 if the cache is set the resultset will return the cached objects rather
2424 than re-querying the database even if the cache attr is not set.
2426 The contents of the cache can also be populated by using the
2427 L</prefetch> attribute to L</search>.
2432 my ( $self, $data ) = @_;
2433 $self->throw_exception("set_cache requires an arrayref")
2434 if defined($data) && (ref $data ne 'ARRAY');
2435 $self->{all_cache} = $data;
2442 =item Arguments: none
2444 =item Return Value: []
2448 Clears the cache for the resultset.
2453 shift->set_cache(undef);
2460 =item Arguments: none
2462 =item Return Value: true, if the resultset has been paginated
2470 return !!$self->{attrs}{page};
2473 =head2 related_resultset
2477 =item Arguments: $relationship_name
2479 =item Return Value: $resultset
2483 Returns a related resultset for the supplied relationship name.
2485 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2489 sub related_resultset {
2490 my ($self, $rel) = @_;
2492 $self->{related_resultsets} ||= {};
2493 return $self->{related_resultsets}{$rel} ||= do {
2494 my $rsrc = $self->result_source;
2495 my $rel_info = $rsrc->relationship_info($rel);
2497 $self->throw_exception(
2498 "search_related: result source '" . $rsrc->source_name .
2499 "' has no such relationship $rel")
2502 my $attrs = $self->_chain_relationship($rel);
2504 my $join_count = $attrs->{seen_join}{$rel};
2506 my $alias = $self->result_source->storage
2507 ->relname_to_table_alias($rel, $join_count);
2509 # since this is search_related, and we already slid the select window inwards
2510 # (the select/as attrs were deleted in the beginning), we need to flip all
2511 # left joins to inner, so we get the expected results
2512 # read the comment on top of the actual function to see what this does
2513 $attrs->{from} = $rsrc->schema->storage->_straight_join_to_node ($attrs->{from}, $alias);
2516 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2517 delete @{$attrs}{qw(result_class alias)};
2521 if (my $cache = $self->get_cache) {
2522 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2523 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2528 my $rel_source = $rsrc->related_source($rel);
2532 # The reason we do this now instead of passing the alias to the
2533 # search_rs below is that if you wrap/overload resultset on the
2534 # source you need to know what alias it's -going- to have for things
2535 # to work sanely (e.g. RestrictWithObject wants to be able to add
2536 # extra query restrictions, and these may need to be $alias.)
2538 my $rel_attrs = $rel_source->resultset_attributes;
2539 local $rel_attrs->{alias} = $alias;
2541 $rel_source->resultset
2545 where => $attrs->{where},
2548 $new->set_cache($new_cache) if $new_cache;
2553 =head2 current_source_alias
2557 =item Arguments: none
2559 =item Return Value: $source_alias
2563 Returns the current table alias for the result source this resultset is built
2564 on, that will be used in the SQL query. Usually it is C<me>.
2566 Currently the source alias that refers to the result set returned by a
2567 L</search>/L</find> family method depends on how you got to the resultset: it's
2568 C<me> by default, but eg. L</search_related> aliases it to the related result
2569 source name (and keeps C<me> referring to the original result set). The long
2570 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2571 (and make this method unnecessary).
2573 Thus it's currently necessary to use this method in predefined queries (see
2574 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2575 source alias of the current result set:
2577 # in a result set class
2579 my ($self, $user) = @_;
2581 my $me = $self->current_source_alias;
2583 return $self->search(
2584 "$me.modified" => $user->id,
2590 sub current_source_alias {
2593 return ($self->{attrs} || {})->{alias} || 'me';
2596 # This code is called by search_related, and makes sure there
2597 # is clear separation between the joins before, during, and
2598 # after the relationship. This information is needed later
2599 # in order to properly resolve prefetch aliases (any alias
2600 # with a relation_chain_depth less than the depth of the
2601 # current prefetch is not considered)
2603 # The increments happen twice per join. An even number means a
2604 # relationship specified via a search_related, whereas an odd
2605 # number indicates a join/prefetch added via attributes
2607 # Also this code will wrap the current resultset (the one we
2608 # chain to) in a subselect IFF it contains limiting attributes
2609 sub _chain_relationship {
2610 my ($self, $rel) = @_;
2611 my $source = $self->result_source;
2612 my $attrs = { %{$self->{attrs}||{}} };
2614 # we need to take the prefetch the attrs into account before we
2615 # ->_resolve_join as otherwise they get lost - captainL
2616 my $join = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2618 delete @{$attrs}{qw/join prefetch collapse distinct select as columns +select +as +columns/};
2620 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
2623 my @force_subq_attrs = qw/offset rows group_by having/;
2626 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
2628 $self->_has_resolved_attr (@force_subq_attrs)
2630 # Nuke the prefetch (if any) before the new $rs attrs
2631 # are resolved (prefetch is useless - we are wrapping
2632 # a subquery anyway).
2633 my $rs_copy = $self->search;
2634 $rs_copy->{attrs}{join} = $self->_merge_attr (
2635 $rs_copy->{attrs}{join},
2636 delete $rs_copy->{attrs}{prefetch},
2640 -source_handle => $source->handle,
2641 -alias => $attrs->{alias},
2642 $attrs->{alias} => $rs_copy->as_query,
2644 delete @{$attrs}{@force_subq_attrs, 'where'};
2645 $seen->{-relation_chain_depth} = 0;
2647 elsif ($attrs->{from}) { #shallow copy suffices
2648 $from = [ @{$attrs->{from}} ];
2652 -source_handle => $source->handle,
2653 -alias => $attrs->{alias},
2654 $attrs->{alias} => $source->from,
2658 my $jpath = ($seen->{-relation_chain_depth})
2659 ? $from->[-1][0]{-join_path}
2662 my @requested_joins = $source->_resolve_join(
2669 push @$from, @requested_joins;
2671 $seen->{-relation_chain_depth}++;
2673 # if $self already had a join/prefetch specified on it, the requested
2674 # $rel might very well be already included. What we do in this case
2675 # is effectively a no-op (except that we bump up the chain_depth on
2676 # the join in question so we could tell it *is* the search_related)
2679 # we consider the last one thus reverse
2680 for my $j (reverse @requested_joins) {
2681 if ($rel eq $j->[0]{-join_path}[-1]) {
2682 $j->[0]{-relation_chain_depth}++;
2687 # alternative way to scan the entire chain - not backwards compatible
2688 # for my $j (reverse @$from) {
2689 # next unless ref $j eq 'ARRAY';
2690 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2691 # $j->[0]{-relation_chain_depth}++;
2692 # $already_joined++;
2697 unless ($already_joined) {
2698 push @$from, $source->_resolve_join(
2706 $seen->{-relation_chain_depth}++;
2708 return {%$attrs, from => $from, seen_join => $seen};
2711 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2712 sub _resolved_attrs_copy {
2714 return { %{$self->_resolved_attrs (@_)} };
2717 sub _resolved_attrs {
2719 return $self->{_attrs} if $self->{_attrs};
2721 my $attrs = { %{ $self->{attrs} || {} } };
2722 my $source = $self->result_source;
2723 my $alias = $attrs->{alias};
2725 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2728 # build columns (as long as select isn't set) into a set of as/select hashes
2729 unless ( $attrs->{select} ) {
2731 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2732 ? @{ delete $attrs->{columns}}
2734 ( delete $attrs->{columns} )
2741 ( ref($_) eq 'HASH' )
2745 /^\Q${alias}.\E(.+)$/
2759 # add the additional columns on
2760 foreach (qw{include_columns +columns}) {
2761 push @colbits, map {
2762 ( ref($_) eq 'HASH' )
2764 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2765 } ( ref($attrs->{$_}) eq 'ARRAY' )
2766 ? @{ delete $attrs->{$_} }
2767 : delete $attrs->{$_} if ( $attrs->{$_} );
2770 # start with initial select items
2771 if ( $attrs->{select} ) {
2773 ( ref $attrs->{select} eq 'ARRAY' )
2774 ? [ @{ $attrs->{select} } ]
2775 : [ $attrs->{select} ];
2779 ref $attrs->{as} eq 'ARRAY'
2780 ? [ @{ $attrs->{as} } ]
2783 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2788 # otherwise we intialise select & as to empty
2789 $attrs->{select} = [];
2793 # now add colbits to select/as
2794 push @{ $attrs->{select} }, map values %{$_}, @colbits;
2795 push @{ $attrs->{as} }, map keys %{$_}, @colbits;
2797 if ( my $adds = delete $attrs->{'+select'} ) {
2798 $adds = [$adds] unless ref $adds eq 'ARRAY';
2799 push @{ $attrs->{select} },
2800 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds;
2802 if ( my $adds = delete $attrs->{'+as'} ) {
2803 $adds = [$adds] unless ref $adds eq 'ARRAY';
2804 push @{ $attrs->{as} }, @$adds;
2807 $attrs->{from} ||= [ {
2808 -source_handle => $source->handle,
2809 -alias => $self->{attrs}{alias},
2810 $self->{attrs}{alias} => $source->from,
2813 if ( $attrs->{join} || $attrs->{prefetch} ) {
2815 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2816 if ref $attrs->{from} ne 'ARRAY';
2818 my $join = delete $attrs->{join} || {};
2820 if ( defined $attrs->{prefetch} ) {
2821 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2824 $attrs->{from} = # have to copy here to avoid corrupting the original
2826 @{ $attrs->{from} },
2827 $source->_resolve_join(
2830 { %{ $attrs->{seen_join} || {} } },
2831 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2832 ? $attrs->{from}[-1][0]{-join_path}
2839 if ( defined $attrs->{order_by} ) {
2840 $attrs->{order_by} = (
2841 ref( $attrs->{order_by} ) eq 'ARRAY'
2842 ? [ @{ $attrs->{order_by} } ]
2843 : [ $attrs->{order_by} || () ]
2847 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2848 $attrs->{group_by} = [ $attrs->{group_by} ];
2851 # generate the distinct induced group_by early, as prefetch will be carried via a
2852 # subquery (since a group_by is present)
2853 if (delete $attrs->{distinct}) {
2854 if ($attrs->{group_by}) {
2855 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2858 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2860 # add any order_by parts that are not already present in the group_by
2861 # we need to be careful not to add any named functions/aggregates
2862 # i.e. select => [ ... { count => 'foo', -as 'foocount' } ... ]
2863 my %already_grouped = map { $_ => 1 } (@{$attrs->{group_by}});
2865 my $storage = $self->result_source->schema->storage;
2866 my $rs_column_list = $storage->_resolve_column_info ($attrs->{from});
2867 my @chunks = $storage->sql_maker->_order_by_chunks ($attrs->{order_by});
2869 for my $chunk (map { ref $_ ? @$_ : $_ } (@chunks) ) {
2870 $chunk =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
2871 if ($rs_column_list->{$chunk} && not $already_grouped{$chunk}++) {
2872 push @{$attrs->{group_by}}, $chunk;
2878 $attrs->{collapse} ||= {};
2879 if ( my $prefetch = delete $attrs->{prefetch} ) {
2880 $prefetch = $self->_merge_attr( {}, $prefetch );
2882 my $prefetch_ordering = [];
2884 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2887 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2889 # we need to somehow mark which columns came from prefetch
2890 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2892 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2893 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2895 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2896 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2899 # if both page and offset are specified, produce a combined offset
2900 # even though it doesn't make much sense, this is what pre 081xx has
2902 if (my $page = delete $attrs->{page}) {
2904 ($attrs->{rows} * ($page - 1))
2906 ($attrs->{offset} || 0)
2910 return $self->{_attrs} = $attrs;
2913 sub _joinpath_aliases {
2914 my ($self, $fromspec, $seen) = @_;
2917 return $paths unless ref $fromspec eq 'ARRAY';
2919 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2921 if ($cur_depth % 2) {
2922 $self->throw_exception ("-relation_chain_depth is not even, something went horribly wrong ($cur_depth)");
2925 for my $j (@$fromspec) {
2927 next if ref $j ne 'ARRAY';
2928 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2930 my $jpath = $j->[0]{-join_path};
2933 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth/2 .. $#$jpath]; #only even depths are actual jpath boundaries
2934 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2941 my ($self, $attr) = @_;
2943 if (ref $attr eq 'HASH') {
2944 return $self->_rollout_hash($attr);
2945 } elsif (ref $attr eq 'ARRAY') {
2946 return $self->_rollout_array($attr);
2952 sub _rollout_array {
2953 my ($self, $attr) = @_;
2956 foreach my $element (@{$attr}) {
2957 if (ref $element eq 'HASH') {
2958 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2959 } elsif (ref $element eq 'ARRAY') {
2960 # XXX - should probably recurse here
2961 push( @rolled_array, @{$self->_rollout_array($element)} );
2963 push( @rolled_array, $element );
2966 return \@rolled_array;
2970 my ($self, $attr) = @_;
2973 foreach my $key (keys %{$attr}) {
2974 push( @rolled_array, { $key => $attr->{$key} } );
2976 return \@rolled_array;
2979 sub _calculate_score {
2980 my ($self, $a, $b) = @_;
2982 if (defined $a xor defined $b) {
2985 elsif (not defined $a) {
2989 if (ref $b eq 'HASH') {
2990 my ($b_key) = keys %{$b};
2991 if (ref $a eq 'HASH') {
2992 my ($a_key) = keys %{$a};
2993 if ($a_key eq $b_key) {
2994 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2999 return ($a eq $b_key) ? 1 : 0;
3002 if (ref $a eq 'HASH') {
3003 my ($a_key) = keys %{$a};
3004 return ($b eq $a_key) ? 1 : 0;
3006 return ($b eq $a) ? 1 : 0;
3012 my ($self, $orig, $import) = @_;
3014 return $import unless defined($orig);
3015 return $orig unless defined($import);
3017 $orig = $self->_rollout_attr($orig);
3018 $import = $self->_rollout_attr($import);
3021 foreach my $import_element ( @{$import} ) {
3022 # find best candidate from $orig to merge $b_element into
3023 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3024 foreach my $orig_element ( @{$orig} ) {
3025 my $score = $self->_calculate_score( $orig_element, $import_element );
3026 if ($score > $best_candidate->{score}) {
3027 $best_candidate->{position} = $position;
3028 $best_candidate->{score} = $score;
3032 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3034 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3035 push( @{$orig}, $import_element );
3037 my $orig_best = $orig->[$best_candidate->{position}];
3038 # merge orig_best and b_element together and replace original with merged
3039 if (ref $orig_best ne 'HASH') {
3040 $orig->[$best_candidate->{position}] = $import_element;
3041 } elsif (ref $import_element eq 'HASH') {
3042 my ($key) = keys %{$orig_best};
3043 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3046 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3056 $self->_source_handle($_[0]->handle);
3058 $self->_source_handle->resolve;
3062 =head2 throw_exception
3064 See L<DBIx::Class::Schema/throw_exception> for details.
3068 sub throw_exception {
3071 if (ref $self && $self->_source_handle->schema) {
3072 $self->_source_handle->schema->throw_exception(@_)
3075 DBIx::Class::Exception->throw(@_);
3079 # XXX: FIXME: Attributes docs need clearing up
3083 Attributes are used to refine a ResultSet in various ways when
3084 searching for data. They can be passed to any method which takes an
3085 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3088 These are in no particular order:
3094 =item Value: ( $order_by | \@order_by | \%order_by )
3098 Which column(s) to order the results by.
3100 [The full list of suitable values is documented in
3101 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3104 If a single column name, or an arrayref of names is supplied, the
3105 argument is passed through directly to SQL. The hashref syntax allows
3106 for connection-agnostic specification of ordering direction:
3108 For descending order:
3110 order_by => { -desc => [qw/col1 col2 col3/] }
3112 For explicit ascending order:
3114 order_by => { -asc => 'col' }
3116 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3117 supported, although you are strongly encouraged to use the hashref
3118 syntax as outlined above.
3124 =item Value: \@columns
3128 Shortcut to request a particular set of columns to be retrieved. Each
3129 column spec may be a string (a table column name), or a hash (in which
3130 case the key is the C<as> value, and the value is used as the C<select>
3131 expression). Adds C<me.> onto the start of any column without a C<.> in
3132 it and sets C<select> from that, then auto-populates C<as> from
3133 C<select> as normal. (You may also use the C<cols> attribute, as in
3134 earlier versions of DBIC.)
3140 =item Value: \@columns
3144 Indicates additional columns to be selected from storage. Works the same
3145 as L</columns> but adds columns to the selection. (You may also use the
3146 C<include_columns> attribute, as in earlier versions of DBIC). For
3149 $schema->resultset('CD')->search(undef, {
3150 '+columns' => ['artist.name'],
3154 would return all CDs and include a 'name' column to the information
3155 passed to object inflation. Note that the 'artist' is the name of the
3156 column (or relationship) accessor, and 'name' is the name of the column
3157 accessor in the related table.
3159 =head2 include_columns
3163 =item Value: \@columns
3167 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3173 =item Value: \@select_columns
3177 Indicates which columns should be selected from the storage. You can use
3178 column names, or in the case of RDBMS back ends, function or stored procedure
3181 $rs = $schema->resultset('Employee')->search(undef, {
3184 { count => 'employeeid' },
3189 When you use function/stored procedure names and do not supply an C<as>
3190 attribute, the column names returned are storage-dependent. E.g. MySQL would
3191 return a column named C<count(employeeid)> in the above example.
3193 B<NOTE:> You will almost always need a corresponding 'as' entry when you use
3200 Indicates additional columns to be selected from storage. Works the same as
3201 L</select> but adds columns to the selection.
3209 Indicates additional column names for those added via L</+select>. See L</as>.
3217 =item Value: \@inflation_names
3221 Indicates column names for object inflation. That is, C<as>
3222 indicates the name that the column can be accessed as via the
3223 C<get_column> method (or via the object accessor, B<if one already
3224 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3226 The C<as> attribute is used in conjunction with C<select>,
3227 usually when C<select> contains one or more function or stored
3230 $rs = $schema->resultset('Employee')->search(undef, {
3233 { count => 'employeeid' }
3235 as => ['name', 'employee_count'],
3238 my $employee = $rs->first(); # get the first Employee
3240 If the object against which the search is performed already has an accessor
3241 matching a column name specified in C<as>, the value can be retrieved using
3242 the accessor as normal:
3244 my $name = $employee->name();
3246 If on the other hand an accessor does not exist in the object, you need to
3247 use C<get_column> instead:
3249 my $employee_count = $employee->get_column('employee_count');
3251 You can create your own accessors if required - see
3252 L<DBIx::Class::Manual::Cookbook> for details.
3254 Please note: This will NOT insert an C<AS employee_count> into the SQL
3255 statement produced, it is used for internal access only. Thus
3256 attempting to use the accessor in an C<order_by> clause or similar
3257 will fail miserably.
3259 To get around this limitation, you can supply literal SQL to your
3260 C<select> attibute that contains the C<AS alias> text, eg:
3262 select => [\'myfield AS alias']
3268 =item Value: ($rel_name | \@rel_names | \%rel_names)
3272 Contains a list of relationships that should be joined for this query. For
3275 # Get CDs by Nine Inch Nails
3276 my $rs = $schema->resultset('CD')->search(
3277 { 'artist.name' => 'Nine Inch Nails' },
3278 { join => 'artist' }
3281 Can also contain a hash reference to refer to the other relation's relations.
3284 package MyApp::Schema::Track;
3285 use base qw/DBIx::Class/;
3286 __PACKAGE__->table('track');
3287 __PACKAGE__->add_columns(qw/trackid cd position title/);
3288 __PACKAGE__->set_primary_key('trackid');
3289 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3292 # In your application
3293 my $rs = $schema->resultset('Artist')->search(
3294 { 'track.title' => 'Teardrop' },
3296 join => { cd => 'track' },
3297 order_by => 'artist.name',
3301 You need to use the relationship (not the table) name in conditions,
3302 because they are aliased as such. The current table is aliased as "me", so
3303 you need to use me.column_name in order to avoid ambiguity. For example:
3305 # Get CDs from 1984 with a 'Foo' track
3306 my $rs = $schema->resultset('CD')->search(
3309 'tracks.name' => 'Foo'
3311 { join => 'tracks' }
3314 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3315 similarly for a third time). For e.g.
3317 my $rs = $schema->resultset('Artist')->search({
3318 'cds.title' => 'Down to Earth',
3319 'cds_2.title' => 'Popular',
3321 join => [ qw/cds cds/ ],
3324 will return a set of all artists that have both a cd with title 'Down
3325 to Earth' and a cd with title 'Popular'.
3327 If you want to fetch related objects from other tables as well, see C<prefetch>
3330 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3336 =item Value: ($rel_name | \@rel_names | \%rel_names)
3340 Contains one or more relationships that should be fetched along with
3341 the main query (when they are accessed afterwards the data will
3342 already be available, without extra queries to the database). This is
3343 useful for when you know you will need the related objects, because it
3344 saves at least one query:
3346 my $rs = $schema->resultset('Tag')->search(
3355 The initial search results in SQL like the following:
3357 SELECT tag.*, cd.*, artist.* FROM tag
3358 JOIN cd ON tag.cd = cd.cdid
3359 JOIN artist ON cd.artist = artist.artistid
3361 L<DBIx::Class> has no need to go back to the database when we access the
3362 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3365 Simple prefetches will be joined automatically, so there is no need
3366 for a C<join> attribute in the above search.
3368 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3369 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3370 with an accessor type of 'single' or 'filter'). A more complex example that
3371 prefetches an artists cds, the tracks on those cds, and the tags associted
3372 with that artist is given below (assuming many-to-many from artists to tags):
3374 my $rs = $schema->resultset('Artist')->search(
3378 { cds => 'tracks' },
3379 { artist_tags => 'tags' }
3385 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3386 attributes will be ignored.
3388 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3389 exactly as you might expect.
3395 Prefetch uses the L</cache> to populate the prefetched relationships. This
3396 may or may not be what you want.
3400 If you specify a condition on a prefetched relationship, ONLY those
3401 rows that match the prefetched condition will be fetched into that relationship.
3402 This means that adding prefetch to a search() B<may alter> what is returned by
3403 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3405 my $artist_rs = $schema->resultset('Artist')->search({
3411 my $count = $artist_rs->first->cds->count;
3413 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3415 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3417 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3419 that cmp_ok() may or may not pass depending on the datasets involved. This
3420 behavior may or may not survive the 0.09 transition.
3432 Makes the resultset paged and specifies the page to retrieve. Effectively
3433 identical to creating a non-pages resultset and then calling ->page($page)
3436 If L<rows> attribute is not specified it defaults to 10 rows per page.
3438 When you have a paged resultset, L</count> will only return the number
3439 of rows in the page. To get the total, use the L</pager> and call
3440 C<total_entries> on it.
3450 Specifes the maximum number of rows for direct retrieval or the number of
3451 rows per page if the page attribute or method is used.
3457 =item Value: $offset
3461 Specifies the (zero-based) row number for the first row to be returned, or the
3462 of the first row of the first page if paging is used.
3468 =item Value: \@columns
3472 A arrayref of columns to group by. Can include columns of joined tables.
3474 group_by => [qw/ column1 column2 ... /]
3480 =item Value: $condition
3484 HAVING is a select statement attribute that is applied between GROUP BY and
3485 ORDER BY. It is applied to the after the grouping calculations have been
3488 having => { 'count(employee)' => { '>=', 100 } }
3494 =item Value: (0 | 1)
3498 Set to 1 to group by all columns. If the resultset already has a group_by
3499 attribute, this setting is ignored and an appropriate warning is issued.
3505 Adds to the WHERE clause.
3507 # only return rows WHERE deleted IS NULL for all searches
3508 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3510 Can be overridden by passing C<< { where => undef } >> as an attribute
3517 Set to 1 to cache search results. This prevents extra SQL queries if you
3518 revisit rows in your ResultSet:
3520 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3522 while( my $artist = $resultset->next ) {
3526 $rs->first; # without cache, this would issue a query
3528 By default, searches are not cached.
3530 For more examples of using these attributes, see
3531 L<DBIx::Class::Manual::Cookbook>.
3537 =item Value: ( 'update' | 'shared' )
3541 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT