1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Exception;
13 use DBIx::Class::ResultSetColumn;
14 use DBIx::Class::ResultSourceHandle;
17 use base qw/DBIx::Class/;
19 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
23 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
27 my $users_rs = $schema->resultset('User');
28 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
29 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
33 A ResultSet is an object which stores a set of conditions representing
34 a query. It is the backbone of DBIx::Class (i.e. the really
35 important/useful bit).
37 No SQL is executed on the database when a ResultSet is created, it
38 just stores all the conditions needed to create the query.
40 A basic ResultSet representing the data of an entire table is returned
41 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
42 L<Source|DBIx::Class::Manual::Glossary/Source> name.
44 my $users_rs = $schema->resultset('User');
46 A new ResultSet is returned from calling L</search> on an existing
47 ResultSet. The new one will contain all the conditions of the
48 original, plus any new conditions added in the C<search> call.
50 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
51 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
54 The query that the ResultSet represents is B<only> executed against
55 the database when these methods are called:
56 L</find> L</next> L</all> L</first> L</single> L</count>
60 =head2 Chaining resultsets
62 Let's say you've got a query that needs to be run to return some data
63 to the user. But, you have an authorization system in place that
64 prevents certain users from seeing certain information. So, you want
65 to construct the basic query in one method, but add constraints to it in
70 my $request = $self->get_request; # Get a request object somehow.
71 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
73 my $cd_rs = $schema->resultset('CD')->search({
74 title => $request->param('title'),
75 year => $request->param('year'),
78 $self->apply_security_policy( $cd_rs );
83 sub apply_security_policy {
92 =head3 Resolving conditions and attributes
94 When a resultset is chained from another resultset, conditions and
95 attributes with the same keys need resolving.
97 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
98 into the existing ones from the original resultset.
100 The L</where>, L</having> attribute, and any search conditions are
101 merged with an SQL C<AND> to the existing condition from the original
104 All other attributes are overridden by any new ones supplied in the
107 =head2 Multiple queries
109 Since a resultset just defines a query, you can do all sorts of
110 things with it with the same object.
112 # Don't hit the DB yet.
113 my $cd_rs = $schema->resultset('CD')->search({
114 title => 'something',
118 # Each of these hits the DB individually.
119 my $count = $cd_rs->count;
120 my $most_recent = $cd_rs->get_column('date_released')->max();
121 my @records = $cd_rs->all;
123 And it's not just limited to SELECT statements.
129 $cd_rs->create({ artist => 'Fred' });
131 Which is the same as:
133 $schema->resultset('CD')->create({
134 title => 'something',
139 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
143 If a resultset is used in a numeric context it returns the L</count>.
144 However, if it is used in a booleand context it is always true. So if
145 you want to check if a resultset has any results use C<if $rs != 0>.
146 C<if $rs> will always be true.
154 =item Arguments: $source, \%$attrs
156 =item Return Value: $rs
160 The resultset constructor. Takes a source object (usually a
161 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
162 L</ATTRIBUTES> below). Does not perform any queries -- these are
163 executed as needed by the other methods.
165 Generally you won't need to construct a resultset manually. You'll
166 automatically get one from e.g. a L</search> called in scalar context:
168 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
170 IMPORTANT: If called on an object, proxies to new_result instead so
172 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
174 will return a CD object, not a ResultSet.
180 return $class->new_result(@_) if ref $class;
182 my ($source, $attrs) = @_;
183 $source = $source->handle
184 unless $source->isa('DBIx::Class::ResultSourceHandle');
185 $attrs = { %{$attrs||{}} };
187 if ($attrs->{page}) {
188 $attrs->{rows} ||= 10;
191 $attrs->{alias} ||= 'me';
193 # Creation of {} and bless separated to mitigate RH perl bug
194 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
196 _source_handle => $source,
197 cond => $attrs->{where},
206 $attrs->{result_class} || $source->resolve->result_class
216 =item Arguments: $cond, \%attrs?
218 =item Return Value: $resultset (scalar context), @row_objs (list context)
222 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
223 my $new_rs = $cd_rs->search({ year => 2005 });
225 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
226 # year = 2005 OR year = 2004
228 If you need to pass in additional attributes but no additional condition,
229 call it as C<search(undef, \%attrs)>.
231 # "SELECT name, artistid FROM $artist_table"
232 my @all_artists = $schema->resultset('Artist')->search(undef, {
233 columns => [qw/name artistid/],
236 For a list of attributes that can be passed to C<search>, see
237 L</ATTRIBUTES>. For more examples of using this function, see
238 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
239 documentation for the first argument, see L<SQL::Abstract>.
241 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
247 my $rs = $self->search_rs( @_ );
248 return (wantarray ? $rs->all : $rs);
255 =item Arguments: $cond, \%attrs?
257 =item Return Value: $resultset
261 This method does the same exact thing as search() except it will
262 always return a resultset, even in list context.
269 # Special-case handling for (undef, undef).
270 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
275 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
276 my $our_attrs = { %{$self->{attrs}} };
277 my $having = delete $our_attrs->{having};
278 my $where = delete $our_attrs->{where};
282 my %safe = (alias => 1, cache => 1);
285 (@_ && defined($_[0])) # @_ == () or (undef)
287 (keys %$attrs # empty attrs or only 'safe' attrs
288 && List::Util::first { !$safe{$_} } keys %$attrs)
290 # no search, effectively just a clone
291 $rows = $self->get_cache;
294 my $new_attrs = { %{$our_attrs}, %{$attrs} };
296 # merge new attrs into inherited
297 foreach my $key (qw/join prefetch +select +as bind/) {
298 next unless exists $attrs->{$key};
299 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
304 (@_ == 1 || ref $_[0] eq "HASH")
306 (ref $_[0] eq 'HASH')
308 (keys %{ $_[0] } > 0)
316 ? $self->throw_exception("Odd number of arguments to search")
323 if (defined $where) {
324 $new_attrs->{where} = (
325 defined $new_attrs->{where}
328 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
329 } $where, $new_attrs->{where}
336 $new_attrs->{where} = (
337 defined $new_attrs->{where}
340 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
341 } $cond, $new_attrs->{where}
347 if (defined $having) {
348 $new_attrs->{having} = (
349 defined $new_attrs->{having}
352 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
353 } $having, $new_attrs->{having}
359 my $rs = (ref $self)->new($self->result_source, $new_attrs);
361 $rs->set_cache($rows) if ($rows);
366 =head2 search_literal
370 =item Arguments: $sql_fragment, @bind_values
372 =item Return Value: $resultset (scalar context), @row_objs (list context)
376 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
377 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
379 Pass a literal chunk of SQL to be added to the conditional part of the
382 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
383 only be used in that context. C<search_literal> is a convenience method.
384 It is equivalent to calling $schema->search(\[]), but if you want to ensure
385 columns are bound correctly, use C<search>.
387 Example of how to use C<search> instead of C<search_literal>
389 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
390 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
393 See L<DBIx::Class::Manual::Cookbook/Searching> and
394 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
395 require C<search_literal>.
400 my ($self, $sql, @bind) = @_;
402 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
405 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
412 =item Arguments: @values | \%cols, \%attrs?
414 =item Return Value: $row_object | undef
418 Finds a row based on its primary key or unique constraint. For example, to find
419 a row by its primary key:
421 my $cd = $schema->resultset('CD')->find(5);
423 You can also find a row by a specific unique constraint using the C<key>
424 attribute. For example:
426 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
427 key => 'cd_artist_title'
430 Additionally, you can specify the columns explicitly by name:
432 my $cd = $schema->resultset('CD')->find(
434 artist => 'Massive Attack',
435 title => 'Mezzanine',
437 { key => 'cd_artist_title' }
440 If the C<key> is specified as C<primary>, it searches only on the primary key.
442 If no C<key> is specified, it searches on all unique constraints defined on the
443 source for which column data is provided, including the primary key.
445 If your table does not have a primary key, you B<must> provide a value for the
446 C<key> attribute matching one of the unique constraints on the source.
448 In addition to C<key>, L</find> recognizes and applies standard
449 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
451 Note: If your query does not return only one row, a warning is generated:
453 Query returned more than one row
455 See also L</find_or_create> and L</update_or_create>. For information on how to
456 declare unique constraints, see
457 L<DBIx::Class::ResultSource/add_unique_constraint>.
463 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
465 # Default to the primary key, but allow a specific key
466 my @cols = exists $attrs->{key}
467 ? $self->result_source->unique_constraint_columns($attrs->{key})
468 : $self->result_source->primary_columns;
469 $self->throw_exception(
470 "Can't find unless a primary key is defined or unique constraint is specified"
473 # Parse out a hashref from input
475 if (ref $_[0] eq 'HASH') {
476 $input_query = { %{$_[0]} };
478 elsif (@_ == @cols) {
480 @{$input_query}{@cols} = @_;
483 # Compatibility: Allow e.g. find(id => $value)
484 carp "Find by key => value deprecated; please use a hashref instead";
488 my (%related, $info);
490 KEY: foreach my $key (keys %$input_query) {
491 if (ref($input_query->{$key})
492 && ($info = $self->result_source->relationship_info($key))) {
493 my $val = delete $input_query->{$key};
494 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
495 my $rel_q = $self->result_source->_resolve_condition(
496 $info->{cond}, $val, $key
498 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
499 @related{keys %$rel_q} = values %$rel_q;
502 if (my @keys = keys %related) {
503 @{$input_query}{@keys} = values %related;
507 # Build the final query: Default to the disjunction of the unique queries,
508 # but allow the input query in case the ResultSet defines the query or the
509 # user is abusing find
510 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
512 if (exists $attrs->{key}) {
513 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
514 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
515 $query = $self->_add_alias($unique_query, $alias);
517 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
518 # This means that we got here after a merger of relationship conditions
519 # in ::Relationship::Base::search_related (the row method), and furthermore
520 # the relationship is of the 'single' type. This means that the condition
521 # provided by the relationship (already attached to $self) is sufficient,
522 # as there can be only one row in the databse that would satisfy the
526 my @unique_queries = $self->_unique_queries($input_query, $attrs);
527 $query = @unique_queries
528 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
529 : $self->_add_alias($input_query, $alias);
533 my $rs = $self->search ($query, {result_class => $self->result_class, %$attrs});
534 if (keys %{$rs->_resolved_attrs->{collapse}}) {
536 carp "Query returned more than one row" if $rs->next;
546 # Add the specified alias to the specified query hash. A copy is made so the
547 # original query is not modified.
550 my ($self, $query, $alias) = @_;
552 my %aliased = %$query;
553 foreach my $col (grep { ! m/\./ } keys %aliased) {
554 $aliased{"$alias.$col"} = delete $aliased{$col};
562 # Build a list of queries which satisfy unique constraints.
564 sub _unique_queries {
565 my ($self, $query, $attrs) = @_;
567 my @constraint_names = exists $attrs->{key}
569 : $self->result_source->unique_constraint_names;
571 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
572 my $num_where = scalar keys %$where;
574 my (@unique_queries, %seen_column_combinations);
575 foreach my $name (@constraint_names) {
576 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
578 my $constraint_sig = join "\x00", sort @constraint_cols;
579 next if $seen_column_combinations{$constraint_sig}++;
581 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
583 my $num_cols = scalar @constraint_cols;
584 my $num_query = scalar keys %$unique_query;
586 my $total = $num_query + $num_where;
587 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
588 # The query is either unique on its own or is unique in combination with
589 # the existing where clause
590 push @unique_queries, $unique_query;
594 return @unique_queries;
597 # _build_unique_query
599 # Constrain the specified query hash based on the specified column names.
601 sub _build_unique_query {
602 my ($self, $query, $unique_cols) = @_;
605 map { $_ => $query->{$_} }
606 grep { exists $query->{$_} }
611 =head2 search_related
615 =item Arguments: $rel, $cond, \%attrs?
617 =item Return Value: $new_resultset
621 $new_rs = $cd_rs->search_related('artist', {
625 Searches the specified relationship, optionally specifying a condition and
626 attributes for matching records. See L</ATTRIBUTES> for more information.
631 return shift->related_resultset(shift)->search(@_);
634 =head2 search_related_rs
636 This method works exactly the same as search_related, except that
637 it guarantees a restultset, even in list context.
641 sub search_related_rs {
642 return shift->related_resultset(shift)->search_rs(@_);
649 =item Arguments: none
651 =item Return Value: $cursor
655 Returns a storage-driven cursor to the given resultset. See
656 L<DBIx::Class::Cursor> for more information.
663 my $attrs = $self->_resolved_attrs_copy;
665 return $self->{cursor}
666 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
667 $attrs->{where},$attrs);
674 =item Arguments: $cond?
676 =item Return Value: $row_object?
680 my $cd = $schema->resultset('CD')->single({ year => 2001 });
682 Inflates the first result without creating a cursor if the resultset has
683 any records in it; if not returns nothing. Used by L</find> as a lean version of
686 While this method can take an optional search condition (just like L</search>)
687 being a fast-code-path it does not recognize search attributes. If you need to
688 add extra joins or similar, call L</search> and then chain-call L</single> on the
689 L<DBIx::Class::ResultSet> returned.
695 As of 0.08100, this method enforces the assumption that the preceeding
696 query returns only one row. If more than one row is returned, you will receive
699 Query returned more than one row
701 In this case, you should be using L</next> or L</find> instead, or if you really
702 know what you are doing, use the L</rows> attribute to explicitly limit the size
705 This method will also throw an exception if it is called on a resultset prefetching
706 has_many, as such a prefetch implies fetching multiple rows from the database in
707 order to assemble the resulting object.
714 my ($self, $where) = @_;
716 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
719 my $attrs = $self->_resolved_attrs_copy;
721 if (keys %{$attrs->{collapse}}) {
722 $self->throw_exception(
723 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
728 if (defined $attrs->{where}) {
731 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
732 $where, delete $attrs->{where} ]
735 $attrs->{where} = $where;
739 # XXX: Disabled since it doesn't infer uniqueness in all cases
740 # unless ($self->_is_unique_query($attrs->{where})) {
741 # carp "Query not guaranteed to return a single row"
742 # . "; please declare your unique constraints or use search instead";
745 my @data = $self->result_source->storage->select_single(
746 $attrs->{from}, $attrs->{select},
747 $attrs->{where}, $attrs
750 return (@data ? ($self->_construct_object(@data))[0] : undef);
756 # Try to determine if the specified query is guaranteed to be unique, based on
757 # the declared unique constraints.
759 sub _is_unique_query {
760 my ($self, $query) = @_;
762 my $collapsed = $self->_collapse_query($query);
763 my $alias = $self->{attrs}{alias};
765 foreach my $name ($self->result_source->unique_constraint_names) {
766 my @unique_cols = map {
768 } $self->result_source->unique_constraint_columns($name);
770 # Count the values for each unique column
771 my %seen = map { $_ => 0 } @unique_cols;
773 foreach my $key (keys %$collapsed) {
774 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
775 next unless exists $seen{$aliased}; # Additional constraints are okay
776 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
779 # If we get 0 or more than 1 value for a column, it's not necessarily unique
780 return 1 unless grep { $_ != 1 } values %seen;
788 # Recursively collapse the query, accumulating values for each column.
790 sub _collapse_query {
791 my ($self, $query, $collapsed) = @_;
795 if (ref $query eq 'ARRAY') {
796 foreach my $subquery (@$query) {
797 next unless ref $subquery; # -or
798 $collapsed = $self->_collapse_query($subquery, $collapsed);
801 elsif (ref $query eq 'HASH') {
802 if (keys %$query and (keys %$query)[0] eq '-and') {
803 foreach my $subquery (@{$query->{-and}}) {
804 $collapsed = $self->_collapse_query($subquery, $collapsed);
808 foreach my $col (keys %$query) {
809 my $value = $query->{$col};
810 $collapsed->{$col}{$value}++;
822 =item Arguments: $cond?
824 =item Return Value: $resultsetcolumn
828 my $max_length = $rs->get_column('length')->max;
830 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
835 my ($self, $column) = @_;
836 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
844 =item Arguments: $cond, \%attrs?
846 =item Return Value: $resultset (scalar context), @row_objs (list context)
850 # WHERE title LIKE '%blue%'
851 $cd_rs = $rs->search_like({ title => '%blue%'});
853 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
854 that this is simply a convenience method retained for ex Class::DBI users.
855 You most likely want to use L</search> with specific operators.
857 For more information, see L<DBIx::Class::Manual::Cookbook>.
859 This method is deprecated and will be removed in 0.09. Use L</search()>
860 instead. An example conversion is:
862 ->search_like({ foo => 'bar' });
866 ->search({ foo => { like => 'bar' } });
873 'search_like() is deprecated and will be removed in DBIC version 0.09.'
874 .' Instead use ->search({ x => { -like => "y%" } })'
875 .' (note the outer pair of {}s - they are important!)'
877 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
878 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
879 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
880 return $class->search($query, { %$attrs });
887 =item Arguments: $first, $last
889 =item Return Value: $resultset (scalar context), @row_objs (list context)
893 Returns a resultset or object list representing a subset of elements from the
894 resultset slice is called on. Indexes are from 0, i.e., to get the first
897 my ($one, $two, $three) = $rs->slice(0, 2);
902 my ($self, $min, $max) = @_;
903 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
904 $attrs->{offset} = $self->{attrs}{offset} || 0;
905 $attrs->{offset} += $min;
906 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
907 return $self->search(undef(), $attrs);
908 #my $slice = (ref $self)->new($self->result_source, $attrs);
909 #return (wantarray ? $slice->all : $slice);
916 =item Arguments: none
918 =item Return Value: $result?
922 Returns the next element in the resultset (C<undef> is there is none).
924 Can be used to efficiently iterate over records in the resultset:
926 my $rs = $schema->resultset('CD')->search;
927 while (my $cd = $rs->next) {
931 Note that you need to store the resultset object, and call C<next> on it.
932 Calling C<< resultset('Table')->next >> repeatedly will always return the
933 first record from the resultset.
939 if (my $cache = $self->get_cache) {
940 $self->{all_cache_position} ||= 0;
941 return $cache->[$self->{all_cache_position}++];
943 if ($self->{attrs}{cache}) {
944 $self->{all_cache_position} = 1;
945 return ($self->all)[0];
947 if ($self->{stashed_objects}) {
948 my $obj = shift(@{$self->{stashed_objects}});
949 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
953 exists $self->{stashed_row}
954 ? @{delete $self->{stashed_row}}
955 : $self->cursor->next
957 return undef unless (@row);
958 my ($row, @more) = $self->_construct_object(@row);
959 $self->{stashed_objects} = \@more if @more;
963 sub _construct_object {
964 my ($self, @row) = @_;
966 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
968 my @new = $self->result_class->inflate_result($self->result_source, @$info);
969 @new = $self->{_attrs}{record_filter}->(@new)
970 if exists $self->{_attrs}{record_filter};
974 sub _collapse_result {
975 my ($self, $as_proto, $row) = @_;
979 # 'foo' => [ undef, 'foo' ]
980 # 'foo.bar' => [ 'foo', 'bar' ]
981 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
983 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
985 my %collapse = %{$self->{_attrs}{collapse}||{}};
989 # if we're doing collapsing (has_many prefetch) we need to grab records
990 # until the PK changes, so fill @pri_index. if not, we leave it empty so
991 # we know we don't have to bother.
993 # the reason for not using the collapse stuff directly is because if you
994 # had for e.g. two artists in a row with no cds, the collapse info for
995 # both would be NULL (undef) so you'd lose the second artist
997 # store just the index so we can check the array positions from the row
998 # without having to contruct the full hash
1000 if (keys %collapse) {
1001 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
1002 foreach my $i (0 .. $#construct_as) {
1003 next if defined($construct_as[$i][0]); # only self table
1004 if (delete $pri{$construct_as[$i][1]}) {
1005 push(@pri_index, $i);
1007 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1011 # no need to do an if, it'll be empty if @pri_index is empty anyway
1013 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1017 do { # no need to check anything at the front, we always want the first row
1021 foreach my $this_as (@construct_as) {
1022 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1025 push(@const_rows, \%const);
1027 } until ( # no pri_index => no collapse => drop straight out
1030 do { # get another row, stash it, drop out if different PK
1032 @copy = $self->cursor->next;
1033 $self->{stashed_row} = \@copy;
1035 # last thing in do block, counts as true if anything doesn't match
1037 # check xor defined first for NULL vs. NOT NULL then if one is
1038 # defined the other must be so check string equality
1041 (defined $pri_vals{$_} ^ defined $copy[$_])
1042 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1047 my $alias = $self->{attrs}{alias};
1054 foreach my $const (@const_rows) {
1055 scalar @const_keys or do {
1056 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1058 foreach my $key (@const_keys) {
1061 my @parts = split(/\./, $key);
1063 my $data = $const->{$key};
1064 foreach my $p (@parts) {
1065 $target = $target->[1]->{$p} ||= [];
1067 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1068 # collapsing at this point and on final part
1069 my $pos = $collapse_pos{$cur};
1070 CK: foreach my $ck (@ckey) {
1071 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1072 $collapse_pos{$cur} = $data;
1073 delete @collapse_pos{ # clear all positioning for sub-entries
1074 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1081 if (exists $collapse{$cur}) {
1082 $target = $target->[-1];
1085 $target->[0] = $data;
1087 $info->[0] = $const->{$key};
1095 =head2 result_source
1099 =item Arguments: $result_source?
1101 =item Return Value: $result_source
1105 An accessor for the primary ResultSource object from which this ResultSet
1112 =item Arguments: $result_class?
1114 =item Return Value: $result_class
1118 An accessor for the class to use when creating row objects. Defaults to
1119 C<< result_source->result_class >> - which in most cases is the name of the
1120 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1122 Note that changing the result_class will also remove any components
1123 that were originally loaded in the source class via
1124 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1125 in the original source class will not run.
1130 my ($self, $result_class) = @_;
1131 if ($result_class) {
1132 $self->ensure_class_loaded($result_class);
1133 $self->_result_class($result_class);
1135 $self->_result_class;
1142 =item Arguments: $cond, \%attrs??
1144 =item Return Value: $count
1148 Performs an SQL C<COUNT> with the same query as the resultset was built
1149 with to find the number of elements. Passing arguments is equivalent to
1150 C<< $rs->search ($cond, \%attrs)->count >>
1156 return $self->search(@_)->count if @_ and defined $_[0];
1157 return scalar @{ $self->get_cache } if $self->get_cache;
1159 my $attrs = $self->_resolved_attrs_copy;
1161 # this is a little optimization - it is faster to do the limit
1162 # adjustments in software, instead of a subquery
1163 my $rows = delete $attrs->{rows};
1164 my $offset = delete $attrs->{offset};
1167 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1168 $crs = $self->_count_subq_rs ($attrs);
1171 $crs = $self->_count_rs ($attrs);
1173 my $count = $crs->next;
1175 $count -= $offset if $offset;
1176 $count = $rows if $rows and $rows < $count;
1177 $count = 0 if ($count < 0);
1186 =item Arguments: $cond, \%attrs??
1188 =item Return Value: $count_rs
1192 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1193 This can be very handy for subqueries:
1195 ->search( { amount => $some_rs->count_rs->as_query } )
1197 As with regular resultsets the SQL query will be executed only after
1198 the resultset is accessed via L</next> or L</all>. That would return
1199 the same single value obtainable via L</count>.
1205 return $self->search(@_)->count_rs if @_;
1207 # this may look like a lack of abstraction (count() does about the same)
1208 # but in fact an _rs *must* use a subquery for the limits, as the
1209 # software based limiting can not be ported if this $rs is to be used
1210 # in a subquery itself (i.e. ->as_query)
1211 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1212 return $self->_count_subq_rs;
1215 return $self->_count_rs;
1220 # returns a ResultSetColumn object tied to the count query
1223 my ($self, $attrs) = @_;
1225 my $rsrc = $self->result_source;
1226 $attrs ||= $self->_resolved_attrs;
1228 my $tmp_attrs = { %$attrs };
1230 # take off any limits, record_filter is cdbi, and no point of ordering a count
1231 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1233 # overwrite the selector (supplied by the storage)
1234 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1235 $tmp_attrs->{as} = 'count';
1237 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1243 # same as above but uses a subquery
1245 sub _count_subq_rs {
1246 my ($self, $attrs) = @_;
1248 my $rsrc = $self->result_source;
1249 $attrs ||= $self->_resolved_attrs_copy;
1251 my $sub_attrs = { %$attrs };
1253 # extra selectors do not go in the subquery and there is no point of ordering it
1254 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1256 # if we prefetch, we group_by primary keys only as this is what we would get out
1257 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1258 if ( keys %{$attrs->{collapse}} ) {
1259 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1262 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1264 # this is so that the query can be simplified e.g.
1265 # * non-limiting joins can be pruned
1266 # * ordering can be thrown away in things like Top limit
1267 $sub_attrs->{-for_count_only} = 1;
1269 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1272 -alias => 'count_subq',
1273 -source_handle => $rsrc->handle,
1274 count_subq => $sub_rs->as_query,
1277 # the subquery replaces this
1278 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1280 return $self->_count_rs ($attrs);
1287 =head2 count_literal
1291 =item Arguments: $sql_fragment, @bind_values
1293 =item Return Value: $count
1297 Counts the results in a literal query. Equivalent to calling L</search_literal>
1298 with the passed arguments, then L</count>.
1302 sub count_literal { shift->search_literal(@_)->count; }
1308 =item Arguments: none
1310 =item Return Value: @objects
1314 Returns all elements in the resultset. Called implicitly if the resultset
1315 is returned in list context.
1322 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1325 return @{ $self->get_cache } if $self->get_cache;
1329 if (keys %{$self->_resolved_attrs->{collapse}}) {
1330 # Using $self->cursor->all is really just an optimisation.
1331 # If we're collapsing has_many prefetches it probably makes
1332 # very little difference, and this is cleaner than hacking
1333 # _construct_object to survive the approach
1334 $self->cursor->reset;
1335 my @row = $self->cursor->next;
1337 push(@obj, $self->_construct_object(@row));
1338 @row = (exists $self->{stashed_row}
1339 ? @{delete $self->{stashed_row}}
1340 : $self->cursor->next);
1343 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1346 $self->set_cache(\@obj) if $self->{attrs}{cache};
1355 =item Arguments: none
1357 =item Return Value: $self
1361 Resets the resultset's cursor, so you can iterate through the elements again.
1362 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1369 delete $self->{_attrs} if exists $self->{_attrs};
1370 $self->{all_cache_position} = 0;
1371 $self->cursor->reset;
1379 =item Arguments: none
1381 =item Return Value: $object?
1385 Resets the resultset and returns an object for the first result (if the
1386 resultset returns anything).
1391 return $_[0]->reset->next;
1397 # Determines whether and what type of subquery is required for the $rs operation.
1398 # If grouping is necessary either supplies its own, or verifies the current one
1399 # After all is done delegates to the proper storage method.
1401 sub _rs_update_delete {
1402 my ($self, $op, $values) = @_;
1404 my $rsrc = $self->result_source;
1406 # if a condition exists we need to strip all table qualifiers
1407 # if this is not possible we'll force a subquery below
1408 my $cond = $rsrc->schema->storage->_strip_cond_qualifiers ($self->{cond});
1410 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1411 my $needs_subq = (not defined $cond) || $self->_has_resolved_attr(qw/row offset/);
1413 if ($needs_group_by_subq or $needs_subq) {
1415 # make a new $rs selecting only the PKs (that's all we really need)
1416 my $attrs = $self->_resolved_attrs_copy;
1418 delete $attrs->{$_} for qw/collapse select as/;
1419 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1421 if ($needs_group_by_subq) {
1422 # make sure no group_by was supplied, or if there is one - make sure it matches
1423 # the columns compiled above perfectly. Anything else can not be sanely executed
1424 # on most databases so croak right then and there
1426 if (my $g = $attrs->{group_by}) {
1427 my @current_group_by = map
1428 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1433 join ("\x00", sort @current_group_by)
1435 join ("\x00", sort @{$attrs->{columns}} )
1437 $self->throw_exception (
1438 "You have just attempted a $op operation on a resultset which does group_by"
1439 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1440 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1441 . ' kind of queries. Please retry the operation with a modified group_by or'
1442 . ' without using one at all.'
1447 $attrs->{group_by} = $attrs->{columns};
1451 my $subrs = (ref $self)->new($rsrc, $attrs);
1453 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1456 return $rsrc->storage->$op(
1458 $op eq 'update' ? $values : (),
1468 =item Arguments: \%values
1470 =item Return Value: $storage_rv
1474 Sets the specified columns in the resultset to the supplied values in a
1475 single query. Return value will be true if the update succeeded or false
1476 if no records were updated; exact type of success value is storage-dependent.
1481 my ($self, $values) = @_;
1482 $self->throw_exception('Values for update must be a hash')
1483 unless ref $values eq 'HASH';
1485 return $self->_rs_update_delete ('update', $values);
1492 =item Arguments: \%values
1494 =item Return Value: 1
1498 Fetches all objects and updates them one at a time. Note that C<update_all>
1499 will run DBIC cascade triggers, while L</update> will not.
1504 my ($self, $values) = @_;
1505 $self->throw_exception('Values for update_all must be a hash')
1506 unless ref $values eq 'HASH';
1507 foreach my $obj ($self->all) {
1508 $obj->set_columns($values)->update;
1517 =item Arguments: none
1519 =item Return Value: $storage_rv
1523 Deletes the contents of the resultset from its result source. Note that this
1524 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1525 to run. See also L<DBIx::Class::Row/delete>.
1527 Return value will be the amount of rows deleted; exact type of return value
1528 is storage-dependent.
1534 $self->throw_exception('delete does not accept any arguments')
1537 return $self->_rs_update_delete ('delete');
1544 =item Arguments: none
1546 =item Return Value: 1
1550 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1551 will run DBIC cascade triggers, while L</delete> will not.
1557 $self->throw_exception('delete_all does not accept any arguments')
1560 $_->delete for $self->all;
1568 =item Arguments: \@data;
1572 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1573 For the arrayref of hashrefs style each hashref should be a structure suitable
1574 forsubmitting to a $resultset->create(...) method.
1576 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1577 to insert the data, as this is a faster method.
1579 Otherwise, each set of data is inserted into the database using
1580 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1581 accumulated into an array. The array itself, or an array reference
1582 is returned depending on scalar or list context.
1584 Example: Assuming an Artist Class that has many CDs Classes relating:
1586 my $Artist_rs = $schema->resultset("Artist");
1588 ## Void Context Example
1589 $Artist_rs->populate([
1590 { artistid => 4, name => 'Manufactured Crap', cds => [
1591 { title => 'My First CD', year => 2006 },
1592 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1595 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1596 { title => 'My parents sold me to a record company' ,year => 2005 },
1597 { title => 'Why Am I So Ugly?', year => 2006 },
1598 { title => 'I Got Surgery and am now Popular', year => 2007 }
1603 ## Array Context Example
1604 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1605 { name => "Artist One"},
1606 { name => "Artist Two"},
1607 { name => "Artist Three", cds=> [
1608 { title => "First CD", year => 2007},
1609 { title => "Second CD", year => 2008},
1613 print $ArtistOne->name; ## response is 'Artist One'
1614 print $ArtistThree->cds->count ## reponse is '2'
1616 For the arrayref of arrayrefs style, the first element should be a list of the
1617 fieldsnames to which the remaining elements are rows being inserted. For
1620 $Arstist_rs->populate([
1621 [qw/artistid name/],
1622 [100, 'A Formally Unknown Singer'],
1623 [101, 'A singer that jumped the shark two albums ago'],
1624 [102, 'An actually cool singer.'],
1627 Please note an important effect on your data when choosing between void and
1628 wantarray context. Since void context goes straight to C<insert_bulk> in
1629 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1630 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1631 create primary keys for you, you will find that your PKs are empty. In this
1632 case you will have to use the wantarray context in order to create those
1640 # cruft placed in standalone method
1641 my $data = $self->_normalize_populate_args(@_);
1643 if(defined wantarray) {
1645 foreach my $item (@$data) {
1646 push(@created, $self->create($item));
1648 return wantarray ? @created : \@created;
1650 my $first = $data->[0];
1652 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1653 # it relationship data
1654 my (@rels, @columns);
1655 for (keys %$first) {
1656 my $ref = ref $first->{$_};
1657 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1663 my @pks = $self->result_source->primary_columns;
1665 ## do the belongs_to relationships
1666 foreach my $index (0..$#$data) {
1668 # delegate to create() for any dataset without primary keys with specified relationships
1669 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1671 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1672 my @ret = $self->populate($data);
1678 foreach my $rel (@rels) {
1679 next unless ref $data->[$index]->{$rel} eq "HASH";
1680 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1681 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1682 my $related = $result->result_source->_resolve_condition(
1683 $result->result_source->relationship_info($reverse)->{cond},
1688 delete $data->[$index]->{$rel};
1689 $data->[$index] = {%{$data->[$index]}, %$related};
1691 push @columns, keys %$related if $index == 0;
1695 ## inherit the data locked in the conditions of the resultset
1696 my ($rs_data) = $self->_merge_cond_with_data({});
1697 delete @{$rs_data}{@columns};
1698 my @inherit_cols = keys %$rs_data;
1699 my @inherit_data = values %$rs_data;
1701 ## do bulk insert on current row
1702 $self->result_source->storage->insert_bulk(
1703 $self->result_source,
1704 [@columns, @inherit_cols],
1705 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
1708 ## do the has_many relationships
1709 foreach my $item (@$data) {
1711 foreach my $rel (@rels) {
1712 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1714 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1715 || $self->throw_exception('Cannot find the relating object.');
1717 my $child = $parent->$rel;
1719 my $related = $child->result_source->_resolve_condition(
1720 $parent->result_source->relationship_info($rel)->{cond},
1725 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1726 my @populate = map { {%$_, %$related} } @rows_to_add;
1728 $child->populate( \@populate );
1735 # populate() argumnets went over several incarnations
1736 # What we ultimately support is AoH
1737 sub _normalize_populate_args {
1738 my ($self, $arg) = @_;
1740 if (ref $arg eq 'ARRAY') {
1741 if (ref $arg->[0] eq 'HASH') {
1744 elsif (ref $arg->[0] eq 'ARRAY') {
1746 my @colnames = @{$arg->[0]};
1747 foreach my $values (@{$arg}[1 .. $#$arg]) {
1748 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
1754 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
1761 =item Arguments: none
1763 =item Return Value: $pager
1767 Return Value a L<Data::Page> object for the current resultset. Only makes
1768 sense for queries with a C<page> attribute.
1770 To get the full count of entries for a paged resultset, call
1771 C<total_entries> on the L<Data::Page> object.
1778 return $self->{pager} if $self->{pager};
1780 my $attrs = $self->{attrs};
1781 $self->throw_exception("Can't create pager for non-paged rs")
1782 unless $self->{attrs}{page};
1783 $attrs->{rows} ||= 10;
1785 # throw away the paging flags and re-run the count (possibly
1786 # with a subselect) to get the real total count
1787 my $count_attrs = { %$attrs };
1788 delete $count_attrs->{$_} for qw/rows offset page pager/;
1789 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1791 return $self->{pager} = Data::Page->new(
1794 $self->{attrs}{page}
1802 =item Arguments: $page_number
1804 =item Return Value: $rs
1808 Returns a resultset for the $page_number page of the resultset on which page
1809 is called, where each page contains a number of rows equal to the 'rows'
1810 attribute set on the resultset (10 by default).
1815 my ($self, $page) = @_;
1816 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1823 =item Arguments: \%vals
1825 =item Return Value: $rowobject
1829 Creates a new row object in the resultset's result class and returns
1830 it. The row is not inserted into the database at this point, call
1831 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1832 will tell you whether the row object has been inserted or not.
1834 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1839 my ($self, $values) = @_;
1840 $self->throw_exception( "new_result needs a hash" )
1841 unless (ref $values eq 'HASH');
1843 my ($merged_cond, $cols_from_relations) = $self->_merge_cond_with_data($values);
1847 @$cols_from_relations
1848 ? (-cols_from_relations => $cols_from_relations)
1850 -source_handle => $self->_source_handle,
1851 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1854 return $self->result_class->new(\%new);
1857 # _merge_cond_with_data
1859 # Takes a simple hash of K/V data and returns its copy merged with the
1860 # condition already present on the resultset. Additionally returns an
1861 # arrayref of value/condition names, which were inferred from related
1862 # objects (this is needed for in-memory related objects)
1863 sub _merge_cond_with_data {
1864 my ($self, $data) = @_;
1866 my (%new_data, @cols_from_relations);
1868 my $alias = $self->{attrs}{alias};
1870 if (! defined $self->{cond}) {
1871 # just massage $data below
1873 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
1874 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1875 @cols_from_relations = keys %new_data;
1877 elsif (ref $self->{cond} ne 'HASH') {
1878 $self->throw_exception(
1879 "Can't abstract implicit construct, resultset condition not a hash"
1883 # precendence must be given to passed values over values inherited from
1884 # the cond, so the order here is important.
1885 my $collapsed_cond = $self->_collapse_cond($self->{cond});
1886 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1888 while ( my($col, $value) = each %implied ) {
1889 if (ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '=') {
1890 $new_data{$col} = $value->{'='};
1893 $new_data{$col} = $value if $self->_is_deterministic_value($value);
1899 %{ $self->_remove_alias($data, $alias) },
1902 return (\%new_data, \@cols_from_relations);
1905 # _is_deterministic_value
1907 # Make an effor to strip non-deterministic values from the condition,
1908 # to make sure new_result chokes less
1910 sub _is_deterministic_value {
1913 my $ref_type = ref $value;
1914 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1915 return 1 if Scalar::Util::blessed($value);
1919 # _has_resolved_attr
1921 # determines if the resultset defines at least one
1922 # of the attributes supplied
1924 # used to determine if a subquery is neccessary
1926 # supports some virtual attributes:
1928 # This will scan for any joins being present on the resultset.
1929 # It is not a mere key-search but a deep inspection of {from}
1932 sub _has_resolved_attr {
1933 my ($self, @attr_names) = @_;
1935 my $attrs = $self->_resolved_attrs;
1939 for my $n (@attr_names) {
1940 if (grep { $n eq $_ } (qw/-join/) ) {
1941 $extra_checks{$n}++;
1945 my $attr = $attrs->{$n};
1947 next if not defined $attr;
1949 if (ref $attr eq 'HASH') {
1950 return 1 if keys %$attr;
1952 elsif (ref $attr eq 'ARRAY') {
1960 # a resolved join is expressed as a multi-level from
1962 $extra_checks{-join}
1964 ref $attrs->{from} eq 'ARRAY'
1966 @{$attrs->{from}} > 1
1974 # Recursively collapse the condition.
1976 sub _collapse_cond {
1977 my ($self, $cond, $collapsed) = @_;
1981 if (ref $cond eq 'ARRAY') {
1982 foreach my $subcond (@$cond) {
1983 next unless ref $subcond; # -or
1984 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1987 elsif (ref $cond eq 'HASH') {
1988 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1989 foreach my $subcond (@{$cond->{-and}}) {
1990 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1994 foreach my $col (keys %$cond) {
1995 my $value = $cond->{$col};
1996 $collapsed->{$col} = $value;
2006 # Remove the specified alias from the specified query hash. A copy is made so
2007 # the original query is not modified.
2010 my ($self, $query, $alias) = @_;
2012 my %orig = %{ $query || {} };
2015 foreach my $key (keys %orig) {
2017 $unaliased{$key} = $orig{$key};
2020 $unaliased{$1} = $orig{$key}
2021 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2027 =head2 as_query (EXPERIMENTAL)
2031 =item Arguments: none
2033 =item Return Value: \[ $sql, @bind ]
2037 Returns the SQL query and bind vars associated with the invocant.
2039 This is generally used as the RHS for a subquery.
2041 B<NOTE>: This feature is still experimental.
2048 my $attrs = $self->_resolved_attrs_copy;
2053 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2054 # $sql also has no wrapping parenthesis in list ctx
2056 my $sqlbind = $self->result_source->storage
2057 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2066 =item Arguments: \%vals, \%attrs?
2068 =item Return Value: $rowobject
2072 my $artist = $schema->resultset('Artist')->find_or_new(
2073 { artist => 'fred' }, { key => 'artists' });
2075 $cd->cd_to_producer->find_or_new({ producer => $producer },
2076 { key => 'primary });
2078 Find an existing record from this resultset, based on its primary
2079 key, or a unique constraint. If none exists, instantiate a new result
2080 object and return it. The object will not be saved into your storage
2081 until you call L<DBIx::Class::Row/insert> on it.
2083 You most likely want this method when looking for existing rows using
2084 a unique constraint that is not the primary key, or looking for
2087 If you want objects to be saved immediately, use L</find_or_create>
2090 B<Note>: Take care when using C<find_or_new> with a table having
2091 columns with default values that you intend to be automatically
2092 supplied by the database (e.g. an auto_increment primary key column).
2093 In normal usage, the value of such columns should NOT be included at
2094 all in the call to C<find_or_new>, even when set to C<undef>.
2100 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2101 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2102 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2105 return $self->new_result($hash);
2112 =item Arguments: \%vals
2114 =item Return Value: a L<DBIx::Class::Row> $object
2118 Attempt to create a single new row or a row with multiple related rows
2119 in the table represented by the resultset (and related tables). This
2120 will not check for duplicate rows before inserting, use
2121 L</find_or_create> to do that.
2123 To create one row for this resultset, pass a hashref of key/value
2124 pairs representing the columns of the table and the values you wish to
2125 store. If the appropriate relationships are set up, foreign key fields
2126 can also be passed an object representing the foreign row, and the
2127 value will be set to its primary key.
2129 To create related objects, pass a hashref of related-object column values
2130 B<keyed on the relationship name>. If the relationship is of type C<multi>
2131 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2132 The process will correctly identify columns holding foreign keys, and will
2133 transparrently populate them from the keys of the corresponding relation.
2134 This can be applied recursively, and will work correctly for a structure
2135 with an arbitrary depth and width, as long as the relationships actually
2136 exists and the correct column data has been supplied.
2139 Instead of hashrefs of plain related data (key/value pairs), you may
2140 also pass new or inserted objects. New objects (not inserted yet, see
2141 L</new>), will be inserted into their appropriate tables.
2143 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2145 Example of creating a new row.
2147 $person_rs->create({
2148 name=>"Some Person",
2149 email=>"somebody@someplace.com"
2152 Example of creating a new row and also creating rows in a related C<has_many>
2153 or C<has_one> resultset. Note Arrayref.
2156 { artistid => 4, name => 'Manufactured Crap', cds => [
2157 { title => 'My First CD', year => 2006 },
2158 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2163 Example of creating a new row and also creating a row in a related
2164 C<belongs_to>resultset. Note Hashref.
2167 title=>"Music for Silly Walks",
2170 name=>"Silly Musician",
2178 When subclassing ResultSet never attempt to override this method. Since
2179 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2180 lot of the internals simply never call it, so your override will be
2181 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2182 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2183 L</create> process you need to intervene.
2190 my ($self, $attrs) = @_;
2191 $self->throw_exception( "create needs a hashref" )
2192 unless ref $attrs eq 'HASH';
2193 return $self->new_result($attrs)->insert;
2196 =head2 find_or_create
2200 =item Arguments: \%vals, \%attrs?
2202 =item Return Value: $rowobject
2206 $cd->cd_to_producer->find_or_create({ producer => $producer },
2207 { key => 'primary' });
2209 Tries to find a record based on its primary key or unique constraints; if none
2210 is found, creates one and returns that instead.
2212 my $cd = $schema->resultset('CD')->find_or_create({
2214 artist => 'Massive Attack',
2215 title => 'Mezzanine',
2219 Also takes an optional C<key> attribute, to search by a specific key or unique
2220 constraint. For example:
2222 my $cd = $schema->resultset('CD')->find_or_create(
2224 artist => 'Massive Attack',
2225 title => 'Mezzanine',
2227 { key => 'cd_artist_title' }
2230 B<Note>: Because find_or_create() reads from the database and then
2231 possibly inserts based on the result, this method is subject to a race
2232 condition. Another process could create a record in the table after
2233 the find has completed and before the create has started. To avoid
2234 this problem, use find_or_create() inside a transaction.
2236 B<Note>: Take care when using C<find_or_create> with a table having
2237 columns with default values that you intend to be automatically
2238 supplied by the database (e.g. an auto_increment primary key column).
2239 In normal usage, the value of such columns should NOT be included at
2240 all in the call to C<find_or_create>, even when set to C<undef>.
2242 See also L</find> and L</update_or_create>. For information on how to declare
2243 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2247 sub find_or_create {
2249 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2250 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2251 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2254 return $self->create($hash);
2257 =head2 update_or_create
2261 =item Arguments: \%col_values, { key => $unique_constraint }?
2263 =item Return Value: $rowobject
2267 $resultset->update_or_create({ col => $val, ... });
2269 First, searches for an existing row matching one of the unique constraints
2270 (including the primary key) on the source of this resultset. If a row is
2271 found, updates it with the other given column values. Otherwise, creates a new
2274 Takes an optional C<key> attribute to search on a specific unique constraint.
2277 # In your application
2278 my $cd = $schema->resultset('CD')->update_or_create(
2280 artist => 'Massive Attack',
2281 title => 'Mezzanine',
2284 { key => 'cd_artist_title' }
2287 $cd->cd_to_producer->update_or_create({
2288 producer => $producer,
2295 If no C<key> is specified, it searches on all unique constraints defined on the
2296 source, including the primary key.
2298 If the C<key> is specified as C<primary>, it searches only on the primary key.
2300 See also L</find> and L</find_or_create>. For information on how to declare
2301 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2303 B<Note>: Take care when using C<update_or_create> with a table having
2304 columns with default values that you intend to be automatically
2305 supplied by the database (e.g. an auto_increment primary key column).
2306 In normal usage, the value of such columns should NOT be included at
2307 all in the call to C<update_or_create>, even when set to C<undef>.
2311 sub update_or_create {
2313 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2314 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2316 my $row = $self->find($cond, $attrs);
2318 $row->update($cond);
2322 return $self->create($cond);
2325 =head2 update_or_new
2329 =item Arguments: \%col_values, { key => $unique_constraint }?
2331 =item Return Value: $rowobject
2335 $resultset->update_or_new({ col => $val, ... });
2337 First, searches for an existing row matching one of the unique constraints
2338 (including the primary key) on the source of this resultset. If a row is
2339 found, updates it with the other given column values. Otherwise, instantiate
2340 a new result object and return it. The object will not be saved into your storage
2341 until you call L<DBIx::Class::Row/insert> on it.
2343 Takes an optional C<key> attribute to search on a specific unique constraint.
2346 # In your application
2347 my $cd = $schema->resultset('CD')->update_or_new(
2349 artist => 'Massive Attack',
2350 title => 'Mezzanine',
2353 { key => 'cd_artist_title' }
2356 if ($cd->in_storage) {
2357 # the cd was updated
2360 # the cd is not yet in the database, let's insert it
2364 B<Note>: Take care when using C<update_or_new> with a table having
2365 columns with default values that you intend to be automatically
2366 supplied by the database (e.g. an auto_increment primary key column).
2367 In normal usage, the value of such columns should NOT be included at
2368 all in the call to C<update_or_new>, even when set to C<undef>.
2370 See also L</find>, L</find_or_create> and L</find_or_new>.
2376 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2377 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2379 my $row = $self->find( $cond, $attrs );
2380 if ( defined $row ) {
2381 $row->update($cond);
2385 return $self->new_result($cond);
2392 =item Arguments: none
2394 =item Return Value: \@cache_objects?
2398 Gets the contents of the cache for the resultset, if the cache is set.
2400 The cache is populated either by using the L</prefetch> attribute to
2401 L</search> or by calling L</set_cache>.
2413 =item Arguments: \@cache_objects
2415 =item Return Value: \@cache_objects
2419 Sets the contents of the cache for the resultset. Expects an arrayref
2420 of objects of the same class as those produced by the resultset. Note that
2421 if the cache is set the resultset will return the cached objects rather
2422 than re-querying the database even if the cache attr is not set.
2424 The contents of the cache can also be populated by using the
2425 L</prefetch> attribute to L</search>.
2430 my ( $self, $data ) = @_;
2431 $self->throw_exception("set_cache requires an arrayref")
2432 if defined($data) && (ref $data ne 'ARRAY');
2433 $self->{all_cache} = $data;
2440 =item Arguments: none
2442 =item Return Value: []
2446 Clears the cache for the resultset.
2451 shift->set_cache(undef);
2458 =item Arguments: none
2460 =item Return Value: true, if the resultset has been paginated
2468 return !!$self->{attrs}{page};
2471 =head2 related_resultset
2475 =item Arguments: $relationship_name
2477 =item Return Value: $resultset
2481 Returns a related resultset for the supplied relationship name.
2483 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2487 sub related_resultset {
2488 my ($self, $rel) = @_;
2490 $self->{related_resultsets} ||= {};
2491 return $self->{related_resultsets}{$rel} ||= do {
2492 my $rsrc = $self->result_source;
2493 my $rel_info = $rsrc->relationship_info($rel);
2495 $self->throw_exception(
2496 "search_related: result source '" . $rsrc->source_name .
2497 "' has no such relationship $rel")
2500 my $attrs = $self->_chain_relationship($rel);
2502 my $join_count = $attrs->{seen_join}{$rel};
2503 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2505 # since this is search_related, and we already slid the select window inwards
2506 # (the select/as attrs were deleted in the beginning), we need to flip all
2507 # left joins to inner, so we get the expected results
2508 # read the comment on top of the actual function to see what this does
2509 $attrs->{from} = $rsrc->schema->storage->_straight_join_to_node ($attrs->{from}, $alias);
2511 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2512 delete @{$attrs}{qw(result_class alias)};
2516 if (my $cache = $self->get_cache) {
2517 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2518 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2523 my $rel_source = $rsrc->related_source($rel);
2527 # The reason we do this now instead of passing the alias to the
2528 # search_rs below is that if you wrap/overload resultset on the
2529 # source you need to know what alias it's -going- to have for things
2530 # to work sanely (e.g. RestrictWithObject wants to be able to add
2531 # extra query restrictions, and these may need to be $alias.)
2533 my $rel_attrs = $rel_source->resultset_attributes;
2534 local $rel_attrs->{alias} = $alias;
2536 $rel_source->resultset
2540 where => $attrs->{where},
2543 $new->set_cache($new_cache) if $new_cache;
2548 =head2 current_source_alias
2552 =item Arguments: none
2554 =item Return Value: $source_alias
2558 Returns the current table alias for the result source this resultset is built
2559 on, that will be used in the SQL query. Usually it is C<me>.
2561 Currently the source alias that refers to the result set returned by a
2562 L</search>/L</find> family method depends on how you got to the resultset: it's
2563 C<me> by default, but eg. L</search_related> aliases it to the related result
2564 source name (and keeps C<me> referring to the original result set). The long
2565 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2566 (and make this method unnecessary).
2568 Thus it's currently necessary to use this method in predefined queries (see
2569 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2570 source alias of the current result set:
2572 # in a result set class
2574 my ($self, $user) = @_;
2576 my $me = $self->current_source_alias;
2578 return $self->search(
2579 "$me.modified" => $user->id,
2585 sub current_source_alias {
2588 return ($self->{attrs} || {})->{alias} || 'me';
2591 # This code is called by search_related, and makes sure there
2592 # is clear separation between the joins before, during, and
2593 # after the relationship. This information is needed later
2594 # in order to properly resolve prefetch aliases (any alias
2595 # with a relation_chain_depth less than the depth of the
2596 # current prefetch is not considered)
2598 # The increments happen twice per join. An even number means a
2599 # relationship specified via a search_related, whereas an odd
2600 # number indicates a join/prefetch added via attributes
2602 # Also this code will wrap the current resultset (the one we
2603 # chain to) in a subselect IFF it contains limiting attributes
2604 sub _chain_relationship {
2605 my ($self, $rel) = @_;
2606 my $source = $self->result_source;
2607 my $attrs = { %{$self->{attrs}||{}} };
2609 # we need to take the prefetch the attrs into account before we
2610 # ->_resolve_join as otherwise they get lost - captainL
2611 my $join = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2613 delete @{$attrs}{qw/join prefetch collapse distinct select as columns +select +as +columns/};
2615 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
2618 my @force_subq_attrs = qw/offset rows group_by having/;
2621 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
2623 $self->_has_resolved_attr (@force_subq_attrs)
2626 -source_handle => $source->handle,
2627 -alias => $attrs->{alias},
2628 $attrs->{alias} => $self->as_query,
2630 delete @{$attrs}{@force_subq_attrs, 'where'};
2631 $seen->{-relation_chain_depth} = 0;
2633 elsif ($attrs->{from}) { #shallow copy suffices
2634 $from = [ @{$attrs->{from}} ];
2638 -source_handle => $source->handle,
2639 -alias => $attrs->{alias},
2640 $attrs->{alias} => $source->from,
2644 my $jpath = ($seen->{-relation_chain_depth})
2645 ? $from->[-1][0]{-join_path}
2648 my @requested_joins = $source->_resolve_join(
2655 push @$from, @requested_joins;
2657 $seen->{-relation_chain_depth}++;
2659 # if $self already had a join/prefetch specified on it, the requested
2660 # $rel might very well be already included. What we do in this case
2661 # is effectively a no-op (except that we bump up the chain_depth on
2662 # the join in question so we could tell it *is* the search_related)
2665 # we consider the last one thus reverse
2666 for my $j (reverse @requested_joins) {
2667 if ($rel eq $j->[0]{-join_path}[-1]) {
2668 $j->[0]{-relation_chain_depth}++;
2673 # alternative way to scan the entire chain - not backwards compatible
2674 # for my $j (reverse @$from) {
2675 # next unless ref $j eq 'ARRAY';
2676 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2677 # $j->[0]{-relation_chain_depth}++;
2678 # $already_joined++;
2683 unless ($already_joined) {
2684 push @$from, $source->_resolve_join(
2692 $seen->{-relation_chain_depth}++;
2694 return {%$attrs, from => $from, seen_join => $seen};
2697 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2698 sub _resolved_attrs_copy {
2700 return { %{$self->_resolved_attrs (@_)} };
2703 sub _resolved_attrs {
2705 return $self->{_attrs} if $self->{_attrs};
2707 my $attrs = { %{ $self->{attrs} || {} } };
2708 my $source = $self->result_source;
2709 my $alias = $attrs->{alias};
2711 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2714 # build columns (as long as select isn't set) into a set of as/select hashes
2715 unless ( $attrs->{select} ) {
2717 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2718 ? @{ delete $attrs->{columns}}
2720 ( delete $attrs->{columns} )
2727 ( ref($_) eq 'HASH' )
2731 /^\Q${alias}.\E(.+)$/
2745 # add the additional columns on
2746 foreach ( 'include_columns', '+columns' ) {
2747 push @colbits, map {
2748 ( ref($_) eq 'HASH' )
2750 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2751 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2754 # start with initial select items
2755 if ( $attrs->{select} ) {
2757 ( ref $attrs->{select} eq 'ARRAY' )
2758 ? [ @{ $attrs->{select} } ]
2759 : [ $attrs->{select} ];
2763 ref $attrs->{as} eq 'ARRAY'
2764 ? [ @{ $attrs->{as} } ]
2767 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2772 # otherwise we intialise select & as to empty
2773 $attrs->{select} = [];
2777 # now add colbits to select/as
2778 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2779 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2782 if ( $adds = delete $attrs->{'+select'} ) {
2783 $adds = [$adds] unless ref $adds eq 'ARRAY';
2785 @{ $attrs->{select} },
2786 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2789 if ( $adds = delete $attrs->{'+as'} ) {
2790 $adds = [$adds] unless ref $adds eq 'ARRAY';
2791 push( @{ $attrs->{as} }, @$adds );
2794 $attrs->{from} ||= [ {
2795 -source_handle => $source->handle,
2796 -alias => $self->{attrs}{alias},
2797 $self->{attrs}{alias} => $source->from,
2800 if ( $attrs->{join} || $attrs->{prefetch} ) {
2802 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2803 if ref $attrs->{from} ne 'ARRAY';
2805 my $join = delete $attrs->{join} || {};
2807 if ( defined $attrs->{prefetch} ) {
2808 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2811 $attrs->{from} = # have to copy here to avoid corrupting the original
2813 @{ $attrs->{from} },
2814 $source->_resolve_join(
2817 { %{ $attrs->{seen_join} || {} } },
2818 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2819 ? $attrs->{from}[-1][0]{-join_path}
2826 if ( defined $attrs->{order_by} ) {
2827 $attrs->{order_by} = (
2828 ref( $attrs->{order_by} ) eq 'ARRAY'
2829 ? [ @{ $attrs->{order_by} } ]
2830 : [ $attrs->{order_by} || () ]
2834 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2835 $attrs->{group_by} = [ $attrs->{group_by} ];
2838 # generate the distinct induced group_by early, as prefetch will be carried via a
2839 # subquery (since a group_by is present)
2840 if (delete $attrs->{distinct}) {
2841 if ($attrs->{group_by}) {
2842 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2845 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2847 # add any order_by parts that are not already present in the group_by
2848 # we need to be careful not to add any named functions/aggregates
2849 # i.e. select => [ ... { count => 'foo', -as 'foocount' } ... ]
2850 my %already_grouped = map { $_ => 1 } (@{$attrs->{group_by}});
2852 my $storage = $self->result_source->schema->storage;
2853 my $rs_column_list = $storage->_resolve_column_info ($attrs->{from});
2854 my @chunks = $storage->sql_maker->_order_by_chunks ($attrs->{order_by});
2856 for my $chunk (map { ref $_ ? @$_ : $_ } (@chunks) ) {
2857 $chunk =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
2858 if ($rs_column_list->{$chunk} && not $already_grouped{$chunk}++) {
2859 push @{$attrs->{group_by}}, $chunk;
2865 $attrs->{collapse} ||= {};
2866 if ( my $prefetch = delete $attrs->{prefetch} ) {
2867 $prefetch = $self->_merge_attr( {}, $prefetch );
2869 my $prefetch_ordering = [];
2871 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2874 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2876 # we need to somehow mark which columns came from prefetch
2877 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2879 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2880 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2882 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2883 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2886 # if both page and offset are specified, produce a combined offset
2887 # even though it doesn't make much sense, this is what pre 081xx has
2889 if (my $page = delete $attrs->{page}) {
2891 ($attrs->{rows} * ($page - 1))
2893 ($attrs->{offset} || 0)
2897 return $self->{_attrs} = $attrs;
2900 sub _joinpath_aliases {
2901 my ($self, $fromspec, $seen) = @_;
2904 return $paths unless ref $fromspec eq 'ARRAY';
2906 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2908 if ($cur_depth % 2) {
2909 $self->throw_exception ("-relation_chain_depth is not even, something went horribly wrong ($cur_depth)");
2912 for my $j (@$fromspec) {
2914 next if ref $j ne 'ARRAY';
2915 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2917 my $jpath = $j->[0]{-join_path};
2920 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth/2 .. $#$jpath]; #only even depths are actual jpath boundaries
2921 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2928 my ($self, $attr) = @_;
2930 if (ref $attr eq 'HASH') {
2931 return $self->_rollout_hash($attr);
2932 } elsif (ref $attr eq 'ARRAY') {
2933 return $self->_rollout_array($attr);
2939 sub _rollout_array {
2940 my ($self, $attr) = @_;
2943 foreach my $element (@{$attr}) {
2944 if (ref $element eq 'HASH') {
2945 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2946 } elsif (ref $element eq 'ARRAY') {
2947 # XXX - should probably recurse here
2948 push( @rolled_array, @{$self->_rollout_array($element)} );
2950 push( @rolled_array, $element );
2953 return \@rolled_array;
2957 my ($self, $attr) = @_;
2960 foreach my $key (keys %{$attr}) {
2961 push( @rolled_array, { $key => $attr->{$key} } );
2963 return \@rolled_array;
2966 sub _calculate_score {
2967 my ($self, $a, $b) = @_;
2969 if (defined $a xor defined $b) {
2972 elsif (not defined $a) {
2976 if (ref $b eq 'HASH') {
2977 my ($b_key) = keys %{$b};
2978 if (ref $a eq 'HASH') {
2979 my ($a_key) = keys %{$a};
2980 if ($a_key eq $b_key) {
2981 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2986 return ($a eq $b_key) ? 1 : 0;
2989 if (ref $a eq 'HASH') {
2990 my ($a_key) = keys %{$a};
2991 return ($b eq $a_key) ? 1 : 0;
2993 return ($b eq $a) ? 1 : 0;
2999 my ($self, $orig, $import) = @_;
3001 return $import unless defined($orig);
3002 return $orig unless defined($import);
3004 $orig = $self->_rollout_attr($orig);
3005 $import = $self->_rollout_attr($import);
3008 foreach my $import_element ( @{$import} ) {
3009 # find best candidate from $orig to merge $b_element into
3010 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3011 foreach my $orig_element ( @{$orig} ) {
3012 my $score = $self->_calculate_score( $orig_element, $import_element );
3013 if ($score > $best_candidate->{score}) {
3014 $best_candidate->{position} = $position;
3015 $best_candidate->{score} = $score;
3019 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3021 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3022 push( @{$orig}, $import_element );
3024 my $orig_best = $orig->[$best_candidate->{position}];
3025 # merge orig_best and b_element together and replace original with merged
3026 if (ref $orig_best ne 'HASH') {
3027 $orig->[$best_candidate->{position}] = $import_element;
3028 } elsif (ref $import_element eq 'HASH') {
3029 my ($key) = keys %{$orig_best};
3030 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3033 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3043 $self->_source_handle($_[0]->handle);
3045 $self->_source_handle->resolve;
3049 =head2 throw_exception
3051 See L<DBIx::Class::Schema/throw_exception> for details.
3055 sub throw_exception {
3058 if (ref $self && $self->_source_handle->schema) {
3059 $self->_source_handle->schema->throw_exception(@_)
3062 DBIx::Class::Exception->throw(@_);
3066 # XXX: FIXME: Attributes docs need clearing up
3070 Attributes are used to refine a ResultSet in various ways when
3071 searching for data. They can be passed to any method which takes an
3072 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3075 These are in no particular order:
3081 =item Value: ( $order_by | \@order_by | \%order_by )
3085 Which column(s) to order the results by.
3087 [The full list of suitable values is documented in
3088 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3091 If a single column name, or an arrayref of names is supplied, the
3092 argument is passed through directly to SQL. The hashref syntax allows
3093 for connection-agnostic specification of ordering direction:
3095 For descending order:
3097 order_by => { -desc => [qw/col1 col2 col3/] }
3099 For explicit ascending order:
3101 order_by => { -asc => 'col' }
3103 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3104 supported, although you are strongly encouraged to use the hashref
3105 syntax as outlined above.
3111 =item Value: \@columns
3115 Shortcut to request a particular set of columns to be retrieved. Each
3116 column spec may be a string (a table column name), or a hash (in which
3117 case the key is the C<as> value, and the value is used as the C<select>
3118 expression). Adds C<me.> onto the start of any column without a C<.> in
3119 it and sets C<select> from that, then auto-populates C<as> from
3120 C<select> as normal. (You may also use the C<cols> attribute, as in
3121 earlier versions of DBIC.)
3127 =item Value: \@columns
3131 Indicates additional columns to be selected from storage. Works the same
3132 as L</columns> but adds columns to the selection. (You may also use the
3133 C<include_columns> attribute, as in earlier versions of DBIC). For
3136 $schema->resultset('CD')->search(undef, {
3137 '+columns' => ['artist.name'],
3141 would return all CDs and include a 'name' column to the information
3142 passed to object inflation. Note that the 'artist' is the name of the
3143 column (or relationship) accessor, and 'name' is the name of the column
3144 accessor in the related table.
3146 =head2 include_columns
3150 =item Value: \@columns
3154 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3160 =item Value: \@select_columns
3164 Indicates which columns should be selected from the storage. You can use
3165 column names, or in the case of RDBMS back ends, function or stored procedure
3168 $rs = $schema->resultset('Employee')->search(undef, {
3171 { count => 'employeeid' },
3176 When you use function/stored procedure names and do not supply an C<as>
3177 attribute, the column names returned are storage-dependent. E.g. MySQL would
3178 return a column named C<count(employeeid)> in the above example.
3180 B<NOTE:> You will almost always need a corresponding 'as' entry when you use
3187 Indicates additional columns to be selected from storage. Works the same as
3188 L</select> but adds columns to the selection.
3196 Indicates additional column names for those added via L</+select>. See L</as>.
3204 =item Value: \@inflation_names
3208 Indicates column names for object inflation. That is, C<as>
3209 indicates the name that the column can be accessed as via the
3210 C<get_column> method (or via the object accessor, B<if one already
3211 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3213 The C<as> attribute is used in conjunction with C<select>,
3214 usually when C<select> contains one or more function or stored
3217 $rs = $schema->resultset('Employee')->search(undef, {
3220 { count => 'employeeid' }
3222 as => ['name', 'employee_count'],
3225 my $employee = $rs->first(); # get the first Employee
3227 If the object against which the search is performed already has an accessor
3228 matching a column name specified in C<as>, the value can be retrieved using
3229 the accessor as normal:
3231 my $name = $employee->name();
3233 If on the other hand an accessor does not exist in the object, you need to
3234 use C<get_column> instead:
3236 my $employee_count = $employee->get_column('employee_count');
3238 You can create your own accessors if required - see
3239 L<DBIx::Class::Manual::Cookbook> for details.
3241 Please note: This will NOT insert an C<AS employee_count> into the SQL
3242 statement produced, it is used for internal access only. Thus
3243 attempting to use the accessor in an C<order_by> clause or similar
3244 will fail miserably.
3246 To get around this limitation, you can supply literal SQL to your
3247 C<select> attibute that contains the C<AS alias> text, eg:
3249 select => [\'myfield AS alias']
3255 =item Value: ($rel_name | \@rel_names | \%rel_names)
3259 Contains a list of relationships that should be joined for this query. For
3262 # Get CDs by Nine Inch Nails
3263 my $rs = $schema->resultset('CD')->search(
3264 { 'artist.name' => 'Nine Inch Nails' },
3265 { join => 'artist' }
3268 Can also contain a hash reference to refer to the other relation's relations.
3271 package MyApp::Schema::Track;
3272 use base qw/DBIx::Class/;
3273 __PACKAGE__->table('track');
3274 __PACKAGE__->add_columns(qw/trackid cd position title/);
3275 __PACKAGE__->set_primary_key('trackid');
3276 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3279 # In your application
3280 my $rs = $schema->resultset('Artist')->search(
3281 { 'track.title' => 'Teardrop' },
3283 join => { cd => 'track' },
3284 order_by => 'artist.name',
3288 You need to use the relationship (not the table) name in conditions,
3289 because they are aliased as such. The current table is aliased as "me", so
3290 you need to use me.column_name in order to avoid ambiguity. For example:
3292 # Get CDs from 1984 with a 'Foo' track
3293 my $rs = $schema->resultset('CD')->search(
3296 'tracks.name' => 'Foo'
3298 { join => 'tracks' }
3301 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3302 similarly for a third time). For e.g.
3304 my $rs = $schema->resultset('Artist')->search({
3305 'cds.title' => 'Down to Earth',
3306 'cds_2.title' => 'Popular',
3308 join => [ qw/cds cds/ ],
3311 will return a set of all artists that have both a cd with title 'Down
3312 to Earth' and a cd with title 'Popular'.
3314 If you want to fetch related objects from other tables as well, see C<prefetch>
3317 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3323 =item Value: ($rel_name | \@rel_names | \%rel_names)
3327 Contains one or more relationships that should be fetched along with
3328 the main query (when they are accessed afterwards the data will
3329 already be available, without extra queries to the database). This is
3330 useful for when you know you will need the related objects, because it
3331 saves at least one query:
3333 my $rs = $schema->resultset('Tag')->search(
3342 The initial search results in SQL like the following:
3344 SELECT tag.*, cd.*, artist.* FROM tag
3345 JOIN cd ON tag.cd = cd.cdid
3346 JOIN artist ON cd.artist = artist.artistid
3348 L<DBIx::Class> has no need to go back to the database when we access the
3349 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3352 Simple prefetches will be joined automatically, so there is no need
3353 for a C<join> attribute in the above search.
3355 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3356 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3357 with an accessor type of 'single' or 'filter'). A more complex example that
3358 prefetches an artists cds, the tracks on those cds, and the tags associted
3359 with that artist is given below (assuming many-to-many from artists to tags):
3361 my $rs = $schema->resultset('Artist')->search(
3365 { cds => 'tracks' },
3366 { artist_tags => 'tags' }
3372 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3373 attributes will be ignored.
3375 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3376 exactly as you might expect.
3382 Prefetch uses the L</cache> to populate the prefetched relationships. This
3383 may or may not be what you want.
3387 If you specify a condition on a prefetched relationship, ONLY those
3388 rows that match the prefetched condition will be fetched into that relationship.
3389 This means that adding prefetch to a search() B<may alter> what is returned by
3390 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3392 my $artist_rs = $schema->resultset('Artist')->search({
3398 my $count = $artist_rs->first->cds->count;
3400 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3402 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3404 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3406 that cmp_ok() may or may not pass depending on the datasets involved. This
3407 behavior may or may not survive the 0.09 transition.
3419 Makes the resultset paged and specifies the page to retrieve. Effectively
3420 identical to creating a non-pages resultset and then calling ->page($page)
3423 If L<rows> attribute is not specified it defaults to 10 rows per page.
3425 When you have a paged resultset, L</count> will only return the number
3426 of rows in the page. To get the total, use the L</pager> and call
3427 C<total_entries> on it.
3437 Specifes the maximum number of rows for direct retrieval or the number of
3438 rows per page if the page attribute or method is used.
3444 =item Value: $offset
3448 Specifies the (zero-based) row number for the first row to be returned, or the
3449 of the first row of the first page if paging is used.
3455 =item Value: \@columns
3459 A arrayref of columns to group by. Can include columns of joined tables.
3461 group_by => [qw/ column1 column2 ... /]
3467 =item Value: $condition
3471 HAVING is a select statement attribute that is applied between GROUP BY and
3472 ORDER BY. It is applied to the after the grouping calculations have been
3475 having => { 'count(employee)' => { '>=', 100 } }
3481 =item Value: (0 | 1)
3485 Set to 1 to group by all columns. If the resultset already has a group_by
3486 attribute, this setting is ignored and an appropriate warning is issued.
3492 Adds to the WHERE clause.
3494 # only return rows WHERE deleted IS NULL for all searches
3495 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3497 Can be overridden by passing C<< { where => undef } >> as an attribute
3504 Set to 1 to cache search results. This prevents extra SQL queries if you
3505 revisit rows in your ResultSet:
3507 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3509 while( my $artist = $resultset->next ) {
3513 $rs->first; # without cache, this would issue a query
3515 By default, searches are not cached.
3517 For more examples of using these attributes, see
3518 L<DBIx::Class::Manual::Cookbook>.
3524 =item Value: ( 'update' | 'shared' )
3528 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT