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 multi-prefetch we group_by primary keys only as this is what we would
1261 # get out 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 # * ordering can be thrown away in things like Top limit
1270 $sub_attrs->{-for_count_only} = 1;
1272 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1275 -alias => 'count_subq',
1276 -source_handle => $rsrc->handle,
1277 count_subq => $sub_rs->as_query,
1280 # the subquery replaces this
1281 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1283 return $self->_count_rs ($attrs);
1290 =head2 count_literal
1294 =item Arguments: $sql_fragment, @bind_values
1296 =item Return Value: $count
1300 Counts the results in a literal query. Equivalent to calling L</search_literal>
1301 with the passed arguments, then L</count>.
1305 sub count_literal { shift->search_literal(@_)->count; }
1311 =item Arguments: none
1313 =item Return Value: @objects
1317 Returns all elements in the resultset. Called implicitly if the resultset
1318 is returned in list context.
1325 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1328 return @{ $self->get_cache } if $self->get_cache;
1332 if (keys %{$self->_resolved_attrs->{collapse}}) {
1333 # Using $self->cursor->all is really just an optimisation.
1334 # If we're collapsing has_many prefetches it probably makes
1335 # very little difference, and this is cleaner than hacking
1336 # _construct_object to survive the approach
1337 $self->cursor->reset;
1338 my @row = $self->cursor->next;
1340 push(@obj, $self->_construct_object(@row));
1341 @row = (exists $self->{stashed_row}
1342 ? @{delete $self->{stashed_row}}
1343 : $self->cursor->next);
1346 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1349 $self->set_cache(\@obj) if $self->{attrs}{cache};
1358 =item Arguments: none
1360 =item Return Value: $self
1364 Resets the resultset's cursor, so you can iterate through the elements again.
1365 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1372 delete $self->{_attrs} if exists $self->{_attrs};
1373 $self->{all_cache_position} = 0;
1374 $self->cursor->reset;
1382 =item Arguments: none
1384 =item Return Value: $object?
1388 Resets the resultset and returns an object for the first result (if the
1389 resultset returns anything).
1394 return $_[0]->reset->next;
1400 # Determines whether and what type of subquery is required for the $rs operation.
1401 # If grouping is necessary either supplies its own, or verifies the current one
1402 # After all is done delegates to the proper storage method.
1404 sub _rs_update_delete {
1405 my ($self, $op, $values) = @_;
1407 my $rsrc = $self->result_source;
1409 # if a condition exists we need to strip all table qualifiers
1410 # if this is not possible we'll force a subquery below
1411 my $cond = $rsrc->schema->storage->_strip_cond_qualifiers ($self->{cond});
1413 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1414 my $needs_subq = $needs_group_by_subq || (not defined $cond) || $self->_has_resolved_attr(qw/row offset/);
1416 if ($needs_group_by_subq or $needs_subq) {
1418 # make a new $rs selecting only the PKs (that's all we really need)
1419 my $attrs = $self->_resolved_attrs_copy;
1421 delete $attrs->{$_} for qw/collapse select as/;
1422 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1424 if ($needs_group_by_subq) {
1425 # make sure no group_by was supplied, or if there is one - make sure it matches
1426 # the columns compiled above perfectly. Anything else can not be sanely executed
1427 # on most databases so croak right then and there
1429 if (my $g = $attrs->{group_by}) {
1430 my @current_group_by = map
1431 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1436 join ("\x00", sort @current_group_by)
1438 join ("\x00", sort @{$attrs->{columns}} )
1440 $self->throw_exception (
1441 "You have just attempted a $op operation on a resultset which does group_by"
1442 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1443 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1444 . ' kind of queries. Please retry the operation with a modified group_by or'
1445 . ' without using one at all.'
1450 $attrs->{group_by} = $attrs->{columns};
1454 my $subrs = (ref $self)->new($rsrc, $attrs);
1456 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1459 return $rsrc->storage->$op(
1461 $op eq 'update' ? $values : (),
1471 =item Arguments: \%values
1473 =item Return Value: $storage_rv
1477 Sets the specified columns in the resultset to the supplied values in a
1478 single query. Return value will be true if the update succeeded or false
1479 if no records were updated; exact type of success value is storage-dependent.
1484 my ($self, $values) = @_;
1485 $self->throw_exception('Values for update must be a hash')
1486 unless ref $values eq 'HASH';
1488 return $self->_rs_update_delete ('update', $values);
1495 =item Arguments: \%values
1497 =item Return Value: 1
1501 Fetches all objects and updates them one at a time. Note that C<update_all>
1502 will run DBIC cascade triggers, while L</update> will not.
1507 my ($self, $values) = @_;
1508 $self->throw_exception('Values for update_all must be a hash')
1509 unless ref $values eq 'HASH';
1510 foreach my $obj ($self->all) {
1511 $obj->set_columns($values)->update;
1520 =item Arguments: none
1522 =item Return Value: $storage_rv
1526 Deletes the contents of the resultset from its result source. Note that this
1527 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1528 to run. See also L<DBIx::Class::Row/delete>.
1530 Return value will be the amount of rows deleted; exact type of return value
1531 is storage-dependent.
1537 $self->throw_exception('delete does not accept any arguments')
1540 return $self->_rs_update_delete ('delete');
1547 =item Arguments: none
1549 =item Return Value: 1
1553 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1554 will run DBIC cascade triggers, while L</delete> will not.
1560 $self->throw_exception('delete_all does not accept any arguments')
1563 $_->delete for $self->all;
1571 =item Arguments: \@data;
1575 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1576 For the arrayref of hashrefs style each hashref should be a structure suitable
1577 forsubmitting to a $resultset->create(...) method.
1579 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1580 to insert the data, as this is a faster method.
1582 Otherwise, each set of data is inserted into the database using
1583 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1584 accumulated into an array. The array itself, or an array reference
1585 is returned depending on scalar or list context.
1587 Example: Assuming an Artist Class that has many CDs Classes relating:
1589 my $Artist_rs = $schema->resultset("Artist");
1591 ## Void Context Example
1592 $Artist_rs->populate([
1593 { artistid => 4, name => 'Manufactured Crap', cds => [
1594 { title => 'My First CD', year => 2006 },
1595 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1598 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1599 { title => 'My parents sold me to a record company' ,year => 2005 },
1600 { title => 'Why Am I So Ugly?', year => 2006 },
1601 { title => 'I Got Surgery and am now Popular', year => 2007 }
1606 ## Array Context Example
1607 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1608 { name => "Artist One"},
1609 { name => "Artist Two"},
1610 { name => "Artist Three", cds=> [
1611 { title => "First CD", year => 2007},
1612 { title => "Second CD", year => 2008},
1616 print $ArtistOne->name; ## response is 'Artist One'
1617 print $ArtistThree->cds->count ## reponse is '2'
1619 For the arrayref of arrayrefs style, the first element should be a list of the
1620 fieldsnames to which the remaining elements are rows being inserted. For
1623 $Arstist_rs->populate([
1624 [qw/artistid name/],
1625 [100, 'A Formally Unknown Singer'],
1626 [101, 'A singer that jumped the shark two albums ago'],
1627 [102, 'An actually cool singer.'],
1630 Please note an important effect on your data when choosing between void and
1631 wantarray context. Since void context goes straight to C<insert_bulk> in
1632 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1633 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1634 create primary keys for you, you will find that your PKs are empty. In this
1635 case you will have to use the wantarray context in order to create those
1643 # cruft placed in standalone method
1644 my $data = $self->_normalize_populate_args(@_);
1646 if(defined wantarray) {
1648 foreach my $item (@$data) {
1649 push(@created, $self->create($item));
1651 return wantarray ? @created : \@created;
1653 my $first = $data->[0];
1655 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1656 # it relationship data
1657 my (@rels, @columns);
1658 for (keys %$first) {
1659 my $ref = ref $first->{$_};
1660 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1666 my @pks = $self->result_source->primary_columns;
1668 ## do the belongs_to relationships
1669 foreach my $index (0..$#$data) {
1671 # delegate to create() for any dataset without primary keys with specified relationships
1672 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1674 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1675 my @ret = $self->populate($data);
1681 foreach my $rel (@rels) {
1682 next unless ref $data->[$index]->{$rel} eq "HASH";
1683 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1684 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1685 my $related = $result->result_source->_resolve_condition(
1686 $result->result_source->relationship_info($reverse)->{cond},
1691 delete $data->[$index]->{$rel};
1692 $data->[$index] = {%{$data->[$index]}, %$related};
1694 push @columns, keys %$related if $index == 0;
1698 ## inherit the data locked in the conditions of the resultset
1699 my ($rs_data) = $self->_merge_cond_with_data({});
1700 delete @{$rs_data}{@columns};
1701 my @inherit_cols = keys %$rs_data;
1702 my @inherit_data = values %$rs_data;
1704 ## do bulk insert on current row
1705 $self->result_source->storage->insert_bulk(
1706 $self->result_source,
1707 [@columns, @inherit_cols],
1708 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
1711 ## do the has_many relationships
1712 foreach my $item (@$data) {
1714 foreach my $rel (@rels) {
1715 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1717 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1718 || $self->throw_exception('Cannot find the relating object.');
1720 my $child = $parent->$rel;
1722 my $related = $child->result_source->_resolve_condition(
1723 $parent->result_source->relationship_info($rel)->{cond},
1728 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1729 my @populate = map { {%$_, %$related} } @rows_to_add;
1731 $child->populate( \@populate );
1738 # populate() argumnets went over several incarnations
1739 # What we ultimately support is AoH
1740 sub _normalize_populate_args {
1741 my ($self, $arg) = @_;
1743 if (ref $arg eq 'ARRAY') {
1744 if (ref $arg->[0] eq 'HASH') {
1747 elsif (ref $arg->[0] eq 'ARRAY') {
1749 my @colnames = @{$arg->[0]};
1750 foreach my $values (@{$arg}[1 .. $#$arg]) {
1751 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
1757 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
1764 =item Arguments: none
1766 =item Return Value: $pager
1770 Return Value a L<Data::Page> object for the current resultset. Only makes
1771 sense for queries with a C<page> attribute.
1773 To get the full count of entries for a paged resultset, call
1774 C<total_entries> on the L<Data::Page> object.
1781 return $self->{pager} if $self->{pager};
1783 my $attrs = $self->{attrs};
1784 $self->throw_exception("Can't create pager for non-paged rs")
1785 unless $self->{attrs}{page};
1786 $attrs->{rows} ||= 10;
1788 # throw away the paging flags and re-run the count (possibly
1789 # with a subselect) to get the real total count
1790 my $count_attrs = { %$attrs };
1791 delete $count_attrs->{$_} for qw/rows offset page pager/;
1792 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1794 return $self->{pager} = Data::Page->new(
1797 $self->{attrs}{page}
1805 =item Arguments: $page_number
1807 =item Return Value: $rs
1811 Returns a resultset for the $page_number page of the resultset on which page
1812 is called, where each page contains a number of rows equal to the 'rows'
1813 attribute set on the resultset (10 by default).
1818 my ($self, $page) = @_;
1819 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1826 =item Arguments: \%vals
1828 =item Return Value: $rowobject
1832 Creates a new row object in the resultset's result class and returns
1833 it. The row is not inserted into the database at this point, call
1834 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1835 will tell you whether the row object has been inserted or not.
1837 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1842 my ($self, $values) = @_;
1843 $self->throw_exception( "new_result needs a hash" )
1844 unless (ref $values eq 'HASH');
1846 my ($merged_cond, $cols_from_relations) = $self->_merge_cond_with_data($values);
1850 @$cols_from_relations
1851 ? (-cols_from_relations => $cols_from_relations)
1853 -source_handle => $self->_source_handle,
1854 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1857 return $self->result_class->new(\%new);
1860 # _merge_cond_with_data
1862 # Takes a simple hash of K/V data and returns its copy merged with the
1863 # condition already present on the resultset. Additionally returns an
1864 # arrayref of value/condition names, which were inferred from related
1865 # objects (this is needed for in-memory related objects)
1866 sub _merge_cond_with_data {
1867 my ($self, $data) = @_;
1869 my (%new_data, @cols_from_relations);
1871 my $alias = $self->{attrs}{alias};
1873 if (! defined $self->{cond}) {
1874 # just massage $data below
1876 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
1877 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1878 @cols_from_relations = keys %new_data;
1880 elsif (ref $self->{cond} ne 'HASH') {
1881 $self->throw_exception(
1882 "Can't abstract implicit construct, resultset condition not a hash"
1886 # precendence must be given to passed values over values inherited from
1887 # the cond, so the order here is important.
1888 my $collapsed_cond = $self->_collapse_cond($self->{cond});
1889 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1891 while ( my($col, $value) = each %implied ) {
1892 if (ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '=') {
1893 $new_data{$col} = $value->{'='};
1896 $new_data{$col} = $value if $self->_is_deterministic_value($value);
1902 %{ $self->_remove_alias($data, $alias) },
1905 return (\%new_data, \@cols_from_relations);
1908 # _is_deterministic_value
1910 # Make an effor to strip non-deterministic values from the condition,
1911 # to make sure new_result chokes less
1913 sub _is_deterministic_value {
1916 my $ref_type = ref $value;
1917 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1918 return 1 if Scalar::Util::blessed($value);
1922 # _has_resolved_attr
1924 # determines if the resultset defines at least one
1925 # of the attributes supplied
1927 # used to determine if a subquery is neccessary
1929 # supports some virtual attributes:
1931 # This will scan for any joins being present on the resultset.
1932 # It is not a mere key-search but a deep inspection of {from}
1935 sub _has_resolved_attr {
1936 my ($self, @attr_names) = @_;
1938 my $attrs = $self->_resolved_attrs;
1942 for my $n (@attr_names) {
1943 if (grep { $n eq $_ } (qw/-join/) ) {
1944 $extra_checks{$n}++;
1948 my $attr = $attrs->{$n};
1950 next if not defined $attr;
1952 if (ref $attr eq 'HASH') {
1953 return 1 if keys %$attr;
1955 elsif (ref $attr eq 'ARRAY') {
1963 # a resolved join is expressed as a multi-level from
1965 $extra_checks{-join}
1967 ref $attrs->{from} eq 'ARRAY'
1969 @{$attrs->{from}} > 1
1977 # Recursively collapse the condition.
1979 sub _collapse_cond {
1980 my ($self, $cond, $collapsed) = @_;
1984 if (ref $cond eq 'ARRAY') {
1985 foreach my $subcond (@$cond) {
1986 next unless ref $subcond; # -or
1987 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1990 elsif (ref $cond eq 'HASH') {
1991 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1992 foreach my $subcond (@{$cond->{-and}}) {
1993 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1997 foreach my $col (keys %$cond) {
1998 my $value = $cond->{$col};
1999 $collapsed->{$col} = $value;
2009 # Remove the specified alias from the specified query hash. A copy is made so
2010 # the original query is not modified.
2013 my ($self, $query, $alias) = @_;
2015 my %orig = %{ $query || {} };
2018 foreach my $key (keys %orig) {
2020 $unaliased{$key} = $orig{$key};
2023 $unaliased{$1} = $orig{$key}
2024 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2034 =item Arguments: none
2036 =item Return Value: \[ $sql, @bind ]
2040 Returns the SQL query and bind vars associated with the invocant.
2042 This is generally used as the RHS for a subquery.
2049 my $attrs = $self->_resolved_attrs_copy;
2054 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2055 # $sql also has no wrapping parenthesis in list ctx
2057 my $sqlbind = $self->result_source->storage
2058 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2067 =item Arguments: \%vals, \%attrs?
2069 =item Return Value: $rowobject
2073 my $artist = $schema->resultset('Artist')->find_or_new(
2074 { artist => 'fred' }, { key => 'artists' });
2076 $cd->cd_to_producer->find_or_new({ producer => $producer },
2077 { key => 'primary });
2079 Find an existing record from this resultset, based on its primary
2080 key, or a unique constraint. If none exists, instantiate a new result
2081 object and return it. The object will not be saved into your storage
2082 until you call L<DBIx::Class::Row/insert> on it.
2084 You most likely want this method when looking for existing rows using
2085 a unique constraint that is not the primary key, or looking for
2088 If you want objects to be saved immediately, use L</find_or_create>
2091 B<Note>: Take care when using C<find_or_new> with a table having
2092 columns with default values that you intend to be automatically
2093 supplied by the database (e.g. an auto_increment primary key column).
2094 In normal usage, the value of such columns should NOT be included at
2095 all in the call to C<find_or_new>, even when set to C<undef>.
2101 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2102 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2103 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2106 return $self->new_result($hash);
2113 =item Arguments: \%vals
2115 =item Return Value: a L<DBIx::Class::Row> $object
2119 Attempt to create a single new row or a row with multiple related rows
2120 in the table represented by the resultset (and related tables). This
2121 will not check for duplicate rows before inserting, use
2122 L</find_or_create> to do that.
2124 To create one row for this resultset, pass a hashref of key/value
2125 pairs representing the columns of the table and the values you wish to
2126 store. If the appropriate relationships are set up, foreign key fields
2127 can also be passed an object representing the foreign row, and the
2128 value will be set to its primary key.
2130 To create related objects, pass a hashref of related-object column values
2131 B<keyed on the relationship name>. If the relationship is of type C<multi>
2132 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2133 The process will correctly identify columns holding foreign keys, and will
2134 transparrently populate them from the keys of the corresponding relation.
2135 This can be applied recursively, and will work correctly for a structure
2136 with an arbitrary depth and width, as long as the relationships actually
2137 exists and the correct column data has been supplied.
2140 Instead of hashrefs of plain related data (key/value pairs), you may
2141 also pass new or inserted objects. New objects (not inserted yet, see
2142 L</new>), will be inserted into their appropriate tables.
2144 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2146 Example of creating a new row.
2148 $person_rs->create({
2149 name=>"Some Person",
2150 email=>"somebody@someplace.com"
2153 Example of creating a new row and also creating rows in a related C<has_many>
2154 or C<has_one> resultset. Note Arrayref.
2157 { artistid => 4, name => 'Manufactured Crap', cds => [
2158 { title => 'My First CD', year => 2006 },
2159 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2164 Example of creating a new row and also creating a row in a related
2165 C<belongs_to>resultset. Note Hashref.
2168 title=>"Music for Silly Walks",
2171 name=>"Silly Musician",
2179 When subclassing ResultSet never attempt to override this method. Since
2180 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2181 lot of the internals simply never call it, so your override will be
2182 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2183 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2184 L</create> process you need to intervene.
2191 my ($self, $attrs) = @_;
2192 $self->throw_exception( "create needs a hashref" )
2193 unless ref $attrs eq 'HASH';
2194 return $self->new_result($attrs)->insert;
2197 =head2 find_or_create
2201 =item Arguments: \%vals, \%attrs?
2203 =item Return Value: $rowobject
2207 $cd->cd_to_producer->find_or_create({ producer => $producer },
2208 { key => 'primary' });
2210 Tries to find a record based on its primary key or unique constraints; if none
2211 is found, creates one and returns that instead.
2213 my $cd = $schema->resultset('CD')->find_or_create({
2215 artist => 'Massive Attack',
2216 title => 'Mezzanine',
2220 Also takes an optional C<key> attribute, to search by a specific key or unique
2221 constraint. For example:
2223 my $cd = $schema->resultset('CD')->find_or_create(
2225 artist => 'Massive Attack',
2226 title => 'Mezzanine',
2228 { key => 'cd_artist_title' }
2231 B<Note>: Because find_or_create() reads from the database and then
2232 possibly inserts based on the result, this method is subject to a race
2233 condition. Another process could create a record in the table after
2234 the find has completed and before the create has started. To avoid
2235 this problem, use find_or_create() inside a transaction.
2237 B<Note>: Take care when using C<find_or_create> with a table having
2238 columns with default values that you intend to be automatically
2239 supplied by the database (e.g. an auto_increment primary key column).
2240 In normal usage, the value of such columns should NOT be included at
2241 all in the call to C<find_or_create>, even when set to C<undef>.
2243 See also L</find> and L</update_or_create>. For information on how to declare
2244 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2248 sub find_or_create {
2250 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2251 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2252 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2255 return $self->create($hash);
2258 =head2 update_or_create
2262 =item Arguments: \%col_values, { key => $unique_constraint }?
2264 =item Return Value: $rowobject
2268 $resultset->update_or_create({ col => $val, ... });
2270 First, searches for an existing row matching one of the unique constraints
2271 (including the primary key) on the source of this resultset. If a row is
2272 found, updates it with the other given column values. Otherwise, creates a new
2275 Takes an optional C<key> attribute to search on a specific unique constraint.
2278 # In your application
2279 my $cd = $schema->resultset('CD')->update_or_create(
2281 artist => 'Massive Attack',
2282 title => 'Mezzanine',
2285 { key => 'cd_artist_title' }
2288 $cd->cd_to_producer->update_or_create({
2289 producer => $producer,
2296 If no C<key> is specified, it searches on all unique constraints defined on the
2297 source, including the primary key.
2299 If the C<key> is specified as C<primary>, it searches only on the primary key.
2301 See also L</find> and L</find_or_create>. For information on how to declare
2302 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2304 B<Note>: Take care when using C<update_or_create> with a table having
2305 columns with default values that you intend to be automatically
2306 supplied by the database (e.g. an auto_increment primary key column).
2307 In normal usage, the value of such columns should NOT be included at
2308 all in the call to C<update_or_create>, even when set to C<undef>.
2312 sub update_or_create {
2314 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2315 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2317 my $row = $self->find($cond, $attrs);
2319 $row->update($cond);
2323 return $self->create($cond);
2326 =head2 update_or_new
2330 =item Arguments: \%col_values, { key => $unique_constraint }?
2332 =item Return Value: $rowobject
2336 $resultset->update_or_new({ col => $val, ... });
2338 First, searches for an existing row matching one of the unique constraints
2339 (including the primary key) on the source of this resultset. If a row is
2340 found, updates it with the other given column values. Otherwise, instantiate
2341 a new result object and return it. The object will not be saved into your storage
2342 until you call L<DBIx::Class::Row/insert> on it.
2344 Takes an optional C<key> attribute to search on a specific unique constraint.
2347 # In your application
2348 my $cd = $schema->resultset('CD')->update_or_new(
2350 artist => 'Massive Attack',
2351 title => 'Mezzanine',
2354 { key => 'cd_artist_title' }
2357 if ($cd->in_storage) {
2358 # the cd was updated
2361 # the cd is not yet in the database, let's insert it
2365 B<Note>: Take care when using C<update_or_new> with a table having
2366 columns with default values that you intend to be automatically
2367 supplied by the database (e.g. an auto_increment primary key column).
2368 In normal usage, the value of such columns should NOT be included at
2369 all in the call to C<update_or_new>, even when set to C<undef>.
2371 See also L</find>, L</find_or_create> and L</find_or_new>.
2377 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2378 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2380 my $row = $self->find( $cond, $attrs );
2381 if ( defined $row ) {
2382 $row->update($cond);
2386 return $self->new_result($cond);
2393 =item Arguments: none
2395 =item Return Value: \@cache_objects?
2399 Gets the contents of the cache for the resultset, if the cache is set.
2401 The cache is populated either by using the L</prefetch> attribute to
2402 L</search> or by calling L</set_cache>.
2414 =item Arguments: \@cache_objects
2416 =item Return Value: \@cache_objects
2420 Sets the contents of the cache for the resultset. Expects an arrayref
2421 of objects of the same class as those produced by the resultset. Note that
2422 if the cache is set the resultset will return the cached objects rather
2423 than re-querying the database even if the cache attr is not set.
2425 The contents of the cache can also be populated by using the
2426 L</prefetch> attribute to L</search>.
2431 my ( $self, $data ) = @_;
2432 $self->throw_exception("set_cache requires an arrayref")
2433 if defined($data) && (ref $data ne 'ARRAY');
2434 $self->{all_cache} = $data;
2441 =item Arguments: none
2443 =item Return Value: []
2447 Clears the cache for the resultset.
2452 shift->set_cache(undef);
2459 =item Arguments: none
2461 =item Return Value: true, if the resultset has been paginated
2469 return !!$self->{attrs}{page};
2472 =head2 related_resultset
2476 =item Arguments: $relationship_name
2478 =item Return Value: $resultset
2482 Returns a related resultset for the supplied relationship name.
2484 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2488 sub related_resultset {
2489 my ($self, $rel) = @_;
2491 $self->{related_resultsets} ||= {};
2492 return $self->{related_resultsets}{$rel} ||= do {
2493 my $rsrc = $self->result_source;
2494 my $rel_info = $rsrc->relationship_info($rel);
2496 $self->throw_exception(
2497 "search_related: result source '" . $rsrc->source_name .
2498 "' has no such relationship $rel")
2501 my $attrs = $self->_chain_relationship($rel);
2503 my $join_count = $attrs->{seen_join}{$rel};
2505 my $alias = $self->result_source->storage
2506 ->relname_to_table_alias($rel, $join_count);
2508 # since this is search_related, and we already slid the select window inwards
2509 # (the select/as attrs were deleted in the beginning), we need to flip all
2510 # left joins to inner, so we get the expected results
2511 # read the comment on top of the actual function to see what this does
2512 $attrs->{from} = $rsrc->schema->storage->_straight_join_to_node ($attrs->{from}, $alias);
2515 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2516 delete @{$attrs}{qw(result_class alias)};
2520 if (my $cache = $self->get_cache) {
2521 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2522 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2527 my $rel_source = $rsrc->related_source($rel);
2531 # The reason we do this now instead of passing the alias to the
2532 # search_rs below is that if you wrap/overload resultset on the
2533 # source you need to know what alias it's -going- to have for things
2534 # to work sanely (e.g. RestrictWithObject wants to be able to add
2535 # extra query restrictions, and these may need to be $alias.)
2537 my $rel_attrs = $rel_source->resultset_attributes;
2538 local $rel_attrs->{alias} = $alias;
2540 $rel_source->resultset
2544 where => $attrs->{where},
2547 $new->set_cache($new_cache) if $new_cache;
2552 =head2 current_source_alias
2556 =item Arguments: none
2558 =item Return Value: $source_alias
2562 Returns the current table alias for the result source this resultset is built
2563 on, that will be used in the SQL query. Usually it is C<me>.
2565 Currently the source alias that refers to the result set returned by a
2566 L</search>/L</find> family method depends on how you got to the resultset: it's
2567 C<me> by default, but eg. L</search_related> aliases it to the related result
2568 source name (and keeps C<me> referring to the original result set). The long
2569 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2570 (and make this method unnecessary).
2572 Thus it's currently necessary to use this method in predefined queries (see
2573 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2574 source alias of the current result set:
2576 # in a result set class
2578 my ($self, $user) = @_;
2580 my $me = $self->current_source_alias;
2582 return $self->search(
2583 "$me.modified" => $user->id,
2589 sub current_source_alias {
2592 return ($self->{attrs} || {})->{alias} || 'me';
2595 # This code is called by search_related, and makes sure there
2596 # is clear separation between the joins before, during, and
2597 # after the relationship. This information is needed later
2598 # in order to properly resolve prefetch aliases (any alias
2599 # with a relation_chain_depth less than the depth of the
2600 # current prefetch is not considered)
2602 # The increments happen twice per join. An even number means a
2603 # relationship specified via a search_related, whereas an odd
2604 # number indicates a join/prefetch added via attributes
2606 # Also this code will wrap the current resultset (the one we
2607 # chain to) in a subselect IFF it contains limiting attributes
2608 sub _chain_relationship {
2609 my ($self, $rel) = @_;
2610 my $source = $self->result_source;
2611 my $attrs = { %{$self->{attrs}||{}} };
2613 # we need to take the prefetch the attrs into account before we
2614 # ->_resolve_join as otherwise they get lost - captainL
2615 my $join = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2617 delete @{$attrs}{qw/join prefetch collapse distinct select as columns +select +as +columns/};
2619 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
2622 my @force_subq_attrs = qw/offset rows group_by having/;
2625 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
2627 $self->_has_resolved_attr (@force_subq_attrs)
2629 # Nuke the prefetch (if any) before the new $rs attrs
2630 # are resolved (prefetch is useless - we are wrapping
2631 # a subquery anyway).
2632 my $rs_copy = $self->search;
2633 $rs_copy->{attrs}{join} = $self->_merge_attr (
2634 $rs_copy->{attrs}{join},
2635 delete $rs_copy->{attrs}{prefetch},
2639 -source_handle => $source->handle,
2640 -alias => $attrs->{alias},
2641 $attrs->{alias} => $rs_copy->as_query,
2643 delete @{$attrs}{@force_subq_attrs, 'where'};
2644 $seen->{-relation_chain_depth} = 0;
2646 elsif ($attrs->{from}) { #shallow copy suffices
2647 $from = [ @{$attrs->{from}} ];
2651 -source_handle => $source->handle,
2652 -alias => $attrs->{alias},
2653 $attrs->{alias} => $source->from,
2657 my $jpath = ($seen->{-relation_chain_depth})
2658 ? $from->[-1][0]{-join_path}
2661 my @requested_joins = $source->_resolve_join(
2668 push @$from, @requested_joins;
2670 $seen->{-relation_chain_depth}++;
2672 # if $self already had a join/prefetch specified on it, the requested
2673 # $rel might very well be already included. What we do in this case
2674 # is effectively a no-op (except that we bump up the chain_depth on
2675 # the join in question so we could tell it *is* the search_related)
2678 # we consider the last one thus reverse
2679 for my $j (reverse @requested_joins) {
2680 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
2681 if ($rel eq $last_j) {
2682 $j->[0]{-relation_chain_depth}++;
2688 unless ($already_joined) {
2689 push @$from, $source->_resolve_join(
2697 $seen->{-relation_chain_depth}++;
2699 return {%$attrs, from => $from, seen_join => $seen};
2702 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2703 sub _resolved_attrs_copy {
2705 return { %{$self->_resolved_attrs (@_)} };
2708 sub _resolved_attrs {
2710 return $self->{_attrs} if $self->{_attrs};
2712 my $attrs = { %{ $self->{attrs} || {} } };
2713 my $source = $self->result_source;
2714 my $alias = $attrs->{alias};
2716 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2719 # build columns (as long as select isn't set) into a set of as/select hashes
2720 unless ( $attrs->{select} ) {
2723 if ( ref $attrs->{columns} eq 'ARRAY' ) {
2724 @cols = @{ delete $attrs->{columns}}
2725 } elsif ( defined $attrs->{columns} ) {
2726 @cols = delete $attrs->{columns}
2728 @cols = $source->columns
2732 if ( ref $_ eq 'HASH' ) {
2735 my $key = /^\Q${alias}.\E(.+)$/
2741 push @colbits, { $key => $value };
2746 # add the additional columns on
2747 foreach (qw{include_columns +columns}) {
2748 if ( $attrs->{$_} ) {
2749 my @list = ( ref($attrs->{$_}) eq 'ARRAY' )
2750 ? @{ delete $attrs->{$_} }
2751 : delete $attrs->{$_};
2753 if ( ref($_) eq 'HASH' ) {
2756 my $key = ( split /\./, $_ )[-1];
2757 my $value = ( /\./ ? $_ : "$alias.$_" );
2758 push @colbits, { $key => $value };
2764 # start with initial select items
2765 if ( $attrs->{select} ) {
2767 ( ref $attrs->{select} eq 'ARRAY' )
2768 ? [ @{ $attrs->{select} } ]
2769 : [ $attrs->{select} ];
2771 if ( $attrs->{as} ) {
2774 ref $attrs->{as} eq 'ARRAY'
2775 ? [ @{ $attrs->{as} } ]
2779 $attrs->{as} = [ map {
2780 m/^\Q${alias}.\E(.+)$/
2783 } @{ $attrs->{select} }
2789 # otherwise we intialise select & as to empty
2790 $attrs->{select} = [];
2794 # now add colbits to select/as
2795 push @{ $attrs->{select} }, map values %{$_}, @colbits;
2796 push @{ $attrs->{as} }, map keys %{$_}, @colbits;
2798 if ( my $adds = delete $attrs->{'+select'} ) {
2799 $adds = [$adds] unless ref $adds eq 'ARRAY';
2800 push @{ $attrs->{select} },
2801 map { /\./ || ref $_ ? $_ : "$alias.$_" } @$adds;
2803 if ( my $adds = delete $attrs->{'+as'} ) {
2804 $adds = [$adds] unless ref $adds eq 'ARRAY';
2805 push @{ $attrs->{as} }, @$adds;
2808 $attrs->{from} ||= [{
2809 -source_handle => $source->handle,
2810 -alias => $self->{attrs}{alias},
2811 $self->{attrs}{alias} => $source->from,
2814 if ( $attrs->{join} || $attrs->{prefetch} ) {
2816 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2817 if ref $attrs->{from} ne 'ARRAY';
2819 my $join = delete $attrs->{join} || {};
2821 if ( defined $attrs->{prefetch} ) {
2822 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2825 $attrs->{from} = # have to copy here to avoid corrupting the original
2827 @{ $attrs->{from} },
2828 $source->_resolve_join(
2831 { %{ $attrs->{seen_join} || {} } },
2832 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
2833 ? $attrs->{from}[-1][0]{-join_path}
2840 if ( defined $attrs->{order_by} ) {
2841 $attrs->{order_by} = (
2842 ref( $attrs->{order_by} ) eq 'ARRAY'
2843 ? [ @{ $attrs->{order_by} } ]
2844 : [ $attrs->{order_by} || () ]
2848 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2849 $attrs->{group_by} = [ $attrs->{group_by} ];
2852 # generate the distinct induced group_by early, as prefetch will be carried via a
2853 # subquery (since a group_by is present)
2854 if (delete $attrs->{distinct}) {
2855 if ($attrs->{group_by}) {
2856 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2859 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2861 # add any order_by parts that are not already present in the group_by
2862 # we need to be careful not to add any named functions/aggregates
2863 # i.e. select => [ ... { count => 'foo', -as 'foocount' } ... ]
2864 my %already_grouped = map { $_ => 1 } (@{$attrs->{group_by}});
2866 my $storage = $self->result_source->schema->storage;
2868 my $rs_column_list = $storage->_resolve_column_info ($attrs->{from});
2870 for my $chunk ($storage->_parse_order_by($attrs->{order_by})) {
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 # this is a separate structure (we don't look in {from} directly)
2885 # as the resolver needs to shift things off the lists to work
2886 # properly (identical-prefetches on different branches)
2888 if (ref $attrs->{from} eq 'ARRAY') {
2890 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
2892 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
2893 next unless $j->[0]{-alias};
2894 next unless $j->[0]{-join_path};
2895 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
2897 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
2900 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
2901 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2906 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2908 # we need to somehow mark which columns came from prefetch
2909 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2911 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2912 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2914 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2915 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2918 # if both page and offset are specified, produce a combined offset
2919 # even though it doesn't make much sense, this is what pre 081xx has
2921 if (my $page = delete $attrs->{page}) {
2923 ($attrs->{rows} * ($page - 1))
2925 ($attrs->{offset} || 0)
2929 return $self->{_attrs} = $attrs;
2933 my ($self, $attr) = @_;
2935 if (ref $attr eq 'HASH') {
2936 return $self->_rollout_hash($attr);
2937 } elsif (ref $attr eq 'ARRAY') {
2938 return $self->_rollout_array($attr);
2944 sub _rollout_array {
2945 my ($self, $attr) = @_;
2948 foreach my $element (@{$attr}) {
2949 if (ref $element eq 'HASH') {
2950 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2951 } elsif (ref $element eq 'ARRAY') {
2952 # XXX - should probably recurse here
2953 push( @rolled_array, @{$self->_rollout_array($element)} );
2955 push( @rolled_array, $element );
2958 return \@rolled_array;
2962 my ($self, $attr) = @_;
2965 foreach my $key (keys %{$attr}) {
2966 push( @rolled_array, { $key => $attr->{$key} } );
2968 return \@rolled_array;
2971 sub _calculate_score {
2972 my ($self, $a, $b) = @_;
2974 if (defined $a xor defined $b) {
2977 elsif (not defined $a) {
2981 if (ref $b eq 'HASH') {
2982 my ($b_key) = keys %{$b};
2983 if (ref $a eq 'HASH') {
2984 my ($a_key) = keys %{$a};
2985 if ($a_key eq $b_key) {
2986 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2991 return ($a eq $b_key) ? 1 : 0;
2994 if (ref $a eq 'HASH') {
2995 my ($a_key) = keys %{$a};
2996 return ($b eq $a_key) ? 1 : 0;
2998 return ($b eq $a) ? 1 : 0;
3004 my ($self, $orig, $import) = @_;
3006 return $import unless defined($orig);
3007 return $orig unless defined($import);
3009 $orig = $self->_rollout_attr($orig);
3010 $import = $self->_rollout_attr($import);
3013 foreach my $import_element ( @{$import} ) {
3014 # find best candidate from $orig to merge $b_element into
3015 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3016 foreach my $orig_element ( @{$orig} ) {
3017 my $score = $self->_calculate_score( $orig_element, $import_element );
3018 if ($score > $best_candidate->{score}) {
3019 $best_candidate->{position} = $position;
3020 $best_candidate->{score} = $score;
3024 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3026 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3027 push( @{$orig}, $import_element );
3029 my $orig_best = $orig->[$best_candidate->{position}];
3030 # merge orig_best and b_element together and replace original with merged
3031 if (ref $orig_best ne 'HASH') {
3032 $orig->[$best_candidate->{position}] = $import_element;
3033 } elsif (ref $import_element eq 'HASH') {
3034 my ($key) = keys %{$orig_best};
3035 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3038 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3048 $self->_source_handle($_[0]->handle);
3050 $self->_source_handle->resolve;
3054 =head2 throw_exception
3056 See L<DBIx::Class::Schema/throw_exception> for details.
3060 sub throw_exception {
3063 if (ref $self && $self->_source_handle->schema) {
3064 $self->_source_handle->schema->throw_exception(@_)
3067 DBIx::Class::Exception->throw(@_);
3071 # XXX: FIXME: Attributes docs need clearing up
3075 Attributes are used to refine a ResultSet in various ways when
3076 searching for data. They can be passed to any method which takes an
3077 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3080 These are in no particular order:
3086 =item Value: ( $order_by | \@order_by | \%order_by )
3090 Which column(s) to order the results by.
3092 [The full list of suitable values is documented in
3093 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3096 If a single column name, or an arrayref of names is supplied, the
3097 argument is passed through directly to SQL. The hashref syntax allows
3098 for connection-agnostic specification of ordering direction:
3100 For descending order:
3102 order_by => { -desc => [qw/col1 col2 col3/] }
3104 For explicit ascending order:
3106 order_by => { -asc => 'col' }
3108 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3109 supported, although you are strongly encouraged to use the hashref
3110 syntax as outlined above.
3116 =item Value: \@columns
3120 Shortcut to request a particular set of columns to be retrieved. Each
3121 column spec may be a string (a table column name), or a hash (in which
3122 case the key is the C<as> value, and the value is used as the C<select>
3123 expression). Adds C<me.> onto the start of any column without a C<.> in
3124 it and sets C<select> from that, then auto-populates C<as> from
3125 C<select> as normal. (You may also use the C<cols> attribute, as in
3126 earlier versions of DBIC.)
3132 =item Value: \@columns
3136 Indicates additional columns to be selected from storage. Works the same
3137 as L</columns> but adds columns to the selection. (You may also use the
3138 C<include_columns> attribute, as in earlier versions of DBIC). For
3141 $schema->resultset('CD')->search(undef, {
3142 '+columns' => ['artist.name'],
3146 would return all CDs and include a 'name' column to the information
3147 passed to object inflation. Note that the 'artist' is the name of the
3148 column (or relationship) accessor, and 'name' is the name of the column
3149 accessor in the related table.
3151 =head2 include_columns
3155 =item Value: \@columns
3159 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3165 =item Value: \@select_columns
3169 Indicates which columns should be selected from the storage. You can use
3170 column names, or in the case of RDBMS back ends, function or stored procedure
3173 $rs = $schema->resultset('Employee')->search(undef, {
3176 { count => 'employeeid' },
3181 When you use function/stored procedure names and do not supply an C<as>
3182 attribute, the column names returned are storage-dependent. E.g. MySQL would
3183 return a column named C<count(employeeid)> in the above example.
3185 B<NOTE:> You will almost always need a corresponding 'as' entry when you use
3192 Indicates additional columns to be selected from storage. Works the same as
3193 L</select> but adds columns to the selection.
3201 Indicates additional column names for those added via L</+select>. See L</as>.
3209 =item Value: \@inflation_names
3213 Indicates column names for object inflation. That is, C<as>
3214 indicates the name that the column can be accessed as via the
3215 C<get_column> method (or via the object accessor, B<if one already
3216 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3218 The C<as> attribute is used in conjunction with C<select>,
3219 usually when C<select> contains one or more function or stored
3222 $rs = $schema->resultset('Employee')->search(undef, {
3225 { count => 'employeeid' }
3227 as => ['name', 'employee_count'],
3230 my $employee = $rs->first(); # get the first Employee
3232 If the object against which the search is performed already has an accessor
3233 matching a column name specified in C<as>, the value can be retrieved using
3234 the accessor as normal:
3236 my $name = $employee->name();
3238 If on the other hand an accessor does not exist in the object, you need to
3239 use C<get_column> instead:
3241 my $employee_count = $employee->get_column('employee_count');
3243 You can create your own accessors if required - see
3244 L<DBIx::Class::Manual::Cookbook> for details.
3246 Please note: This will NOT insert an C<AS employee_count> into the SQL
3247 statement produced, it is used for internal access only. Thus
3248 attempting to use the accessor in an C<order_by> clause or similar
3249 will fail miserably.
3251 To get around this limitation, you can supply literal SQL to your
3252 C<select> attibute that contains the C<AS alias> text, eg:
3254 select => [\'myfield AS alias']
3260 =item Value: ($rel_name | \@rel_names | \%rel_names)
3264 Contains a list of relationships that should be joined for this query. For
3267 # Get CDs by Nine Inch Nails
3268 my $rs = $schema->resultset('CD')->search(
3269 { 'artist.name' => 'Nine Inch Nails' },
3270 { join => 'artist' }
3273 Can also contain a hash reference to refer to the other relation's relations.
3276 package MyApp::Schema::Track;
3277 use base qw/DBIx::Class/;
3278 __PACKAGE__->table('track');
3279 __PACKAGE__->add_columns(qw/trackid cd position title/);
3280 __PACKAGE__->set_primary_key('trackid');
3281 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3284 # In your application
3285 my $rs = $schema->resultset('Artist')->search(
3286 { 'track.title' => 'Teardrop' },
3288 join => { cd => 'track' },
3289 order_by => 'artist.name',
3293 You need to use the relationship (not the table) name in conditions,
3294 because they are aliased as such. The current table is aliased as "me", so
3295 you need to use me.column_name in order to avoid ambiguity. For example:
3297 # Get CDs from 1984 with a 'Foo' track
3298 my $rs = $schema->resultset('CD')->search(
3301 'tracks.name' => 'Foo'
3303 { join => 'tracks' }
3306 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3307 similarly for a third time). For e.g.
3309 my $rs = $schema->resultset('Artist')->search({
3310 'cds.title' => 'Down to Earth',
3311 'cds_2.title' => 'Popular',
3313 join => [ qw/cds cds/ ],
3316 will return a set of all artists that have both a cd with title 'Down
3317 to Earth' and a cd with title 'Popular'.
3319 If you want to fetch related objects from other tables as well, see C<prefetch>
3322 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3328 =item Value: ($rel_name | \@rel_names | \%rel_names)
3332 Contains one or more relationships that should be fetched along with
3333 the main query (when they are accessed afterwards the data will
3334 already be available, without extra queries to the database). This is
3335 useful for when you know you will need the related objects, because it
3336 saves at least one query:
3338 my $rs = $schema->resultset('Tag')->search(
3347 The initial search results in SQL like the following:
3349 SELECT tag.*, cd.*, artist.* FROM tag
3350 JOIN cd ON tag.cd = cd.cdid
3351 JOIN artist ON cd.artist = artist.artistid
3353 L<DBIx::Class> has no need to go back to the database when we access the
3354 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3357 Simple prefetches will be joined automatically, so there is no need
3358 for a C<join> attribute in the above search.
3360 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3361 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3362 with an accessor type of 'single' or 'filter'). A more complex example that
3363 prefetches an artists cds, the tracks on those cds, and the tags associted
3364 with that artist is given below (assuming many-to-many from artists to tags):
3366 my $rs = $schema->resultset('Artist')->search(
3370 { cds => 'tracks' },
3371 { artist_tags => 'tags' }
3377 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3378 attributes will be ignored.
3380 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3381 exactly as you might expect.
3387 Prefetch uses the L</cache> to populate the prefetched relationships. This
3388 may or may not be what you want.
3392 If you specify a condition on a prefetched relationship, ONLY those
3393 rows that match the prefetched condition will be fetched into that relationship.
3394 This means that adding prefetch to a search() B<may alter> what is returned by
3395 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3397 my $artist_rs = $schema->resultset('Artist')->search({
3403 my $count = $artist_rs->first->cds->count;
3405 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3407 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3409 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3411 that cmp_ok() may or may not pass depending on the datasets involved. This
3412 behavior may or may not survive the 0.09 transition.
3424 Makes the resultset paged and specifies the page to retrieve. Effectively
3425 identical to creating a non-pages resultset and then calling ->page($page)
3428 If L<rows> attribute is not specified it defaults to 10 rows per page.
3430 When you have a paged resultset, L</count> will only return the number
3431 of rows in the page. To get the total, use the L</pager> and call
3432 C<total_entries> on it.
3442 Specifes the maximum number of rows for direct retrieval or the number of
3443 rows per page if the page attribute or method is used.
3449 =item Value: $offset
3453 Specifies the (zero-based) row number for the first row to be returned, or the
3454 of the first row of the first page if paging is used.
3460 =item Value: \@columns
3464 A arrayref of columns to group by. Can include columns of joined tables.
3466 group_by => [qw/ column1 column2 ... /]
3472 =item Value: $condition
3476 HAVING is a select statement attribute that is applied between GROUP BY and
3477 ORDER BY. It is applied to the after the grouping calculations have been
3480 having => { 'count(employee)' => { '>=', 100 } }
3486 =item Value: (0 | 1)
3490 Set to 1 to group by all columns. If the resultset already has a group_by
3491 attribute, this setting is ignored and an appropriate warning is issued.
3497 Adds to the WHERE clause.
3499 # only return rows WHERE deleted IS NULL for all searches
3500 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3502 Can be overridden by passing C<< { where => undef } >> as an attribute
3509 Set to 1 to cache search results. This prevents extra SQL queries if you
3510 revisit rows in your ResultSet:
3512 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3514 while( my $artist = $resultset->next ) {
3518 $rs->first; # without cache, this would issue a query
3520 By default, searches are not cached.
3522 For more examples of using these attributes, see
3523 L<DBIx::Class::Manual::Cookbook>.
3529 =item Value: ( 'update' | 'shared' )
3533 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT