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 prefetch_select select as order_by/;
1269 # if we prefetch, we group_by primary keys only as this is what we would get out of the rs via ->next/->all
1270 # 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}
1283 count_subq => $rsrc->resultset_class->new ($rsrc, $sub_attrs )->as_query
1286 # the subquery replaces this
1287 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1289 return $self->_count_rs ($attrs);
1293 # The DBIC relationship chaining implementation is pretty simple - every
1294 # new related_relationship is pushed onto the {from} stack, and the {select}
1295 # window simply slides further in. This means that when we count somewhere
1296 # in the middle, we got to make sure that everything in the join chain is an
1297 # actual inner join, otherwise the count will come back with unpredictable
1298 # results (a resultset may be generated with _some_ rows regardless of if
1299 # the relation which the $rs currently selects has rows or not). E.g.
1300 # $artist_rs->cds->count - normally generates:
1301 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
1302 # which actually returns the number of artists * (number of cds || 1)
1304 # So what we do here is crawl {from}, determine if the current alias is at
1305 # the top of the stack, and if not - make sure the chain is inner-joined down
1308 sub _switch_to_inner_join_if_needed {
1309 my ($self, $from, $alias) = @_;
1312 ref $from ne 'ARRAY'
1314 ref $from->[0] ne 'HASH'
1316 ! $from->[0]{-alias}
1318 $from->[0]{-alias} eq $alias
1321 # this would be the case with a subquery - we'll never find
1322 # the target as it is not in the parseable part of {from}
1323 return $from if @$from == 1;
1327 for my $j (@{$from}[1 .. $#$from]) {
1328 if ($j->[0]{-alias} eq $alias) {
1329 $switch_branch = $j->[0]{-join_path};
1334 # something else went wrong
1335 return $from unless $switch_branch;
1337 # So it looks like we will have to switch some stuff around.
1338 # local() is useless here as we will be leaving the scope
1339 # anyway, and deep cloning is just too fucking expensive
1340 # So replace the inner hashref manually
1341 my @new_from = ($from->[0]);
1342 my $sw_idx = { map { $_ => 1 } @$switch_branch };
1344 for my $j (@{$from}[1 .. $#$from]) {
1345 my $jalias = $j->[0]{-alias};
1347 if ($sw_idx->{$jalias}) {
1348 my %attrs = %{$j->[0]};
1349 delete $attrs{-join_type};
1368 =head2 count_literal
1372 =item Arguments: $sql_fragment, @bind_values
1374 =item Return Value: $count
1378 Counts the results in a literal query. Equivalent to calling L</search_literal>
1379 with the passed arguments, then L</count>.
1383 sub count_literal { shift->search_literal(@_)->count; }
1389 =item Arguments: none
1391 =item Return Value: @objects
1395 Returns all elements in the resultset. Called implicitly if the resultset
1396 is returned in list context.
1403 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1406 return @{ $self->get_cache } if $self->get_cache;
1410 if (keys %{$self->_resolved_attrs->{collapse}}) {
1411 # Using $self->cursor->all is really just an optimisation.
1412 # If we're collapsing has_many prefetches it probably makes
1413 # very little difference, and this is cleaner than hacking
1414 # _construct_object to survive the approach
1415 $self->cursor->reset;
1416 my @row = $self->cursor->next;
1418 push(@obj, $self->_construct_object(@row));
1419 @row = (exists $self->{stashed_row}
1420 ? @{delete $self->{stashed_row}}
1421 : $self->cursor->next);
1424 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1427 $self->set_cache(\@obj) if $self->{attrs}{cache};
1436 =item Arguments: none
1438 =item Return Value: $self
1442 Resets the resultset's cursor, so you can iterate through the elements again.
1443 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1450 delete $self->{_attrs} if exists $self->{_attrs};
1451 $self->{all_cache_position} = 0;
1452 $self->cursor->reset;
1460 =item Arguments: none
1462 =item Return Value: $object?
1466 Resets the resultset and returns an object for the first result (if the
1467 resultset returns anything).
1472 return $_[0]->reset->next;
1478 # Determines whether and what type of subquery is required for the $rs operation.
1479 # If grouping is necessary either supplies its own, or verifies the current one
1480 # After all is done delegates to the proper storage method.
1482 sub _rs_update_delete {
1483 my ($self, $op, $values) = @_;
1485 my $rsrc = $self->result_source;
1487 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1488 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1490 if ($needs_group_by_subq or $needs_subq) {
1492 # make a new $rs selecting only the PKs (that's all we really need)
1493 my $attrs = $self->_resolved_attrs_copy;
1495 delete $attrs->{$_} for qw/collapse select as/;
1496 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1498 if ($needs_group_by_subq) {
1499 # make sure no group_by was supplied, or if there is one - make sure it matches
1500 # the columns compiled above perfectly. Anything else can not be sanely executed
1501 # on most databases so croak right then and there
1503 if (my $g = $attrs->{group_by}) {
1504 my @current_group_by = map
1505 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1506 (ref $g eq 'ARRAY' ? @$g : $g );
1509 join ("\x00", sort @current_group_by)
1511 join ("\x00", sort @{$attrs->{columns}} )
1513 $self->throw_exception (
1514 "You have just attempted a $op operation on a resultset which does group_by"
1515 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1516 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1517 . ' kind of queries. Please retry the operation with a modified group_by or'
1518 . ' without using one at all.'
1523 $attrs->{group_by} = $attrs->{columns};
1527 my $subrs = (ref $self)->new($rsrc, $attrs);
1529 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1532 return $rsrc->storage->$op(
1534 $op eq 'update' ? $values : (),
1535 $self->_cond_for_update_delete,
1541 # _cond_for_update_delete
1543 # update/delete require the condition to be modified to handle
1544 # the differing SQL syntax available. This transforms the $self->{cond}
1545 # appropriately, returning the new condition.
1547 sub _cond_for_update_delete {
1548 my ($self, $full_cond) = @_;
1551 $full_cond ||= $self->{cond};
1552 # No-op. No condition, we're updating/deleting everything
1553 return $cond unless ref $full_cond;
1555 if (ref $full_cond eq 'ARRAY') {
1559 foreach my $key (keys %{$_}) {
1561 $hash{$1} = $_->{$key};
1567 elsif (ref $full_cond eq 'HASH') {
1568 if ((keys %{$full_cond})[0] eq '-and') {
1570 my @cond = @{$full_cond->{-and}};
1571 for (my $i = 0; $i < @cond; $i++) {
1572 my $entry = $cond[$i];
1574 if (ref $entry eq 'HASH') {
1575 $hash = $self->_cond_for_update_delete($entry);
1578 $entry =~ /([^.]+)$/;
1579 $hash->{$1} = $cond[++$i];
1581 push @{$cond->{-and}}, $hash;
1585 foreach my $key (keys %{$full_cond}) {
1587 $cond->{$1} = $full_cond->{$key};
1592 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1603 =item Arguments: \%values
1605 =item Return Value: $storage_rv
1609 Sets the specified columns in the resultset to the supplied values in a
1610 single query. Return value will be true if the update succeeded or false
1611 if no records were updated; exact type of success value is storage-dependent.
1616 my ($self, $values) = @_;
1617 $self->throw_exception('Values for update must be a hash')
1618 unless ref $values eq 'HASH';
1620 return $self->_rs_update_delete ('update', $values);
1627 =item Arguments: \%values
1629 =item Return Value: 1
1633 Fetches all objects and updates them one at a time. Note that C<update_all>
1634 will run DBIC cascade triggers, while L</update> will not.
1639 my ($self, $values) = @_;
1640 $self->throw_exception('Values for update_all must be a hash')
1641 unless ref $values eq 'HASH';
1642 foreach my $obj ($self->all) {
1643 $obj->set_columns($values)->update;
1652 =item Arguments: none
1654 =item Return Value: $storage_rv
1658 Deletes the contents of the resultset from its result source. Note that this
1659 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1660 to run. See also L<DBIx::Class::Row/delete>.
1662 Return value will be the amount of rows deleted; exact type of return value
1663 is storage-dependent.
1669 $self->throw_exception('delete does not accept any arguments')
1672 return $self->_rs_update_delete ('delete');
1679 =item Arguments: none
1681 =item Return Value: 1
1685 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1686 will run DBIC cascade triggers, while L</delete> will not.
1692 $self->throw_exception('delete_all does not accept any arguments')
1695 $_->delete for $self->all;
1703 =item Arguments: \@data;
1707 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1708 For the arrayref of hashrefs style each hashref should be a structure suitable
1709 forsubmitting to a $resultset->create(...) method.
1711 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1712 to insert the data, as this is a faster method.
1714 Otherwise, each set of data is inserted into the database using
1715 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1716 accumulated into an array. The array itself, or an array reference
1717 is returned depending on scalar or list context.
1719 Example: Assuming an Artist Class that has many CDs Classes relating:
1721 my $Artist_rs = $schema->resultset("Artist");
1723 ## Void Context Example
1724 $Artist_rs->populate([
1725 { artistid => 4, name => 'Manufactured Crap', cds => [
1726 { title => 'My First CD', year => 2006 },
1727 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1730 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1731 { title => 'My parents sold me to a record company' ,year => 2005 },
1732 { title => 'Why Am I So Ugly?', year => 2006 },
1733 { title => 'I Got Surgery and am now Popular', year => 2007 }
1738 ## Array Context Example
1739 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1740 { name => "Artist One"},
1741 { name => "Artist Two"},
1742 { name => "Artist Three", cds=> [
1743 { title => "First CD", year => 2007},
1744 { title => "Second CD", year => 2008},
1748 print $ArtistOne->name; ## response is 'Artist One'
1749 print $ArtistThree->cds->count ## reponse is '2'
1751 For the arrayref of arrayrefs style, the first element should be a list of the
1752 fieldsnames to which the remaining elements are rows being inserted. For
1755 $Arstist_rs->populate([
1756 [qw/artistid name/],
1757 [100, 'A Formally Unknown Singer'],
1758 [101, 'A singer that jumped the shark two albums ago'],
1759 [102, 'An actually cool singer.'],
1762 Please note an important effect on your data when choosing between void and
1763 wantarray context. Since void context goes straight to C<insert_bulk> in
1764 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1765 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1766 create primary keys for you, you will find that your PKs are empty. In this
1767 case you will have to use the wantarray context in order to create those
1773 my $self = shift @_;
1774 my $data = ref $_[0][0] eq 'HASH'
1775 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1776 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1778 if(defined wantarray) {
1780 foreach my $item (@$data) {
1781 push(@created, $self->create($item));
1783 return wantarray ? @created : \@created;
1785 my ($first, @rest) = @$data;
1787 my @names = grep {!ref $first->{$_}} keys %$first;
1788 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1789 my @pks = $self->result_source->primary_columns;
1791 ## do the belongs_to relationships
1792 foreach my $index (0..$#$data) {
1794 # delegate to create() for any dataset without primary keys with specified relationships
1795 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1797 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1798 my @ret = $self->populate($data);
1804 foreach my $rel (@rels) {
1805 next unless ref $data->[$index]->{$rel} eq "HASH";
1806 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1807 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1808 my $related = $result->result_source->_resolve_condition(
1809 $result->result_source->relationship_info($reverse)->{cond},
1814 delete $data->[$index]->{$rel};
1815 $data->[$index] = {%{$data->[$index]}, %$related};
1817 push @names, keys %$related if $index == 0;
1821 ## do bulk insert on current row
1822 my @values = map { [ @$_{@names} ] } @$data;
1824 $self->result_source->storage->insert_bulk(
1825 $self->result_source,
1830 ## do the has_many relationships
1831 foreach my $item (@$data) {
1833 foreach my $rel (@rels) {
1834 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1836 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1837 || $self->throw_exception('Cannot find the relating object.');
1839 my $child = $parent->$rel;
1841 my $related = $child->result_source->_resolve_condition(
1842 $parent->result_source->relationship_info($rel)->{cond},
1847 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1848 my @populate = map { {%$_, %$related} } @rows_to_add;
1850 $child->populate( \@populate );
1856 =head2 _normalize_populate_args ($args)
1858 Private method used by L</populate> to normalize its incoming arguments. Factored
1859 out in case you want to subclass and accept new argument structures to the
1860 L</populate> method.
1864 sub _normalize_populate_args {
1865 my ($self, $data) = @_;
1866 my @names = @{shift(@$data)};
1867 my @results_to_create;
1868 foreach my $datum (@$data) {
1869 my %result_to_create;
1870 foreach my $index (0..$#names) {
1871 $result_to_create{$names[$index]} = $$datum[$index];
1873 push @results_to_create, \%result_to_create;
1875 return \@results_to_create;
1882 =item Arguments: none
1884 =item Return Value: $pager
1888 Return Value a L<Data::Page> object for the current resultset. Only makes
1889 sense for queries with a C<page> attribute.
1891 To get the full count of entries for a paged resultset, call
1892 C<total_entries> on the L<Data::Page> object.
1899 return $self->{pager} if $self->{pager};
1901 my $attrs = $self->{attrs};
1902 $self->throw_exception("Can't create pager for non-paged rs")
1903 unless $self->{attrs}{page};
1904 $attrs->{rows} ||= 10;
1906 # throw away the paging flags and re-run the count (possibly
1907 # with a subselect) to get the real total count
1908 my $count_attrs = { %$attrs };
1909 delete $count_attrs->{$_} for qw/rows offset page pager/;
1910 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1912 return $self->{pager} = Data::Page->new(
1915 $self->{attrs}{page}
1923 =item Arguments: $page_number
1925 =item Return Value: $rs
1929 Returns a resultset for the $page_number page of the resultset on which page
1930 is called, where each page contains a number of rows equal to the 'rows'
1931 attribute set on the resultset (10 by default).
1936 my ($self, $page) = @_;
1937 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1944 =item Arguments: \%vals
1946 =item Return Value: $rowobject
1950 Creates a new row object in the resultset's result class and returns
1951 it. The row is not inserted into the database at this point, call
1952 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1953 will tell you whether the row object has been inserted or not.
1955 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1960 my ($self, $values) = @_;
1961 $self->throw_exception( "new_result needs a hash" )
1962 unless (ref $values eq 'HASH');
1965 my $alias = $self->{attrs}{alias};
1968 defined $self->{cond}
1969 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1971 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1972 $new{-from_resultset} = [ keys %new ] if keys %new;
1974 $self->throw_exception(
1975 "Can't abstract implicit construct, condition not a hash"
1976 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1978 my $collapsed_cond = (
1980 ? $self->_collapse_cond($self->{cond})
1984 # precendence must be given to passed values over values inherited from
1985 # the cond, so the order here is important.
1986 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1987 while( my($col,$value) = each %implied ){
1988 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1989 $new{$col} = $value->{'='};
1992 $new{$col} = $value if $self->_is_deterministic_value($value);
1998 %{ $self->_remove_alias($values, $alias) },
1999 -source_handle => $self->_source_handle,
2000 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2003 return $self->result_class->new(\%new);
2006 # _is_deterministic_value
2008 # Make an effor to strip non-deterministic values from the condition,
2009 # to make sure new_result chokes less
2011 sub _is_deterministic_value {
2014 my $ref_type = ref $value;
2015 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
2016 return 1 if Scalar::Util::blessed($value);
2020 # _has_resolved_attr
2022 # determines if the resultset defines at least one
2023 # of the attributes supplied
2025 # used to determine if a subquery is neccessary
2027 # supports some virtual attributes:
2029 # This will scan for any joins being present on the resultset.
2030 # It is not a mere key-search but a deep inspection of {from}
2033 sub _has_resolved_attr {
2034 my ($self, @attr_names) = @_;
2036 my $attrs = $self->_resolved_attrs;
2040 for my $n (@attr_names) {
2041 if (grep { $n eq $_ } (qw/-join/) ) {
2042 $extra_checks{$n}++;
2046 my $attr = $attrs->{$n};
2048 next if not defined $attr;
2050 if (ref $attr eq 'HASH') {
2051 return 1 if keys %$attr;
2053 elsif (ref $attr eq 'ARRAY') {
2061 # a resolved join is expressed as a multi-level from
2063 $extra_checks{-join}
2065 ref $attrs->{from} eq 'ARRAY'
2067 @{$attrs->{from}} > 1
2075 # Recursively collapse the condition.
2077 sub _collapse_cond {
2078 my ($self, $cond, $collapsed) = @_;
2082 if (ref $cond eq 'ARRAY') {
2083 foreach my $subcond (@$cond) {
2084 next unless ref $subcond; # -or
2085 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2088 elsif (ref $cond eq 'HASH') {
2089 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2090 foreach my $subcond (@{$cond->{-and}}) {
2091 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2095 foreach my $col (keys %$cond) {
2096 my $value = $cond->{$col};
2097 $collapsed->{$col} = $value;
2107 # Remove the specified alias from the specified query hash. A copy is made so
2108 # the original query is not modified.
2111 my ($self, $query, $alias) = @_;
2113 my %orig = %{ $query || {} };
2116 foreach my $key (keys %orig) {
2118 $unaliased{$key} = $orig{$key};
2121 $unaliased{$1} = $orig{$key}
2122 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2128 =head2 as_query (EXPERIMENTAL)
2132 =item Arguments: none
2134 =item Return Value: \[ $sql, @bind ]
2138 Returns the SQL query and bind vars associated with the invocant.
2140 This is generally used as the RHS for a subquery.
2142 B<NOTE>: This feature is still experimental.
2149 my $attrs = $self->_resolved_attrs_copy;
2154 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2155 # $sql also has no wrapping parenthesis in list ctx
2157 my $sqlbind = $self->result_source->storage
2158 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2167 =item Arguments: \%vals, \%attrs?
2169 =item Return Value: $rowobject
2173 my $artist = $schema->resultset('Artist')->find_or_new(
2174 { artist => 'fred' }, { key => 'artists' });
2176 $cd->cd_to_producer->find_or_new({ producer => $producer },
2177 { key => 'primary });
2179 Find an existing record from this resultset, based on its primary
2180 key, or a unique constraint. If none exists, instantiate a new result
2181 object and return it. The object will not be saved into your storage
2182 until you call L<DBIx::Class::Row/insert> on it.
2184 You most likely want this method when looking for existing rows using
2185 a unique constraint that is not the primary key, or looking for
2188 If you want objects to be saved immediately, use L</find_or_create> instead.
2190 B<Note>: C<find_or_new> is probably not what you want when creating a
2191 new row in a table that uses primary keys supplied by the
2192 database. Passing in a primary key column with a value of I<undef>
2193 will cause L</find> to attempt to search for a row with a value of
2200 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2201 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2202 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2205 return $self->new_result($hash);
2212 =item Arguments: \%vals
2214 =item Return Value: a L<DBIx::Class::Row> $object
2218 Attempt to create a single new row or a row with multiple related rows
2219 in the table represented by the resultset (and related tables). This
2220 will not check for duplicate rows before inserting, use
2221 L</find_or_create> to do that.
2223 To create one row for this resultset, pass a hashref of key/value
2224 pairs representing the columns of the table and the values you wish to
2225 store. If the appropriate relationships are set up, foreign key fields
2226 can also be passed an object representing the foreign row, and the
2227 value will be set to its primary key.
2229 To create related objects, pass a hashref of related-object column values
2230 B<keyed on the relationship name>. If the relationship is of type C<multi>
2231 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2232 The process will correctly identify columns holding foreign keys, and will
2233 transparrently populate them from the keys of the corresponding relation.
2234 This can be applied recursively, and will work correctly for a structure
2235 with an arbitrary depth and width, as long as the relationships actually
2236 exists and the correct column data has been supplied.
2239 Instead of hashrefs of plain related data (key/value pairs), you may
2240 also pass new or inserted objects. New objects (not inserted yet, see
2241 L</new>), will be inserted into their appropriate tables.
2243 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2245 Example of creating a new row.
2247 $person_rs->create({
2248 name=>"Some Person",
2249 email=>"somebody@someplace.com"
2252 Example of creating a new row and also creating rows in a related C<has_many>
2253 or C<has_one> resultset. Note Arrayref.
2256 { artistid => 4, name => 'Manufactured Crap', cds => [
2257 { title => 'My First CD', year => 2006 },
2258 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2263 Example of creating a new row and also creating a row in a related
2264 C<belongs_to>resultset. Note Hashref.
2267 title=>"Music for Silly Walks",
2270 name=>"Silly Musician",
2277 my ($self, $attrs) = @_;
2278 $self->throw_exception( "create needs a hashref" )
2279 unless ref $attrs eq 'HASH';
2280 return $self->new_result($attrs)->insert;
2283 =head2 find_or_create
2287 =item Arguments: \%vals, \%attrs?
2289 =item Return Value: $rowobject
2293 $cd->cd_to_producer->find_or_create({ producer => $producer },
2294 { key => 'primary' });
2296 Tries to find a record based on its primary key or unique constraints; if none
2297 is found, creates one and returns that instead.
2299 my $cd = $schema->resultset('CD')->find_or_create({
2301 artist => 'Massive Attack',
2302 title => 'Mezzanine',
2306 Also takes an optional C<key> attribute, to search by a specific key or unique
2307 constraint. For example:
2309 my $cd = $schema->resultset('CD')->find_or_create(
2311 artist => 'Massive Attack',
2312 title => 'Mezzanine',
2314 { key => 'cd_artist_title' }
2317 B<Note>: Because find_or_create() reads from the database and then
2318 possibly inserts based on the result, this method is subject to a race
2319 condition. Another process could create a record in the table after
2320 the find has completed and before the create has started. To avoid
2321 this problem, use find_or_create() inside a transaction.
2323 B<Note>: C<find_or_create> is probably not what you want when creating
2324 a new row in a table that uses primary keys supplied by the
2325 database. Passing in a primary key column with a value of I<undef>
2326 will cause L</find> to attempt to search for a row with a value of
2329 See also L</find> and L</update_or_create>. For information on how to declare
2330 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2334 sub find_or_create {
2336 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2337 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2338 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2341 return $self->create($hash);
2344 =head2 update_or_create
2348 =item Arguments: \%col_values, { key => $unique_constraint }?
2350 =item Return Value: $rowobject
2354 $resultset->update_or_create({ col => $val, ... });
2356 First, searches for an existing row matching one of the unique constraints
2357 (including the primary key) on the source of this resultset. If a row is
2358 found, updates it with the other given column values. Otherwise, creates a new
2361 Takes an optional C<key> attribute to search on a specific unique constraint.
2364 # In your application
2365 my $cd = $schema->resultset('CD')->update_or_create(
2367 artist => 'Massive Attack',
2368 title => 'Mezzanine',
2371 { key => 'cd_artist_title' }
2374 $cd->cd_to_producer->update_or_create({
2375 producer => $producer,
2382 If no C<key> is specified, it searches on all unique constraints defined on the
2383 source, including the primary key.
2385 If the C<key> is specified as C<primary>, it searches only on the primary key.
2387 See also L</find> and L</find_or_create>. For information on how to declare
2388 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2390 B<Note>: C<update_or_create> is probably not what you want when
2391 looking for a row in a table that uses primary keys supplied by the
2392 database, unless you actually have a key value. Passing in a primary
2393 key column with a value of I<undef> will cause L</find> to attempt to
2394 search for a row with a value of I<NULL>.
2398 sub update_or_create {
2400 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2401 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2403 my $row = $self->find($cond, $attrs);
2405 $row->update($cond);
2409 return $self->create($cond);
2412 =head2 update_or_new
2416 =item Arguments: \%col_values, { key => $unique_constraint }?
2418 =item Return Value: $rowobject
2422 $resultset->update_or_new({ col => $val, ... });
2424 First, searches for an existing row matching one of the unique constraints
2425 (including the primary key) on the source of this resultset. If a row is
2426 found, updates it with the other given column values. Otherwise, instantiate
2427 a new result object and return it. The object will not be saved into your storage
2428 until you call L<DBIx::Class::Row/insert> on it.
2430 Takes an optional C<key> attribute to search on a specific unique constraint.
2433 # In your application
2434 my $cd = $schema->resultset('CD')->update_or_new(
2436 artist => 'Massive Attack',
2437 title => 'Mezzanine',
2440 { key => 'cd_artist_title' }
2443 if ($cd->in_storage) {
2444 # the cd was updated
2447 # the cd is not yet in the database, let's insert it
2451 See also L</find>, L</find_or_create> and L<find_or_new>.
2457 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2458 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2460 my $row = $self->find( $cond, $attrs );
2461 if ( defined $row ) {
2462 $row->update($cond);
2466 return $self->new_result($cond);
2473 =item Arguments: none
2475 =item Return Value: \@cache_objects?
2479 Gets the contents of the cache for the resultset, if the cache is set.
2481 The cache is populated either by using the L</prefetch> attribute to
2482 L</search> or by calling L</set_cache>.
2494 =item Arguments: \@cache_objects
2496 =item Return Value: \@cache_objects
2500 Sets the contents of the cache for the resultset. Expects an arrayref
2501 of objects of the same class as those produced by the resultset. Note that
2502 if the cache is set the resultset will return the cached objects rather
2503 than re-querying the database even if the cache attr is not set.
2505 The contents of the cache can also be populated by using the
2506 L</prefetch> attribute to L</search>.
2511 my ( $self, $data ) = @_;
2512 $self->throw_exception("set_cache requires an arrayref")
2513 if defined($data) && (ref $data ne 'ARRAY');
2514 $self->{all_cache} = $data;
2521 =item Arguments: none
2523 =item Return Value: []
2527 Clears the cache for the resultset.
2532 shift->set_cache(undef);
2535 =head2 related_resultset
2539 =item Arguments: $relationship_name
2541 =item Return Value: $resultset
2545 Returns a related resultset for the supplied relationship name.
2547 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2551 sub related_resultset {
2552 my ($self, $rel) = @_;
2554 $self->{related_resultsets} ||= {};
2555 return $self->{related_resultsets}{$rel} ||= do {
2556 my $rel_info = $self->result_source->relationship_info($rel);
2558 $self->throw_exception(
2559 "search_related: result source '" . $self->result_source->source_name .
2560 "' has no such relationship $rel")
2563 my ($from,$seen) = $self->_chain_relationship($rel);
2565 my $join_count = $seen->{$rel};
2566 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2568 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2569 my %attrs = %{$self->{attrs}||{}};
2570 delete @attrs{qw(result_class alias)};
2574 if (my $cache = $self->get_cache) {
2575 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2576 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2581 my $rel_source = $self->result_source->related_source($rel);
2585 # The reason we do this now instead of passing the alias to the
2586 # search_rs below is that if you wrap/overload resultset on the
2587 # source you need to know what alias it's -going- to have for things
2588 # to work sanely (e.g. RestrictWithObject wants to be able to add
2589 # extra query restrictions, and these may need to be $alias.)
2591 my $attrs = $rel_source->resultset_attributes;
2592 local $attrs->{alias} = $alias;
2594 $rel_source->resultset
2602 where => $self->{cond},
2607 $new->set_cache($new_cache) if $new_cache;
2612 =head2 current_source_alias
2616 =item Arguments: none
2618 =item Return Value: $source_alias
2622 Returns the current table alias for the result source this resultset is built
2623 on, that will be used in the SQL query. Usually it is C<me>.
2625 Currently the source alias that refers to the result set returned by a
2626 L</search>/L</find> family method depends on how you got to the resultset: it's
2627 C<me> by default, but eg. L</search_related> aliases it to the related result
2628 source name (and keeps C<me> referring to the original result set). The long
2629 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2630 (and make this method unnecessary).
2632 Thus it's currently necessary to use this method in predefined queries (see
2633 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2634 source alias of the current result set:
2636 # in a result set class
2638 my ($self, $user) = @_;
2640 my $me = $self->current_source_alias;
2642 return $self->search(
2643 "$me.modified" => $user->id,
2649 sub current_source_alias {
2652 return ($self->{attrs} || {})->{alias} || 'me';
2655 # This code is called by search_related, and makes sure there
2656 # is clear separation between the joins before, during, and
2657 # after the relationship. This information is needed later
2658 # in order to properly resolve prefetch aliases (any alias
2659 # with a relation_chain_depth less than the depth of the
2660 # current prefetch is not considered)
2662 # The increments happen in 1/2s to make it easier to correlate the
2663 # join depth with the join path. An integer means a relationship
2664 # specified via a search_related, whereas a fraction means an added
2665 # join/prefetch via attributes
2666 sub _chain_relationship {
2667 my ($self, $rel) = @_;
2668 my $source = $self->result_source;
2669 my $attrs = $self->{attrs};
2675 -source_handle => $source->handle,
2676 -alias => $attrs->{alias},
2677 $attrs->{alias} => $source->from,
2681 my $seen = { %{$attrs->{seen_join} || {} } };
2682 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2683 ? $from->[-1][0]{-join_path}
2687 # we need to take the prefetch the attrs into account before we
2688 # ->_resolve_join as otherwise they get lost - captainL
2689 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2691 my @requested_joins = $source->_resolve_join(
2698 push @$from, @requested_joins;
2700 $seen->{-relation_chain_depth} += 0.5;
2702 # if $self already had a join/prefetch specified on it, the requested
2703 # $rel might very well be already included. What we do in this case
2704 # is effectively a no-op (except that we bump up the chain_depth on
2705 # the join in question so we could tell it *is* the search_related)
2709 # we consider the last one thus reverse
2710 for my $j (reverse @requested_joins) {
2711 if ($rel eq $j->[0]{-join_path}[-1]) {
2712 $j->[0]{-relation_chain_depth} += 0.5;
2718 # alternative way to scan the entire chain - not backwards compatible
2719 # for my $j (reverse @$from) {
2720 # next unless ref $j eq 'ARRAY';
2721 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2722 # $j->[0]{-relation_chain_depth} += 0.5;
2723 # $already_joined++;
2728 unless ($already_joined) {
2729 push @$from, $source->_resolve_join(
2737 $seen->{-relation_chain_depth} += 0.5;
2739 return ($from,$seen);
2742 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2743 sub _resolved_attrs_copy {
2745 return { %{$self->_resolved_attrs (@_)} };
2748 sub _resolved_attrs {
2750 return $self->{_attrs} if $self->{_attrs};
2752 my $attrs = { %{ $self->{attrs} || {} } };
2753 my $source = $self->result_source;
2754 my $alias = $attrs->{alias};
2756 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2759 # build columns (as long as select isn't set) into a set of as/select hashes
2760 unless ( $attrs->{select} ) {
2762 ( ref($_) eq 'HASH' )
2766 /^\Q${alias}.\E(.+)$/
2777 } ( ref($attrs->{columns}) eq 'ARRAY' ) ? @{ delete $attrs->{columns}} : (delete $attrs->{columns} || $source->columns );
2779 # add the additional columns on
2780 foreach ( 'include_columns', '+columns' ) {
2781 push @colbits, map {
2782 ( ref($_) eq 'HASH' )
2784 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2785 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2788 # start with initial select items
2789 if ( $attrs->{select} ) {
2791 ( ref $attrs->{select} eq 'ARRAY' )
2792 ? [ @{ $attrs->{select} } ]
2793 : [ $attrs->{select} ];
2797 ref $attrs->{as} eq 'ARRAY'
2798 ? [ @{ $attrs->{as} } ]
2801 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2806 # otherwise we intialise select & as to empty
2807 $attrs->{select} = [];
2811 # now add colbits to select/as
2812 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2813 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2816 if ( $adds = delete $attrs->{'+select'} ) {
2817 $adds = [$adds] unless ref $adds eq 'ARRAY';
2819 @{ $attrs->{select} },
2820 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2823 if ( $adds = delete $attrs->{'+as'} ) {
2824 $adds = [$adds] unless ref $adds eq 'ARRAY';
2825 push( @{ $attrs->{as} }, @$adds );
2828 $attrs->{from} ||= [ {
2829 -source_handle => $source->handle,
2830 -alias => $self->{attrs}{alias},
2831 $self->{attrs}{alias} => $source->from,
2834 if ( $attrs->{join} || $attrs->{prefetch} ) {
2836 $self->throw_exception ('join/prefetch can not be used with a literal scalarref {from}')
2837 if ref $attrs->{from} ne 'ARRAY';
2839 my $join = delete $attrs->{join} || {};
2841 if ( defined $attrs->{prefetch} ) {
2842 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2845 $attrs->{from} = # have to copy here to avoid corrupting the original
2847 @{ $attrs->{from} },
2848 $source->_resolve_join(
2851 { %{ $attrs->{seen_join} || {} } },
2852 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2853 ? $attrs->{from}[-1][0]{-join_path}
2860 if ( $attrs->{order_by} ) {
2861 $attrs->{order_by} = (
2862 ref( $attrs->{order_by} ) eq 'ARRAY'
2863 ? [ @{ $attrs->{order_by} } ]
2864 : [ $attrs->{order_by} ]
2868 if ($attrs->{group_by} and ! ref $attrs->{group_by}) {
2869 $attrs->{group_by} = [ $attrs->{group_by} ];
2872 # If the order_by is otherwise empty - we will use this for TOP limit
2873 # emulation and the like.
2874 # Although this is needed only if the order_by is not defined, it is
2875 # actually cheaper to just populate this rather than properly examining
2876 # order_by (stuf like [ {} ] and the like)
2877 $attrs->{_virtual_order_by} = [ $self->result_source->primary_columns ];
2880 $attrs->{collapse} ||= {};
2881 if ( my $prefetch = delete $attrs->{prefetch} ) {
2882 $prefetch = $self->_merge_attr( {}, $prefetch );
2884 my $prefetch_ordering = [];
2886 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2889 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2891 $attrs->{prefetch_select} = [ map { $_->[0] } @prefetch ];
2892 push @{ $attrs->{select} }, @{$attrs->{prefetch_select}};
2893 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2895 push( @{ $attrs->{order_by} }, @$prefetch_ordering );
2896 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2900 if (delete $attrs->{distinct}) {
2901 $attrs->{group_by} ||= [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2904 # if both page and offset are specified, produce a combined offset
2905 # even though it doesn't make much sense, this is what pre 081xx has
2907 if (my $page = delete $attrs->{page}) {
2909 ($attrs->{rows} * ($page - 1))
2911 ($attrs->{offset} || 0)
2915 return $self->{_attrs} = $attrs;
2918 sub _joinpath_aliases {
2919 my ($self, $fromspec, $seen) = @_;
2922 return $paths unless ref $fromspec eq 'ARRAY';
2924 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2926 if (int ($cur_depth) != $cur_depth) {
2927 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2930 for my $j (@$fromspec) {
2932 next if ref $j ne 'ARRAY';
2933 next if $j->[0]{-relation_chain_depth} < $cur_depth;
2935 my $jpath = $j->[0]{-join_path};
2938 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2939 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2946 my ($self, $attr) = @_;
2948 if (ref $attr eq 'HASH') {
2949 return $self->_rollout_hash($attr);
2950 } elsif (ref $attr eq 'ARRAY') {
2951 return $self->_rollout_array($attr);
2957 sub _rollout_array {
2958 my ($self, $attr) = @_;
2961 foreach my $element (@{$attr}) {
2962 if (ref $element eq 'HASH') {
2963 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2964 } elsif (ref $element eq 'ARRAY') {
2965 # XXX - should probably recurse here
2966 push( @rolled_array, @{$self->_rollout_array($element)} );
2968 push( @rolled_array, $element );
2971 return \@rolled_array;
2975 my ($self, $attr) = @_;
2978 foreach my $key (keys %{$attr}) {
2979 push( @rolled_array, { $key => $attr->{$key} } );
2981 return \@rolled_array;
2984 sub _calculate_score {
2985 my ($self, $a, $b) = @_;
2987 if (ref $b eq 'HASH') {
2988 my ($b_key) = keys %{$b};
2989 if (ref $a eq 'HASH') {
2990 my ($a_key) = keys %{$a};
2991 if ($a_key eq $b_key) {
2992 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2997 return ($a eq $b_key) ? 1 : 0;
3000 if (ref $a eq 'HASH') {
3001 my ($a_key) = keys %{$a};
3002 return ($b eq $a_key) ? 1 : 0;
3004 return ($b eq $a) ? 1 : 0;
3010 my ($self, $orig, $import) = @_;
3012 return $import unless defined($orig);
3013 return $orig unless defined($import);
3015 $orig = $self->_rollout_attr($orig);
3016 $import = $self->_rollout_attr($import);
3019 foreach my $import_element ( @{$import} ) {
3020 # find best candidate from $orig to merge $b_element into
3021 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3022 foreach my $orig_element ( @{$orig} ) {
3023 my $score = $self->_calculate_score( $orig_element, $import_element );
3024 if ($score > $best_candidate->{score}) {
3025 $best_candidate->{position} = $position;
3026 $best_candidate->{score} = $score;
3030 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3032 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3033 push( @{$orig}, $import_element );
3035 my $orig_best = $orig->[$best_candidate->{position}];
3036 # merge orig_best and b_element together and replace original with merged
3037 if (ref $orig_best ne 'HASH') {
3038 $orig->[$best_candidate->{position}] = $import_element;
3039 } elsif (ref $import_element eq 'HASH') {
3040 my ($key) = keys %{$orig_best};
3041 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3044 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3054 $self->_source_handle($_[0]->handle);
3056 $self->_source_handle->resolve;
3060 =head2 throw_exception
3062 See L<DBIx::Class::Schema/throw_exception> for details.
3066 sub throw_exception {
3068 if (ref $self && $self->_source_handle->schema) {
3069 $self->_source_handle->schema->throw_exception(@_)
3076 # XXX: FIXME: Attributes docs need clearing up
3080 Attributes are used to refine a ResultSet in various ways when
3081 searching for data. They can be passed to any method which takes an
3082 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3085 These are in no particular order:
3091 =item Value: ( $order_by | \@order_by | \%order_by )
3095 Which column(s) to order the results by. If a single column name, or
3096 an arrayref of names is supplied, the argument is passed through
3097 directly to SQL. The hashref syntax allows for connection-agnostic
3098 specification of ordering direction:
3100 For descending order:
3102 order_by => { -desc => [qw/col1 col2 col3/] }
3104 For explicit ascending order:
3106 order_by => { -asc => 'col' }
3108 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3109 supported, although you are strongly encouraged to use the hashref
3110 syntax as outlined above.
3116 =item Value: \@columns
3120 Shortcut to request a particular set of columns to be retrieved. Each
3121 column spec may be a string (a table column name), or a hash (in which
3122 case the key is the C<as> value, and the value is used as the C<select>
3123 expression). Adds C<me.> onto the start of any column without a C<.> in
3124 it and sets C<select> from that, then auto-populates C<as> from
3125 C<select> as normal. (You may also use the C<cols> attribute, as in
3126 earlier versions of DBIC.)
3132 =item Value: \@columns
3136 Indicates additional columns to be selected from storage. Works the same
3137 as L</columns> but adds columns to the selection. (You may also use the
3138 C<include_columns> attribute, as in earlier versions of DBIC). For
3141 $schema->resultset('CD')->search(undef, {
3142 '+columns' => ['artist.name'],
3146 would return all CDs and include a 'name' column to the information
3147 passed to object inflation. Note that the 'artist' is the name of the
3148 column (or relationship) accessor, and 'name' is the name of the column
3149 accessor in the related table.
3151 =head2 include_columns
3155 =item Value: \@columns
3159 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3165 =item Value: \@select_columns
3169 Indicates which columns should be selected from the storage. You can use
3170 column names, or in the case of RDBMS back ends, function or stored procedure
3173 $rs = $schema->resultset('Employee')->search(undef, {
3176 { count => 'employeeid' },
3181 When you use function/stored procedure names and do not supply an C<as>
3182 attribute, the column names returned are storage-dependent. E.g. MySQL would
3183 return a column named C<count(employeeid)> in the above example.
3189 Indicates additional columns to be selected from storage. Works the same as
3190 L</select> but adds columns to the selection.
3198 Indicates additional column names for those added via L</+select>. See L</as>.
3206 =item Value: \@inflation_names
3210 Indicates column names for object inflation. That is, C<as>
3211 indicates the name that the column can be accessed as via the
3212 C<get_column> method (or via the object accessor, B<if one already
3213 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3215 The C<as> attribute is used in conjunction with C<select>,
3216 usually when C<select> contains one or more function or stored
3219 $rs = $schema->resultset('Employee')->search(undef, {
3222 { count => 'employeeid' }
3224 as => ['name', 'employee_count'],
3227 my $employee = $rs->first(); # get the first Employee
3229 If the object against which the search is performed already has an accessor
3230 matching a column name specified in C<as>, the value can be retrieved using
3231 the accessor as normal:
3233 my $name = $employee->name();
3235 If on the other hand an accessor does not exist in the object, you need to
3236 use C<get_column> instead:
3238 my $employee_count = $employee->get_column('employee_count');
3240 You can create your own accessors if required - see
3241 L<DBIx::Class::Manual::Cookbook> for details.
3243 Please note: This will NOT insert an C<AS employee_count> into the SQL
3244 statement produced, it is used for internal access only. Thus
3245 attempting to use the accessor in an C<order_by> clause or similar
3246 will fail miserably.
3248 To get around this limitation, you can supply literal SQL to your
3249 C<select> attibute that contains the C<AS alias> text, eg:
3251 select => [\'myfield AS alias']
3257 =item Value: ($rel_name | \@rel_names | \%rel_names)
3261 Contains a list of relationships that should be joined for this query. For
3264 # Get CDs by Nine Inch Nails
3265 my $rs = $schema->resultset('CD')->search(
3266 { 'artist.name' => 'Nine Inch Nails' },
3267 { join => 'artist' }
3270 Can also contain a hash reference to refer to the other relation's relations.
3273 package MyApp::Schema::Track;
3274 use base qw/DBIx::Class/;
3275 __PACKAGE__->table('track');
3276 __PACKAGE__->add_columns(qw/trackid cd position title/);
3277 __PACKAGE__->set_primary_key('trackid');
3278 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3281 # In your application
3282 my $rs = $schema->resultset('Artist')->search(
3283 { 'track.title' => 'Teardrop' },
3285 join => { cd => 'track' },
3286 order_by => 'artist.name',
3290 You need to use the relationship (not the table) name in conditions,
3291 because they are aliased as such. The current table is aliased as "me", so
3292 you need to use me.column_name in order to avoid ambiguity. For example:
3294 # Get CDs from 1984 with a 'Foo' track
3295 my $rs = $schema->resultset('CD')->search(
3298 'tracks.name' => 'Foo'
3300 { join => 'tracks' }
3303 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3304 similarly for a third time). For e.g.
3306 my $rs = $schema->resultset('Artist')->search({
3307 'cds.title' => 'Down to Earth',
3308 'cds_2.title' => 'Popular',
3310 join => [ qw/cds cds/ ],
3313 will return a set of all artists that have both a cd with title 'Down
3314 to Earth' and a cd with title 'Popular'.
3316 If you want to fetch related objects from other tables as well, see C<prefetch>
3319 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3325 =item Value: ($rel_name | \@rel_names | \%rel_names)
3329 Contains one or more relationships that should be fetched along with
3330 the main query (when they are accessed afterwards the data will
3331 already be available, without extra queries to the database). This is
3332 useful for when you know you will need the related objects, because it
3333 saves at least one query:
3335 my $rs = $schema->resultset('Tag')->search(
3344 The initial search results in SQL like the following:
3346 SELECT tag.*, cd.*, artist.* FROM tag
3347 JOIN cd ON tag.cd = cd.cdid
3348 JOIN artist ON cd.artist = artist.artistid
3350 L<DBIx::Class> has no need to go back to the database when we access the
3351 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3354 Simple prefetches will be joined automatically, so there is no need
3355 for a C<join> attribute in the above search.
3357 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3358 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3359 with an accessor type of 'single' or 'filter'). A more complex example that
3360 prefetches an artists cds, the tracks on those cds, and the tags associted
3361 with that artist is given below (assuming many-to-many from artists to tags):
3363 my $rs = $schema->resultset('Artist')->search(
3367 { cds => 'tracks' },
3368 { artist_tags => 'tags' }
3374 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3375 attributes will be ignored.
3385 Makes the resultset paged and specifies the page to retrieve. Effectively
3386 identical to creating a non-pages resultset and then calling ->page($page)
3389 If L<rows> attribute is not specified it defaults to 10 rows per page.
3391 When you have a paged resultset, L</count> will only return the number
3392 of rows in the page. To get the total, use the L</pager> and call
3393 C<total_entries> on it.
3403 Specifes the maximum number of rows for direct retrieval or the number of
3404 rows per page if the page attribute or method is used.
3410 =item Value: $offset
3414 Specifies the (zero-based) row number for the first row to be returned, or the
3415 of the first row of the first page if paging is used.
3421 =item Value: \@columns
3425 A arrayref of columns to group by. Can include columns of joined tables.
3427 group_by => [qw/ column1 column2 ... /]
3433 =item Value: $condition
3437 HAVING is a select statement attribute that is applied between GROUP BY and
3438 ORDER BY. It is applied to the after the grouping calculations have been
3441 having => { 'count(employee)' => { '>=', 100 } }
3447 =item Value: (0 | 1)
3451 Set to 1 to group by all columns.
3457 Adds to the WHERE clause.
3459 # only return rows WHERE deleted IS NULL for all searches
3460 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3462 Can be overridden by passing C<{ where => undef }> as an attribute
3469 Set to 1 to cache search results. This prevents extra SQL queries if you
3470 revisit rows in your ResultSet:
3472 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3474 while( my $artist = $resultset->next ) {
3478 $rs->first; # without cache, this would issue a query
3480 By default, searches are not cached.
3482 For more examples of using these attributes, see
3483 L<DBIx::Class::Manual::Cookbook>.
3489 =item Value: \@from_clause
3493 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
3494 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
3497 NOTE: Use this on your own risk. This allows you to shoot off your foot!
3499 C<join> will usually do what you need and it is strongly recommended that you
3500 avoid using C<from> unless you cannot achieve the desired result using C<join>.
3501 And we really do mean "cannot", not just tried and failed. Attempting to use
3502 this because you're having problems with C<join> is like trying to use x86
3503 ASM because you've got a syntax error in your C. Trust us on this.
3505 Now, if you're still really, really sure you need to use this (and if you're
3506 not 100% sure, ask the mailing list first), here's an explanation of how this
3509 The syntax is as follows -
3512 { <alias1> => <table1> },
3514 { <alias2> => <table2>, -join_type => 'inner|left|right' },
3515 [], # nested JOIN (optional)
3516 { <table1.column1> => <table2.column2>, ... (more conditions) },
3518 # More of the above [ ] may follow for additional joins
3525 ON <table1.column1> = <table2.column2>
3526 <more joins may follow>
3528 An easy way to follow the examples below is to remember the following:
3530 Anything inside "[]" is a JOIN
3531 Anything inside "{}" is a condition for the enclosing JOIN
3533 The following examples utilize a "person" table in a family tree application.
3534 In order to express parent->child relationships, this table is self-joined:
3536 # Person->belongs_to('father' => 'Person');
3537 # Person->belongs_to('mother' => 'Person');
3539 C<from> can be used to nest joins. Here we return all children with a father,
3540 then search against all mothers of those children:
3542 $rs = $schema->resultset('Person')->search(
3545 alias => 'mother', # alias columns in accordance with "from"
3547 { mother => 'person' },
3550 { child => 'person' },
3552 { father => 'person' },
3553 { 'father.person_id' => 'child.father_id' }
3556 { 'mother.person_id' => 'child.mother_id' }
3563 # SELECT mother.* FROM person mother
3566 # JOIN person father
3567 # ON ( father.person_id = child.father_id )
3569 # ON ( mother.person_id = child.mother_id )
3571 The type of any join can be controlled manually. To search against only people
3572 with a father in the person table, we could explicitly use C<INNER JOIN>:
3574 $rs = $schema->resultset('Person')->search(
3577 alias => 'child', # alias columns in accordance with "from"
3579 { child => 'person' },
3581 { father => 'person', -join_type => 'inner' },
3582 { 'father.id' => 'child.father_id' }
3589 # SELECT child.* FROM person child
3590 # INNER JOIN person father ON child.father_id = father.id
3592 You can select from a subquery by passing a resultset to from as follows.
3594 $schema->resultset('Artist')->search(
3596 { alias => 'artist2',
3597 from => [ { artist2 => $artist_rs->as_query } ],
3600 # and you'll get sql like this..
3601 # SELECT artist2.artistid, artist2.name, artist2.rank, artist2.charfield FROM
3602 # ( SELECT me.artistid, me.name, me.rank, me.charfield FROM artists me ) artist2
3604 If you need to express really complex joins, you
3605 can supply literal SQL to C<from> via a scalar reference. In this case
3606 the contents of the scalar will replace the table name associated with the
3609 WARNING: This technique might very well not work as expected on chained
3610 searches - you have been warned.
3612 # Assuming the Event resultsource is defined as:
3614 MySchema::Event->add_columns (
3617 is_auto_increment => 1,
3626 MySchema::Event->set_primary_key ('sequence');
3628 # This will get back the latest event for every location. The column
3629 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3630 # combo to limit the resultset
3632 $rs = $schema->resultset('Event');
3633 $table = $rs->result_source->name;
3634 $latest = $rs->search (
3637 (SELECT e1.* FROM $table e1
3639 ON e1.location = e2.location
3640 AND e1.sequence < e2.sequence
3641 WHERE e2.sequence is NULL
3646 # Equivalent SQL (with the DBIC chunks added):
3648 SELECT me.sequence, me.location, me.type FROM
3649 (SELECT e1.* FROM events e1
3651 ON e1.location = e2.location
3652 AND e1.sequence < e2.sequence
3653 WHERE e2.sequence is NULL
3660 =item Value: ( 'update' | 'shared' )
3664 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT