1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Exception;
13 use DBIx::Class::ResultSetColumn;
14 use DBIx::Class::ResultSourceHandle;
17 use base qw/DBIx::Class/;
19 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
23 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
27 my $users_rs = $schema->resultset('User');
28 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
29 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
33 A ResultSet is an object which stores a set of conditions representing
34 a query. It is the backbone of DBIx::Class (i.e. the really
35 important/useful bit).
37 No SQL is executed on the database when a ResultSet is created, it
38 just stores all the conditions needed to create the query.
40 A basic ResultSet representing the data of an entire table is returned
41 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
42 L<Source|DBIx::Class::Manual::Glossary/Source> name.
44 my $users_rs = $schema->resultset('User');
46 A new ResultSet is returned from calling L</search> on an existing
47 ResultSet. The new one will contain all the conditions of the
48 original, plus any new conditions added in the C<search> call.
50 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
51 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
54 The query that the ResultSet represents is B<only> executed against
55 the database when these methods are called:
56 L</find> L</next> L</all> L</first> L</single> L</count>
60 =head2 Chaining resultsets
62 Let's say you've got a query that needs to be run to return some data
63 to the user. But, you have an authorization system in place that
64 prevents certain users from seeing certain information. So, you want
65 to construct the basic query in one method, but add constraints to it in
70 my $request = $self->get_request; # Get a request object somehow.
71 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
73 my $cd_rs = $schema->resultset('CD')->search({
74 title => $request->param('title'),
75 year => $request->param('year'),
78 $self->apply_security_policy( $cd_rs );
83 sub apply_security_policy {
92 =head3 Resolving conditions and attributes
94 When a resultset is chained from another resultset, conditions and
95 attributes with the same keys need resolving.
97 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
98 into the existing ones from the original resultset.
100 The L</where>, L</having> attribute, and any search conditions are
101 merged with an SQL C<AND> to the existing condition from the original
104 All other attributes are overridden by any new ones supplied in the
107 =head2 Multiple queries
109 Since a resultset just defines a query, you can do all sorts of
110 things with it with the same object.
112 # Don't hit the DB yet.
113 my $cd_rs = $schema->resultset('CD')->search({
114 title => 'something',
118 # Each of these hits the DB individually.
119 my $count = $cd_rs->count;
120 my $most_recent = $cd_rs->get_column('date_released')->max();
121 my @records = $cd_rs->all;
123 And it's not just limited to SELECT statements.
129 $cd_rs->create({ artist => 'Fred' });
131 Which is the same as:
133 $schema->resultset('CD')->create({
134 title => 'something',
139 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
143 If a resultset is used in a numeric context it returns the L</count>.
144 However, if it is used in a booleand context it is always true. So if
145 you want to check if a resultset has any results use C<if $rs != 0>.
146 C<if $rs> will always be true.
154 =item Arguments: $source, \%$attrs
156 =item Return Value: $rs
160 The resultset constructor. Takes a source object (usually a
161 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
162 L</ATTRIBUTES> below). Does not perform any queries -- these are
163 executed as needed by the other methods.
165 Generally you won't need to construct a resultset manually. You'll
166 automatically get one from e.g. a L</search> called in scalar context:
168 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
170 IMPORTANT: If called on an object, proxies to new_result instead so
172 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
174 will return a CD object, not a ResultSet.
180 return $class->new_result(@_) if ref $class;
182 my ($source, $attrs) = @_;
183 $source = $source->handle
184 unless $source->isa('DBIx::Class::ResultSourceHandle');
185 $attrs = { %{$attrs||{}} };
187 if ($attrs->{page}) {
188 $attrs->{rows} ||= 10;
191 $attrs->{alias} ||= 'me';
193 # Creation of {} and bless separated to mitigate RH perl bug
194 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
196 _source_handle => $source,
197 cond => $attrs->{where},
206 $attrs->{result_class} || $source->resolve->result_class
216 =item Arguments: $cond, \%attrs?
218 =item Return Value: $resultset (scalar context), @row_objs (list context)
222 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
223 my $new_rs = $cd_rs->search({ year => 2005 });
225 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
226 # year = 2005 OR year = 2004
228 If you need to pass in additional attributes but no additional condition,
229 call it as C<search(undef, \%attrs)>.
231 # "SELECT name, artistid FROM $artist_table"
232 my @all_artists = $schema->resultset('Artist')->search(undef, {
233 columns => [qw/name artistid/],
236 For a list of attributes that can be passed to C<search>, see
237 L</ATTRIBUTES>. For more examples of using this function, see
238 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
239 documentation for the first argument, see L<SQL::Abstract>.
241 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
247 my $rs = $self->search_rs( @_ );
248 return (wantarray ? $rs->all : $rs);
255 =item Arguments: $cond, \%attrs?
257 =item Return Value: $resultset
261 This method does the same exact thing as search() except it will
262 always return a resultset, even in list context.
269 # Special-case handling for (undef, undef).
270 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
275 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
276 my $our_attrs = { %{$self->{attrs}} };
277 my $having = delete $our_attrs->{having};
278 my $where = delete $our_attrs->{where};
282 my %safe = (alias => 1, cache => 1);
285 (@_ && defined($_[0])) # @_ == () or (undef)
287 (keys %$attrs # empty attrs or only 'safe' attrs
288 && List::Util::first { !$safe{$_} } keys %$attrs)
290 # no search, effectively just a clone
291 $rows = $self->get_cache;
294 my $new_attrs = { %{$our_attrs}, %{$attrs} };
296 # merge new attrs into inherited
297 foreach my $key (qw/join prefetch +select +as bind/) {
298 next unless exists $attrs->{$key};
299 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
304 (@_ == 1 || ref $_[0] eq "HASH")
306 (ref $_[0] eq 'HASH')
308 (keys %{ $_[0] } > 0)
316 ? $self->throw_exception("Odd number of arguments to search")
323 if (defined $where) {
324 $new_attrs->{where} = (
325 defined $new_attrs->{where}
328 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
329 } $where, $new_attrs->{where}
336 $new_attrs->{where} = (
337 defined $new_attrs->{where}
340 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
341 } $cond, $new_attrs->{where}
347 if (defined $having) {
348 $new_attrs->{having} = (
349 defined $new_attrs->{having}
352 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
353 } $having, $new_attrs->{having}
359 my $rs = (ref $self)->new($self->result_source, $new_attrs);
361 $rs->set_cache($rows);
366 =head2 search_literal
370 =item Arguments: $sql_fragment, @bind_values
372 =item Return Value: $resultset (scalar context), @row_objs (list context)
376 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
377 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
379 Pass a literal chunk of SQL to be added to the conditional part of the
382 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
383 only be used in that context. C<search_literal> is a convenience method.
384 It is equivalent to calling $schema->search(\[]), but if you want to ensure
385 columns are bound correctly, use C<search>.
387 Example of how to use C<search> instead of C<search_literal>
389 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
390 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
393 See L<DBIx::Class::Manual::Cookbook/Searching> and
394 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
395 require C<search_literal>.
400 my ($self, $sql, @bind) = @_;
402 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
405 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
412 =item Arguments: @values | \%cols, \%attrs?
414 =item Return Value: $row_object | undef
418 Finds a row based on its primary key or unique constraint. For example, to find
419 a row by its primary key:
421 my $cd = $schema->resultset('CD')->find(5);
423 You can also find a row by a specific unique constraint using the C<key>
424 attribute. For example:
426 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
427 key => 'cd_artist_title'
430 Additionally, you can specify the columns explicitly by name:
432 my $cd = $schema->resultset('CD')->find(
434 artist => 'Massive Attack',
435 title => 'Mezzanine',
437 { key => 'cd_artist_title' }
440 If the C<key> is specified as C<primary>, it searches only on the primary key.
442 If no C<key> is specified, it searches on all unique constraints defined on the
443 source for which column data is provided, including the primary key.
445 If your table does not have a primary key, you B<must> provide a value for the
446 C<key> attribute matching one of the unique constraints on the source.
448 In addition to C<key>, L</find> recognizes and applies standard
449 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
451 Note: If your query does not return only one row, a warning is generated:
453 Query returned more than one row
455 See also L</find_or_create> and L</update_or_create>. For information on how to
456 declare unique constraints, see
457 L<DBIx::Class::ResultSource/add_unique_constraint>.
463 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
465 # Default to the primary key, but allow a specific key
466 my @cols = exists $attrs->{key}
467 ? $self->result_source->unique_constraint_columns($attrs->{key})
468 : $self->result_source->primary_columns;
469 $self->throw_exception(
470 "Can't find unless a primary key is defined or unique constraint is specified"
473 # Parse out a hashref from input
475 if (ref $_[0] eq 'HASH') {
476 $input_query = { %{$_[0]} };
478 elsif (@_ == @cols) {
480 @{$input_query}{@cols} = @_;
483 # Compatibility: Allow e.g. find(id => $value)
484 carp "Find by key => value deprecated; please use a hashref instead";
488 my (%related, $info);
490 KEY: foreach my $key (keys %$input_query) {
491 if (ref($input_query->{$key})
492 && ($info = $self->result_source->relationship_info($key))) {
493 my $val = delete $input_query->{$key};
494 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
495 my $rel_q = $self->result_source->_resolve_condition(
496 $info->{cond}, $val, $key
498 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
499 @related{keys %$rel_q} = values %$rel_q;
502 if (my @keys = keys %related) {
503 @{$input_query}{@keys} = values %related;
507 # Build the final query: Default to the disjunction of the unique queries,
508 # but allow the input query in case the ResultSet defines the query or the
509 # user is abusing find
510 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
512 if (exists $attrs->{key}) {
513 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
514 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
515 $query = $self->_add_alias($unique_query, $alias);
517 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
518 # This means that we got here after a merger of relationship conditions
519 # in ::Relationship::Base::search_related (the row method), and furthermore
520 # the relationship is of the 'single' type. This means that the condition
521 # provided by the relationship (already attached to $self) is sufficient,
522 # as there can be only one row in the databse that would satisfy the
526 my @unique_queries = $self->_unique_queries($input_query, $attrs);
527 $query = @unique_queries
528 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
529 : $self->_add_alias($input_query, $alias);
533 my $rs = $self->search ($query, $attrs);
534 if (keys %{$rs->_resolved_attrs->{collapse}}) {
536 carp "Query returned more than one row" if $rs->next;
546 # Add the specified alias to the specified query hash. A copy is made so the
547 # original query is not modified.
550 my ($self, $query, $alias) = @_;
552 my %aliased = %$query;
553 foreach my $col (grep { ! m/\./ } keys %aliased) {
554 $aliased{"$alias.$col"} = delete $aliased{$col};
562 # Build a list of queries which satisfy unique constraints.
564 sub _unique_queries {
565 my ($self, $query, $attrs) = @_;
567 my @constraint_names = exists $attrs->{key}
569 : $self->result_source->unique_constraint_names;
571 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
572 my $num_where = scalar keys %$where;
574 my (@unique_queries, %seen_column_combinations);
575 foreach my $name (@constraint_names) {
576 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
578 my $constraint_sig = join "\x00", sort @constraint_cols;
579 next if $seen_column_combinations{$constraint_sig}++;
581 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
583 my $num_cols = scalar @constraint_cols;
584 my $num_query = scalar keys %$unique_query;
586 my $total = $num_query + $num_where;
587 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
588 # The query is either unique on its own or is unique in combination with
589 # the existing where clause
590 push @unique_queries, $unique_query;
594 return @unique_queries;
597 # _build_unique_query
599 # Constrain the specified query hash based on the specified column names.
601 sub _build_unique_query {
602 my ($self, $query, $unique_cols) = @_;
605 map { $_ => $query->{$_} }
606 grep { exists $query->{$_} }
611 =head2 search_related
615 =item Arguments: $rel, $cond, \%attrs?
617 =item Return Value: $new_resultset
621 $new_rs = $cd_rs->search_related('artist', {
625 Searches the specified relationship, optionally specifying a condition and
626 attributes for matching records. See L</ATTRIBUTES> for more information.
631 return shift->related_resultset(shift)->search(@_);
634 =head2 search_related_rs
636 This method works exactly the same as search_related, except that
637 it guarantees a restultset, even in list context.
641 sub search_related_rs {
642 return shift->related_resultset(shift)->search_rs(@_);
649 =item Arguments: none
651 =item Return Value: $cursor
655 Returns a storage-driven cursor to the given resultset. See
656 L<DBIx::Class::Cursor> for more information.
663 my $attrs = $self->_resolved_attrs_copy;
665 return $self->{cursor}
666 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
667 $attrs->{where},$attrs);
674 =item Arguments: $cond?
676 =item Return Value: $row_object?
680 my $cd = $schema->resultset('CD')->single({ year => 2001 });
682 Inflates the first result without creating a cursor if the resultset has
683 any records in it; if not returns nothing. Used by L</find> as a lean version of
686 While this method can take an optional search condition (just like L</search>)
687 being a fast-code-path it does not recognize search attributes. If you need to
688 add extra joins or similar, call L</search> and then chain-call L</single> on the
689 L<DBIx::Class::ResultSet> returned.
695 As of 0.08100, this method enforces the assumption that the preceeding
696 query returns only one row. If more than one row is returned, you will receive
699 Query returned more than one row
701 In this case, you should be using L</next> or L</find> instead, or if you really
702 know what you are doing, use the L</rows> attribute to explicitly limit the size
705 This method will also throw an exception if it is called on a resultset prefetching
706 has_many, as such a prefetch implies fetching multiple rows from the database in
707 order to assemble the resulting object.
714 my ($self, $where) = @_;
716 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
719 my $attrs = $self->_resolved_attrs_copy;
721 if (keys %{$attrs->{collapse}}) {
722 $self->throw_exception(
723 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
728 if (defined $attrs->{where}) {
731 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
732 $where, delete $attrs->{where} ]
735 $attrs->{where} = $where;
739 # XXX: Disabled since it doesn't infer uniqueness in all cases
740 # unless ($self->_is_unique_query($attrs->{where})) {
741 # carp "Query not guaranteed to return a single row"
742 # . "; please declare your unique constraints or use search instead";
745 my @data = $self->result_source->storage->select_single(
746 $attrs->{from}, $attrs->{select},
747 $attrs->{where}, $attrs
750 return (@data ? ($self->_construct_object(@data))[0] : undef);
756 # Try to determine if the specified query is guaranteed to be unique, based on
757 # the declared unique constraints.
759 sub _is_unique_query {
760 my ($self, $query) = @_;
762 my $collapsed = $self->_collapse_query($query);
763 my $alias = $self->{attrs}{alias};
765 foreach my $name ($self->result_source->unique_constraint_names) {
766 my @unique_cols = map {
768 } $self->result_source->unique_constraint_columns($name);
770 # Count the values for each unique column
771 my %seen = map { $_ => 0 } @unique_cols;
773 foreach my $key (keys %$collapsed) {
774 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
775 next unless exists $seen{$aliased}; # Additional constraints are okay
776 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
779 # If we get 0 or more than 1 value for a column, it's not necessarily unique
780 return 1 unless grep { $_ != 1 } values %seen;
788 # Recursively collapse the query, accumulating values for each column.
790 sub _collapse_query {
791 my ($self, $query, $collapsed) = @_;
795 if (ref $query eq 'ARRAY') {
796 foreach my $subquery (@$query) {
797 next unless ref $subquery; # -or
798 $collapsed = $self->_collapse_query($subquery, $collapsed);
801 elsif (ref $query eq 'HASH') {
802 if (keys %$query and (keys %$query)[0] eq '-and') {
803 foreach my $subquery (@{$query->{-and}}) {
804 $collapsed = $self->_collapse_query($subquery, $collapsed);
808 foreach my $col (keys %$query) {
809 my $value = $query->{$col};
810 $collapsed->{$col}{$value}++;
822 =item Arguments: $cond?
824 =item Return Value: $resultsetcolumn
828 my $max_length = $rs->get_column('length')->max;
830 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
835 my ($self, $column) = @_;
836 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
844 =item Arguments: $cond, \%attrs?
846 =item Return Value: $resultset (scalar context), @row_objs (list context)
850 # WHERE title LIKE '%blue%'
851 $cd_rs = $rs->search_like({ title => '%blue%'});
853 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
854 that this is simply a convenience method retained for ex Class::DBI users.
855 You most likely want to use L</search> with specific operators.
857 For more information, see L<DBIx::Class::Manual::Cookbook>.
859 This method is deprecated and will be removed in 0.09. Use L</search()>
860 instead. An example conversion is:
862 ->search_like({ foo => 'bar' });
866 ->search({ foo => { like => 'bar' } });
873 'search_like() is deprecated and will be removed in DBIC version 0.09.'
874 .' Instead use ->search({ x => { -like => "y%" } })'
875 .' (note the outer pair of {}s - they are important!)'
877 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
878 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
879 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
880 return $class->search($query, { %$attrs });
887 =item Arguments: $first, $last
889 =item Return Value: $resultset (scalar context), @row_objs (list context)
893 Returns a resultset or object list representing a subset of elements from the
894 resultset slice is called on. Indexes are from 0, i.e., to get the first
897 my ($one, $two, $three) = $rs->slice(0, 2);
902 my ($self, $min, $max) = @_;
903 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
904 $attrs->{offset} = $self->{attrs}{offset} || 0;
905 $attrs->{offset} += $min;
906 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
907 return $self->search(undef(), $attrs);
908 #my $slice = (ref $self)->new($self->result_source, $attrs);
909 #return (wantarray ? $slice->all : $slice);
916 =item Arguments: none
918 =item Return Value: $result?
922 Returns the next element in the resultset (C<undef> is there is none).
924 Can be used to efficiently iterate over records in the resultset:
926 my $rs = $schema->resultset('CD')->search;
927 while (my $cd = $rs->next) {
931 Note that you need to store the resultset object, and call C<next> on it.
932 Calling C<< resultset('Table')->next >> repeatedly will always return the
933 first record from the resultset.
939 if (my $cache = $self->get_cache) {
940 $self->{all_cache_position} ||= 0;
941 return $cache->[$self->{all_cache_position}++];
943 if ($self->{attrs}{cache}) {
944 $self->{all_cache_position} = 1;
945 return ($self->all)[0];
947 if ($self->{stashed_objects}) {
948 my $obj = shift(@{$self->{stashed_objects}});
949 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
953 exists $self->{stashed_row}
954 ? @{delete $self->{stashed_row}}
955 : $self->cursor->next
957 return undef unless (@row);
958 my ($row, @more) = $self->_construct_object(@row);
959 $self->{stashed_objects} = \@more if @more;
963 sub _construct_object {
964 my ($self, @row) = @_;
966 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
968 my @new = $self->result_class->inflate_result($self->result_source, @$info);
969 @new = $self->{_attrs}{record_filter}->(@new)
970 if exists $self->{_attrs}{record_filter};
975 # two arguments: $as_proto is an arrayref of column names,
976 # $row_ref is an arrayref of the data. If none of the row data
977 # is defined we return undef (that's copied from the old
978 # _collapse_result). Next we decide whether we need to collapse
979 # the resultset (i.e. we prefetch something) or not. $collapse
980 # indicates that. The do-while loop will run once if we do not need
981 # to collapse the result and will run as long as _merge_result returns
982 # a true value. It will return undef if the current added row does not
983 # match the previous row. A bit of stashing and cursor magic is
984 # required so that the cursor is not mixed up.
986 # "$rows" is a bit misleading. In the end, there should only be one
987 # element in this arrayref.
989 sub _collapse_result {
990 my ( $self, $as_proto, $row_ref ) = @_;
998 return undef unless $has_def;
1000 my $collapse = keys %{ $self->{_attrs}{collapse} || {} };
1002 my @row = @$row_ref;
1005 my $row = { map { $_ => $row[ $i++ ] } @$as_proto };
1006 $row = $self->result_source->_parse_row($row, $collapse);
1007 unless ( scalar @$rows ) {
1008 push( @$rows, $row );
1010 $collapse = undef unless ( $self->_merge_result( $rows, $row ) );
1013 && do { @row = $self->cursor->next; $self->{stashed_row} = \@row if @row; }
1020 # _merge_result accepts an arrayref of rows objects (again, an arrayref of two elements)
1021 # and a row object which should be merged into the first object.
1022 # First we try to find out whether $row is already in $rows. If this is the case
1023 # we try to merge them by iteration through their relationship data. We call
1024 # _merge_result again on them, so they get merged.
1026 # If we don't find the $row in $rows, we append it to $rows and return undef.
1027 # _merge_result returns 1 otherwise (i.e. $row has been found in $rows).
1030 my ( $self, $rows, $row ) = @_;
1031 my ( $columns, $rels ) = @$row;
1033 foreach my $seen (@$rows) {
1035 foreach my $column ( keys %$columns ) {
1036 if ( defined $seen->[0]->{$column} ^ defined $columns->{$column}
1037 or defined $columns->{$column}
1038 && $seen->[0]->{$column} ne $columns->{$column} )
1051 foreach my $rel ( keys %$rels ) {
1052 my $old_rows = $found->[1]->{$rel};
1053 $self->_merge_result(
1054 ref $found->[1]->{$rel}->[0] eq 'HASH' ? [ $found->[1]->{$rel} ]
1055 : $found->[1]->{$rel},
1056 ref $rels->{$rel}->[0] eq 'HASH' ? [ $rels->{$rel}->[0], $rels->{$rel}->[1] ]
1057 : $rels->{$rel}->[0]
1064 push( @$rows, $row );
1072 =head2 result_source
1076 =item Arguments: $result_source?
1078 =item Return Value: $result_source
1082 An accessor for the primary ResultSource object from which this ResultSet
1089 =item Arguments: $result_class?
1091 =item Return Value: $result_class
1095 An accessor for the class to use when creating row objects. Defaults to
1096 C<< result_source->result_class >> - which in most cases is the name of the
1097 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1099 Note that changing the result_class will also remove any components
1100 that were originally loaded in the source class via
1101 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1102 in the original source class will not run.
1107 my ($self, $result_class) = @_;
1108 if ($result_class) {
1109 $self->ensure_class_loaded($result_class);
1110 $self->_result_class($result_class);
1112 $self->_result_class;
1119 =item Arguments: $cond, \%attrs??
1121 =item Return Value: $count
1125 Performs an SQL C<COUNT> with the same query as the resultset was built
1126 with to find the number of elements. Passing arguments is equivalent to
1127 C<< $rs->search ($cond, \%attrs)->count >>
1133 return $self->search(@_)->count if @_ and defined $_[0];
1134 return scalar @{ $self->get_cache } if $self->get_cache;
1136 my $attrs = $self->_resolved_attrs_copy;
1138 # this is a little optimization - it is faster to do the limit
1139 # adjustments in software, instead of a subquery
1140 my $rows = delete $attrs->{rows};
1141 my $offset = delete $attrs->{offset};
1144 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1145 $crs = $self->_count_subq_rs ($attrs);
1148 $crs = $self->_count_rs ($attrs);
1150 my $count = $crs->next;
1152 $count -= $offset if $offset;
1153 $count = $rows if $rows and $rows < $count;
1154 $count = 0 if ($count < 0);
1163 =item Arguments: $cond, \%attrs??
1165 =item Return Value: $count_rs
1169 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1170 This can be very handy for subqueries:
1172 ->search( { amount => $some_rs->count_rs->as_query } )
1174 As with regular resultsets the SQL query will be executed only after
1175 the resultset is accessed via L</next> or L</all>. That would return
1176 the same single value obtainable via L</count>.
1182 return $self->search(@_)->count_rs if @_;
1184 # this may look like a lack of abstraction (count() does about the same)
1185 # but in fact an _rs *must* use a subquery for the limits, as the
1186 # software based limiting can not be ported if this $rs is to be used
1187 # in a subquery itself (i.e. ->as_query)
1188 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1189 return $self->_count_subq_rs;
1192 return $self->_count_rs;
1197 # returns a ResultSetColumn object tied to the count query
1200 my ($self, $attrs) = @_;
1202 my $rsrc = $self->result_source;
1203 $attrs ||= $self->_resolved_attrs;
1205 my $tmp_attrs = { %$attrs };
1207 # take off any limits, record_filter is cdbi, and no point of ordering a count
1208 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1210 # overwrite the selector (supplied by the storage)
1211 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1212 $tmp_attrs->{as} = 'count';
1214 # read the comment on top of the actual function to see what this does
1215 $tmp_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1216 $tmp_attrs->{from}, $tmp_attrs->{alias}
1219 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1225 # same as above but uses a subquery
1227 sub _count_subq_rs {
1228 my ($self, $attrs) = @_;
1230 my $rsrc = $self->result_source;
1231 $attrs ||= $self->_resolved_attrs_copy;
1233 my $sub_attrs = { %$attrs };
1235 # extra selectors do not go in the subquery and there is no point of ordering it
1236 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1238 # if we prefetch, we group_by primary keys only as this is what we would get out
1239 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1240 if ( keys %{$attrs->{collapse}} ) {
1241 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1244 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1246 # read the comment on top of the actual function to see what this does
1247 $sub_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1248 $sub_attrs->{from}, $sub_attrs->{alias}
1251 # this is so that ordering can be thrown away in things like Top limit
1252 $sub_attrs->{-for_count_only} = 1;
1254 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1257 -alias => 'count_subq',
1258 -source_handle => $rsrc->handle,
1259 count_subq => $sub_rs->as_query,
1262 # the subquery replaces this
1263 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1265 return $self->_count_rs ($attrs);
1269 # The DBIC relationship chaining implementation is pretty simple - every
1270 # new related_relationship is pushed onto the {from} stack, and the {select}
1271 # window simply slides further in. This means that when we count somewhere
1272 # in the middle, we got to make sure that everything in the join chain is an
1273 # actual inner join, otherwise the count will come back with unpredictable
1274 # results (a resultset may be generated with _some_ rows regardless of if
1275 # the relation which the $rs currently selects has rows or not). E.g.
1276 # $artist_rs->cds->count - normally generates:
1277 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
1278 # which actually returns the number of artists * (number of cds || 1)
1280 # So what we do here is crawl {from}, determine if the current alias is at
1281 # the top of the stack, and if not - make sure the chain is inner-joined down
1284 sub _switch_to_inner_join_if_needed {
1285 my ($self, $from, $alias) = @_;
1287 # subqueries and other oddness is naturally not supported
1289 ref $from ne 'ARRAY'
1293 ref $from->[0] ne 'HASH'
1295 ! $from->[0]{-alias}
1297 $from->[0]{-alias} eq $alias
1302 for my $j (@{$from}[1 .. $#$from]) {
1303 if ($j->[0]{-alias} eq $alias) {
1304 $switch_branch = $j->[0]{-join_path};
1309 # something else went wrong
1310 return $from unless $switch_branch;
1312 # So it looks like we will have to switch some stuff around.
1313 # local() is useless here as we will be leaving the scope
1314 # anyway, and deep cloning is just too fucking expensive
1315 # So replace the inner hashref manually
1316 my @new_from = ($from->[0]);
1317 my $sw_idx = { map { $_ => 1 } @$switch_branch };
1319 for my $j (@{$from}[1 .. $#$from]) {
1320 my $jalias = $j->[0]{-alias};
1322 if ($sw_idx->{$jalias}) {
1323 my %attrs = %{$j->[0]};
1324 delete $attrs{-join_type};
1343 =head2 count_literal
1347 =item Arguments: $sql_fragment, @bind_values
1349 =item Return Value: $count
1353 Counts the results in a literal query. Equivalent to calling L</search_literal>
1354 with the passed arguments, then L</count>.
1358 sub count_literal { shift->search_literal(@_)->count; }
1364 =item Arguments: none
1366 =item Return Value: @objects
1370 Returns all elements in the resultset. Called implicitly if the resultset
1371 is returned in list context.
1378 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1381 return @{ $self->get_cache } if $self->get_cache;
1385 if (keys %{$self->_resolved_attrs->{collapse}}) {
1386 # Using $self->cursor->all is really just an optimisation.
1387 # If we're collapsing has_many prefetches it probably makes
1388 # very little difference, and this is cleaner than hacking
1389 # _construct_object to survive the approach
1390 $self->cursor->reset;
1391 my @row = $self->cursor->next;
1393 push(@obj, $self->_construct_object(@row));
1394 @row = (exists $self->{stashed_row}
1395 ? @{delete $self->{stashed_row}}
1396 : $self->cursor->next);
1399 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1402 $self->set_cache(\@obj) if $self->{attrs}{cache};
1411 =item Arguments: none
1413 =item Return Value: $self
1417 Resets the resultset's cursor, so you can iterate through the elements again.
1418 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1425 delete $self->{_attrs} if exists $self->{_attrs};
1426 $self->{all_cache_position} = 0;
1427 $self->cursor->reset;
1435 =item Arguments: none
1437 =item Return Value: $object?
1441 Resets the resultset and returns an object for the first result (if the
1442 resultset returns anything).
1447 return $_[0]->reset->next;
1453 # Determines whether and what type of subquery is required for the $rs operation.
1454 # If grouping is necessary either supplies its own, or verifies the current one
1455 # After all is done delegates to the proper storage method.
1457 sub _rs_update_delete {
1458 my ($self, $op, $values) = @_;
1460 my $rsrc = $self->result_source;
1462 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1463 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1465 if ($needs_group_by_subq or $needs_subq) {
1467 # make a new $rs selecting only the PKs (that's all we really need)
1468 my $attrs = $self->_resolved_attrs_copy;
1470 delete $attrs->{$_} for qw/collapse select as/;
1471 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1473 if ($needs_group_by_subq) {
1474 # make sure no group_by was supplied, or if there is one - make sure it matches
1475 # the columns compiled above perfectly. Anything else can not be sanely executed
1476 # on most databases so croak right then and there
1478 if (my $g = $attrs->{group_by}) {
1479 my @current_group_by = map
1480 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1485 join ("\x00", sort @current_group_by)
1487 join ("\x00", sort @{$attrs->{columns}} )
1489 $self->throw_exception (
1490 "You have just attempted a $op operation on a resultset which does group_by"
1491 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1492 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1493 . ' kind of queries. Please retry the operation with a modified group_by or'
1494 . ' without using one at all.'
1499 $attrs->{group_by} = $attrs->{columns};
1503 my $subrs = (ref $self)->new($rsrc, $attrs);
1505 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1508 return $rsrc->storage->$op(
1510 $op eq 'update' ? $values : (),
1511 $self->_cond_for_update_delete,
1517 # _cond_for_update_delete
1519 # update/delete require the condition to be modified to handle
1520 # the differing SQL syntax available. This transforms the $self->{cond}
1521 # appropriately, returning the new condition.
1523 sub _cond_for_update_delete {
1524 my ($self, $full_cond) = @_;
1527 $full_cond ||= $self->{cond};
1528 # No-op. No condition, we're updating/deleting everything
1529 return $cond unless ref $full_cond;
1531 if (ref $full_cond eq 'ARRAY') {
1535 foreach my $key (keys %{$_}) {
1537 $hash{$1} = $_->{$key};
1543 elsif (ref $full_cond eq 'HASH') {
1544 if ((keys %{$full_cond})[0] eq '-and') {
1546 my @cond = @{$full_cond->{-and}};
1547 for (my $i = 0; $i < @cond; $i++) {
1548 my $entry = $cond[$i];
1550 if (ref $entry eq 'HASH') {
1551 $hash = $self->_cond_for_update_delete($entry);
1554 $entry =~ /([^.]+)$/;
1555 $hash->{$1} = $cond[++$i];
1557 push @{$cond->{-and}}, $hash;
1561 foreach my $key (keys %{$full_cond}) {
1563 $cond->{$1} = $full_cond->{$key};
1568 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1579 =item Arguments: \%values
1581 =item Return Value: $storage_rv
1585 Sets the specified columns in the resultset to the supplied values in a
1586 single query. Return value will be true if the update succeeded or false
1587 if no records were updated; exact type of success value is storage-dependent.
1592 my ($self, $values) = @_;
1593 $self->throw_exception('Values for update must be a hash')
1594 unless ref $values eq 'HASH';
1596 return $self->_rs_update_delete ('update', $values);
1603 =item Arguments: \%values
1605 =item Return Value: 1
1609 Fetches all objects and updates them one at a time. Note that C<update_all>
1610 will run DBIC cascade triggers, while L</update> will not.
1615 my ($self, $values) = @_;
1616 $self->throw_exception('Values for update_all must be a hash')
1617 unless ref $values eq 'HASH';
1618 foreach my $obj ($self->all) {
1619 $obj->set_columns($values)->update;
1628 =item Arguments: none
1630 =item Return Value: $storage_rv
1634 Deletes the contents of the resultset from its result source. Note that this
1635 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1636 to run. See also L<DBIx::Class::Row/delete>.
1638 Return value will be the amount of rows deleted; exact type of return value
1639 is storage-dependent.
1645 $self->throw_exception('delete does not accept any arguments')
1648 return $self->_rs_update_delete ('delete');
1655 =item Arguments: none
1657 =item Return Value: 1
1661 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1662 will run DBIC cascade triggers, while L</delete> will not.
1668 $self->throw_exception('delete_all does not accept any arguments')
1671 $_->delete for $self->all;
1679 =item Arguments: \@data;
1683 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1684 For the arrayref of hashrefs style each hashref should be a structure suitable
1685 forsubmitting to a $resultset->create(...) method.
1687 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1688 to insert the data, as this is a faster method.
1690 Otherwise, each set of data is inserted into the database using
1691 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1692 accumulated into an array. The array itself, or an array reference
1693 is returned depending on scalar or list context.
1695 Example: Assuming an Artist Class that has many CDs Classes relating:
1697 my $Artist_rs = $schema->resultset("Artist");
1699 ## Void Context Example
1700 $Artist_rs->populate([
1701 { artistid => 4, name => 'Manufactured Crap', cds => [
1702 { title => 'My First CD', year => 2006 },
1703 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1706 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1707 { title => 'My parents sold me to a record company' ,year => 2005 },
1708 { title => 'Why Am I So Ugly?', year => 2006 },
1709 { title => 'I Got Surgery and am now Popular', year => 2007 }
1714 ## Array Context Example
1715 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1716 { name => "Artist One"},
1717 { name => "Artist Two"},
1718 { name => "Artist Three", cds=> [
1719 { title => "First CD", year => 2007},
1720 { title => "Second CD", year => 2008},
1724 print $ArtistOne->name; ## response is 'Artist One'
1725 print $ArtistThree->cds->count ## reponse is '2'
1727 For the arrayref of arrayrefs style, the first element should be a list of the
1728 fieldsnames to which the remaining elements are rows being inserted. For
1731 $Arstist_rs->populate([
1732 [qw/artistid name/],
1733 [100, 'A Formally Unknown Singer'],
1734 [101, 'A singer that jumped the shark two albums ago'],
1735 [102, 'An actually cool singer.'],
1738 Please note an important effect on your data when choosing between void and
1739 wantarray context. Since void context goes straight to C<insert_bulk> in
1740 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1741 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1742 create primary keys for you, you will find that your PKs are empty. In this
1743 case you will have to use the wantarray context in order to create those
1749 my $self = shift @_;
1750 my $data = ref $_[0][0] eq 'HASH'
1751 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1752 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1754 if(defined wantarray) {
1756 foreach my $item (@$data) {
1757 push(@created, $self->create($item));
1759 return wantarray ? @created : \@created;
1761 my ($first, @rest) = @$data;
1763 my @names = grep {!ref $first->{$_}} keys %$first;
1764 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1765 my @pks = $self->result_source->primary_columns;
1767 ## do the belongs_to relationships
1768 foreach my $index (0..$#$data) {
1770 # delegate to create() for any dataset without primary keys with specified relationships
1771 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1773 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1774 my @ret = $self->populate($data);
1780 foreach my $rel (@rels) {
1781 next unless ref $data->[$index]->{$rel} eq "HASH";
1782 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1783 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1784 my $related = $result->result_source->_resolve_condition(
1785 $result->result_source->relationship_info($reverse)->{cond},
1790 delete $data->[$index]->{$rel};
1791 $data->[$index] = {%{$data->[$index]}, %$related};
1793 push @names, keys %$related if $index == 0;
1797 ## do bulk insert on current row
1798 my @values = map { [ @$_{@names} ] } @$data;
1800 $self->result_source->storage->insert_bulk(
1801 $self->result_source,
1806 ## do the has_many relationships
1807 foreach my $item (@$data) {
1809 foreach my $rel (@rels) {
1810 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1812 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1813 || $self->throw_exception('Cannot find the relating object.');
1815 my $child = $parent->$rel;
1817 my $related = $child->result_source->_resolve_condition(
1818 $parent->result_source->relationship_info($rel)->{cond},
1823 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1824 my @populate = map { {%$_, %$related} } @rows_to_add;
1826 $child->populate( \@populate );
1832 =head2 _normalize_populate_args ($args)
1834 Private method used by L</populate> to normalize its incoming arguments. Factored
1835 out in case you want to subclass and accept new argument structures to the
1836 L</populate> method.
1840 sub _normalize_populate_args {
1841 my ($self, $data) = @_;
1842 my @names = @{shift(@$data)};
1843 my @results_to_create;
1844 foreach my $datum (@$data) {
1845 my %result_to_create;
1846 foreach my $index (0..$#names) {
1847 $result_to_create{$names[$index]} = $$datum[$index];
1849 push @results_to_create, \%result_to_create;
1851 return \@results_to_create;
1858 =item Arguments: none
1860 =item Return Value: $pager
1864 Return Value a L<Data::Page> object for the current resultset. Only makes
1865 sense for queries with a C<page> attribute.
1867 To get the full count of entries for a paged resultset, call
1868 C<total_entries> on the L<Data::Page> object.
1875 return $self->{pager} if $self->{pager};
1877 my $attrs = $self->{attrs};
1878 $self->throw_exception("Can't create pager for non-paged rs")
1879 unless $self->{attrs}{page};
1880 $attrs->{rows} ||= 10;
1882 # throw away the paging flags and re-run the count (possibly
1883 # with a subselect) to get the real total count
1884 my $count_attrs = { %$attrs };
1885 delete $count_attrs->{$_} for qw/rows offset page pager/;
1886 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1888 return $self->{pager} = Data::Page->new(
1891 $self->{attrs}{page}
1899 =item Arguments: $page_number
1901 =item Return Value: $rs
1905 Returns a resultset for the $page_number page of the resultset on which page
1906 is called, where each page contains a number of rows equal to the 'rows'
1907 attribute set on the resultset (10 by default).
1912 my ($self, $page) = @_;
1913 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1920 =item Arguments: \%vals
1922 =item Return Value: $rowobject
1926 Creates a new row object in the resultset's result class and returns
1927 it. The row is not inserted into the database at this point, call
1928 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1929 will tell you whether the row object has been inserted or not.
1931 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1936 my ($self, $values) = @_;
1937 $self->throw_exception( "new_result needs a hash" )
1938 unless (ref $values eq 'HASH');
1941 my $alias = $self->{attrs}{alias};
1944 defined $self->{cond}
1945 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1947 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1948 $new{-from_resultset} = [ keys %new ] if keys %new;
1950 $self->throw_exception(
1951 "Can't abstract implicit construct, condition not a hash"
1952 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1954 my $collapsed_cond = (
1956 ? $self->_collapse_cond($self->{cond})
1960 # precendence must be given to passed values over values inherited from
1961 # the cond, so the order here is important.
1962 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1963 while( my($col,$value) = each %implied ){
1964 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1965 $new{$col} = $value->{'='};
1968 $new{$col} = $value if $self->_is_deterministic_value($value);
1974 %{ $self->_remove_alias($values, $alias) },
1975 -source_handle => $self->_source_handle,
1976 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1979 return $self->result_class->new(\%new);
1982 # _is_deterministic_value
1984 # Make an effor to strip non-deterministic values from the condition,
1985 # to make sure new_result chokes less
1987 sub _is_deterministic_value {
1990 my $ref_type = ref $value;
1991 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1992 return 1 if Scalar::Util::blessed($value);
1996 # _has_resolved_attr
1998 # determines if the resultset defines at least one
1999 # of the attributes supplied
2001 # used to determine if a subquery is neccessary
2003 # supports some virtual attributes:
2005 # This will scan for any joins being present on the resultset.
2006 # It is not a mere key-search but a deep inspection of {from}
2009 sub _has_resolved_attr {
2010 my ($self, @attr_names) = @_;
2012 my $attrs = $self->_resolved_attrs;
2016 for my $n (@attr_names) {
2017 if (grep { $n eq $_ } (qw/-join/) ) {
2018 $extra_checks{$n}++;
2022 my $attr = $attrs->{$n};
2024 next if not defined $attr;
2026 if (ref $attr eq 'HASH') {
2027 return 1 if keys %$attr;
2029 elsif (ref $attr eq 'ARRAY') {
2037 # a resolved join is expressed as a multi-level from
2039 $extra_checks{-join}
2041 ref $attrs->{from} eq 'ARRAY'
2043 @{$attrs->{from}} > 1
2051 # Recursively collapse the condition.
2053 sub _collapse_cond {
2054 my ($self, $cond, $collapsed) = @_;
2058 if (ref $cond eq 'ARRAY') {
2059 foreach my $subcond (@$cond) {
2060 next unless ref $subcond; # -or
2061 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2064 elsif (ref $cond eq 'HASH') {
2065 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2066 foreach my $subcond (@{$cond->{-and}}) {
2067 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2071 foreach my $col (keys %$cond) {
2072 my $value = $cond->{$col};
2073 $collapsed->{$col} = $value;
2083 # Remove the specified alias from the specified query hash. A copy is made so
2084 # the original query is not modified.
2087 my ($self, $query, $alias) = @_;
2089 my %orig = %{ $query || {} };
2092 foreach my $key (keys %orig) {
2094 $unaliased{$key} = $orig{$key};
2097 $unaliased{$1} = $orig{$key}
2098 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2104 =head2 as_query (EXPERIMENTAL)
2108 =item Arguments: none
2110 =item Return Value: \[ $sql, @bind ]
2114 Returns the SQL query and bind vars associated with the invocant.
2116 This is generally used as the RHS for a subquery.
2118 B<NOTE>: This feature is still experimental.
2125 my $attrs = $self->_resolved_attrs_copy;
2130 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2131 # $sql also has no wrapping parenthesis in list ctx
2133 my $sqlbind = $self->result_source->storage
2134 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2143 =item Arguments: \%vals, \%attrs?
2145 =item Return Value: $rowobject
2149 my $artist = $schema->resultset('Artist')->find_or_new(
2150 { artist => 'fred' }, { key => 'artists' });
2152 $cd->cd_to_producer->find_or_new({ producer => $producer },
2153 { key => 'primary });
2155 Find an existing record from this resultset, based on its primary
2156 key, or a unique constraint. If none exists, instantiate a new result
2157 object and return it. The object will not be saved into your storage
2158 until you call L<DBIx::Class::Row/insert> on it.
2160 You most likely want this method when looking for existing rows using
2161 a unique constraint that is not the primary key, or looking for
2164 If you want objects to be saved immediately, use L</find_or_create>
2167 B<Note>: Take care when using C<find_or_new> with a table having
2168 columns with default values that you intend to be automatically
2169 supplied by the database (e.g. an auto_increment primary key column).
2170 In normal usage, the value of such columns should NOT be included at
2171 all in the call to C<find_or_new>, even when set to C<undef>.
2177 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2178 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2179 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2182 return $self->new_result($hash);
2189 =item Arguments: \%vals
2191 =item Return Value: a L<DBIx::Class::Row> $object
2195 Attempt to create a single new row or a row with multiple related rows
2196 in the table represented by the resultset (and related tables). This
2197 will not check for duplicate rows before inserting, use
2198 L</find_or_create> to do that.
2200 To create one row for this resultset, pass a hashref of key/value
2201 pairs representing the columns of the table and the values you wish to
2202 store. If the appropriate relationships are set up, foreign key fields
2203 can also be passed an object representing the foreign row, and the
2204 value will be set to its primary key.
2206 To create related objects, pass a hashref of related-object column values
2207 B<keyed on the relationship name>. If the relationship is of type C<multi>
2208 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2209 The process will correctly identify columns holding foreign keys, and will
2210 transparrently populate them from the keys of the corresponding relation.
2211 This can be applied recursively, and will work correctly for a structure
2212 with an arbitrary depth and width, as long as the relationships actually
2213 exists and the correct column data has been supplied.
2216 Instead of hashrefs of plain related data (key/value pairs), you may
2217 also pass new or inserted objects. New objects (not inserted yet, see
2218 L</new>), will be inserted into their appropriate tables.
2220 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2222 Example of creating a new row.
2224 $person_rs->create({
2225 name=>"Some Person",
2226 email=>"somebody@someplace.com"
2229 Example of creating a new row and also creating rows in a related C<has_many>
2230 or C<has_one> resultset. Note Arrayref.
2233 { artistid => 4, name => 'Manufactured Crap', cds => [
2234 { title => 'My First CD', year => 2006 },
2235 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2240 Example of creating a new row and also creating a row in a related
2241 C<belongs_to>resultset. Note Hashref.
2244 title=>"Music for Silly Walks",
2247 name=>"Silly Musician",
2255 When subclassing ResultSet never attempt to override this method. Since
2256 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2257 lot of the internals simply never call it, so your override will be
2258 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2259 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2260 L</create> process you need to intervene.
2267 my ($self, $attrs) = @_;
2268 $self->throw_exception( "create needs a hashref" )
2269 unless ref $attrs eq 'HASH';
2270 return $self->new_result($attrs)->insert;
2273 =head2 find_or_create
2277 =item Arguments: \%vals, \%attrs?
2279 =item Return Value: $rowobject
2283 $cd->cd_to_producer->find_or_create({ producer => $producer },
2284 { key => 'primary' });
2286 Tries to find a record based on its primary key or unique constraints; if none
2287 is found, creates one and returns that instead.
2289 my $cd = $schema->resultset('CD')->find_or_create({
2291 artist => 'Massive Attack',
2292 title => 'Mezzanine',
2296 Also takes an optional C<key> attribute, to search by a specific key or unique
2297 constraint. For example:
2299 my $cd = $schema->resultset('CD')->find_or_create(
2301 artist => 'Massive Attack',
2302 title => 'Mezzanine',
2304 { key => 'cd_artist_title' }
2307 B<Note>: Because find_or_create() reads from the database and then
2308 possibly inserts based on the result, this method is subject to a race
2309 condition. Another process could create a record in the table after
2310 the find has completed and before the create has started. To avoid
2311 this problem, use find_or_create() inside a transaction.
2313 B<Note>: Take care when using C<find_or_create> with a table having
2314 columns with default values that you intend to be automatically
2315 supplied by the database (e.g. an auto_increment primary key column).
2316 In normal usage, the value of such columns should NOT be included at
2317 all in the call to C<find_or_create>, even when set to C<undef>.
2319 See also L</find> and L</update_or_create>. For information on how to declare
2320 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2324 sub find_or_create {
2326 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2327 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2328 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2331 return $self->create($hash);
2334 =head2 update_or_create
2338 =item Arguments: \%col_values, { key => $unique_constraint }?
2340 =item Return Value: $rowobject
2344 $resultset->update_or_create({ col => $val, ... });
2346 First, searches for an existing row matching one of the unique constraints
2347 (including the primary key) on the source of this resultset. If a row is
2348 found, updates it with the other given column values. Otherwise, creates a new
2351 Takes an optional C<key> attribute to search on a specific unique constraint.
2354 # In your application
2355 my $cd = $schema->resultset('CD')->update_or_create(
2357 artist => 'Massive Attack',
2358 title => 'Mezzanine',
2361 { key => 'cd_artist_title' }
2364 $cd->cd_to_producer->update_or_create({
2365 producer => $producer,
2372 If no C<key> is specified, it searches on all unique constraints defined on the
2373 source, including the primary key.
2375 If the C<key> is specified as C<primary>, it searches only on the primary key.
2377 See also L</find> and L</find_or_create>. For information on how to declare
2378 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2380 B<Note>: Take care when using C<update_or_create> with a table having
2381 columns with default values that you intend to be automatically
2382 supplied by the database (e.g. an auto_increment primary key column).
2383 In normal usage, the value of such columns should NOT be included at
2384 all in the call to C<update_or_create>, even when set to C<undef>.
2388 sub update_or_create {
2390 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2391 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2393 my $row = $self->find($cond, $attrs);
2395 $row->update($cond);
2399 return $self->create($cond);
2402 =head2 update_or_new
2406 =item Arguments: \%col_values, { key => $unique_constraint }?
2408 =item Return Value: $rowobject
2412 $resultset->update_or_new({ col => $val, ... });
2414 First, searches for an existing row matching one of the unique constraints
2415 (including the primary key) on the source of this resultset. If a row is
2416 found, updates it with the other given column values. Otherwise, instantiate
2417 a new result object and return it. The object will not be saved into your storage
2418 until you call L<DBIx::Class::Row/insert> on it.
2420 Takes an optional C<key> attribute to search on a specific unique constraint.
2423 # In your application
2424 my $cd = $schema->resultset('CD')->update_or_new(
2426 artist => 'Massive Attack',
2427 title => 'Mezzanine',
2430 { key => 'cd_artist_title' }
2433 if ($cd->in_storage) {
2434 # the cd was updated
2437 # the cd is not yet in the database, let's insert it
2441 B<Note>: Take care when using C<update_or_new> with a table having
2442 columns with default values that you intend to be automatically
2443 supplied by the database (e.g. an auto_increment primary key column).
2444 In normal usage, the value of such columns should NOT be included at
2445 all in the call to C<update_or_new>, even when set to C<undef>.
2447 See also L</find>, L</find_or_create> and L</find_or_new>.
2453 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2454 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2456 my $row = $self->find( $cond, $attrs );
2457 if ( defined $row ) {
2458 $row->update($cond);
2462 return $self->new_result($cond);
2469 =item Arguments: none
2471 =item Return Value: \@cache_objects?
2475 Gets the contents of the cache for the resultset, if the cache is set.
2477 The cache is populated either by using the L</prefetch> attribute to
2478 L</search> or by calling L</set_cache>.
2490 =item Arguments: \@cache_objects
2492 =item Return Value: \@cache_objects
2496 Sets the contents of the cache for the resultset. Expects an arrayref
2497 of objects of the same class as those produced by the resultset. Note that
2498 if the cache is set the resultset will return the cached objects rather
2499 than re-querying the database even if the cache attr is not set.
2501 The contents of the cache can also be populated by using the
2502 L</prefetch> attribute to L</search>.
2507 my ( $self, $data ) = @_;
2508 $self->throw_exception("set_cache requires an arrayref")
2509 if defined($data) && (ref $data ne 'ARRAY');
2510 $self->{all_cache} = $data;
2517 =item Arguments: none
2519 =item Return Value: []
2523 Clears the cache for the resultset.
2528 shift->set_cache(undef);
2531 =head2 related_resultset
2535 =item Arguments: $relationship_name
2537 =item Return Value: $resultset
2541 Returns a related resultset for the supplied relationship name.
2543 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2547 sub related_resultset {
2548 my ($self, $rel) = @_;
2550 $self->{related_resultsets} ||= {};
2551 return $self->{related_resultsets}{$rel} ||= do {
2552 my $rel_info = $self->result_source->relationship_info($rel);
2554 $self->throw_exception(
2555 "search_related: result source '" . $self->result_source->source_name .
2556 "' has no such relationship $rel")
2559 my ($from,$seen) = $self->_chain_relationship($rel);
2561 my $join_count = $seen->{$rel};
2562 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2564 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2565 my %attrs = %{$self->{attrs}||{}};
2566 delete @attrs{qw(result_class alias)};
2570 if (my $cache = $self->get_cache) {
2571 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2572 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2577 my $rel_source = $self->result_source->related_source($rel);
2581 # The reason we do this now instead of passing the alias to the
2582 # search_rs below is that if you wrap/overload resultset on the
2583 # source you need to know what alias it's -going- to have for things
2584 # to work sanely (e.g. RestrictWithObject wants to be able to add
2585 # extra query restrictions, and these may need to be $alias.)
2587 my $attrs = $rel_source->resultset_attributes;
2588 local $attrs->{alias} = $alias;
2590 $rel_source->resultset
2598 where => $self->{cond},
2603 $new->set_cache($new_cache) if $new_cache;
2608 =head2 current_source_alias
2612 =item Arguments: none
2614 =item Return Value: $source_alias
2618 Returns the current table alias for the result source this resultset is built
2619 on, that will be used in the SQL query. Usually it is C<me>.
2621 Currently the source alias that refers to the result set returned by a
2622 L</search>/L</find> family method depends on how you got to the resultset: it's
2623 C<me> by default, but eg. L</search_related> aliases it to the related result
2624 source name (and keeps C<me> referring to the original result set). The long
2625 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2626 (and make this method unnecessary).
2628 Thus it's currently necessary to use this method in predefined queries (see
2629 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2630 source alias of the current result set:
2632 # in a result set class
2634 my ($self, $user) = @_;
2636 my $me = $self->current_source_alias;
2638 return $self->search(
2639 "$me.modified" => $user->id,
2645 sub current_source_alias {
2648 return ($self->{attrs} || {})->{alias} || 'me';
2651 # This code is called by search_related, and makes sure there
2652 # is clear separation between the joins before, during, and
2653 # after the relationship. This information is needed later
2654 # in order to properly resolve prefetch aliases (any alias
2655 # with a relation_chain_depth less than the depth of the
2656 # current prefetch is not considered)
2658 # The increments happen in 1/2s to make it easier to correlate the
2659 # join depth with the join path. An integer means a relationship
2660 # specified via a search_related, whereas a fraction means an added
2661 # join/prefetch via attributes
2662 sub _chain_relationship {
2663 my ($self, $rel) = @_;
2664 my $source = $self->result_source;
2665 my $attrs = $self->{attrs};
2671 -source_handle => $source->handle,
2672 -alias => $attrs->{alias},
2673 $attrs->{alias} => $source->from,
2677 my $seen = { %{$attrs->{seen_join} || {} } };
2678 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2679 ? $from->[-1][0]{-join_path}
2683 # we need to take the prefetch the attrs into account before we
2684 # ->_resolve_join as otherwise they get lost - captainL
2685 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2687 my @requested_joins = $source->_resolve_join(
2694 push @$from, @requested_joins;
2696 $seen->{-relation_chain_depth} += 0.5;
2698 # if $self already had a join/prefetch specified on it, the requested
2699 # $rel might very well be already included. What we do in this case
2700 # is effectively a no-op (except that we bump up the chain_depth on
2701 # the join in question so we could tell it *is* the search_related)
2705 # we consider the last one thus reverse
2706 for my $j (reverse @requested_joins) {
2707 if ($rel eq $j->[0]{-join_path}[-1]) {
2708 $j->[0]{-relation_chain_depth} += 0.5;
2714 # alternative way to scan the entire chain - not backwards compatible
2715 # for my $j (reverse @$from) {
2716 # next unless ref $j eq 'ARRAY';
2717 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2718 # $j->[0]{-relation_chain_depth} += 0.5;
2719 # $already_joined++;
2724 unless ($already_joined) {
2725 push @$from, $source->_resolve_join(
2733 $seen->{-relation_chain_depth} += 0.5;
2735 return ($from,$seen);
2738 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2739 sub _resolved_attrs_copy {
2741 return { %{$self->_resolved_attrs (@_)} };
2744 sub _resolved_attrs {
2746 return $self->{_attrs} if $self->{_attrs};
2748 my $attrs = { %{ $self->{attrs} || {} } };
2749 my $source = $self->result_source;
2750 my $alias = $attrs->{alias};
2752 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2755 # build columns (as long as select isn't set) into a set of as/select hashes
2756 unless ( $attrs->{select} ) {
2758 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2759 ? @{ delete $attrs->{columns}}
2761 ( delete $attrs->{columns} )
2768 ( ref($_) eq 'HASH' )
2772 /^\Q${alias}.\E(.+)$/
2786 # add the additional columns on
2787 foreach ( 'include_columns', '+columns' ) {
2788 push @colbits, map {
2789 ( ref($_) eq 'HASH' )
2791 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2792 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2795 # start with initial select items
2796 if ( $attrs->{select} ) {
2798 ( ref $attrs->{select} eq 'ARRAY' )
2799 ? [ @{ $attrs->{select} } ]
2800 : [ $attrs->{select} ];
2804 ref $attrs->{as} eq 'ARRAY'
2805 ? [ @{ $attrs->{as} } ]
2808 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2813 # otherwise we intialise select & as to empty
2814 $attrs->{select} = [];
2818 # now add colbits to select/as
2819 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2820 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2823 if ( $adds = delete $attrs->{'+select'} ) {
2824 $adds = [$adds] unless ref $adds eq 'ARRAY';
2826 @{ $attrs->{select} },
2827 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2830 if ( $adds = delete $attrs->{'+as'} ) {
2831 $adds = [$adds] unless ref $adds eq 'ARRAY';
2832 push( @{ $attrs->{as} }, @$adds );
2835 $attrs->{from} ||= [ {
2836 -source_handle => $source->handle,
2837 -alias => $self->{attrs}{alias},
2838 $self->{attrs}{alias} => $source->from,
2841 if ( $attrs->{join} || $attrs->{prefetch} ) {
2843 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2844 if ref $attrs->{from} ne 'ARRAY';
2846 my $join = delete $attrs->{join} || {};
2848 if ( defined $attrs->{prefetch} ) {
2849 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2852 $attrs->{from} = # have to copy here to avoid corrupting the original
2854 @{ $attrs->{from} },
2855 $source->_resolve_join(
2858 { %{ $attrs->{seen_join} || {} } },
2859 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2860 ? $attrs->{from}[-1][0]{-join_path}
2867 if ( defined $attrs->{order_by} ) {
2868 $attrs->{order_by} = (
2869 ref( $attrs->{order_by} ) eq 'ARRAY'
2870 ? [ @{ $attrs->{order_by} } ]
2871 : [ $attrs->{order_by} || () ]
2875 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2876 $attrs->{group_by} = [ $attrs->{group_by} ];
2879 # generate the distinct induced group_by early, as prefetch will be carried via a
2880 # subquery (since a group_by is present)
2881 if (delete $attrs->{distinct}) {
2882 if ($attrs->{group_by}) {
2883 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2886 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2890 $attrs->{collapse} ||= {};
2891 if ( my $prefetch = delete $attrs->{prefetch} ) {
2892 $prefetch = $self->_merge_attr( {}, $prefetch );
2894 my $prefetch_ordering = [];
2896 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2899 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2901 # we need to somehow mark which columns came from prefetch
2902 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2904 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2905 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2907 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2908 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2911 # if both page and offset are specified, produce a combined offset
2912 # even though it doesn't make much sense, this is what pre 081xx has
2914 if (my $page = delete $attrs->{page}) {
2916 ($attrs->{rows} * ($page - 1))
2918 ($attrs->{offset} || 0)
2922 return $self->{_attrs} = $attrs;
2925 sub _joinpath_aliases {
2926 my ($self, $fromspec, $seen) = @_;
2929 return $paths unless ref $fromspec eq 'ARRAY';
2931 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2933 if (int ($cur_depth) != $cur_depth) {
2934 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2937 for my $j (@$fromspec) {
2939 next if ref $j ne 'ARRAY';
2940 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2942 my $jpath = $j->[0]{-join_path};
2945 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2946 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2953 my ($self, $attr) = @_;
2955 if (ref $attr eq 'HASH') {
2956 return $self->_rollout_hash($attr);
2957 } elsif (ref $attr eq 'ARRAY') {
2958 return $self->_rollout_array($attr);
2964 sub _rollout_array {
2965 my ($self, $attr) = @_;
2968 foreach my $element (@{$attr}) {
2969 if (ref $element eq 'HASH') {
2970 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2971 } elsif (ref $element eq 'ARRAY') {
2972 # XXX - should probably recurse here
2973 push( @rolled_array, @{$self->_rollout_array($element)} );
2975 push( @rolled_array, $element );
2978 return \@rolled_array;
2982 my ($self, $attr) = @_;
2985 foreach my $key (keys %{$attr}) {
2986 push( @rolled_array, { $key => $attr->{$key} } );
2988 return \@rolled_array;
2991 sub _calculate_score {
2992 my ($self, $a, $b) = @_;
2994 if (defined $a xor defined $b) {
2997 elsif (not defined $a) {
3001 if (ref $b eq 'HASH') {
3002 my ($b_key) = keys %{$b};
3003 if (ref $a eq 'HASH') {
3004 my ($a_key) = keys %{$a};
3005 if ($a_key eq $b_key) {
3006 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3011 return ($a eq $b_key) ? 1 : 0;
3014 if (ref $a eq 'HASH') {
3015 my ($a_key) = keys %{$a};
3016 return ($b eq $a_key) ? 1 : 0;
3018 return ($b eq $a) ? 1 : 0;
3024 my ($self, $orig, $import) = @_;
3026 return $import unless defined($orig);
3027 return $orig unless defined($import);
3029 $orig = $self->_rollout_attr($orig);
3030 $import = $self->_rollout_attr($import);
3033 foreach my $import_element ( @{$import} ) {
3034 # find best candidate from $orig to merge $b_element into
3035 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3036 foreach my $orig_element ( @{$orig} ) {
3037 my $score = $self->_calculate_score( $orig_element, $import_element );
3038 if ($score > $best_candidate->{score}) {
3039 $best_candidate->{position} = $position;
3040 $best_candidate->{score} = $score;
3044 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3046 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3047 push( @{$orig}, $import_element );
3049 my $orig_best = $orig->[$best_candidate->{position}];
3050 # merge orig_best and b_element together and replace original with merged
3051 if (ref $orig_best ne 'HASH') {
3052 $orig->[$best_candidate->{position}] = $import_element;
3053 } elsif (ref $import_element eq 'HASH') {
3054 my ($key) = keys %{$orig_best};
3055 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3058 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3068 $self->_source_handle($_[0]->handle);
3070 $self->_source_handle->resolve;
3074 =head2 throw_exception
3076 See L<DBIx::Class::Schema/throw_exception> for details.
3080 sub throw_exception {
3083 if (ref $self && $self->_source_handle->schema) {
3084 $self->_source_handle->schema->throw_exception(@_)
3087 DBIx::Class::Exception->throw(@_);
3091 # XXX: FIXME: Attributes docs need clearing up
3095 Attributes are used to refine a ResultSet in various ways when
3096 searching for data. They can be passed to any method which takes an
3097 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3100 These are in no particular order:
3106 =item Value: ( $order_by | \@order_by | \%order_by )
3110 Which column(s) to order the results by.
3112 [The full list of suitable values is documented in
3113 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3116 If a single column name, or an arrayref of names is supplied, the
3117 argument is passed through directly to SQL. The hashref syntax allows
3118 for connection-agnostic specification of ordering direction:
3120 For descending order:
3122 order_by => { -desc => [qw/col1 col2 col3/] }
3124 For explicit ascending order:
3126 order_by => { -asc => 'col' }
3128 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3129 supported, although you are strongly encouraged to use the hashref
3130 syntax as outlined above.
3136 =item Value: \@columns
3140 Shortcut to request a particular set of columns to be retrieved. Each
3141 column spec may be a string (a table column name), or a hash (in which
3142 case the key is the C<as> value, and the value is used as the C<select>
3143 expression). Adds C<me.> onto the start of any column without a C<.> in
3144 it and sets C<select> from that, then auto-populates C<as> from
3145 C<select> as normal. (You may also use the C<cols> attribute, as in
3146 earlier versions of DBIC.)
3152 =item Value: \@columns
3156 Indicates additional columns to be selected from storage. Works the same
3157 as L</columns> but adds columns to the selection. (You may also use the
3158 C<include_columns> attribute, as in earlier versions of DBIC). For
3161 $schema->resultset('CD')->search(undef, {
3162 '+columns' => ['artist.name'],
3166 would return all CDs and include a 'name' column to the information
3167 passed to object inflation. Note that the 'artist' is the name of the
3168 column (or relationship) accessor, and 'name' is the name of the column
3169 accessor in the related table.
3171 =head2 include_columns
3175 =item Value: \@columns
3179 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3185 =item Value: \@select_columns
3189 Indicates which columns should be selected from the storage. You can use
3190 column names, or in the case of RDBMS back ends, function or stored procedure
3193 $rs = $schema->resultset('Employee')->search(undef, {
3196 { count => 'employeeid' },
3201 When you use function/stored procedure names and do not supply an C<as>
3202 attribute, the column names returned are storage-dependent. E.g. MySQL would
3203 return a column named C<count(employeeid)> in the above example.
3209 Indicates additional columns to be selected from storage. Works the same as
3210 L</select> but adds columns to the selection.
3218 Indicates additional column names for those added via L</+select>. See L</as>.
3226 =item Value: \@inflation_names
3230 Indicates column names for object inflation. That is, C<as>
3231 indicates the name that the column can be accessed as via the
3232 C<get_column> method (or via the object accessor, B<if one already
3233 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3235 The C<as> attribute is used in conjunction with C<select>,
3236 usually when C<select> contains one or more function or stored
3239 $rs = $schema->resultset('Employee')->search(undef, {
3242 { count => 'employeeid' }
3244 as => ['name', 'employee_count'],
3247 my $employee = $rs->first(); # get the first Employee
3249 If the object against which the search is performed already has an accessor
3250 matching a column name specified in C<as>, the value can be retrieved using
3251 the accessor as normal:
3253 my $name = $employee->name();
3255 If on the other hand an accessor does not exist in the object, you need to
3256 use C<get_column> instead:
3258 my $employee_count = $employee->get_column('employee_count');
3260 You can create your own accessors if required - see
3261 L<DBIx::Class::Manual::Cookbook> for details.
3263 Please note: This will NOT insert an C<AS employee_count> into the SQL
3264 statement produced, it is used for internal access only. Thus
3265 attempting to use the accessor in an C<order_by> clause or similar
3266 will fail miserably.
3268 To get around this limitation, you can supply literal SQL to your
3269 C<select> attibute that contains the C<AS alias> text, eg:
3271 select => [\'myfield AS alias']
3277 =item Value: ($rel_name | \@rel_names | \%rel_names)
3281 Contains a list of relationships that should be joined for this query. For
3284 # Get CDs by Nine Inch Nails
3285 my $rs = $schema->resultset('CD')->search(
3286 { 'artist.name' => 'Nine Inch Nails' },
3287 { join => 'artist' }
3290 Can also contain a hash reference to refer to the other relation's relations.
3293 package MyApp::Schema::Track;
3294 use base qw/DBIx::Class/;
3295 __PACKAGE__->table('track');
3296 __PACKAGE__->add_columns(qw/trackid cd position title/);
3297 __PACKAGE__->set_primary_key('trackid');
3298 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3301 # In your application
3302 my $rs = $schema->resultset('Artist')->search(
3303 { 'track.title' => 'Teardrop' },
3305 join => { cd => 'track' },
3306 order_by => 'artist.name',
3310 You need to use the relationship (not the table) name in conditions,
3311 because they are aliased as such. The current table is aliased as "me", so
3312 you need to use me.column_name in order to avoid ambiguity. For example:
3314 # Get CDs from 1984 with a 'Foo' track
3315 my $rs = $schema->resultset('CD')->search(
3318 'tracks.name' => 'Foo'
3320 { join => 'tracks' }
3323 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3324 similarly for a third time). For e.g.
3326 my $rs = $schema->resultset('Artist')->search({
3327 'cds.title' => 'Down to Earth',
3328 'cds_2.title' => 'Popular',
3330 join => [ qw/cds cds/ ],
3333 will return a set of all artists that have both a cd with title 'Down
3334 to Earth' and a cd with title 'Popular'.
3336 If you want to fetch related objects from other tables as well, see C<prefetch>
3339 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3345 =item Value: ($rel_name | \@rel_names | \%rel_names)
3349 Contains one or more relationships that should be fetched along with
3350 the main query (when they are accessed afterwards the data will
3351 already be available, without extra queries to the database). This is
3352 useful for when you know you will need the related objects, because it
3353 saves at least one query:
3355 my $rs = $schema->resultset('Tag')->search(
3364 The initial search results in SQL like the following:
3366 SELECT tag.*, cd.*, artist.* FROM tag
3367 JOIN cd ON tag.cd = cd.cdid
3368 JOIN artist ON cd.artist = artist.artistid
3370 L<DBIx::Class> has no need to go back to the database when we access the
3371 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3374 Simple prefetches will be joined automatically, so there is no need
3375 for a C<join> attribute in the above search.
3377 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3378 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3379 with an accessor type of 'single' or 'filter'). A more complex example that
3380 prefetches an artists cds, the tracks on those cds, and the tags associted
3381 with that artist is given below (assuming many-to-many from artists to tags):
3383 my $rs = $schema->resultset('Artist')->search(
3387 { cds => 'tracks' },
3388 { artist_tags => 'tags' }
3394 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3395 attributes will be ignored.
3397 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3398 exactly as you might expect.
3404 Prefetch uses the L</cache> to populate the prefetched relationships. This
3405 may or may not be what you want.
3409 If you specify a condition on a prefetched relationship, ONLY those
3410 rows that match the prefetched condition will be fetched into that relationship.
3411 This means that adding prefetch to a search() B<may alter> what is returned by
3412 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3414 my $artist_rs = $schema->resultset('Artist')->search({
3420 my $count = $artist_rs->first->cds->count;
3422 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3424 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3426 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3428 that cmp_ok() may or may not pass depending on the datasets involved. This
3429 behavior may or may not survive the 0.09 transition.
3441 Makes the resultset paged and specifies the page to retrieve. Effectively
3442 identical to creating a non-pages resultset and then calling ->page($page)
3445 If L<rows> attribute is not specified it defaults to 10 rows per page.
3447 When you have a paged resultset, L</count> will only return the number
3448 of rows in the page. To get the total, use the L</pager> and call
3449 C<total_entries> on it.
3459 Specifes the maximum number of rows for direct retrieval or the number of
3460 rows per page if the page attribute or method is used.
3466 =item Value: $offset
3470 Specifies the (zero-based) row number for the first row to be returned, or the
3471 of the first row of the first page if paging is used.
3477 =item Value: \@columns
3481 A arrayref of columns to group by. Can include columns of joined tables.
3483 group_by => [qw/ column1 column2 ... /]
3489 =item Value: $condition
3493 HAVING is a select statement attribute that is applied between GROUP BY and
3494 ORDER BY. It is applied to the after the grouping calculations have been
3497 having => { 'count(employee)' => { '>=', 100 } }
3503 =item Value: (0 | 1)
3507 Set to 1 to group by all columns. If the resultset already has a group_by
3508 attribute, this setting is ignored and an appropriate warning is issued.
3514 Adds to the WHERE clause.
3516 # only return rows WHERE deleted IS NULL for all searches
3517 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3519 Can be overridden by passing C<{ where => undef }> as an attribute
3526 Set to 1 to cache search results. This prevents extra SQL queries if you
3527 revisit rows in your ResultSet:
3529 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3531 while( my $artist = $resultset->next ) {
3535 $rs->first; # without cache, this would issue a query
3537 By default, searches are not cached.
3539 For more examples of using these attributes, see
3540 L<DBIx::Class::Manual::Cookbook>.
3546 =item Value: ( 'update' | 'shared' )
3550 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT