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 sub _collapse_result {
970 my ($self, $as_proto, $row) = @_;
972 # if the first row that ever came in is totally empty - this means we got
973 # hit by a smooth^Wempty left-joined resultset. Just noop in that case
974 # instead of producing a {}
983 return undef unless $has_def;
987 # 'foo' => [ undef, 'foo' ]
988 # 'foo.bar' => [ 'foo', 'bar' ]
989 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
991 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
993 my %collapse = %{$self->{_attrs}{collapse}||{}};
997 # if we're doing collapsing (has_many prefetch) we need to grab records
998 # until the PK changes, so fill @pri_index. if not, we leave it empty so
999 # we know we don't have to bother.
1001 # the reason for not using the collapse stuff directly is because if you
1002 # had for e.g. two artists in a row with no cds, the collapse info for
1003 # both would be NULL (undef) so you'd lose the second artist
1005 # store just the index so we can check the array positions from the row
1006 # without having to contruct the full hash
1008 if (keys %collapse) {
1009 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
1010 foreach my $i (0 .. $#construct_as) {
1011 next if defined($construct_as[$i][0]); # only self table
1012 if (delete $pri{$construct_as[$i][1]}) {
1013 push(@pri_index, $i);
1015 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1019 # no need to do an if, it'll be empty if @pri_index is empty anyway
1021 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1025 do { # no need to check anything at the front, we always want the first row
1029 foreach my $this_as (@construct_as) {
1030 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1033 push(@const_rows, \%const);
1035 } until ( # no pri_index => no collapse => drop straight out
1038 do { # get another row, stash it, drop out if different PK
1040 @copy = $self->cursor->next;
1041 $self->{stashed_row} = \@copy;
1043 # last thing in do block, counts as true if anything doesn't match
1045 # check xor defined first for NULL vs. NOT NULL then if one is
1046 # defined the other must be so check string equality
1049 (defined $pri_vals{$_} ^ defined $copy[$_])
1050 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1055 my $alias = $self->{attrs}{alias};
1062 foreach my $const (@const_rows) {
1063 scalar @const_keys or do {
1064 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1066 foreach my $key (@const_keys) {
1069 my @parts = split(/\./, $key);
1071 my $data = $const->{$key};
1072 foreach my $p (@parts) {
1073 $target = $target->[1]->{$p} ||= [];
1075 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1076 # collapsing at this point and on final part
1077 my $pos = $collapse_pos{$cur};
1078 CK: foreach my $ck (@ckey) {
1079 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1080 $collapse_pos{$cur} = $data;
1081 delete @collapse_pos{ # clear all positioning for sub-entries
1082 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1089 if (exists $collapse{$cur}) {
1090 $target = $target->[-1];
1093 $target->[0] = $data;
1095 $info->[0] = $const->{$key};
1103 =head2 result_source
1107 =item Arguments: $result_source?
1109 =item Return Value: $result_source
1113 An accessor for the primary ResultSource object from which this ResultSet
1120 =item Arguments: $result_class?
1122 =item Return Value: $result_class
1126 An accessor for the class to use when creating row objects. Defaults to
1127 C<< result_source->result_class >> - which in most cases is the name of the
1128 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1130 Note that changing the result_class will also remove any components
1131 that were originally loaded in the source class via
1132 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1133 in the original source class will not run.
1138 my ($self, $result_class) = @_;
1139 if ($result_class) {
1140 $self->ensure_class_loaded($result_class);
1141 $self->_result_class($result_class);
1143 $self->_result_class;
1150 =item Arguments: $cond, \%attrs??
1152 =item Return Value: $count
1156 Performs an SQL C<COUNT> with the same query as the resultset was built
1157 with to find the number of elements. Passing arguments is equivalent to
1158 C<< $rs->search ($cond, \%attrs)->count >>
1164 return $self->search(@_)->count if @_ and defined $_[0];
1165 return scalar @{ $self->get_cache } if $self->get_cache;
1167 my $attrs = $self->_resolved_attrs_copy;
1169 # this is a little optimization - it is faster to do the limit
1170 # adjustments in software, instead of a subquery
1171 my $rows = delete $attrs->{rows};
1172 my $offset = delete $attrs->{offset};
1175 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1176 $crs = $self->_count_subq_rs ($attrs);
1179 $crs = $self->_count_rs ($attrs);
1181 my $count = $crs->next;
1183 $count -= $offset if $offset;
1184 $count = $rows if $rows and $rows < $count;
1185 $count = 0 if ($count < 0);
1194 =item Arguments: $cond, \%attrs??
1196 =item Return Value: $count_rs
1200 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1201 This can be very handy for subqueries:
1203 ->search( { amount => $some_rs->count_rs->as_query } )
1205 As with regular resultsets the SQL query will be executed only after
1206 the resultset is accessed via L</next> or L</all>. That would return
1207 the same single value obtainable via L</count>.
1213 return $self->search(@_)->count_rs if @_;
1215 # this may look like a lack of abstraction (count() does about the same)
1216 # but in fact an _rs *must* use a subquery for the limits, as the
1217 # software based limiting can not be ported if this $rs is to be used
1218 # in a subquery itself (i.e. ->as_query)
1219 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1220 return $self->_count_subq_rs;
1223 return $self->_count_rs;
1228 # returns a ResultSetColumn object tied to the count query
1231 my ($self, $attrs) = @_;
1233 my $rsrc = $self->result_source;
1234 $attrs ||= $self->_resolved_attrs;
1236 my $tmp_attrs = { %$attrs };
1238 # take off any limits, record_filter is cdbi, and no point of ordering a count
1239 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1241 # overwrite the selector (supplied by the storage)
1242 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1243 $tmp_attrs->{as} = 'count';
1245 # read the comment on top of the actual function to see what this does
1246 $tmp_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1247 $tmp_attrs->{from}, $tmp_attrs->{alias}
1250 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1256 # same as above but uses a subquery
1258 sub _count_subq_rs {
1259 my ($self, $attrs) = @_;
1261 my $rsrc = $self->result_source;
1262 $attrs ||= $self->_resolved_attrs_copy;
1264 my $sub_attrs = { %$attrs };
1266 # extra selectors do not go in the subquery and there is no point of ordering it
1267 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1269 # if we prefetch, we group_by primary keys only as this is what we would get out
1270 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1271 if ( keys %{$attrs->{collapse}} ) {
1272 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1275 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1277 # read the comment on top of the actual function to see what this does
1278 $sub_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1279 $sub_attrs->{from}, $sub_attrs->{alias}
1282 # this is so that ordering can be thrown away in things like Top limit
1283 $sub_attrs->{-for_count_only} = 1;
1285 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1288 -alias => 'count_subq',
1289 -source_handle => $rsrc->handle,
1290 count_subq => $sub_rs->as_query,
1293 # the subquery replaces this
1294 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1296 return $self->_count_rs ($attrs);
1300 # The DBIC relationship chaining implementation is pretty simple - every
1301 # new related_relationship is pushed onto the {from} stack, and the {select}
1302 # window simply slides further in. This means that when we count somewhere
1303 # in the middle, we got to make sure that everything in the join chain is an
1304 # actual inner join, otherwise the count will come back with unpredictable
1305 # results (a resultset may be generated with _some_ rows regardless of if
1306 # the relation which the $rs currently selects has rows or not). E.g.
1307 # $artist_rs->cds->count - normally generates:
1308 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
1309 # which actually returns the number of artists * (number of cds || 1)
1311 # So what we do here is crawl {from}, determine if the current alias is at
1312 # the top of the stack, and if not - make sure the chain is inner-joined down
1315 sub _switch_to_inner_join_if_needed {
1316 my ($self, $from, $alias) = @_;
1318 # subqueries and other oddness is naturally not supported
1320 ref $from ne 'ARRAY'
1324 ref $from->[0] ne 'HASH'
1326 ! $from->[0]{-alias}
1328 $from->[0]{-alias} eq $alias
1333 for my $j (@{$from}[1 .. $#$from]) {
1334 if ($j->[0]{-alias} eq $alias) {
1335 $switch_branch = $j->[0]{-join_path};
1340 # something else went wrong
1341 return $from unless $switch_branch;
1343 # So it looks like we will have to switch some stuff around.
1344 # local() is useless here as we will be leaving the scope
1345 # anyway, and deep cloning is just too fucking expensive
1346 # So replace the inner hashref manually
1347 my @new_from = ($from->[0]);
1348 my $sw_idx = { map { $_ => 1 } @$switch_branch };
1350 for my $j (@{$from}[1 .. $#$from]) {
1351 my $jalias = $j->[0]{-alias};
1353 if ($sw_idx->{$jalias}) {
1354 my %attrs = %{$j->[0]};
1355 delete $attrs{-join_type};
1374 =head2 count_literal
1378 =item Arguments: $sql_fragment, @bind_values
1380 =item Return Value: $count
1384 Counts the results in a literal query. Equivalent to calling L</search_literal>
1385 with the passed arguments, then L</count>.
1389 sub count_literal { shift->search_literal(@_)->count; }
1395 =item Arguments: none
1397 =item Return Value: @objects
1401 Returns all elements in the resultset. Called implicitly if the resultset
1402 is returned in list context.
1409 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1412 return @{ $self->get_cache } if $self->get_cache;
1416 if (keys %{$self->_resolved_attrs->{collapse}}) {
1417 # Using $self->cursor->all is really just an optimisation.
1418 # If we're collapsing has_many prefetches it probably makes
1419 # very little difference, and this is cleaner than hacking
1420 # _construct_object to survive the approach
1421 $self->cursor->reset;
1422 my @row = $self->cursor->next;
1424 push(@obj, $self->_construct_object(@row));
1425 @row = (exists $self->{stashed_row}
1426 ? @{delete $self->{stashed_row}}
1427 : $self->cursor->next);
1430 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1433 $self->set_cache(\@obj) if $self->{attrs}{cache};
1442 =item Arguments: none
1444 =item Return Value: $self
1448 Resets the resultset's cursor, so you can iterate through the elements again.
1449 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1456 delete $self->{_attrs} if exists $self->{_attrs};
1457 $self->{all_cache_position} = 0;
1458 $self->cursor->reset;
1466 =item Arguments: none
1468 =item Return Value: $object?
1472 Resets the resultset and returns an object for the first result (if the
1473 resultset returns anything).
1478 return $_[0]->reset->next;
1484 # Determines whether and what type of subquery is required for the $rs operation.
1485 # If grouping is necessary either supplies its own, or verifies the current one
1486 # After all is done delegates to the proper storage method.
1488 sub _rs_update_delete {
1489 my ($self, $op, $values) = @_;
1491 my $rsrc = $self->result_source;
1493 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1494 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1496 if ($needs_group_by_subq or $needs_subq) {
1498 # make a new $rs selecting only the PKs (that's all we really need)
1499 my $attrs = $self->_resolved_attrs_copy;
1501 delete $attrs->{$_} for qw/collapse select as/;
1502 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1504 if ($needs_group_by_subq) {
1505 # make sure no group_by was supplied, or if there is one - make sure it matches
1506 # the columns compiled above perfectly. Anything else can not be sanely executed
1507 # on most databases so croak right then and there
1509 if (my $g = $attrs->{group_by}) {
1510 my @current_group_by = map
1511 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1516 join ("\x00", sort @current_group_by)
1518 join ("\x00", sort @{$attrs->{columns}} )
1520 $self->throw_exception (
1521 "You have just attempted a $op operation on a resultset which does group_by"
1522 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1523 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1524 . ' kind of queries. Please retry the operation with a modified group_by or'
1525 . ' without using one at all.'
1530 $attrs->{group_by} = $attrs->{columns};
1534 my $subrs = (ref $self)->new($rsrc, $attrs);
1536 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1539 return $rsrc->storage->$op(
1541 $op eq 'update' ? $values : (),
1542 $self->_cond_for_update_delete,
1548 # _cond_for_update_delete
1550 # update/delete require the condition to be modified to handle
1551 # the differing SQL syntax available. This transforms the $self->{cond}
1552 # appropriately, returning the new condition.
1554 sub _cond_for_update_delete {
1555 my ($self, $full_cond) = @_;
1558 $full_cond ||= $self->{cond};
1559 # No-op. No condition, we're updating/deleting everything
1560 return $cond unless ref $full_cond;
1562 if (ref $full_cond eq 'ARRAY') {
1566 foreach my $key (keys %{$_}) {
1568 $hash{$1} = $_->{$key};
1574 elsif (ref $full_cond eq 'HASH') {
1575 if ((keys %{$full_cond})[0] eq '-and') {
1577 my @cond = @{$full_cond->{-and}};
1578 for (my $i = 0; $i < @cond; $i++) {
1579 my $entry = $cond[$i];
1581 if (ref $entry eq 'HASH') {
1582 $hash = $self->_cond_for_update_delete($entry);
1585 $entry =~ /([^.]+)$/;
1586 $hash->{$1} = $cond[++$i];
1588 push @{$cond->{-and}}, $hash;
1592 foreach my $key (keys %{$full_cond}) {
1594 $cond->{$1} = $full_cond->{$key};
1599 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1610 =item Arguments: \%values
1612 =item Return Value: $storage_rv
1616 Sets the specified columns in the resultset to the supplied values in a
1617 single query. Return value will be true if the update succeeded or false
1618 if no records were updated; exact type of success value is storage-dependent.
1623 my ($self, $values) = @_;
1624 $self->throw_exception('Values for update must be a hash')
1625 unless ref $values eq 'HASH';
1627 return $self->_rs_update_delete ('update', $values);
1634 =item Arguments: \%values
1636 =item Return Value: 1
1640 Fetches all objects and updates them one at a time. Note that C<update_all>
1641 will run DBIC cascade triggers, while L</update> will not.
1646 my ($self, $values) = @_;
1647 $self->throw_exception('Values for update_all must be a hash')
1648 unless ref $values eq 'HASH';
1649 foreach my $obj ($self->all) {
1650 $obj->set_columns($values)->update;
1659 =item Arguments: none
1661 =item Return Value: $storage_rv
1665 Deletes the contents of the resultset from its result source. Note that this
1666 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1667 to run. See also L<DBIx::Class::Row/delete>.
1669 Return value will be the amount of rows deleted; exact type of return value
1670 is storage-dependent.
1676 $self->throw_exception('delete does not accept any arguments')
1679 return $self->_rs_update_delete ('delete');
1686 =item Arguments: none
1688 =item Return Value: 1
1692 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1693 will run DBIC cascade triggers, while L</delete> will not.
1699 $self->throw_exception('delete_all does not accept any arguments')
1702 $_->delete for $self->all;
1710 =item Arguments: \@data;
1714 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1715 For the arrayref of hashrefs style each hashref should be a structure suitable
1716 forsubmitting to a $resultset->create(...) method.
1718 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1719 to insert the data, as this is a faster method.
1721 Otherwise, each set of data is inserted into the database using
1722 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1723 accumulated into an array. The array itself, or an array reference
1724 is returned depending on scalar or list context.
1726 Example: Assuming an Artist Class that has many CDs Classes relating:
1728 my $Artist_rs = $schema->resultset("Artist");
1730 ## Void Context Example
1731 $Artist_rs->populate([
1732 { artistid => 4, name => 'Manufactured Crap', cds => [
1733 { title => 'My First CD', year => 2006 },
1734 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1737 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1738 { title => 'My parents sold me to a record company' ,year => 2005 },
1739 { title => 'Why Am I So Ugly?', year => 2006 },
1740 { title => 'I Got Surgery and am now Popular', year => 2007 }
1745 ## Array Context Example
1746 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1747 { name => "Artist One"},
1748 { name => "Artist Two"},
1749 { name => "Artist Three", cds=> [
1750 { title => "First CD", year => 2007},
1751 { title => "Second CD", year => 2008},
1755 print $ArtistOne->name; ## response is 'Artist One'
1756 print $ArtistThree->cds->count ## reponse is '2'
1758 For the arrayref of arrayrefs style, the first element should be a list of the
1759 fieldsnames to which the remaining elements are rows being inserted. For
1762 $Arstist_rs->populate([
1763 [qw/artistid name/],
1764 [100, 'A Formally Unknown Singer'],
1765 [101, 'A singer that jumped the shark two albums ago'],
1766 [102, 'An actually cool singer.'],
1769 Please note an important effect on your data when choosing between void and
1770 wantarray context. Since void context goes straight to C<insert_bulk> in
1771 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1772 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1773 create primary keys for you, you will find that your PKs are empty. In this
1774 case you will have to use the wantarray context in order to create those
1780 my $self = shift @_;
1781 my $data = ref $_[0][0] eq 'HASH'
1782 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1783 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1785 if(defined wantarray) {
1787 foreach my $item (@$data) {
1788 push(@created, $self->create($item));
1790 return wantarray ? @created : \@created;
1792 my ($first, @rest) = @$data;
1794 my @names = grep {!ref $first->{$_}} keys %$first;
1795 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1796 my @pks = $self->result_source->primary_columns;
1798 ## do the belongs_to relationships
1799 foreach my $index (0..$#$data) {
1801 # delegate to create() for any dataset without primary keys with specified relationships
1802 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1804 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1805 my @ret = $self->populate($data);
1811 foreach my $rel (@rels) {
1812 next unless ref $data->[$index]->{$rel} eq "HASH";
1813 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1814 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1815 my $related = $result->result_source->_resolve_condition(
1816 $result->result_source->relationship_info($reverse)->{cond},
1821 delete $data->[$index]->{$rel};
1822 $data->[$index] = {%{$data->[$index]}, %$related};
1824 push @names, keys %$related if $index == 0;
1828 ## do bulk insert on current row
1829 my @values = map { [ @$_{@names} ] } @$data;
1831 $self->result_source->storage->insert_bulk(
1832 $self->result_source,
1837 ## do the has_many relationships
1838 foreach my $item (@$data) {
1840 foreach my $rel (@rels) {
1841 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1843 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1844 || $self->throw_exception('Cannot find the relating object.');
1846 my $child = $parent->$rel;
1848 my $related = $child->result_source->_resolve_condition(
1849 $parent->result_source->relationship_info($rel)->{cond},
1854 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1855 my @populate = map { {%$_, %$related} } @rows_to_add;
1857 $child->populate( \@populate );
1863 =head2 _normalize_populate_args ($args)
1865 Private method used by L</populate> to normalize its incoming arguments. Factored
1866 out in case you want to subclass and accept new argument structures to the
1867 L</populate> method.
1871 sub _normalize_populate_args {
1872 my ($self, $data) = @_;
1873 my @names = @{shift(@$data)};
1874 my @results_to_create;
1875 foreach my $datum (@$data) {
1876 my %result_to_create;
1877 foreach my $index (0..$#names) {
1878 $result_to_create{$names[$index]} = $$datum[$index];
1880 push @results_to_create, \%result_to_create;
1882 return \@results_to_create;
1889 =item Arguments: none
1891 =item Return Value: $pager
1895 Return Value a L<Data::Page> object for the current resultset. Only makes
1896 sense for queries with a C<page> attribute.
1898 To get the full count of entries for a paged resultset, call
1899 C<total_entries> on the L<Data::Page> object.
1906 return $self->{pager} if $self->{pager};
1908 my $attrs = $self->{attrs};
1909 $self->throw_exception("Can't create pager for non-paged rs")
1910 unless $self->{attrs}{page};
1911 $attrs->{rows} ||= 10;
1913 # throw away the paging flags and re-run the count (possibly
1914 # with a subselect) to get the real total count
1915 my $count_attrs = { %$attrs };
1916 delete $count_attrs->{$_} for qw/rows offset page pager/;
1917 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1919 return $self->{pager} = Data::Page->new(
1922 $self->{attrs}{page}
1930 =item Arguments: $page_number
1932 =item Return Value: $rs
1936 Returns a resultset for the $page_number page of the resultset on which page
1937 is called, where each page contains a number of rows equal to the 'rows'
1938 attribute set on the resultset (10 by default).
1943 my ($self, $page) = @_;
1944 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1951 =item Arguments: \%vals
1953 =item Return Value: $rowobject
1957 Creates a new row object in the resultset's result class and returns
1958 it. The row is not inserted into the database at this point, call
1959 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1960 will tell you whether the row object has been inserted or not.
1962 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1967 my ($self, $values) = @_;
1968 $self->throw_exception( "new_result needs a hash" )
1969 unless (ref $values eq 'HASH');
1972 my $alias = $self->{attrs}{alias};
1975 defined $self->{cond}
1976 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1978 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1979 $new{-from_resultset} = [ keys %new ] if keys %new;
1981 $self->throw_exception(
1982 "Can't abstract implicit construct, condition not a hash"
1983 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1985 my $collapsed_cond = (
1987 ? $self->_collapse_cond($self->{cond})
1991 # precendence must be given to passed values over values inherited from
1992 # the cond, so the order here is important.
1993 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1994 while( my($col,$value) = each %implied ){
1995 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1996 $new{$col} = $value->{'='};
1999 $new{$col} = $value if $self->_is_deterministic_value($value);
2005 %{ $self->_remove_alias($values, $alias) },
2006 -source_handle => $self->_source_handle,
2007 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2010 return $self->result_class->new(\%new);
2013 # _is_deterministic_value
2015 # Make an effor to strip non-deterministic values from the condition,
2016 # to make sure new_result chokes less
2018 sub _is_deterministic_value {
2021 my $ref_type = ref $value;
2022 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
2023 return 1 if Scalar::Util::blessed($value);
2027 # _has_resolved_attr
2029 # determines if the resultset defines at least one
2030 # of the attributes supplied
2032 # used to determine if a subquery is neccessary
2034 # supports some virtual attributes:
2036 # This will scan for any joins being present on the resultset.
2037 # It is not a mere key-search but a deep inspection of {from}
2040 sub _has_resolved_attr {
2041 my ($self, @attr_names) = @_;
2043 my $attrs = $self->_resolved_attrs;
2047 for my $n (@attr_names) {
2048 if (grep { $n eq $_ } (qw/-join/) ) {
2049 $extra_checks{$n}++;
2053 my $attr = $attrs->{$n};
2055 next if not defined $attr;
2057 if (ref $attr eq 'HASH') {
2058 return 1 if keys %$attr;
2060 elsif (ref $attr eq 'ARRAY') {
2068 # a resolved join is expressed as a multi-level from
2070 $extra_checks{-join}
2072 ref $attrs->{from} eq 'ARRAY'
2074 @{$attrs->{from}} > 1
2082 # Recursively collapse the condition.
2084 sub _collapse_cond {
2085 my ($self, $cond, $collapsed) = @_;
2089 if (ref $cond eq 'ARRAY') {
2090 foreach my $subcond (@$cond) {
2091 next unless ref $subcond; # -or
2092 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2095 elsif (ref $cond eq 'HASH') {
2096 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2097 foreach my $subcond (@{$cond->{-and}}) {
2098 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2102 foreach my $col (keys %$cond) {
2103 my $value = $cond->{$col};
2104 $collapsed->{$col} = $value;
2114 # Remove the specified alias from the specified query hash. A copy is made so
2115 # the original query is not modified.
2118 my ($self, $query, $alias) = @_;
2120 my %orig = %{ $query || {} };
2123 foreach my $key (keys %orig) {
2125 $unaliased{$key} = $orig{$key};
2128 $unaliased{$1} = $orig{$key}
2129 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2135 =head2 as_query (EXPERIMENTAL)
2139 =item Arguments: none
2141 =item Return Value: \[ $sql, @bind ]
2145 Returns the SQL query and bind vars associated with the invocant.
2147 This is generally used as the RHS for a subquery.
2149 B<NOTE>: This feature is still experimental.
2156 my $attrs = $self->_resolved_attrs_copy;
2161 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2162 # $sql also has no wrapping parenthesis in list ctx
2164 my $sqlbind = $self->result_source->storage
2165 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2174 =item Arguments: \%vals, \%attrs?
2176 =item Return Value: $rowobject
2180 my $artist = $schema->resultset('Artist')->find_or_new(
2181 { artist => 'fred' }, { key => 'artists' });
2183 $cd->cd_to_producer->find_or_new({ producer => $producer },
2184 { key => 'primary });
2186 Find an existing record from this resultset, based on its primary
2187 key, or a unique constraint. If none exists, instantiate a new result
2188 object and return it. The object will not be saved into your storage
2189 until you call L<DBIx::Class::Row/insert> on it.
2191 You most likely want this method when looking for existing rows using
2192 a unique constraint that is not the primary key, or looking for
2195 If you want objects to be saved immediately, use L</find_or_create> instead.
2197 B<Note>: C<find_or_new> is probably not what you want when creating a
2198 new row in a table that uses primary keys supplied by the
2199 database. Passing in a primary key column with a value of I<undef>
2200 will cause L</find> to attempt to search for a row with a value of
2207 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2208 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2209 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2212 return $self->new_result($hash);
2219 =item Arguments: \%vals
2221 =item Return Value: a L<DBIx::Class::Row> $object
2225 Attempt to create a single new row or a row with multiple related rows
2226 in the table represented by the resultset (and related tables). This
2227 will not check for duplicate rows before inserting, use
2228 L</find_or_create> to do that.
2230 To create one row for this resultset, pass a hashref of key/value
2231 pairs representing the columns of the table and the values you wish to
2232 store. If the appropriate relationships are set up, foreign key fields
2233 can also be passed an object representing the foreign row, and the
2234 value will be set to its primary key.
2236 To create related objects, pass a hashref of related-object column values
2237 B<keyed on the relationship name>. If the relationship is of type C<multi>
2238 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2239 The process will correctly identify columns holding foreign keys, and will
2240 transparrently populate them from the keys of the corresponding relation.
2241 This can be applied recursively, and will work correctly for a structure
2242 with an arbitrary depth and width, as long as the relationships actually
2243 exists and the correct column data has been supplied.
2246 Instead of hashrefs of plain related data (key/value pairs), you may
2247 also pass new or inserted objects. New objects (not inserted yet, see
2248 L</new>), will be inserted into their appropriate tables.
2250 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2252 Example of creating a new row.
2254 $person_rs->create({
2255 name=>"Some Person",
2256 email=>"somebody@someplace.com"
2259 Example of creating a new row and also creating rows in a related C<has_many>
2260 or C<has_one> resultset. Note Arrayref.
2263 { artistid => 4, name => 'Manufactured Crap', cds => [
2264 { title => 'My First CD', year => 2006 },
2265 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2270 Example of creating a new row and also creating a row in a related
2271 C<belongs_to>resultset. Note Hashref.
2274 title=>"Music for Silly Walks",
2277 name=>"Silly Musician",
2285 When subclassing ResultSet never attempt to override this method. Since
2286 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2287 lot of the internals simply never call it, so your override will be
2288 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2289 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2290 L</create> process you need to intervene.
2297 my ($self, $attrs) = @_;
2298 $self->throw_exception( "create needs a hashref" )
2299 unless ref $attrs eq 'HASH';
2300 return $self->new_result($attrs)->insert;
2303 =head2 find_or_create
2307 =item Arguments: \%vals, \%attrs?
2309 =item Return Value: $rowobject
2313 $cd->cd_to_producer->find_or_create({ producer => $producer },
2314 { key => 'primary' });
2316 Tries to find a record based on its primary key or unique constraints; if none
2317 is found, creates one and returns that instead.
2319 my $cd = $schema->resultset('CD')->find_or_create({
2321 artist => 'Massive Attack',
2322 title => 'Mezzanine',
2326 Also takes an optional C<key> attribute, to search by a specific key or unique
2327 constraint. For example:
2329 my $cd = $schema->resultset('CD')->find_or_create(
2331 artist => 'Massive Attack',
2332 title => 'Mezzanine',
2334 { key => 'cd_artist_title' }
2337 B<Note>: Because find_or_create() reads from the database and then
2338 possibly inserts based on the result, this method is subject to a race
2339 condition. Another process could create a record in the table after
2340 the find has completed and before the create has started. To avoid
2341 this problem, use find_or_create() inside a transaction.
2343 B<Note>: C<find_or_create> is probably not what you want when creating
2344 a new row in a table that uses primary keys supplied by the
2345 database. Passing in a primary key column with a value of I<undef>
2346 will cause L</find> to attempt to search for a row with a value of
2349 See also L</find> and L</update_or_create>. For information on how to declare
2350 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2354 sub find_or_create {
2356 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2357 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2358 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2361 return $self->create($hash);
2364 =head2 update_or_create
2368 =item Arguments: \%col_values, { key => $unique_constraint }?
2370 =item Return Value: $rowobject
2374 $resultset->update_or_create({ col => $val, ... });
2376 First, searches for an existing row matching one of the unique constraints
2377 (including the primary key) on the source of this resultset. If a row is
2378 found, updates it with the other given column values. Otherwise, creates a new
2381 Takes an optional C<key> attribute to search on a specific unique constraint.
2384 # In your application
2385 my $cd = $schema->resultset('CD')->update_or_create(
2387 artist => 'Massive Attack',
2388 title => 'Mezzanine',
2391 { key => 'cd_artist_title' }
2394 $cd->cd_to_producer->update_or_create({
2395 producer => $producer,
2402 If no C<key> is specified, it searches on all unique constraints defined on the
2403 source, including the primary key.
2405 If the C<key> is specified as C<primary>, it searches only on the primary key.
2407 See also L</find> and L</find_or_create>. For information on how to declare
2408 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2410 B<Note>: C<update_or_create> is probably not what you want when
2411 looking for a row in a table that uses primary keys supplied by the
2412 database, unless you actually have a key value. Passing in a primary
2413 key column with a value of I<undef> will cause L</find> to attempt to
2414 search for a row with a value of I<NULL>.
2418 sub update_or_create {
2420 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2421 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2423 my $row = $self->find($cond, $attrs);
2425 $row->update($cond);
2429 return $self->create($cond);
2432 =head2 update_or_new
2436 =item Arguments: \%col_values, { key => $unique_constraint }?
2438 =item Return Value: $rowobject
2442 $resultset->update_or_new({ col => $val, ... });
2444 First, searches for an existing row matching one of the unique constraints
2445 (including the primary key) on the source of this resultset. If a row is
2446 found, updates it with the other given column values. Otherwise, instantiate
2447 a new result object and return it. The object will not be saved into your storage
2448 until you call L<DBIx::Class::Row/insert> on it.
2450 Takes an optional C<key> attribute to search on a specific unique constraint.
2453 # In your application
2454 my $cd = $schema->resultset('CD')->update_or_new(
2456 artist => 'Massive Attack',
2457 title => 'Mezzanine',
2460 { key => 'cd_artist_title' }
2463 if ($cd->in_storage) {
2464 # the cd was updated
2467 # the cd is not yet in the database, let's insert it
2471 See also L</find>, L</find_or_create> and L<find_or_new>.
2477 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2478 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2480 my $row = $self->find( $cond, $attrs );
2481 if ( defined $row ) {
2482 $row->update($cond);
2486 return $self->new_result($cond);
2493 =item Arguments: none
2495 =item Return Value: \@cache_objects?
2499 Gets the contents of the cache for the resultset, if the cache is set.
2501 The cache is populated either by using the L</prefetch> attribute to
2502 L</search> or by calling L</set_cache>.
2514 =item Arguments: \@cache_objects
2516 =item Return Value: \@cache_objects
2520 Sets the contents of the cache for the resultset. Expects an arrayref
2521 of objects of the same class as those produced by the resultset. Note that
2522 if the cache is set the resultset will return the cached objects rather
2523 than re-querying the database even if the cache attr is not set.
2525 The contents of the cache can also be populated by using the
2526 L</prefetch> attribute to L</search>.
2531 my ( $self, $data ) = @_;
2532 $self->throw_exception("set_cache requires an arrayref")
2533 if defined($data) && (ref $data ne 'ARRAY');
2534 $self->{all_cache} = $data;
2541 =item Arguments: none
2543 =item Return Value: []
2547 Clears the cache for the resultset.
2552 shift->set_cache(undef);
2555 =head2 related_resultset
2559 =item Arguments: $relationship_name
2561 =item Return Value: $resultset
2565 Returns a related resultset for the supplied relationship name.
2567 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2571 sub related_resultset {
2572 my ($self, $rel) = @_;
2574 $self->{related_resultsets} ||= {};
2575 return $self->{related_resultsets}{$rel} ||= do {
2576 my $rel_info = $self->result_source->relationship_info($rel);
2578 $self->throw_exception(
2579 "search_related: result source '" . $self->result_source->source_name .
2580 "' has no such relationship $rel")
2583 my ($from,$seen) = $self->_chain_relationship($rel);
2585 my $join_count = $seen->{$rel};
2586 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2588 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2589 my %attrs = %{$self->{attrs}||{}};
2590 delete @attrs{qw(result_class alias)};
2594 if (my $cache = $self->get_cache) {
2595 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2596 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2601 my $rel_source = $self->result_source->related_source($rel);
2605 # The reason we do this now instead of passing the alias to the
2606 # search_rs below is that if you wrap/overload resultset on the
2607 # source you need to know what alias it's -going- to have for things
2608 # to work sanely (e.g. RestrictWithObject wants to be able to add
2609 # extra query restrictions, and these may need to be $alias.)
2611 my $attrs = $rel_source->resultset_attributes;
2612 local $attrs->{alias} = $alias;
2614 $rel_source->resultset
2622 where => $self->{cond},
2627 $new->set_cache($new_cache) if $new_cache;
2632 =head2 current_source_alias
2636 =item Arguments: none
2638 =item Return Value: $source_alias
2642 Returns the current table alias for the result source this resultset is built
2643 on, that will be used in the SQL query. Usually it is C<me>.
2645 Currently the source alias that refers to the result set returned by a
2646 L</search>/L</find> family method depends on how you got to the resultset: it's
2647 C<me> by default, but eg. L</search_related> aliases it to the related result
2648 source name (and keeps C<me> referring to the original result set). The long
2649 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2650 (and make this method unnecessary).
2652 Thus it's currently necessary to use this method in predefined queries (see
2653 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2654 source alias of the current result set:
2656 # in a result set class
2658 my ($self, $user) = @_;
2660 my $me = $self->current_source_alias;
2662 return $self->search(
2663 "$me.modified" => $user->id,
2669 sub current_source_alias {
2672 return ($self->{attrs} || {})->{alias} || 'me';
2675 # This code is called by search_related, and makes sure there
2676 # is clear separation between the joins before, during, and
2677 # after the relationship. This information is needed later
2678 # in order to properly resolve prefetch aliases (any alias
2679 # with a relation_chain_depth less than the depth of the
2680 # current prefetch is not considered)
2682 # The increments happen in 1/2s to make it easier to correlate the
2683 # join depth with the join path. An integer means a relationship
2684 # specified via a search_related, whereas a fraction means an added
2685 # join/prefetch via attributes
2686 sub _chain_relationship {
2687 my ($self, $rel) = @_;
2688 my $source = $self->result_source;
2689 my $attrs = $self->{attrs};
2695 -source_handle => $source->handle,
2696 -alias => $attrs->{alias},
2697 $attrs->{alias} => $source->from,
2701 my $seen = { %{$attrs->{seen_join} || {} } };
2702 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2703 ? $from->[-1][0]{-join_path}
2707 # we need to take the prefetch the attrs into account before we
2708 # ->_resolve_join as otherwise they get lost - captainL
2709 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2711 my @requested_joins = $source->_resolve_join(
2718 push @$from, @requested_joins;
2720 $seen->{-relation_chain_depth} += 0.5;
2722 # if $self already had a join/prefetch specified on it, the requested
2723 # $rel might very well be already included. What we do in this case
2724 # is effectively a no-op (except that we bump up the chain_depth on
2725 # the join in question so we could tell it *is* the search_related)
2729 # we consider the last one thus reverse
2730 for my $j (reverse @requested_joins) {
2731 if ($rel eq $j->[0]{-join_path}[-1]) {
2732 $j->[0]{-relation_chain_depth} += 0.5;
2738 # alternative way to scan the entire chain - not backwards compatible
2739 # for my $j (reverse @$from) {
2740 # next unless ref $j eq 'ARRAY';
2741 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2742 # $j->[0]{-relation_chain_depth} += 0.5;
2743 # $already_joined++;
2748 unless ($already_joined) {
2749 push @$from, $source->_resolve_join(
2757 $seen->{-relation_chain_depth} += 0.5;
2759 return ($from,$seen);
2762 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2763 sub _resolved_attrs_copy {
2765 return { %{$self->_resolved_attrs (@_)} };
2768 sub _resolved_attrs {
2770 return $self->{_attrs} if $self->{_attrs};
2772 my $attrs = { %{ $self->{attrs} || {} } };
2773 my $source = $self->result_source;
2774 my $alias = $attrs->{alias};
2776 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2779 # build columns (as long as select isn't set) into a set of as/select hashes
2780 unless ( $attrs->{select} ) {
2782 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2783 ? @{ delete $attrs->{columns}}
2785 ( delete $attrs->{columns} )
2787 $source->storage->_order_select_columns(
2789 [ $source->columns ],
2795 ( ref($_) eq 'HASH' )
2799 /^\Q${alias}.\E(.+)$/
2813 # add the additional columns on
2814 foreach ( 'include_columns', '+columns' ) {
2815 push @colbits, map {
2816 ( ref($_) eq 'HASH' )
2818 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2819 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2822 # start with initial select items
2823 if ( $attrs->{select} ) {
2825 ( ref $attrs->{select} eq 'ARRAY' )
2826 ? [ @{ $attrs->{select} } ]
2827 : [ $attrs->{select} ];
2831 ref $attrs->{as} eq 'ARRAY'
2832 ? [ @{ $attrs->{as} } ]
2835 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2840 # otherwise we intialise select & as to empty
2841 $attrs->{select} = [];
2845 # now add colbits to select/as
2846 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2847 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2850 if ( $adds = delete $attrs->{'+select'} ) {
2851 $adds = [$adds] unless ref $adds eq 'ARRAY';
2853 @{ $attrs->{select} },
2854 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2857 if ( $adds = delete $attrs->{'+as'} ) {
2858 $adds = [$adds] unless ref $adds eq 'ARRAY';
2859 push( @{ $attrs->{as} }, @$adds );
2862 $attrs->{from} ||= [ {
2863 -source_handle => $source->handle,
2864 -alias => $self->{attrs}{alias},
2865 $self->{attrs}{alias} => $source->from,
2868 if ( $attrs->{join} || $attrs->{prefetch} ) {
2870 $self->throw_exception ('join/prefetch can not be used with a literal scalarref {from}')
2871 if ref $attrs->{from} ne 'ARRAY';
2873 my $join = delete $attrs->{join} || {};
2875 if ( defined $attrs->{prefetch} ) {
2876 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2879 $attrs->{from} = # have to copy here to avoid corrupting the original
2881 @{ $attrs->{from} },
2882 $source->_resolve_join(
2885 { %{ $attrs->{seen_join} || {} } },
2886 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2887 ? $attrs->{from}[-1][0]{-join_path}
2894 if ( defined $attrs->{order_by} ) {
2895 $attrs->{order_by} = (
2896 ref( $attrs->{order_by} ) eq 'ARRAY'
2897 ? [ @{ $attrs->{order_by} } ]
2898 : [ $attrs->{order_by} || () ]
2902 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2903 $attrs->{group_by} = [ $attrs->{group_by} ];
2906 # generate the distinct induced group_by early, as prefetch will be carried via a
2907 # subquery (since a group_by is present)
2908 if (delete $attrs->{distinct}) {
2909 $attrs->{group_by} ||= [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2912 $attrs->{collapse} ||= {};
2913 if ( my $prefetch = delete $attrs->{prefetch} ) {
2914 $prefetch = $self->_merge_attr( {}, $prefetch );
2916 my $prefetch_ordering = [];
2918 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2921 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2923 # we need to somehow mark which columns came from prefetch
2924 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2926 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2927 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2929 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2930 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2933 # if both page and offset are specified, produce a combined offset
2934 # even though it doesn't make much sense, this is what pre 081xx has
2936 if (my $page = delete $attrs->{page}) {
2938 ($attrs->{rows} * ($page - 1))
2940 ($attrs->{offset} || 0)
2944 return $self->{_attrs} = $attrs;
2947 sub _joinpath_aliases {
2948 my ($self, $fromspec, $seen) = @_;
2951 return $paths unless ref $fromspec eq 'ARRAY';
2953 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2955 if (int ($cur_depth) != $cur_depth) {
2956 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2959 for my $j (@$fromspec) {
2961 next if ref $j ne 'ARRAY';
2962 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2964 my $jpath = $j->[0]{-join_path};
2967 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2968 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2975 my ($self, $attr) = @_;
2977 if (ref $attr eq 'HASH') {
2978 return $self->_rollout_hash($attr);
2979 } elsif (ref $attr eq 'ARRAY') {
2980 return $self->_rollout_array($attr);
2986 sub _rollout_array {
2987 my ($self, $attr) = @_;
2990 foreach my $element (@{$attr}) {
2991 if (ref $element eq 'HASH') {
2992 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2993 } elsif (ref $element eq 'ARRAY') {
2994 # XXX - should probably recurse here
2995 push( @rolled_array, @{$self->_rollout_array($element)} );
2997 push( @rolled_array, $element );
3000 return \@rolled_array;
3004 my ($self, $attr) = @_;
3007 foreach my $key (keys %{$attr}) {
3008 push( @rolled_array, { $key => $attr->{$key} } );
3010 return \@rolled_array;
3013 sub _calculate_score {
3014 my ($self, $a, $b) = @_;
3016 if (ref $b eq 'HASH') {
3017 my ($b_key) = keys %{$b};
3018 if (ref $a eq 'HASH') {
3019 my ($a_key) = keys %{$a};
3020 if ($a_key eq $b_key) {
3021 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3026 return ($a eq $b_key) ? 1 : 0;
3029 if (ref $a eq 'HASH') {
3030 my ($a_key) = keys %{$a};
3031 return ($b eq $a_key) ? 1 : 0;
3033 return ($b eq $a) ? 1 : 0;
3039 my ($self, $orig, $import) = @_;
3041 return $import unless defined($orig);
3042 return $orig unless defined($import);
3044 $orig = $self->_rollout_attr($orig);
3045 $import = $self->_rollout_attr($import);
3048 foreach my $import_element ( @{$import} ) {
3049 # find best candidate from $orig to merge $b_element into
3050 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3051 foreach my $orig_element ( @{$orig} ) {
3052 my $score = $self->_calculate_score( $orig_element, $import_element );
3053 if ($score > $best_candidate->{score}) {
3054 $best_candidate->{position} = $position;
3055 $best_candidate->{score} = $score;
3059 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3061 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3062 push( @{$orig}, $import_element );
3064 my $orig_best = $orig->[$best_candidate->{position}];
3065 # merge orig_best and b_element together and replace original with merged
3066 if (ref $orig_best ne 'HASH') {
3067 $orig->[$best_candidate->{position}] = $import_element;
3068 } elsif (ref $import_element eq 'HASH') {
3069 my ($key) = keys %{$orig_best};
3070 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3073 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3083 $self->_source_handle($_[0]->handle);
3085 $self->_source_handle->resolve;
3089 =head2 throw_exception
3091 See L<DBIx::Class::Schema/throw_exception> for details.
3095 sub throw_exception {
3097 if (ref $self && $self->_source_handle->schema) {
3098 $self->_source_handle->schema->throw_exception(@_)
3105 # XXX: FIXME: Attributes docs need clearing up
3109 Attributes are used to refine a ResultSet in various ways when
3110 searching for data. They can be passed to any method which takes an
3111 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3114 These are in no particular order:
3120 =item Value: ( $order_by | \@order_by | \%order_by )
3124 Which column(s) to order the results by.
3126 [The full list of suitable values is documented in
3127 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3130 If a single column name, or an arrayref of names is supplied, the
3131 argument is passed through directly to SQL. The hashref syntax allows
3132 for connection-agnostic specification of ordering direction:
3134 For descending order:
3136 order_by => { -desc => [qw/col1 col2 col3/] }
3138 For explicit ascending order:
3140 order_by => { -asc => 'col' }
3142 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3143 supported, although you are strongly encouraged to use the hashref
3144 syntax as outlined above.
3150 =item Value: \@columns
3154 Shortcut to request a particular set of columns to be retrieved. Each
3155 column spec may be a string (a table column name), or a hash (in which
3156 case the key is the C<as> value, and the value is used as the C<select>
3157 expression). Adds C<me.> onto the start of any column without a C<.> in
3158 it and sets C<select> from that, then auto-populates C<as> from
3159 C<select> as normal. (You may also use the C<cols> attribute, as in
3160 earlier versions of DBIC.)
3166 =item Value: \@columns
3170 Indicates additional columns to be selected from storage. Works the same
3171 as L</columns> but adds columns to the selection. (You may also use the
3172 C<include_columns> attribute, as in earlier versions of DBIC). For
3175 $schema->resultset('CD')->search(undef, {
3176 '+columns' => ['artist.name'],
3180 would return all CDs and include a 'name' column to the information
3181 passed to object inflation. Note that the 'artist' is the name of the
3182 column (or relationship) accessor, and 'name' is the name of the column
3183 accessor in the related table.
3185 =head2 include_columns
3189 =item Value: \@columns
3193 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3199 =item Value: \@select_columns
3203 Indicates which columns should be selected from the storage. You can use
3204 column names, or in the case of RDBMS back ends, function or stored procedure
3207 $rs = $schema->resultset('Employee')->search(undef, {
3210 { count => 'employeeid' },
3215 When you use function/stored procedure names and do not supply an C<as>
3216 attribute, the column names returned are storage-dependent. E.g. MySQL would
3217 return a column named C<count(employeeid)> in the above example.
3223 Indicates additional columns to be selected from storage. Works the same as
3224 L</select> but adds columns to the selection.
3232 Indicates additional column names for those added via L</+select>. See L</as>.
3240 =item Value: \@inflation_names
3244 Indicates column names for object inflation. That is, C<as>
3245 indicates the name that the column can be accessed as via the
3246 C<get_column> method (or via the object accessor, B<if one already
3247 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3249 The C<as> attribute is used in conjunction with C<select>,
3250 usually when C<select> contains one or more function or stored
3253 $rs = $schema->resultset('Employee')->search(undef, {
3256 { count => 'employeeid' }
3258 as => ['name', 'employee_count'],
3261 my $employee = $rs->first(); # get the first Employee
3263 If the object against which the search is performed already has an accessor
3264 matching a column name specified in C<as>, the value can be retrieved using
3265 the accessor as normal:
3267 my $name = $employee->name();
3269 If on the other hand an accessor does not exist in the object, you need to
3270 use C<get_column> instead:
3272 my $employee_count = $employee->get_column('employee_count');
3274 You can create your own accessors if required - see
3275 L<DBIx::Class::Manual::Cookbook> for details.
3277 Please note: This will NOT insert an C<AS employee_count> into the SQL
3278 statement produced, it is used for internal access only. Thus
3279 attempting to use the accessor in an C<order_by> clause or similar
3280 will fail miserably.
3282 To get around this limitation, you can supply literal SQL to your
3283 C<select> attibute that contains the C<AS alias> text, eg:
3285 select => [\'myfield AS alias']
3291 =item Value: ($rel_name | \@rel_names | \%rel_names)
3295 Contains a list of relationships that should be joined for this query. For
3298 # Get CDs by Nine Inch Nails
3299 my $rs = $schema->resultset('CD')->search(
3300 { 'artist.name' => 'Nine Inch Nails' },
3301 { join => 'artist' }
3304 Can also contain a hash reference to refer to the other relation's relations.
3307 package MyApp::Schema::Track;
3308 use base qw/DBIx::Class/;
3309 __PACKAGE__->table('track');
3310 __PACKAGE__->add_columns(qw/trackid cd position title/);
3311 __PACKAGE__->set_primary_key('trackid');
3312 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3315 # In your application
3316 my $rs = $schema->resultset('Artist')->search(
3317 { 'track.title' => 'Teardrop' },
3319 join => { cd => 'track' },
3320 order_by => 'artist.name',
3324 You need to use the relationship (not the table) name in conditions,
3325 because they are aliased as such. The current table is aliased as "me", so
3326 you need to use me.column_name in order to avoid ambiguity. For example:
3328 # Get CDs from 1984 with a 'Foo' track
3329 my $rs = $schema->resultset('CD')->search(
3332 'tracks.name' => 'Foo'
3334 { join => 'tracks' }
3337 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3338 similarly for a third time). For e.g.
3340 my $rs = $schema->resultset('Artist')->search({
3341 'cds.title' => 'Down to Earth',
3342 'cds_2.title' => 'Popular',
3344 join => [ qw/cds cds/ ],
3347 will return a set of all artists that have both a cd with title 'Down
3348 to Earth' and a cd with title 'Popular'.
3350 If you want to fetch related objects from other tables as well, see C<prefetch>
3353 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3359 =item Value: ($rel_name | \@rel_names | \%rel_names)
3363 Contains one or more relationships that should be fetched along with
3364 the main query (when they are accessed afterwards the data will
3365 already be available, without extra queries to the database). This is
3366 useful for when you know you will need the related objects, because it
3367 saves at least one query:
3369 my $rs = $schema->resultset('Tag')->search(
3378 The initial search results in SQL like the following:
3380 SELECT tag.*, cd.*, artist.* FROM tag
3381 JOIN cd ON tag.cd = cd.cdid
3382 JOIN artist ON cd.artist = artist.artistid
3384 L<DBIx::Class> has no need to go back to the database when we access the
3385 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3388 Simple prefetches will be joined automatically, so there is no need
3389 for a C<join> attribute in the above search.
3391 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3392 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3393 with an accessor type of 'single' or 'filter'). A more complex example that
3394 prefetches an artists cds, the tracks on those cds, and the tags associted
3395 with that artist is given below (assuming many-to-many from artists to tags):
3397 my $rs = $schema->resultset('Artist')->search(
3401 { cds => 'tracks' },
3402 { artist_tags => 'tags' }
3408 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3409 attributes will be ignored.
3411 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3412 exactly as you might expect.
3418 Prefetch uses the L</cache> to populate the prefetched relationships. This
3419 may or may not be what you want.
3423 If you specify a condition on a prefetched relationship, ONLY those
3424 rows that match the prefetched condition will be fetched into that relationship.
3425 This means that adding prefetch to a search() B<may alter> what is returned by
3426 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3428 my $artist_rs = $schema->resultset('Artist')->search({
3434 my $count = $artist_rs->first->cds->count;
3436 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3438 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3440 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3442 that cmp_ok() may or may not pass depending on the datasets involved. This
3443 behavior may or may not survive the 0.09 transition.
3455 Makes the resultset paged and specifies the page to retrieve. Effectively
3456 identical to creating a non-pages resultset and then calling ->page($page)
3459 If L<rows> attribute is not specified it defaults to 10 rows per page.
3461 When you have a paged resultset, L</count> will only return the number
3462 of rows in the page. To get the total, use the L</pager> and call
3463 C<total_entries> on it.
3473 Specifes the maximum number of rows for direct retrieval or the number of
3474 rows per page if the page attribute or method is used.
3480 =item Value: $offset
3484 Specifies the (zero-based) row number for the first row to be returned, or the
3485 of the first row of the first page if paging is used.
3491 =item Value: \@columns
3495 A arrayref of columns to group by. Can include columns of joined tables.
3497 group_by => [qw/ column1 column2 ... /]
3503 =item Value: $condition
3507 HAVING is a select statement attribute that is applied between GROUP BY and
3508 ORDER BY. It is applied to the after the grouping calculations have been
3511 having => { 'count(employee)' => { '>=', 100 } }
3517 =item Value: (0 | 1)
3521 Set to 1 to group by all columns.
3527 Adds to the WHERE clause.
3529 # only return rows WHERE deleted IS NULL for all searches
3530 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3532 Can be overridden by passing C<{ where => undef }> as an attribute
3539 Set to 1 to cache search results. This prevents extra SQL queries if you
3540 revisit rows in your ResultSet:
3542 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3544 while( my $artist = $resultset->next ) {
3548 $rs->first; # without cache, this would issue a query
3550 By default, searches are not cached.
3552 For more examples of using these attributes, see
3553 L<DBIx::Class::Manual::Cookbook>.
3559 =item Value: \@from_clause
3563 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
3564 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
3567 NOTE: Use this on your own risk. This allows you to shoot off your foot!
3569 C<join> will usually do what you need and it is strongly recommended that you
3570 avoid using C<from> unless you cannot achieve the desired result using C<join>.
3571 And we really do mean "cannot", not just tried and failed. Attempting to use
3572 this because you're having problems with C<join> is like trying to use x86
3573 ASM because you've got a syntax error in your C. Trust us on this.
3575 Now, if you're still really, really sure you need to use this (and if you're
3576 not 100% sure, ask the mailing list first), here's an explanation of how this
3579 The syntax is as follows -
3582 { <alias1> => <table1> },
3584 { <alias2> => <table2>, -join_type => 'inner|left|right' },
3585 [], # nested JOIN (optional)
3586 { <table1.column1> => <table2.column2>, ... (more conditions) },
3588 # More of the above [ ] may follow for additional joins
3595 ON <table1.column1> = <table2.column2>
3596 <more joins may follow>
3598 An easy way to follow the examples below is to remember the following:
3600 Anything inside "[]" is a JOIN
3601 Anything inside "{}" is a condition for the enclosing JOIN
3603 The following examples utilize a "person" table in a family tree application.
3604 In order to express parent->child relationships, this table is self-joined:
3606 # Person->belongs_to('father' => 'Person');
3607 # Person->belongs_to('mother' => 'Person');
3609 C<from> can be used to nest joins. Here we return all children with a father,
3610 then search against all mothers of those children:
3612 $rs = $schema->resultset('Person')->search(
3615 alias => 'mother', # alias columns in accordance with "from"
3617 { mother => 'person' },
3620 { child => 'person' },
3622 { father => 'person' },
3623 { 'father.person_id' => 'child.father_id' }
3626 { 'mother.person_id' => 'child.mother_id' }
3633 # SELECT mother.* FROM person mother
3636 # JOIN person father
3637 # ON ( father.person_id = child.father_id )
3639 # ON ( mother.person_id = child.mother_id )
3641 The type of any join can be controlled manually. To search against only people
3642 with a father in the person table, we could explicitly use C<INNER JOIN>:
3644 $rs = $schema->resultset('Person')->search(
3647 alias => 'child', # alias columns in accordance with "from"
3649 { child => 'person' },
3651 { father => 'person', -join_type => 'inner' },
3652 { 'father.id' => 'child.father_id' }
3659 # SELECT child.* FROM person child
3660 # INNER JOIN person father ON child.father_id = father.id
3662 You can select from a subquery by passing a resultset to from as follows.
3664 $schema->resultset('Artist')->search(
3666 { alias => 'artist2',
3667 from => [ { artist2 => $artist_rs->as_query } ],
3670 # and you'll get sql like this..
3671 # SELECT artist2.artistid, artist2.name, artist2.rank, artist2.charfield FROM
3672 # ( SELECT me.artistid, me.name, me.rank, me.charfield FROM artists me ) artist2
3674 If you need to express really complex joins, you
3675 can supply literal SQL to C<from> via a scalar reference. In this case
3676 the contents of the scalar will replace the table name associated with the
3679 WARNING: This technique might very well not work as expected on chained
3680 searches - you have been warned.
3682 # Assuming the Event resultsource is defined as:
3684 MySchema::Event->add_columns (
3687 is_auto_increment => 1,
3696 MySchema::Event->set_primary_key ('sequence');
3698 # This will get back the latest event for every location. The column
3699 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3700 # combo to limit the resultset
3702 $rs = $schema->resultset('Event');
3703 $table = $rs->result_source->name;
3704 $latest = $rs->search (
3707 (SELECT e1.* FROM $table e1
3709 ON e1.location = e2.location
3710 AND e1.sequence < e2.sequence
3711 WHERE e2.sequence is NULL
3716 # Equivalent SQL (with the DBIC chunks added):
3718 SELECT me.sequence, me.location, me.type FROM
3719 (SELECT e1.* FROM events e1
3721 ON e1.location = e2.location
3722 AND e1.sequence < e2.sequence
3723 WHERE e2.sequence is NULL
3730 =item Value: ( 'update' | 'shared' )
3734 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT