1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::ResultSetColumn;
13 use DBIx::Class::ResultSourceHandle;
16 use base qw/DBIx::Class/;
18 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
22 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
26 my $users_rs = $schema->resultset('User');
27 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
28 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
32 A ResultSet is an object which stores a set of conditions representing
33 a query. It is the backbone of DBIx::Class (i.e. the really
34 important/useful bit).
36 No SQL is executed on the database when a ResultSet is created, it
37 just stores all the conditions needed to create the query.
39 A basic ResultSet representing the data of an entire table is returned
40 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
41 L<Source|DBIx::Class::Manual::Glossary/Source> name.
43 my $users_rs = $schema->resultset('User');
45 A new ResultSet is returned from calling L</search> on an existing
46 ResultSet. The new one will contain all the conditions of the
47 original, plus any new conditions added in the C<search> call.
49 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
50 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
53 The query that the ResultSet represents is B<only> executed against
54 the database when these methods are called:
55 L</find> L</next> L</all> L</first> L</single> L</count>
59 =head2 Chaining resultsets
61 Let's say you've got a query that needs to be run to return some data
62 to the user. But, you have an authorization system in place that
63 prevents certain users from seeing certain information. So, you want
64 to construct the basic query in one method, but add constraints to it in
69 my $request = $self->get_request; # Get a request object somehow.
70 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
72 my $cd_rs = $schema->resultset('CD')->search({
73 title => $request->param('title'),
74 year => $request->param('year'),
77 $self->apply_security_policy( $cd_rs );
82 sub apply_security_policy {
91 =head3 Resolving conditions and attributes
93 When a resultset is chained from another resultset, conditions and
94 attributes with the same keys need resolving.
96 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
97 into the existing ones from the original resultset.
99 The L</where>, L</having> attribute, and any search conditions are
100 merged with an SQL C<AND> to the existing condition from the original
103 All other attributes are overridden by any new ones supplied in the
106 =head2 Multiple queries
108 Since a resultset just defines a query, you can do all sorts of
109 things with it with the same object.
111 # Don't hit the DB yet.
112 my $cd_rs = $schema->resultset('CD')->search({
113 title => 'something',
117 # Each of these hits the DB individually.
118 my $count = $cd_rs->count;
119 my $most_recent = $cd_rs->get_column('date_released')->max();
120 my @records = $cd_rs->all;
122 And it's not just limited to SELECT statements.
128 $cd_rs->create({ artist => 'Fred' });
130 Which is the same as:
132 $schema->resultset('CD')->create({
133 title => 'something',
138 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
142 If a resultset is used in a numeric context it returns the L</count>.
143 However, if it is used in a booleand context it is always true. So if
144 you want to check if a resultset has any results use C<if $rs != 0>.
145 C<if $rs> will always be true.
153 =item Arguments: $source, \%$attrs
155 =item Return Value: $rs
159 The resultset constructor. Takes a source object (usually a
160 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
161 L</ATTRIBUTES> below). Does not perform any queries -- these are
162 executed as needed by the other methods.
164 Generally you won't need to construct a resultset manually. You'll
165 automatically get one from e.g. a L</search> called in scalar context:
167 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
169 IMPORTANT: If called on an object, proxies to new_result instead so
171 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
173 will return a CD object, not a ResultSet.
179 return $class->new_result(@_) if ref $class;
181 my ($source, $attrs) = @_;
182 $source = $source->handle
183 unless $source->isa('DBIx::Class::ResultSourceHandle');
184 $attrs = { %{$attrs||{}} };
186 if ($attrs->{page}) {
187 $attrs->{rows} ||= 10;
190 $attrs->{alias} ||= 'me';
192 # Creation of {} and bless separated to mitigate RH perl bug
193 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
195 _source_handle => $source,
196 cond => $attrs->{where},
205 $attrs->{result_class} || $source->resolve->result_class
215 =item Arguments: $cond, \%attrs?
217 =item Return Value: $resultset (scalar context), @row_objs (list context)
221 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
222 my $new_rs = $cd_rs->search({ year => 2005 });
224 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
225 # year = 2005 OR year = 2004
227 If you need to pass in additional attributes but no additional condition,
228 call it as C<search(undef, \%attrs)>.
230 # "SELECT name, artistid FROM $artist_table"
231 my @all_artists = $schema->resultset('Artist')->search(undef, {
232 columns => [qw/name artistid/],
235 For a list of attributes that can be passed to C<search>, see
236 L</ATTRIBUTES>. For more examples of using this function, see
237 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
238 documentation for the first argument, see L<SQL::Abstract>.
240 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
246 my $rs = $self->search_rs( @_ );
247 return (wantarray ? $rs->all : $rs);
254 =item Arguments: $cond, \%attrs?
256 =item Return Value: $resultset
260 This method does the same exact thing as search() except it will
261 always return a resultset, even in list context.
268 # Special-case handling for (undef, undef).
269 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
274 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
275 my $our_attrs = { %{$self->{attrs}} };
276 my $having = delete $our_attrs->{having};
277 my $where = delete $our_attrs->{where};
281 my %safe = (alias => 1, cache => 1);
284 (@_ && defined($_[0])) # @_ == () or (undef)
286 (keys %$attrs # empty attrs or only 'safe' attrs
287 && List::Util::first { !$safe{$_} } keys %$attrs)
289 # no search, effectively just a clone
290 $rows = $self->get_cache;
293 my $new_attrs = { %{$our_attrs}, %{$attrs} };
295 # merge new attrs into inherited
296 foreach my $key (qw/join prefetch +select +as bind/) {
297 next unless exists $attrs->{$key};
298 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
303 (@_ == 1 || ref $_[0] eq "HASH")
305 (ref $_[0] eq 'HASH')
307 (keys %{ $_[0] } > 0)
315 ? $self->throw_exception("Odd number of arguments to search")
322 if (defined $where) {
323 $new_attrs->{where} = (
324 defined $new_attrs->{where}
327 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
328 } $where, $new_attrs->{where}
335 $new_attrs->{where} = (
336 defined $new_attrs->{where}
339 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
340 } $cond, $new_attrs->{where}
346 if (defined $having) {
347 $new_attrs->{having} = (
348 defined $new_attrs->{having}
351 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
352 } $having, $new_attrs->{having}
358 my $rs = (ref $self)->new($self->result_source, $new_attrs);
360 $rs->set_cache($rows);
365 =head2 search_literal
369 =item Arguments: $sql_fragment, @bind_values
371 =item Return Value: $resultset (scalar context), @row_objs (list context)
375 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
376 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
378 Pass a literal chunk of SQL to be added to the conditional part of the
381 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
382 only be used in that context. C<search_literal> is a convenience method.
383 It is equivalent to calling $schema->search(\[]), but if you want to ensure
384 columns are bound correctly, use C<search>.
386 Example of how to use C<search> instead of C<search_literal>
388 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
389 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
392 See L<DBIx::Class::Manual::Cookbook/Searching> and
393 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
394 require C<search_literal>.
399 my ($self, $sql, @bind) = @_;
401 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
404 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
411 =item Arguments: @values | \%cols, \%attrs?
413 =item Return Value: $row_object | undef
417 Finds a row based on its primary key or unique constraint. For example, to find
418 a row by its primary key:
420 my $cd = $schema->resultset('CD')->find(5);
422 You can also find a row by a specific unique constraint using the C<key>
423 attribute. For example:
425 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
426 key => 'cd_artist_title'
429 Additionally, you can specify the columns explicitly by name:
431 my $cd = $schema->resultset('CD')->find(
433 artist => 'Massive Attack',
434 title => 'Mezzanine',
436 { key => 'cd_artist_title' }
439 If the C<key> is specified as C<primary>, it searches only on the primary key.
441 If no C<key> is specified, it searches on all unique constraints defined on the
442 source for which column data is provided, including the primary key.
444 If your table does not have a primary key, you B<must> provide a value for the
445 C<key> attribute matching one of the unique constraints on the source.
447 In addition to C<key>, L</find> recognizes and applies standard
448 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
450 Note: If your query does not return only one row, a warning is generated:
452 Query returned more than one row
454 See also L</find_or_create> and L</update_or_create>. For information on how to
455 declare unique constraints, see
456 L<DBIx::Class::ResultSource/add_unique_constraint>.
462 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
464 # Default to the primary key, but allow a specific key
465 my @cols = exists $attrs->{key}
466 ? $self->result_source->unique_constraint_columns($attrs->{key})
467 : $self->result_source->primary_columns;
468 $self->throw_exception(
469 "Can't find unless a primary key is defined or unique constraint is specified"
472 # Parse out a hashref from input
474 if (ref $_[0] eq 'HASH') {
475 $input_query = { %{$_[0]} };
477 elsif (@_ == @cols) {
479 @{$input_query}{@cols} = @_;
482 # Compatibility: Allow e.g. find(id => $value)
483 carp "Find by key => value deprecated; please use a hashref instead";
487 my (%related, $info);
489 KEY: foreach my $key (keys %$input_query) {
490 if (ref($input_query->{$key})
491 && ($info = $self->result_source->relationship_info($key))) {
492 my $val = delete $input_query->{$key};
493 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
494 my $rel_q = $self->result_source->_resolve_condition(
495 $info->{cond}, $val, $key
497 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
498 @related{keys %$rel_q} = values %$rel_q;
501 if (my @keys = keys %related) {
502 @{$input_query}{@keys} = values %related;
506 # Build the final query: Default to the disjunction of the unique queries,
507 # but allow the input query in case the ResultSet defines the query or the
508 # user is abusing find
509 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
511 if (exists $attrs->{key}) {
512 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
513 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
514 $query = $self->_add_alias($unique_query, $alias);
516 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
517 # This means that we got here after a merger of relationship conditions
518 # in ::Relationship::Base::search_related (the row method), and furthermore
519 # the relationship is of the 'single' type. This means that the condition
520 # provided by the relationship (already attached to $self) is sufficient,
521 # as there can be only one row in the databse that would satisfy the
525 my @unique_queries = $self->_unique_queries($input_query, $attrs);
526 $query = @unique_queries
527 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
528 : $self->_add_alias($input_query, $alias);
532 my $rs = $self->search ($query, $attrs);
533 if (keys %{$rs->_resolved_attrs->{collapse}}) {
535 carp "Query returned more than one row" if $rs->next;
545 # Add the specified alias to the specified query hash. A copy is made so the
546 # original query is not modified.
549 my ($self, $query, $alias) = @_;
551 my %aliased = %$query;
552 foreach my $col (grep { ! m/\./ } keys %aliased) {
553 $aliased{"$alias.$col"} = delete $aliased{$col};
561 # Build a list of queries which satisfy unique constraints.
563 sub _unique_queries {
564 my ($self, $query, $attrs) = @_;
566 my @constraint_names = exists $attrs->{key}
568 : $self->result_source->unique_constraint_names;
570 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
571 my $num_where = scalar keys %$where;
574 foreach my $name (@constraint_names) {
575 my @unique_cols = $self->result_source->unique_constraint_columns($name);
576 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
578 my $num_cols = scalar @unique_cols;
579 my $num_query = scalar keys %$unique_query;
581 my $total = $num_query + $num_where;
582 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
583 # The query is either unique on its own or is unique in combination with
584 # the existing where clause
585 push @unique_queries, $unique_query;
589 return @unique_queries;
592 # _build_unique_query
594 # Constrain the specified query hash based on the specified column names.
596 sub _build_unique_query {
597 my ($self, $query, $unique_cols) = @_;
600 map { $_ => $query->{$_} }
601 grep { exists $query->{$_} }
606 =head2 search_related
610 =item Arguments: $rel, $cond, \%attrs?
612 =item Return Value: $new_resultset
616 $new_rs = $cd_rs->search_related('artist', {
620 Searches the specified relationship, optionally specifying a condition and
621 attributes for matching records. See L</ATTRIBUTES> for more information.
626 return shift->related_resultset(shift)->search(@_);
629 =head2 search_related_rs
631 This method works exactly the same as search_related, except that
632 it guarantees a restultset, even in list context.
636 sub search_related_rs {
637 return shift->related_resultset(shift)->search_rs(@_);
644 =item Arguments: none
646 =item Return Value: $cursor
650 Returns a storage-driven cursor to the given resultset. See
651 L<DBIx::Class::Cursor> for more information.
658 my $attrs = $self->_resolved_attrs_copy;
660 return $self->{cursor}
661 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
662 $attrs->{where},$attrs);
669 =item Arguments: $cond?
671 =item Return Value: $row_object?
675 my $cd = $schema->resultset('CD')->single({ year => 2001 });
677 Inflates the first result without creating a cursor if the resultset has
678 any records in it; if not returns nothing. Used by L</find> as a lean version of
681 While this method can take an optional search condition (just like L</search>)
682 being a fast-code-path it does not recognize search attributes. If you need to
683 add extra joins or similar, call L</search> and then chain-call L</single> on the
684 L<DBIx::Class::ResultSet> returned.
690 As of 0.08100, this method enforces the assumption that the preceeding
691 query returns only one row. If more than one row is returned, you will receive
694 Query returned more than one row
696 In this case, you should be using L</next> or L</find> instead, or if you really
697 know what you are doing, use the L</rows> attribute to explicitly limit the size
700 This method will also throw an exception if it is called on a resultset prefetching
701 has_many, as such a prefetch implies fetching multiple rows from the database in
702 order to assemble the resulting object.
709 my ($self, $where) = @_;
711 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
714 my $attrs = $self->_resolved_attrs_copy;
716 if (keys %{$attrs->{collapse}}) {
717 $self->throw_exception(
718 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
723 if (defined $attrs->{where}) {
726 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
727 $where, delete $attrs->{where} ]
730 $attrs->{where} = $where;
734 # XXX: Disabled since it doesn't infer uniqueness in all cases
735 # unless ($self->_is_unique_query($attrs->{where})) {
736 # carp "Query not guaranteed to return a single row"
737 # . "; please declare your unique constraints or use search instead";
740 my @data = $self->result_source->storage->select_single(
741 $attrs->{from}, $attrs->{select},
742 $attrs->{where}, $attrs
745 return (@data ? ($self->_construct_object(@data))[0] : undef);
751 # Try to determine if the specified query is guaranteed to be unique, based on
752 # the declared unique constraints.
754 sub _is_unique_query {
755 my ($self, $query) = @_;
757 my $collapsed = $self->_collapse_query($query);
758 my $alias = $self->{attrs}{alias};
760 foreach my $name ($self->result_source->unique_constraint_names) {
761 my @unique_cols = map {
763 } $self->result_source->unique_constraint_columns($name);
765 # Count the values for each unique column
766 my %seen = map { $_ => 0 } @unique_cols;
768 foreach my $key (keys %$collapsed) {
769 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
770 next unless exists $seen{$aliased}; # Additional constraints are okay
771 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
774 # If we get 0 or more than 1 value for a column, it's not necessarily unique
775 return 1 unless grep { $_ != 1 } values %seen;
783 # Recursively collapse the query, accumulating values for each column.
785 sub _collapse_query {
786 my ($self, $query, $collapsed) = @_;
790 if (ref $query eq 'ARRAY') {
791 foreach my $subquery (@$query) {
792 next unless ref $subquery; # -or
793 $collapsed = $self->_collapse_query($subquery, $collapsed);
796 elsif (ref $query eq 'HASH') {
797 if (keys %$query and (keys %$query)[0] eq '-and') {
798 foreach my $subquery (@{$query->{-and}}) {
799 $collapsed = $self->_collapse_query($subquery, $collapsed);
803 foreach my $col (keys %$query) {
804 my $value = $query->{$col};
805 $collapsed->{$col}{$value}++;
817 =item Arguments: $cond?
819 =item Return Value: $resultsetcolumn
823 my $max_length = $rs->get_column('length')->max;
825 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
830 my ($self, $column) = @_;
831 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
839 =item Arguments: $cond, \%attrs?
841 =item Return Value: $resultset (scalar context), @row_objs (list context)
845 # WHERE title LIKE '%blue%'
846 $cd_rs = $rs->search_like({ title => '%blue%'});
848 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
849 that this is simply a convenience method retained for ex Class::DBI users.
850 You most likely want to use L</search> with specific operators.
852 For more information, see L<DBIx::Class::Manual::Cookbook>.
854 This method is deprecated and will be removed in 0.09. Use L</search()>
855 instead. An example conversion is:
857 ->search_like({ foo => 'bar' });
861 ->search({ foo => { like => 'bar' } });
868 'search_like() is deprecated and will be removed in DBIC version 0.09.'
869 .' Instead use ->search({ x => { -like => "y%" } })'
870 .' (note the outer pair of {}s - they are important!)'
872 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
873 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
874 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
875 return $class->search($query, { %$attrs });
882 =item Arguments: $first, $last
884 =item Return Value: $resultset (scalar context), @row_objs (list context)
888 Returns a resultset or object list representing a subset of elements from the
889 resultset slice is called on. Indexes are from 0, i.e., to get the first
892 my ($one, $two, $three) = $rs->slice(0, 2);
897 my ($self, $min, $max) = @_;
898 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
899 $attrs->{offset} = $self->{attrs}{offset} || 0;
900 $attrs->{offset} += $min;
901 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
902 return $self->search(undef(), $attrs);
903 #my $slice = (ref $self)->new($self->result_source, $attrs);
904 #return (wantarray ? $slice->all : $slice);
911 =item Arguments: none
913 =item Return Value: $result?
917 Returns the next element in the resultset (C<undef> is there is none).
919 Can be used to efficiently iterate over records in the resultset:
921 my $rs = $schema->resultset('CD')->search;
922 while (my $cd = $rs->next) {
926 Note that you need to store the resultset object, and call C<next> on it.
927 Calling C<< resultset('Table')->next >> repeatedly will always return the
928 first record from the resultset.
934 if (my $cache = $self->get_cache) {
935 $self->{all_cache_position} ||= 0;
936 return $cache->[$self->{all_cache_position}++];
938 if ($self->{attrs}{cache}) {
939 $self->{all_cache_position} = 1;
940 return ($self->all)[0];
942 if ($self->{stashed_objects}) {
943 my $obj = shift(@{$self->{stashed_objects}});
944 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
948 exists $self->{stashed_row}
949 ? @{delete $self->{stashed_row}}
950 : $self->cursor->next
952 return undef unless (@row);
953 my ($row, @more) = $self->_construct_object(@row);
954 $self->{stashed_objects} = \@more if @more;
958 sub _construct_object {
959 my ($self, @row) = @_;
961 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
963 my @new = $self->result_class->inflate_result($self->result_source, @$info);
964 @new = $self->{_attrs}{record_filter}->(@new)
965 if exists $self->{_attrs}{record_filter};
969 # _unflatten_result takes a row hashref which looks like this:
971 # 'cd.artist.artistid' => '1',
972 # 'cd.artist' => '1',
974 # 'cd.genreid' => undef,
975 # 'cd.year' => '1999',
976 # 'cd.title' => 'Spoonful of bees',
977 # 'cd.single_track' => undef,
978 # 'cd.artist.name' => 'Caterwauler McCrae',
979 # 'cd.artist.rank' => '13',
980 # 'cd.artist.charfield' => undef,
984 # and generates the following structure:
993 # 'single_track' => undef,
996 # 'title' => 'Spoonful of bees',
1003 # 'artistid' => '1',
1004 # 'charfield' => undef,
1005 # 'name' => 'Caterwauler McCrae',
1014 # It returns one row object which consists of an arrayref with two
1015 # elements. The first contains the plain column data, the second
1016 # contains the data of relationships. Those are row arrayrefs, themselves.
1018 # it's a recursive function. It needs to request the relationship_info
1019 # to decide whether to put the data of a relationship in a hashref
1020 # (i.e. belongs_to) or an arrayref (i.e. has_many).
1022 sub _unflatten_result {
1023 my ( $self, $row ) = @_;
1028 foreach my $column ( sort keys %$row ) {
1029 if ( $column =~ /^(.*?)\.(.*)$/ ) {
1031 $rels->{$1}->{$2} = $row->{$column};
1034 $columns->{$column} = $row->{$column};
1038 foreach my $rel ( sort keys %$rels ) {
1039 my $rel_info = $self->result_source->relationship_info($rel);
1041 $self->related_resultset($rel)->_unflatten_result( $rels->{$rel} );
1042 $rels->{$rel} = [ $rels->{$rel} ]
1043 if ( $rel_info->{attrs}->{accessor} eq 'multi' );
1046 return keys %$rels ? [ $columns, $rels ] : [$columns];
1049 # two arguments: $as_proto is an arrayref of column names,
1050 # $row_ref is an arrayref of the data. If none of the row data
1051 # is defined we return undef (that's copied from the old
1052 # _collapse_result). Next we decide whether we need to collapse
1053 # the resultset (i.e. we prefetch something) or not. $collapse
1054 # indicates that. The do-while loop will run once if we do not need
1055 # to collapse the result and will run as long as _merge_result returns
1056 # a true value. It will return undef if the current added row does not
1057 # match the previous row. A bit of stashing and cursor magic is
1058 # required so that the cursor is not mixed up.
1060 # "$rows" is a bit misleading. In the end, there should only be one
1061 # element in this arrayref.
1063 sub _collapse_result {
1064 my ( $self, $as_proto, $row_ref ) = @_;
1072 return undef unless $has_def;
1074 my $collapse = keys %{ $self->{_attrs}{collapse} || {} };
1076 my @row = @$row_ref;
1079 my $row = { map { $_ => $row[ $i++ ] } @$as_proto };
1080 $row = $self->_unflatten_result($row);
1081 unless ( scalar @$rows ) {
1082 push( @$rows, $row );
1084 $collapse = undef unless ( $self->_merge_result( $rows, $row ) );
1087 && do { @row = $self->cursor->next; $self->{stashed_row} = \@row if @row; }
1094 # _merge_result accepts an arrayref of rows objects (again, an arrayref of two elements)
1095 # and a row object which should be merged into the first object.
1096 # First we try to find out whether $row is already in $rows. If this is the case
1097 # we try to merge them by iteration through their relationship data. We call
1098 # _merge_result again on them, so they get merged.
1100 # If we don't find the $row in $rows, we append it to $rows and return undef.
1101 # _merge_result returns 1 otherwise (i.e. $row has been found in $rows).
1104 my ( $self, $rows, $row ) = @_;
1105 my ( $columns, $rels ) = @$row;
1107 foreach my $seen (@$rows) {
1109 foreach my $column ( keys %$columns ) {
1110 if ( defined $seen->[0]->{$column} ^ defined $columns->{$column}
1111 or defined $columns->{$column}
1112 && $seen->[0]->{$column} ne $columns->{$column} )
1125 foreach my $rel ( keys %$rels ) {
1126 my $old_rows = $found->[1]->{$rel};
1127 $self->_merge_result(
1128 ref $found->[1]->{$rel}->[0] eq 'HASH' ? [ $found->[1]->{$rel} ]
1129 : $found->[1]->{$rel},
1130 ref $rels->{$rel}->[0] eq 'HASH' ? [ $rels->{$rel}->[0], $rels->{$rel}->[1] ]
1131 : $rels->{$rel}->[0]
1138 push( @$rows, $row );
1146 =head2 result_source
1150 =item Arguments: $result_source?
1152 =item Return Value: $result_source
1156 An accessor for the primary ResultSource object from which this ResultSet
1163 =item Arguments: $result_class?
1165 =item Return Value: $result_class
1169 An accessor for the class to use when creating row objects. Defaults to
1170 C<< result_source->result_class >> - which in most cases is the name of the
1171 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1173 Note that changing the result_class will also remove any components
1174 that were originally loaded in the source class via
1175 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1176 in the original source class will not run.
1181 my ($self, $result_class) = @_;
1182 if ($result_class) {
1183 $self->ensure_class_loaded($result_class);
1184 $self->_result_class($result_class);
1186 $self->_result_class;
1193 =item Arguments: $cond, \%attrs??
1195 =item Return Value: $count
1199 Performs an SQL C<COUNT> with the same query as the resultset was built
1200 with to find the number of elements. Passing arguments is equivalent to
1201 C<< $rs->search ($cond, \%attrs)->count >>
1207 return $self->search(@_)->count if @_ and defined $_[0];
1208 return scalar @{ $self->get_cache } if $self->get_cache;
1210 my $attrs = $self->_resolved_attrs_copy;
1212 # this is a little optimization - it is faster to do the limit
1213 # adjustments in software, instead of a subquery
1214 my $rows = delete $attrs->{rows};
1215 my $offset = delete $attrs->{offset};
1218 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1219 $crs = $self->_count_subq_rs ($attrs);
1222 $crs = $self->_count_rs ($attrs);
1224 my $count = $crs->next;
1226 $count -= $offset if $offset;
1227 $count = $rows if $rows and $rows < $count;
1228 $count = 0 if ($count < 0);
1237 =item Arguments: $cond, \%attrs??
1239 =item Return Value: $count_rs
1243 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1244 This can be very handy for subqueries:
1246 ->search( { amount => $some_rs->count_rs->as_query } )
1248 As with regular resultsets the SQL query will be executed only after
1249 the resultset is accessed via L</next> or L</all>. That would return
1250 the same single value obtainable via L</count>.
1256 return $self->search(@_)->count_rs if @_;
1258 # this may look like a lack of abstraction (count() does about the same)
1259 # but in fact an _rs *must* use a subquery for the limits, as the
1260 # software based limiting can not be ported if this $rs is to be used
1261 # in a subquery itself (i.e. ->as_query)
1262 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1263 return $self->_count_subq_rs;
1266 return $self->_count_rs;
1271 # returns a ResultSetColumn object tied to the count query
1274 my ($self, $attrs) = @_;
1276 my $rsrc = $self->result_source;
1277 $attrs ||= $self->_resolved_attrs;
1279 my $tmp_attrs = { %$attrs };
1281 # take off any limits, record_filter is cdbi, and no point of ordering a count
1282 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1284 # overwrite the selector (supplied by the storage)
1285 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1286 $tmp_attrs->{as} = 'count';
1288 # read the comment on top of the actual function to see what this does
1289 $tmp_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1290 $tmp_attrs->{from}, $tmp_attrs->{alias}
1293 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1299 # same as above but uses a subquery
1301 sub _count_subq_rs {
1302 my ($self, $attrs) = @_;
1304 my $rsrc = $self->result_source;
1305 $attrs ||= $self->_resolved_attrs_copy;
1307 my $sub_attrs = { %$attrs };
1309 # extra selectors do not go in the subquery and there is no point of ordering it
1310 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1312 # if we prefetch, we group_by primary keys only as this is what we would get out
1313 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1314 if ( keys %{$attrs->{collapse}} ) {
1315 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1318 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1320 # read the comment on top of the actual function to see what this does
1321 $sub_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1322 $sub_attrs->{from}, $sub_attrs->{alias}
1325 # this is so that ordering can be thrown away in things like Top limit
1326 $sub_attrs->{-for_count_only} = 1;
1328 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1331 -alias => 'count_subq',
1332 -source_handle => $rsrc->handle,
1333 count_subq => $sub_rs->as_query,
1336 # the subquery replaces this
1337 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1339 return $self->_count_rs ($attrs);
1343 # The DBIC relationship chaining implementation is pretty simple - every
1344 # new related_relationship is pushed onto the {from} stack, and the {select}
1345 # window simply slides further in. This means that when we count somewhere
1346 # in the middle, we got to make sure that everything in the join chain is an
1347 # actual inner join, otherwise the count will come back with unpredictable
1348 # results (a resultset may be generated with _some_ rows regardless of if
1349 # the relation which the $rs currently selects has rows or not). E.g.
1350 # $artist_rs->cds->count - normally generates:
1351 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
1352 # which actually returns the number of artists * (number of cds || 1)
1354 # So what we do here is crawl {from}, determine if the current alias is at
1355 # the top of the stack, and if not - make sure the chain is inner-joined down
1358 sub _switch_to_inner_join_if_needed {
1359 my ($self, $from, $alias) = @_;
1361 # subqueries and other oddness is naturally not supported
1363 ref $from ne 'ARRAY'
1367 ref $from->[0] ne 'HASH'
1369 ! $from->[0]{-alias}
1371 $from->[0]{-alias} eq $alias
1376 for my $j (@{$from}[1 .. $#$from]) {
1377 if ($j->[0]{-alias} eq $alias) {
1378 $switch_branch = $j->[0]{-join_path};
1383 # something else went wrong
1384 return $from unless $switch_branch;
1386 # So it looks like we will have to switch some stuff around.
1387 # local() is useless here as we will be leaving the scope
1388 # anyway, and deep cloning is just too fucking expensive
1389 # So replace the inner hashref manually
1390 my @new_from = ($from->[0]);
1391 my $sw_idx = { map { $_ => 1 } @$switch_branch };
1393 for my $j (@{$from}[1 .. $#$from]) {
1394 my $jalias = $j->[0]{-alias};
1396 if ($sw_idx->{$jalias}) {
1397 my %attrs = %{$j->[0]};
1398 delete $attrs{-join_type};
1417 =head2 count_literal
1421 =item Arguments: $sql_fragment, @bind_values
1423 =item Return Value: $count
1427 Counts the results in a literal query. Equivalent to calling L</search_literal>
1428 with the passed arguments, then L</count>.
1432 sub count_literal { shift->search_literal(@_)->count; }
1438 =item Arguments: none
1440 =item Return Value: @objects
1444 Returns all elements in the resultset. Called implicitly if the resultset
1445 is returned in list context.
1452 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1455 return @{ $self->get_cache } if $self->get_cache;
1459 if (keys %{$self->_resolved_attrs->{collapse}}) {
1460 # Using $self->cursor->all is really just an optimisation.
1461 # If we're collapsing has_many prefetches it probably makes
1462 # very little difference, and this is cleaner than hacking
1463 # _construct_object to survive the approach
1464 $self->cursor->reset;
1465 my @row = $self->cursor->next;
1467 push(@obj, $self->_construct_object(@row));
1468 @row = (exists $self->{stashed_row}
1469 ? @{delete $self->{stashed_row}}
1470 : $self->cursor->next);
1473 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1476 $self->set_cache(\@obj) if $self->{attrs}{cache};
1485 =item Arguments: none
1487 =item Return Value: $self
1491 Resets the resultset's cursor, so you can iterate through the elements again.
1492 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1499 delete $self->{_attrs} if exists $self->{_attrs};
1500 $self->{all_cache_position} = 0;
1501 $self->cursor->reset;
1509 =item Arguments: none
1511 =item Return Value: $object?
1515 Resets the resultset and returns an object for the first result (if the
1516 resultset returns anything).
1521 return $_[0]->reset->next;
1527 # Determines whether and what type of subquery is required for the $rs operation.
1528 # If grouping is necessary either supplies its own, or verifies the current one
1529 # After all is done delegates to the proper storage method.
1531 sub _rs_update_delete {
1532 my ($self, $op, $values) = @_;
1534 my $rsrc = $self->result_source;
1536 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1537 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1539 if ($needs_group_by_subq or $needs_subq) {
1541 # make a new $rs selecting only the PKs (that's all we really need)
1542 my $attrs = $self->_resolved_attrs_copy;
1544 delete $attrs->{$_} for qw/collapse select as/;
1545 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1547 if ($needs_group_by_subq) {
1548 # make sure no group_by was supplied, or if there is one - make sure it matches
1549 # the columns compiled above perfectly. Anything else can not be sanely executed
1550 # on most databases so croak right then and there
1552 if (my $g = $attrs->{group_by}) {
1553 my @current_group_by = map
1554 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1559 join ("\x00", sort @current_group_by)
1561 join ("\x00", sort @{$attrs->{columns}} )
1563 $self->throw_exception (
1564 "You have just attempted a $op operation on a resultset which does group_by"
1565 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1566 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1567 . ' kind of queries. Please retry the operation with a modified group_by or'
1568 . ' without using one at all.'
1573 $attrs->{group_by} = $attrs->{columns};
1577 my $subrs = (ref $self)->new($rsrc, $attrs);
1579 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1582 return $rsrc->storage->$op(
1584 $op eq 'update' ? $values : (),
1585 $self->_cond_for_update_delete,
1591 # _cond_for_update_delete
1593 # update/delete require the condition to be modified to handle
1594 # the differing SQL syntax available. This transforms the $self->{cond}
1595 # appropriately, returning the new condition.
1597 sub _cond_for_update_delete {
1598 my ($self, $full_cond) = @_;
1601 $full_cond ||= $self->{cond};
1602 # No-op. No condition, we're updating/deleting everything
1603 return $cond unless ref $full_cond;
1605 if (ref $full_cond eq 'ARRAY') {
1609 foreach my $key (keys %{$_}) {
1611 $hash{$1} = $_->{$key};
1617 elsif (ref $full_cond eq 'HASH') {
1618 if ((keys %{$full_cond})[0] eq '-and') {
1620 my @cond = @{$full_cond->{-and}};
1621 for (my $i = 0; $i < @cond; $i++) {
1622 my $entry = $cond[$i];
1624 if (ref $entry eq 'HASH') {
1625 $hash = $self->_cond_for_update_delete($entry);
1628 $entry =~ /([^.]+)$/;
1629 $hash->{$1} = $cond[++$i];
1631 push @{$cond->{-and}}, $hash;
1635 foreach my $key (keys %{$full_cond}) {
1637 $cond->{$1} = $full_cond->{$key};
1642 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1653 =item Arguments: \%values
1655 =item Return Value: $storage_rv
1659 Sets the specified columns in the resultset to the supplied values in a
1660 single query. Return value will be true if the update succeeded or false
1661 if no records were updated; exact type of success value is storage-dependent.
1666 my ($self, $values) = @_;
1667 $self->throw_exception('Values for update must be a hash')
1668 unless ref $values eq 'HASH';
1670 return $self->_rs_update_delete ('update', $values);
1677 =item Arguments: \%values
1679 =item Return Value: 1
1683 Fetches all objects and updates them one at a time. Note that C<update_all>
1684 will run DBIC cascade triggers, while L</update> will not.
1689 my ($self, $values) = @_;
1690 $self->throw_exception('Values for update_all must be a hash')
1691 unless ref $values eq 'HASH';
1692 foreach my $obj ($self->all) {
1693 $obj->set_columns($values)->update;
1702 =item Arguments: none
1704 =item Return Value: $storage_rv
1708 Deletes the contents of the resultset from its result source. Note that this
1709 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1710 to run. See also L<DBIx::Class::Row/delete>.
1712 Return value will be the amount of rows deleted; exact type of return value
1713 is storage-dependent.
1719 $self->throw_exception('delete does not accept any arguments')
1722 return $self->_rs_update_delete ('delete');
1729 =item Arguments: none
1731 =item Return Value: 1
1735 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1736 will run DBIC cascade triggers, while L</delete> will not.
1742 $self->throw_exception('delete_all does not accept any arguments')
1745 $_->delete for $self->all;
1753 =item Arguments: \@data;
1757 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1758 For the arrayref of hashrefs style each hashref should be a structure suitable
1759 forsubmitting to a $resultset->create(...) method.
1761 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1762 to insert the data, as this is a faster method.
1764 Otherwise, each set of data is inserted into the database using
1765 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1766 accumulated into an array. The array itself, or an array reference
1767 is returned depending on scalar or list context.
1769 Example: Assuming an Artist Class that has many CDs Classes relating:
1771 my $Artist_rs = $schema->resultset("Artist");
1773 ## Void Context Example
1774 $Artist_rs->populate([
1775 { artistid => 4, name => 'Manufactured Crap', cds => [
1776 { title => 'My First CD', year => 2006 },
1777 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1780 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1781 { title => 'My parents sold me to a record company' ,year => 2005 },
1782 { title => 'Why Am I So Ugly?', year => 2006 },
1783 { title => 'I Got Surgery and am now Popular', year => 2007 }
1788 ## Array Context Example
1789 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1790 { name => "Artist One"},
1791 { name => "Artist Two"},
1792 { name => "Artist Three", cds=> [
1793 { title => "First CD", year => 2007},
1794 { title => "Second CD", year => 2008},
1798 print $ArtistOne->name; ## response is 'Artist One'
1799 print $ArtistThree->cds->count ## reponse is '2'
1801 For the arrayref of arrayrefs style, the first element should be a list of the
1802 fieldsnames to which the remaining elements are rows being inserted. For
1805 $Arstist_rs->populate([
1806 [qw/artistid name/],
1807 [100, 'A Formally Unknown Singer'],
1808 [101, 'A singer that jumped the shark two albums ago'],
1809 [102, 'An actually cool singer.'],
1812 Please note an important effect on your data when choosing between void and
1813 wantarray context. Since void context goes straight to C<insert_bulk> in
1814 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1815 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1816 create primary keys for you, you will find that your PKs are empty. In this
1817 case you will have to use the wantarray context in order to create those
1823 my $self = shift @_;
1824 my $data = ref $_[0][0] eq 'HASH'
1825 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1826 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1828 if(defined wantarray) {
1830 foreach my $item (@$data) {
1831 push(@created, $self->create($item));
1833 return wantarray ? @created : \@created;
1835 my ($first, @rest) = @$data;
1837 my @names = grep {!ref $first->{$_}} keys %$first;
1838 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1839 my @pks = $self->result_source->primary_columns;
1841 ## do the belongs_to relationships
1842 foreach my $index (0..$#$data) {
1844 # delegate to create() for any dataset without primary keys with specified relationships
1845 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1847 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1848 my @ret = $self->populate($data);
1854 foreach my $rel (@rels) {
1855 next unless ref $data->[$index]->{$rel} eq "HASH";
1856 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1857 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1858 my $related = $result->result_source->_resolve_condition(
1859 $result->result_source->relationship_info($reverse)->{cond},
1864 delete $data->[$index]->{$rel};
1865 $data->[$index] = {%{$data->[$index]}, %$related};
1867 push @names, keys %$related if $index == 0;
1871 ## do bulk insert on current row
1872 my @values = map { [ @$_{@names} ] } @$data;
1874 $self->result_source->storage->insert_bulk(
1875 $self->result_source,
1880 ## do the has_many relationships
1881 foreach my $item (@$data) {
1883 foreach my $rel (@rels) {
1884 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1886 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1887 || $self->throw_exception('Cannot find the relating object.');
1889 my $child = $parent->$rel;
1891 my $related = $child->result_source->_resolve_condition(
1892 $parent->result_source->relationship_info($rel)->{cond},
1897 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1898 my @populate = map { {%$_, %$related} } @rows_to_add;
1900 $child->populate( \@populate );
1906 =head2 _normalize_populate_args ($args)
1908 Private method used by L</populate> to normalize its incoming arguments. Factored
1909 out in case you want to subclass and accept new argument structures to the
1910 L</populate> method.
1914 sub _normalize_populate_args {
1915 my ($self, $data) = @_;
1916 my @names = @{shift(@$data)};
1917 my @results_to_create;
1918 foreach my $datum (@$data) {
1919 my %result_to_create;
1920 foreach my $index (0..$#names) {
1921 $result_to_create{$names[$index]} = $$datum[$index];
1923 push @results_to_create, \%result_to_create;
1925 return \@results_to_create;
1932 =item Arguments: none
1934 =item Return Value: $pager
1938 Return Value a L<Data::Page> object for the current resultset. Only makes
1939 sense for queries with a C<page> attribute.
1941 To get the full count of entries for a paged resultset, call
1942 C<total_entries> on the L<Data::Page> object.
1949 return $self->{pager} if $self->{pager};
1951 my $attrs = $self->{attrs};
1952 $self->throw_exception("Can't create pager for non-paged rs")
1953 unless $self->{attrs}{page};
1954 $attrs->{rows} ||= 10;
1956 # throw away the paging flags and re-run the count (possibly
1957 # with a subselect) to get the real total count
1958 my $count_attrs = { %$attrs };
1959 delete $count_attrs->{$_} for qw/rows offset page pager/;
1960 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1962 return $self->{pager} = Data::Page->new(
1965 $self->{attrs}{page}
1973 =item Arguments: $page_number
1975 =item Return Value: $rs
1979 Returns a resultset for the $page_number page of the resultset on which page
1980 is called, where each page contains a number of rows equal to the 'rows'
1981 attribute set on the resultset (10 by default).
1986 my ($self, $page) = @_;
1987 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1994 =item Arguments: \%vals
1996 =item Return Value: $rowobject
2000 Creates a new row object in the resultset's result class and returns
2001 it. The row is not inserted into the database at this point, call
2002 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2003 will tell you whether the row object has been inserted or not.
2005 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2010 my ($self, $values) = @_;
2011 $self->throw_exception( "new_result needs a hash" )
2012 unless (ref $values eq 'HASH');
2015 my $alias = $self->{attrs}{alias};
2018 defined $self->{cond}
2019 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
2021 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2022 $new{-from_resultset} = [ keys %new ] if keys %new;
2024 $self->throw_exception(
2025 "Can't abstract implicit construct, condition not a hash"
2026 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
2028 my $collapsed_cond = (
2030 ? $self->_collapse_cond($self->{cond})
2034 # precendence must be given to passed values over values inherited from
2035 # the cond, so the order here is important.
2036 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2037 while( my($col,$value) = each %implied ){
2038 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
2039 $new{$col} = $value->{'='};
2042 $new{$col} = $value if $self->_is_deterministic_value($value);
2048 %{ $self->_remove_alias($values, $alias) },
2049 -source_handle => $self->_source_handle,
2050 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2053 return $self->result_class->new(\%new);
2056 # _is_deterministic_value
2058 # Make an effor to strip non-deterministic values from the condition,
2059 # to make sure new_result chokes less
2061 sub _is_deterministic_value {
2064 my $ref_type = ref $value;
2065 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
2066 return 1 if Scalar::Util::blessed($value);
2070 # _has_resolved_attr
2072 # determines if the resultset defines at least one
2073 # of the attributes supplied
2075 # used to determine if a subquery is neccessary
2077 # supports some virtual attributes:
2079 # This will scan for any joins being present on the resultset.
2080 # It is not a mere key-search but a deep inspection of {from}
2083 sub _has_resolved_attr {
2084 my ($self, @attr_names) = @_;
2086 my $attrs = $self->_resolved_attrs;
2090 for my $n (@attr_names) {
2091 if (grep { $n eq $_ } (qw/-join/) ) {
2092 $extra_checks{$n}++;
2096 my $attr = $attrs->{$n};
2098 next if not defined $attr;
2100 if (ref $attr eq 'HASH') {
2101 return 1 if keys %$attr;
2103 elsif (ref $attr eq 'ARRAY') {
2111 # a resolved join is expressed as a multi-level from
2113 $extra_checks{-join}
2115 ref $attrs->{from} eq 'ARRAY'
2117 @{$attrs->{from}} > 1
2125 # Recursively collapse the condition.
2127 sub _collapse_cond {
2128 my ($self, $cond, $collapsed) = @_;
2132 if (ref $cond eq 'ARRAY') {
2133 foreach my $subcond (@$cond) {
2134 next unless ref $subcond; # -or
2135 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2138 elsif (ref $cond eq 'HASH') {
2139 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2140 foreach my $subcond (@{$cond->{-and}}) {
2141 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2145 foreach my $col (keys %$cond) {
2146 my $value = $cond->{$col};
2147 $collapsed->{$col} = $value;
2157 # Remove the specified alias from the specified query hash. A copy is made so
2158 # the original query is not modified.
2161 my ($self, $query, $alias) = @_;
2163 my %orig = %{ $query || {} };
2166 foreach my $key (keys %orig) {
2168 $unaliased{$key} = $orig{$key};
2171 $unaliased{$1} = $orig{$key}
2172 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2178 =head2 as_query (EXPERIMENTAL)
2182 =item Arguments: none
2184 =item Return Value: \[ $sql, @bind ]
2188 Returns the SQL query and bind vars associated with the invocant.
2190 This is generally used as the RHS for a subquery.
2192 B<NOTE>: This feature is still experimental.
2199 my $attrs = $self->_resolved_attrs_copy;
2204 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2205 # $sql also has no wrapping parenthesis in list ctx
2207 my $sqlbind = $self->result_source->storage
2208 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2217 =item Arguments: \%vals, \%attrs?
2219 =item Return Value: $rowobject
2223 my $artist = $schema->resultset('Artist')->find_or_new(
2224 { artist => 'fred' }, { key => 'artists' });
2226 $cd->cd_to_producer->find_or_new({ producer => $producer },
2227 { key => 'primary });
2229 Find an existing record from this resultset, based on its primary
2230 key, or a unique constraint. If none exists, instantiate a new result
2231 object and return it. The object will not be saved into your storage
2232 until you call L<DBIx::Class::Row/insert> on it.
2234 You most likely want this method when looking for existing rows using
2235 a unique constraint that is not the primary key, or looking for
2238 If you want objects to be saved immediately, use L</find_or_create> instead.
2240 B<Note>: C<find_or_new> is probably not what you want when creating a
2241 new row in a table that uses primary keys supplied by the
2242 database. Passing in a primary key column with a value of I<undef>
2243 will cause L</find> to attempt to search for a row with a value of
2250 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2251 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2252 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2255 return $self->new_result($hash);
2262 =item Arguments: \%vals
2264 =item Return Value: a L<DBIx::Class::Row> $object
2268 Attempt to create a single new row or a row with multiple related rows
2269 in the table represented by the resultset (and related tables). This
2270 will not check for duplicate rows before inserting, use
2271 L</find_or_create> to do that.
2273 To create one row for this resultset, pass a hashref of key/value
2274 pairs representing the columns of the table and the values you wish to
2275 store. If the appropriate relationships are set up, foreign key fields
2276 can also be passed an object representing the foreign row, and the
2277 value will be set to its primary key.
2279 To create related objects, pass a hashref of related-object column values
2280 B<keyed on the relationship name>. If the relationship is of type C<multi>
2281 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2282 The process will correctly identify columns holding foreign keys, and will
2283 transparrently populate them from the keys of the corresponding relation.
2284 This can be applied recursively, and will work correctly for a structure
2285 with an arbitrary depth and width, as long as the relationships actually
2286 exists and the correct column data has been supplied.
2289 Instead of hashrefs of plain related data (key/value pairs), you may
2290 also pass new or inserted objects. New objects (not inserted yet, see
2291 L</new>), will be inserted into their appropriate tables.
2293 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2295 Example of creating a new row.
2297 $person_rs->create({
2298 name=>"Some Person",
2299 email=>"somebody@someplace.com"
2302 Example of creating a new row and also creating rows in a related C<has_many>
2303 or C<has_one> resultset. Note Arrayref.
2306 { artistid => 4, name => 'Manufactured Crap', cds => [
2307 { title => 'My First CD', year => 2006 },
2308 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2313 Example of creating a new row and also creating a row in a related
2314 C<belongs_to>resultset. Note Hashref.
2317 title=>"Music for Silly Walks",
2320 name=>"Silly Musician",
2327 my ($self, $attrs) = @_;
2328 $self->throw_exception( "create needs a hashref" )
2329 unless ref $attrs eq 'HASH';
2330 return $self->new_result($attrs)->insert;
2333 =head2 find_or_create
2337 =item Arguments: \%vals, \%attrs?
2339 =item Return Value: $rowobject
2343 $cd->cd_to_producer->find_or_create({ producer => $producer },
2344 { key => 'primary' });
2346 Tries to find a record based on its primary key or unique constraints; if none
2347 is found, creates one and returns that instead.
2349 my $cd = $schema->resultset('CD')->find_or_create({
2351 artist => 'Massive Attack',
2352 title => 'Mezzanine',
2356 Also takes an optional C<key> attribute, to search by a specific key or unique
2357 constraint. For example:
2359 my $cd = $schema->resultset('CD')->find_or_create(
2361 artist => 'Massive Attack',
2362 title => 'Mezzanine',
2364 { key => 'cd_artist_title' }
2367 B<Note>: Because find_or_create() reads from the database and then
2368 possibly inserts based on the result, this method is subject to a race
2369 condition. Another process could create a record in the table after
2370 the find has completed and before the create has started. To avoid
2371 this problem, use find_or_create() inside a transaction.
2373 B<Note>: C<find_or_create> is probably not what you want when creating
2374 a new row in a table that uses primary keys supplied by the
2375 database. Passing in a primary key column with a value of I<undef>
2376 will cause L</find> to attempt to search for a row with a value of
2379 See also L</find> and L</update_or_create>. For information on how to declare
2380 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2384 sub find_or_create {
2386 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2387 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2388 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2391 return $self->create($hash);
2394 =head2 update_or_create
2398 =item Arguments: \%col_values, { key => $unique_constraint }?
2400 =item Return Value: $rowobject
2404 $resultset->update_or_create({ col => $val, ... });
2406 First, searches for an existing row matching one of the unique constraints
2407 (including the primary key) on the source of this resultset. If a row is
2408 found, updates it with the other given column values. Otherwise, creates a new
2411 Takes an optional C<key> attribute to search on a specific unique constraint.
2414 # In your application
2415 my $cd = $schema->resultset('CD')->update_or_create(
2417 artist => 'Massive Attack',
2418 title => 'Mezzanine',
2421 { key => 'cd_artist_title' }
2424 $cd->cd_to_producer->update_or_create({
2425 producer => $producer,
2432 If no C<key> is specified, it searches on all unique constraints defined on the
2433 source, including the primary key.
2435 If the C<key> is specified as C<primary>, it searches only on the primary key.
2437 See also L</find> and L</find_or_create>. For information on how to declare
2438 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2440 B<Note>: C<update_or_create> is probably not what you want when
2441 looking for a row in a table that uses primary keys supplied by the
2442 database, unless you actually have a key value. Passing in a primary
2443 key column with a value of I<undef> will cause L</find> to attempt to
2444 search for a row with a value of I<NULL>.
2448 sub update_or_create {
2450 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2451 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2453 my $row = $self->find($cond, $attrs);
2455 $row->update($cond);
2459 return $self->create($cond);
2462 =head2 update_or_new
2466 =item Arguments: \%col_values, { key => $unique_constraint }?
2468 =item Return Value: $rowobject
2472 $resultset->update_or_new({ col => $val, ... });
2474 First, searches for an existing row matching one of the unique constraints
2475 (including the primary key) on the source of this resultset. If a row is
2476 found, updates it with the other given column values. Otherwise, instantiate
2477 a new result object and return it. The object will not be saved into your storage
2478 until you call L<DBIx::Class::Row/insert> on it.
2480 Takes an optional C<key> attribute to search on a specific unique constraint.
2483 # In your application
2484 my $cd = $schema->resultset('CD')->update_or_new(
2486 artist => 'Massive Attack',
2487 title => 'Mezzanine',
2490 { key => 'cd_artist_title' }
2493 if ($cd->in_storage) {
2494 # the cd was updated
2497 # the cd is not yet in the database, let's insert it
2501 See also L</find>, L</find_or_create> and L<find_or_new>.
2507 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2508 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2510 my $row = $self->find( $cond, $attrs );
2511 if ( defined $row ) {
2512 $row->update($cond);
2516 return $self->new_result($cond);
2523 =item Arguments: none
2525 =item Return Value: \@cache_objects?
2529 Gets the contents of the cache for the resultset, if the cache is set.
2531 The cache is populated either by using the L</prefetch> attribute to
2532 L</search> or by calling L</set_cache>.
2544 =item Arguments: \@cache_objects
2546 =item Return Value: \@cache_objects
2550 Sets the contents of the cache for the resultset. Expects an arrayref
2551 of objects of the same class as those produced by the resultset. Note that
2552 if the cache is set the resultset will return the cached objects rather
2553 than re-querying the database even if the cache attr is not set.
2555 The contents of the cache can also be populated by using the
2556 L</prefetch> attribute to L</search>.
2561 my ( $self, $data ) = @_;
2562 $self->throw_exception("set_cache requires an arrayref")
2563 if defined($data) && (ref $data ne 'ARRAY');
2564 $self->{all_cache} = $data;
2571 =item Arguments: none
2573 =item Return Value: []
2577 Clears the cache for the resultset.
2582 shift->set_cache(undef);
2585 =head2 related_resultset
2589 =item Arguments: $relationship_name
2591 =item Return Value: $resultset
2595 Returns a related resultset for the supplied relationship name.
2597 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2601 sub related_resultset {
2602 my ($self, $rel) = @_;
2604 $self->{related_resultsets} ||= {};
2605 return $self->{related_resultsets}{$rel} ||= do {
2606 my $rel_info = $self->result_source->relationship_info($rel);
2608 $self->throw_exception(
2609 "search_related: result source '" . $self->result_source->source_name .
2610 "' has no such relationship $rel")
2613 my ($from,$seen) = $self->_chain_relationship($rel);
2615 my $join_count = $seen->{$rel};
2616 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2618 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2619 my %attrs = %{$self->{attrs}||{}};
2620 delete @attrs{qw(result_class alias)};
2624 if (my $cache = $self->get_cache) {
2625 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2626 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2631 my $rel_source = $self->result_source->related_source($rel);
2635 # The reason we do this now instead of passing the alias to the
2636 # search_rs below is that if you wrap/overload resultset on the
2637 # source you need to know what alias it's -going- to have for things
2638 # to work sanely (e.g. RestrictWithObject wants to be able to add
2639 # extra query restrictions, and these may need to be $alias.)
2641 my $attrs = $rel_source->resultset_attributes;
2642 local $attrs->{alias} = $alias;
2644 $rel_source->resultset
2652 where => $self->{cond},
2657 $new->set_cache($new_cache) if $new_cache;
2662 =head2 current_source_alias
2666 =item Arguments: none
2668 =item Return Value: $source_alias
2672 Returns the current table alias for the result source this resultset is built
2673 on, that will be used in the SQL query. Usually it is C<me>.
2675 Currently the source alias that refers to the result set returned by a
2676 L</search>/L</find> family method depends on how you got to the resultset: it's
2677 C<me> by default, but eg. L</search_related> aliases it to the related result
2678 source name (and keeps C<me> referring to the original result set). The long
2679 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2680 (and make this method unnecessary).
2682 Thus it's currently necessary to use this method in predefined queries (see
2683 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2684 source alias of the current result set:
2686 # in a result set class
2688 my ($self, $user) = @_;
2690 my $me = $self->current_source_alias;
2692 return $self->search(
2693 "$me.modified" => $user->id,
2699 sub current_source_alias {
2702 return ($self->{attrs} || {})->{alias} || 'me';
2705 # This code is called by search_related, and makes sure there
2706 # is clear separation between the joins before, during, and
2707 # after the relationship. This information is needed later
2708 # in order to properly resolve prefetch aliases (any alias
2709 # with a relation_chain_depth less than the depth of the
2710 # current prefetch is not considered)
2712 # The increments happen in 1/2s to make it easier to correlate the
2713 # join depth with the join path. An integer means a relationship
2714 # specified via a search_related, whereas a fraction means an added
2715 # join/prefetch via attributes
2716 sub _chain_relationship {
2717 my ($self, $rel) = @_;
2718 my $source = $self->result_source;
2719 my $attrs = $self->{attrs};
2725 -source_handle => $source->handle,
2726 -alias => $attrs->{alias},
2727 $attrs->{alias} => $source->from,
2731 my $seen = { %{$attrs->{seen_join} || {} } };
2732 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2733 ? $from->[-1][0]{-join_path}
2737 # we need to take the prefetch the attrs into account before we
2738 # ->_resolve_join as otherwise they get lost - captainL
2739 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2741 my @requested_joins = $source->_resolve_join(
2748 push @$from, @requested_joins;
2750 $seen->{-relation_chain_depth} += 0.5;
2752 # if $self already had a join/prefetch specified on it, the requested
2753 # $rel might very well be already included. What we do in this case
2754 # is effectively a no-op (except that we bump up the chain_depth on
2755 # the join in question so we could tell it *is* the search_related)
2759 # we consider the last one thus reverse
2760 for my $j (reverse @requested_joins) {
2761 if ($rel eq $j->[0]{-join_path}[-1]) {
2762 $j->[0]{-relation_chain_depth} += 0.5;
2768 # alternative way to scan the entire chain - not backwards compatible
2769 # for my $j (reverse @$from) {
2770 # next unless ref $j eq 'ARRAY';
2771 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2772 # $j->[0]{-relation_chain_depth} += 0.5;
2773 # $already_joined++;
2778 unless ($already_joined) {
2779 push @$from, $source->_resolve_join(
2787 $seen->{-relation_chain_depth} += 0.5;
2789 return ($from,$seen);
2792 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2793 sub _resolved_attrs_copy {
2795 return { %{$self->_resolved_attrs (@_)} };
2798 sub _resolved_attrs {
2800 return $self->{_attrs} if $self->{_attrs};
2802 my $attrs = { %{ $self->{attrs} || {} } };
2803 my $source = $self->result_source;
2804 my $alias = $attrs->{alias};
2806 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2809 # build columns (as long as select isn't set) into a set of as/select hashes
2810 unless ( $attrs->{select} ) {
2812 ( ref($_) eq 'HASH' )
2816 /^\Q${alias}.\E(.+)$/
2827 } ( ref($attrs->{columns}) eq 'ARRAY' ) ? @{ delete $attrs->{columns}} : (delete $attrs->{columns} || $source->columns );
2829 # add the additional columns on
2830 foreach ( 'include_columns', '+columns' ) {
2831 push @colbits, map {
2832 ( ref($_) eq 'HASH' )
2834 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2835 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2838 # start with initial select items
2839 if ( $attrs->{select} ) {
2841 ( ref $attrs->{select} eq 'ARRAY' )
2842 ? [ @{ $attrs->{select} } ]
2843 : [ $attrs->{select} ];
2847 ref $attrs->{as} eq 'ARRAY'
2848 ? [ @{ $attrs->{as} } ]
2851 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2856 # otherwise we intialise select & as to empty
2857 $attrs->{select} = [];
2861 # now add colbits to select/as
2862 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2863 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2866 if ( $adds = delete $attrs->{'+select'} ) {
2867 $adds = [$adds] unless ref $adds eq 'ARRAY';
2869 @{ $attrs->{select} },
2870 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2873 if ( $adds = delete $attrs->{'+as'} ) {
2874 $adds = [$adds] unless ref $adds eq 'ARRAY';
2875 push( @{ $attrs->{as} }, @$adds );
2878 $attrs->{from} ||= [ {
2879 -source_handle => $source->handle,
2880 -alias => $self->{attrs}{alias},
2881 $self->{attrs}{alias} => $source->from,
2884 if ( $attrs->{join} || $attrs->{prefetch} ) {
2886 $self->throw_exception ('join/prefetch can not be used with a literal scalarref {from}')
2887 if ref $attrs->{from} ne 'ARRAY';
2889 my $join = delete $attrs->{join} || {};
2891 if ( defined $attrs->{prefetch} ) {
2892 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2895 $attrs->{from} = # have to copy here to avoid corrupting the original
2897 @{ $attrs->{from} },
2898 $source->_resolve_join(
2901 { %{ $attrs->{seen_join} || {} } },
2902 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2903 ? $attrs->{from}[-1][0]{-join_path}
2910 if ( defined $attrs->{order_by} ) {
2911 $attrs->{order_by} = (
2912 ref( $attrs->{order_by} ) eq 'ARRAY'
2913 ? [ @{ $attrs->{order_by} } ]
2914 : [ $attrs->{order_by} || () ]
2918 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2919 $attrs->{group_by} = [ $attrs->{group_by} ];
2922 # generate the distinct induced group_by early, as prefetch will be carried via a
2923 # subquery (since a group_by is present)
2924 if (delete $attrs->{distinct}) {
2925 $attrs->{group_by} ||= [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2928 $attrs->{collapse} ||= {};
2929 if ( my $prefetch = delete $attrs->{prefetch} ) {
2930 $prefetch = $self->_merge_attr( {}, $prefetch );
2932 my $prefetch_ordering = [];
2934 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2937 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2939 # we need to somehow mark which columns came from prefetch
2940 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2942 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2943 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2945 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2946 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2949 # if both page and offset are specified, produce a combined offset
2950 # even though it doesn't make much sense, this is what pre 081xx has
2952 if (my $page = delete $attrs->{page}) {
2954 ($attrs->{rows} * ($page - 1))
2956 ($attrs->{offset} || 0)
2960 return $self->{_attrs} = $attrs;
2963 sub _joinpath_aliases {
2964 my ($self, $fromspec, $seen) = @_;
2967 return $paths unless ref $fromspec eq 'ARRAY';
2969 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2971 if (int ($cur_depth) != $cur_depth) {
2972 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2975 for my $j (@$fromspec) {
2977 next if ref $j ne 'ARRAY';
2978 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2980 my $jpath = $j->[0]{-join_path};
2983 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2984 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2991 my ($self, $attr) = @_;
2993 if (ref $attr eq 'HASH') {
2994 return $self->_rollout_hash($attr);
2995 } elsif (ref $attr eq 'ARRAY') {
2996 return $self->_rollout_array($attr);
3002 sub _rollout_array {
3003 my ($self, $attr) = @_;
3006 foreach my $element (@{$attr}) {
3007 if (ref $element eq 'HASH') {
3008 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3009 } elsif (ref $element eq 'ARRAY') {
3010 # XXX - should probably recurse here
3011 push( @rolled_array, @{$self->_rollout_array($element)} );
3013 push( @rolled_array, $element );
3016 return \@rolled_array;
3020 my ($self, $attr) = @_;
3023 foreach my $key (keys %{$attr}) {
3024 push( @rolled_array, { $key => $attr->{$key} } );
3026 return \@rolled_array;
3029 sub _calculate_score {
3030 my ($self, $a, $b) = @_;
3032 if (ref $b eq 'HASH') {
3033 my ($b_key) = keys %{$b};
3034 if (ref $a eq 'HASH') {
3035 my ($a_key) = keys %{$a};
3036 if ($a_key eq $b_key) {
3037 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3042 return ($a eq $b_key) ? 1 : 0;
3045 if (ref $a eq 'HASH') {
3046 my ($a_key) = keys %{$a};
3047 return ($b eq $a_key) ? 1 : 0;
3049 return ($b eq $a) ? 1 : 0;
3055 my ($self, $orig, $import) = @_;
3057 return $import unless defined($orig);
3058 return $orig unless defined($import);
3060 $orig = $self->_rollout_attr($orig);
3061 $import = $self->_rollout_attr($import);
3064 foreach my $import_element ( @{$import} ) {
3065 # find best candidate from $orig to merge $b_element into
3066 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3067 foreach my $orig_element ( @{$orig} ) {
3068 my $score = $self->_calculate_score( $orig_element, $import_element );
3069 if ($score > $best_candidate->{score}) {
3070 $best_candidate->{position} = $position;
3071 $best_candidate->{score} = $score;
3075 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3077 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3078 push( @{$orig}, $import_element );
3080 my $orig_best = $orig->[$best_candidate->{position}];
3081 # merge orig_best and b_element together and replace original with merged
3082 if (ref $orig_best ne 'HASH') {
3083 $orig->[$best_candidate->{position}] = $import_element;
3084 } elsif (ref $import_element eq 'HASH') {
3085 my ($key) = keys %{$orig_best};
3086 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3089 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3099 $self->_source_handle($_[0]->handle);
3101 $self->_source_handle->resolve;
3105 =head2 throw_exception
3107 See L<DBIx::Class::Schema/throw_exception> for details.
3111 sub throw_exception {
3113 if (ref $self && $self->_source_handle->schema) {
3114 $self->_source_handle->schema->throw_exception(@_)
3121 # XXX: FIXME: Attributes docs need clearing up
3125 Attributes are used to refine a ResultSet in various ways when
3126 searching for data. They can be passed to any method which takes an
3127 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3130 These are in no particular order:
3136 =item Value: ( $order_by | \@order_by | \%order_by )
3140 Which column(s) to order the results by.
3142 [The full list of suitable values is documented in
3143 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3146 If a single column name, or an arrayref of names is supplied, the
3147 argument is passed through directly to SQL. The hashref syntax allows
3148 for connection-agnostic specification of ordering direction:
3150 For descending order:
3152 order_by => { -desc => [qw/col1 col2 col3/] }
3154 For explicit ascending order:
3156 order_by => { -asc => 'col' }
3158 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3159 supported, although you are strongly encouraged to use the hashref
3160 syntax as outlined above.
3166 =item Value: \@columns
3170 Shortcut to request a particular set of columns to be retrieved. Each
3171 column spec may be a string (a table column name), or a hash (in which
3172 case the key is the C<as> value, and the value is used as the C<select>
3173 expression). Adds C<me.> onto the start of any column without a C<.> in
3174 it and sets C<select> from that, then auto-populates C<as> from
3175 C<select> as normal. (You may also use the C<cols> attribute, as in
3176 earlier versions of DBIC.)
3182 =item Value: \@columns
3186 Indicates additional columns to be selected from storage. Works the same
3187 as L</columns> but adds columns to the selection. (You may also use the
3188 C<include_columns> attribute, as in earlier versions of DBIC). For
3191 $schema->resultset('CD')->search(undef, {
3192 '+columns' => ['artist.name'],
3196 would return all CDs and include a 'name' column to the information
3197 passed to object inflation. Note that the 'artist' is the name of the
3198 column (or relationship) accessor, and 'name' is the name of the column
3199 accessor in the related table.
3201 =head2 include_columns
3205 =item Value: \@columns
3209 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3215 =item Value: \@select_columns
3219 Indicates which columns should be selected from the storage. You can use
3220 column names, or in the case of RDBMS back ends, function or stored procedure
3223 $rs = $schema->resultset('Employee')->search(undef, {
3226 { count => 'employeeid' },
3231 When you use function/stored procedure names and do not supply an C<as>
3232 attribute, the column names returned are storage-dependent. E.g. MySQL would
3233 return a column named C<count(employeeid)> in the above example.
3239 Indicates additional columns to be selected from storage. Works the same as
3240 L</select> but adds columns to the selection.
3248 Indicates additional column names for those added via L</+select>. See L</as>.
3256 =item Value: \@inflation_names
3260 Indicates column names for object inflation. That is, C<as>
3261 indicates the name that the column can be accessed as via the
3262 C<get_column> method (or via the object accessor, B<if one already
3263 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3265 The C<as> attribute is used in conjunction with C<select>,
3266 usually when C<select> contains one or more function or stored
3269 $rs = $schema->resultset('Employee')->search(undef, {
3272 { count => 'employeeid' }
3274 as => ['name', 'employee_count'],
3277 my $employee = $rs->first(); # get the first Employee
3279 If the object against which the search is performed already has an accessor
3280 matching a column name specified in C<as>, the value can be retrieved using
3281 the accessor as normal:
3283 my $name = $employee->name();
3285 If on the other hand an accessor does not exist in the object, you need to
3286 use C<get_column> instead:
3288 my $employee_count = $employee->get_column('employee_count');
3290 You can create your own accessors if required - see
3291 L<DBIx::Class::Manual::Cookbook> for details.
3293 Please note: This will NOT insert an C<AS employee_count> into the SQL
3294 statement produced, it is used for internal access only. Thus
3295 attempting to use the accessor in an C<order_by> clause or similar
3296 will fail miserably.
3298 To get around this limitation, you can supply literal SQL to your
3299 C<select> attibute that contains the C<AS alias> text, eg:
3301 select => [\'myfield AS alias']
3307 =item Value: ($rel_name | \@rel_names | \%rel_names)
3311 Contains a list of relationships that should be joined for this query. For
3314 # Get CDs by Nine Inch Nails
3315 my $rs = $schema->resultset('CD')->search(
3316 { 'artist.name' => 'Nine Inch Nails' },
3317 { join => 'artist' }
3320 Can also contain a hash reference to refer to the other relation's relations.
3323 package MyApp::Schema::Track;
3324 use base qw/DBIx::Class/;
3325 __PACKAGE__->table('track');
3326 __PACKAGE__->add_columns(qw/trackid cd position title/);
3327 __PACKAGE__->set_primary_key('trackid');
3328 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3331 # In your application
3332 my $rs = $schema->resultset('Artist')->search(
3333 { 'track.title' => 'Teardrop' },
3335 join => { cd => 'track' },
3336 order_by => 'artist.name',
3340 You need to use the relationship (not the table) name in conditions,
3341 because they are aliased as such. The current table is aliased as "me", so
3342 you need to use me.column_name in order to avoid ambiguity. For example:
3344 # Get CDs from 1984 with a 'Foo' track
3345 my $rs = $schema->resultset('CD')->search(
3348 'tracks.name' => 'Foo'
3350 { join => 'tracks' }
3353 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3354 similarly for a third time). For e.g.
3356 my $rs = $schema->resultset('Artist')->search({
3357 'cds.title' => 'Down to Earth',
3358 'cds_2.title' => 'Popular',
3360 join => [ qw/cds cds/ ],
3363 will return a set of all artists that have both a cd with title 'Down
3364 to Earth' and a cd with title 'Popular'.
3366 If you want to fetch related objects from other tables as well, see C<prefetch>
3369 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3375 =item Value: ($rel_name | \@rel_names | \%rel_names)
3379 Contains one or more relationships that should be fetched along with
3380 the main query (when they are accessed afterwards the data will
3381 already be available, without extra queries to the database). This is
3382 useful for when you know you will need the related objects, because it
3383 saves at least one query:
3385 my $rs = $schema->resultset('Tag')->search(
3394 The initial search results in SQL like the following:
3396 SELECT tag.*, cd.*, artist.* FROM tag
3397 JOIN cd ON tag.cd = cd.cdid
3398 JOIN artist ON cd.artist = artist.artistid
3400 L<DBIx::Class> has no need to go back to the database when we access the
3401 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3404 Simple prefetches will be joined automatically, so there is no need
3405 for a C<join> attribute in the above search.
3407 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3408 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3409 with an accessor type of 'single' or 'filter'). A more complex example that
3410 prefetches an artists cds, the tracks on those cds, and the tags associted
3411 with that artist is given below (assuming many-to-many from artists to tags):
3413 my $rs = $schema->resultset('Artist')->search(
3417 { cds => 'tracks' },
3418 { artist_tags => 'tags' }
3424 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3425 attributes will be ignored.
3427 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3428 exactly as you might expect.
3434 Prefetch uses the L</cache> to populate the prefetched relationships. This
3435 may or may not be what you want.
3439 If you specify a condition on a prefetched relationship, ONLY those
3440 rows that match the prefetched condition will be fetched into that relationship.
3441 This means that adding prefetch to a search() B<may alter> what is returned by
3442 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3444 my $artist_rs = $schema->resultset('Artist')->search({
3450 my $count = $artist_rs->first->cds->count;
3452 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3454 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3456 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3458 that cmp_ok() may or may not pass depending on the datasets involved. This
3459 behavior may or may not survive the 0.09 transition.
3471 Makes the resultset paged and specifies the page to retrieve. Effectively
3472 identical to creating a non-pages resultset and then calling ->page($page)
3475 If L<rows> attribute is not specified it defaults to 10 rows per page.
3477 When you have a paged resultset, L</count> will only return the number
3478 of rows in the page. To get the total, use the L</pager> and call
3479 C<total_entries> on it.
3489 Specifes the maximum number of rows for direct retrieval or the number of
3490 rows per page if the page attribute or method is used.
3496 =item Value: $offset
3500 Specifies the (zero-based) row number for the first row to be returned, or the
3501 of the first row of the first page if paging is used.
3507 =item Value: \@columns
3511 A arrayref of columns to group by. Can include columns of joined tables.
3513 group_by => [qw/ column1 column2 ... /]
3519 =item Value: $condition
3523 HAVING is a select statement attribute that is applied between GROUP BY and
3524 ORDER BY. It is applied to the after the grouping calculations have been
3527 having => { 'count(employee)' => { '>=', 100 } }
3533 =item Value: (0 | 1)
3537 Set to 1 to group by all columns.
3543 Adds to the WHERE clause.
3545 # only return rows WHERE deleted IS NULL for all searches
3546 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3548 Can be overridden by passing C<{ where => undef }> as an attribute
3555 Set to 1 to cache search results. This prevents extra SQL queries if you
3556 revisit rows in your ResultSet:
3558 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3560 while( my $artist = $resultset->next ) {
3564 $rs->first; # without cache, this would issue a query
3566 By default, searches are not cached.
3568 For more examples of using these attributes, see
3569 L<DBIx::Class::Manual::Cookbook>.
3575 =item Value: \@from_clause
3579 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
3580 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
3583 NOTE: Use this on your own risk. This allows you to shoot off your foot!
3585 C<join> will usually do what you need and it is strongly recommended that you
3586 avoid using C<from> unless you cannot achieve the desired result using C<join>.
3587 And we really do mean "cannot", not just tried and failed. Attempting to use
3588 this because you're having problems with C<join> is like trying to use x86
3589 ASM because you've got a syntax error in your C. Trust us on this.
3591 Now, if you're still really, really sure you need to use this (and if you're
3592 not 100% sure, ask the mailing list first), here's an explanation of how this
3595 The syntax is as follows -
3598 { <alias1> => <table1> },
3600 { <alias2> => <table2>, -join_type => 'inner|left|right' },
3601 [], # nested JOIN (optional)
3602 { <table1.column1> => <table2.column2>, ... (more conditions) },
3604 # More of the above [ ] may follow for additional joins
3611 ON <table1.column1> = <table2.column2>
3612 <more joins may follow>
3614 An easy way to follow the examples below is to remember the following:
3616 Anything inside "[]" is a JOIN
3617 Anything inside "{}" is a condition for the enclosing JOIN
3619 The following examples utilize a "person" table in a family tree application.
3620 In order to express parent->child relationships, this table is self-joined:
3622 # Person->belongs_to('father' => 'Person');
3623 # Person->belongs_to('mother' => 'Person');
3625 C<from> can be used to nest joins. Here we return all children with a father,
3626 then search against all mothers of those children:
3628 $rs = $schema->resultset('Person')->search(
3631 alias => 'mother', # alias columns in accordance with "from"
3633 { mother => 'person' },
3636 { child => 'person' },
3638 { father => 'person' },
3639 { 'father.person_id' => 'child.father_id' }
3642 { 'mother.person_id' => 'child.mother_id' }
3649 # SELECT mother.* FROM person mother
3652 # JOIN person father
3653 # ON ( father.person_id = child.father_id )
3655 # ON ( mother.person_id = child.mother_id )
3657 The type of any join can be controlled manually. To search against only people
3658 with a father in the person table, we could explicitly use C<INNER JOIN>:
3660 $rs = $schema->resultset('Person')->search(
3663 alias => 'child', # alias columns in accordance with "from"
3665 { child => 'person' },
3667 { father => 'person', -join_type => 'inner' },
3668 { 'father.id' => 'child.father_id' }
3675 # SELECT child.* FROM person child
3676 # INNER JOIN person father ON child.father_id = father.id
3678 You can select from a subquery by passing a resultset to from as follows.
3680 $schema->resultset('Artist')->search(
3682 { alias => 'artist2',
3683 from => [ { artist2 => $artist_rs->as_query } ],
3686 # and you'll get sql like this..
3687 # SELECT artist2.artistid, artist2.name, artist2.rank, artist2.charfield FROM
3688 # ( SELECT me.artistid, me.name, me.rank, me.charfield FROM artists me ) artist2
3690 If you need to express really complex joins, you
3691 can supply literal SQL to C<from> via a scalar reference. In this case
3692 the contents of the scalar will replace the table name associated with the
3695 WARNING: This technique might very well not work as expected on chained
3696 searches - you have been warned.
3698 # Assuming the Event resultsource is defined as:
3700 MySchema::Event->add_columns (
3703 is_auto_increment => 1,
3712 MySchema::Event->set_primary_key ('sequence');
3714 # This will get back the latest event for every location. The column
3715 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3716 # combo to limit the resultset
3718 $rs = $schema->resultset('Event');
3719 $table = $rs->result_source->name;
3720 $latest = $rs->search (
3723 (SELECT e1.* FROM $table e1
3725 ON e1.location = e2.location
3726 AND e1.sequence < e2.sequence
3727 WHERE e2.sequence is NULL
3732 # Equivalent SQL (with the DBIC chunks added):
3734 SELECT me.sequence, me.location, me.type FROM
3735 (SELECT e1.* FROM events e1
3737 ON e1.location = e2.location
3738 AND e1.sequence < e2.sequence
3739 WHERE e2.sequence is NULL
3746 =item Value: ( 'update' | 'shared' )
3750 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT