1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
10 use DBIx::Class::Exception;
13 use DBIx::Class::ResultSetColumn;
14 use DBIx::Class::ResultSourceHandle;
17 use base qw/DBIx::Class/;
19 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
23 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
27 my $users_rs = $schema->resultset('User');
28 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
29 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
33 A ResultSet is an object which stores a set of conditions representing
34 a query. It is the backbone of DBIx::Class (i.e. the really
35 important/useful bit).
37 No SQL is executed on the database when a ResultSet is created, it
38 just stores all the conditions needed to create the query.
40 A basic ResultSet representing the data of an entire table is returned
41 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
42 L<Source|DBIx::Class::Manual::Glossary/Source> name.
44 my $users_rs = $schema->resultset('User');
46 A new ResultSet is returned from calling L</search> on an existing
47 ResultSet. The new one will contain all the conditions of the
48 original, plus any new conditions added in the C<search> call.
50 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
51 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
54 The query that the ResultSet represents is B<only> executed against
55 the database when these methods are called:
56 L</find> L</next> L</all> L</first> L</single> L</count>
60 =head2 Chaining resultsets
62 Let's say you've got a query that needs to be run to return some data
63 to the user. But, you have an authorization system in place that
64 prevents certain users from seeing certain information. So, you want
65 to construct the basic query in one method, but add constraints to it in
70 my $request = $self->get_request; # Get a request object somehow.
71 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
73 my $cd_rs = $schema->resultset('CD')->search({
74 title => $request->param('title'),
75 year => $request->param('year'),
78 $self->apply_security_policy( $cd_rs );
83 sub apply_security_policy {
92 =head3 Resolving conditions and attributes
94 When a resultset is chained from another resultset, conditions and
95 attributes with the same keys need resolving.
97 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
98 into the existing ones from the original resultset.
100 The L</where>, L</having> attribute, and any search conditions are
101 merged with an SQL C<AND> to the existing condition from the original
104 All other attributes are overridden by any new ones supplied in the
107 =head2 Multiple queries
109 Since a resultset just defines a query, you can do all sorts of
110 things with it with the same object.
112 # Don't hit the DB yet.
113 my $cd_rs = $schema->resultset('CD')->search({
114 title => 'something',
118 # Each of these hits the DB individually.
119 my $count = $cd_rs->count;
120 my $most_recent = $cd_rs->get_column('date_released')->max();
121 my @records = $cd_rs->all;
123 And it's not just limited to SELECT statements.
129 $cd_rs->create({ artist => 'Fred' });
131 Which is the same as:
133 $schema->resultset('CD')->create({
134 title => 'something',
139 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
143 If a resultset is used in a numeric context it returns the L</count>.
144 However, if it is used in a booleand context it is always true. So if
145 you want to check if a resultset has any results use C<if $rs != 0>.
146 C<if $rs> will always be true.
154 =item Arguments: $source, \%$attrs
156 =item Return Value: $rs
160 The resultset constructor. Takes a source object (usually a
161 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
162 L</ATTRIBUTES> below). Does not perform any queries -- these are
163 executed as needed by the other methods.
165 Generally you won't need to construct a resultset manually. You'll
166 automatically get one from e.g. a L</search> called in scalar context:
168 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
170 IMPORTANT: If called on an object, proxies to new_result instead so
172 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
174 will return a CD object, not a ResultSet.
180 return $class->new_result(@_) if ref $class;
182 my ($source, $attrs) = @_;
183 $source = $source->handle
184 unless $source->isa('DBIx::Class::ResultSourceHandle');
185 $attrs = { %{$attrs||{}} };
187 if ($attrs->{page}) {
188 $attrs->{rows} ||= 10;
191 $attrs->{alias} ||= 'me';
193 # Creation of {} and bless separated to mitigate RH perl bug
194 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
196 _source_handle => $source,
197 cond => $attrs->{where},
206 $attrs->{result_class} || $source->resolve->result_class
216 =item Arguments: $cond, \%attrs?
218 =item Return Value: $resultset (scalar context), @row_objs (list context)
222 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
223 my $new_rs = $cd_rs->search({ year => 2005 });
225 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
226 # year = 2005 OR year = 2004
228 If you need to pass in additional attributes but no additional condition,
229 call it as C<search(undef, \%attrs)>.
231 # "SELECT name, artistid FROM $artist_table"
232 my @all_artists = $schema->resultset('Artist')->search(undef, {
233 columns => [qw/name artistid/],
236 For a list of attributes that can be passed to C<search>, see
237 L</ATTRIBUTES>. For more examples of using this function, see
238 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
239 documentation for the first argument, see L<SQL::Abstract>.
241 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
247 my $rs = $self->search_rs( @_ );
248 return (wantarray ? $rs->all : $rs);
255 =item Arguments: $cond, \%attrs?
257 =item Return Value: $resultset
261 This method does the same exact thing as search() except it will
262 always return a resultset, even in list context.
269 # Special-case handling for (undef, undef).
270 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
275 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
276 my $our_attrs = { %{$self->{attrs}} };
277 my $having = delete $our_attrs->{having};
278 my $where = delete $our_attrs->{where};
282 my %safe = (alias => 1, cache => 1);
285 (@_ && defined($_[0])) # @_ == () or (undef)
287 (keys %$attrs # empty attrs or only 'safe' attrs
288 && List::Util::first { !$safe{$_} } keys %$attrs)
290 # no search, effectively just a clone
291 $rows = $self->get_cache;
294 my $new_attrs = { %{$our_attrs}, %{$attrs} };
296 # merge new attrs into inherited
297 foreach my $key (qw/join prefetch +select +as bind/) {
298 next unless exists $attrs->{$key};
299 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
302 if (List::Util::first { exists $new_attrs->{$_} } qw{select as}) {
303 delete $new_attrs->{$_} for (qw{+select +as});
306 if (exists $new_attrs->{columns}) {
307 delete $new_attrs->{'+columns'};
312 (@_ == 1 || ref $_[0] eq "HASH")
314 (ref $_[0] eq 'HASH')
316 (keys %{ $_[0] } > 0)
324 ? $self->throw_exception("Odd number of arguments to search")
331 if (defined $where) {
332 $new_attrs->{where} = (
333 defined $new_attrs->{where}
336 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
337 } $where, $new_attrs->{where}
344 $new_attrs->{where} = (
345 defined $new_attrs->{where}
348 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
349 } $cond, $new_attrs->{where}
355 if (defined $having) {
356 $new_attrs->{having} = (
357 defined $new_attrs->{having}
360 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
361 } $having, $new_attrs->{having}
367 my $rs = (ref $self)->new($self->result_source, $new_attrs);
369 $rs->set_cache($rows) if ($rows);
374 =head2 search_literal
378 =item Arguments: $sql_fragment, @bind_values
380 =item Return Value: $resultset (scalar context), @row_objs (list context)
384 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
385 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
387 Pass a literal chunk of SQL to be added to the conditional part of the
390 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
391 only be used in that context. C<search_literal> is a convenience method.
392 It is equivalent to calling $schema->search(\[]), but if you want to ensure
393 columns are bound correctly, use C<search>.
395 Example of how to use C<search> instead of C<search_literal>
397 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
398 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
401 See L<DBIx::Class::Manual::Cookbook/Searching> and
402 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
403 require C<search_literal>.
408 my ($self, $sql, @bind) = @_;
410 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
413 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
420 =item Arguments: @values | \%cols, \%attrs?
422 =item Return Value: $row_object | undef
426 Finds a row based on its primary key or unique constraint. For example, to find
427 a row by its primary key:
429 my $cd = $schema->resultset('CD')->find(5);
431 You can also find a row by a specific unique constraint using the C<key>
432 attribute. For example:
434 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
435 key => 'cd_artist_title'
438 Additionally, you can specify the columns explicitly by name:
440 my $cd = $schema->resultset('CD')->find(
442 artist => 'Massive Attack',
443 title => 'Mezzanine',
445 { key => 'cd_artist_title' }
448 If the C<key> is specified as C<primary>, it searches only on the primary key.
450 If no C<key> is specified, it searches on all unique constraints defined on the
451 source for which column data is provided, including the primary key.
453 If your table does not have a primary key, you B<must> provide a value for the
454 C<key> attribute matching one of the unique constraints on the source.
456 In addition to C<key>, L</find> recognizes and applies standard
457 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
459 Note: If your query does not return only one row, a warning is generated:
461 Query returned more than one row
463 See also L</find_or_create> and L</update_or_create>. For information on how to
464 declare unique constraints, see
465 L<DBIx::Class::ResultSource/add_unique_constraint>.
471 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
473 # Default to the primary key, but allow a specific key
474 my @cols = exists $attrs->{key}
475 ? $self->result_source->unique_constraint_columns($attrs->{key})
476 : $self->result_source->primary_columns;
477 $self->throw_exception(
478 "Can't find unless a primary key is defined or unique constraint is specified"
481 # Parse out a hashref from input
483 if (ref $_[0] eq 'HASH') {
484 $input_query = { %{$_[0]} };
486 elsif (@_ == @cols) {
488 @{$input_query}{@cols} = @_;
491 # Compatibility: Allow e.g. find(id => $value)
492 carp "Find by key => value deprecated; please use a hashref instead";
496 my (%related, $info);
498 KEY: foreach my $key (keys %$input_query) {
499 if (ref($input_query->{$key})
500 && ($info = $self->result_source->relationship_info($key))) {
501 my $val = delete $input_query->{$key};
502 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
503 my $rel_q = $self->result_source->_resolve_condition(
504 $info->{cond}, $val, $key
506 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
507 @related{keys %$rel_q} = values %$rel_q;
510 if (my @keys = keys %related) {
511 @{$input_query}{@keys} = values %related;
515 # Build the final query: Default to the disjunction of the unique queries,
516 # but allow the input query in case the ResultSet defines the query or the
517 # user is abusing find
518 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
520 if (exists $attrs->{key}) {
521 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
522 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
523 $query = $self->_add_alias($unique_query, $alias);
525 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
526 # This means that we got here after a merger of relationship conditions
527 # in ::Relationship::Base::search_related (the row method), and furthermore
528 # the relationship is of the 'single' type. This means that the condition
529 # provided by the relationship (already attached to $self) is sufficient,
530 # as there can be only one row in the databse that would satisfy the
534 my @unique_queries = $self->_unique_queries($input_query, $attrs);
535 $query = @unique_queries
536 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
537 : $self->_add_alias($input_query, $alias);
541 my $rs = $self->search ($query, {result_class => $self->result_class, %$attrs});
542 if (keys %{$rs->_resolved_attrs->{collapse}}) {
544 carp "Query returned more than one row" if $rs->next;
554 # Add the specified alias to the specified query hash. A copy is made so the
555 # original query is not modified.
558 my ($self, $query, $alias) = @_;
560 my %aliased = %$query;
561 foreach my $col (grep { ! m/\./ } keys %aliased) {
562 $aliased{"$alias.$col"} = delete $aliased{$col};
570 # Build a list of queries which satisfy unique constraints.
572 sub _unique_queries {
573 my ($self, $query, $attrs) = @_;
575 my @constraint_names = exists $attrs->{key}
577 : $self->result_source->unique_constraint_names;
579 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
580 my $num_where = scalar keys %$where;
582 my (@unique_queries, %seen_column_combinations);
583 foreach my $name (@constraint_names) {
584 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
586 my $constraint_sig = join "\x00", sort @constraint_cols;
587 next if $seen_column_combinations{$constraint_sig}++;
589 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
591 my $num_cols = scalar @constraint_cols;
592 my $num_query = scalar keys %$unique_query;
594 my $total = $num_query + $num_where;
595 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
596 # The query is either unique on its own or is unique in combination with
597 # the existing where clause
598 push @unique_queries, $unique_query;
602 return @unique_queries;
605 # _build_unique_query
607 # Constrain the specified query hash based on the specified column names.
609 sub _build_unique_query {
610 my ($self, $query, $unique_cols) = @_;
613 map { $_ => $query->{$_} }
614 grep { exists $query->{$_} }
619 =head2 search_related
623 =item Arguments: $rel, $cond, \%attrs?
625 =item Return Value: $new_resultset
629 $new_rs = $cd_rs->search_related('artist', {
633 Searches the specified relationship, optionally specifying a condition and
634 attributes for matching records. See L</ATTRIBUTES> for more information.
639 return shift->related_resultset(shift)->search(@_);
642 =head2 search_related_rs
644 This method works exactly the same as search_related, except that
645 it guarantees a restultset, even in list context.
649 sub search_related_rs {
650 return shift->related_resultset(shift)->search_rs(@_);
657 =item Arguments: none
659 =item Return Value: $cursor
663 Returns a storage-driven cursor to the given resultset. See
664 L<DBIx::Class::Cursor> for more information.
671 my $attrs = $self->_resolved_attrs_copy;
673 return $self->{cursor}
674 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
675 $attrs->{where},$attrs);
682 =item Arguments: $cond?
684 =item Return Value: $row_object?
688 my $cd = $schema->resultset('CD')->single({ year => 2001 });
690 Inflates the first result without creating a cursor if the resultset has
691 any records in it; if not returns nothing. Used by L</find> as a lean version of
694 While this method can take an optional search condition (just like L</search>)
695 being a fast-code-path it does not recognize search attributes. If you need to
696 add extra joins or similar, call L</search> and then chain-call L</single> on the
697 L<DBIx::Class::ResultSet> returned.
703 As of 0.08100, this method enforces the assumption that the preceeding
704 query returns only one row. If more than one row is returned, you will receive
707 Query returned more than one row
709 In this case, you should be using L</next> or L</find> instead, or if you really
710 know what you are doing, use the L</rows> attribute to explicitly limit the size
713 This method will also throw an exception if it is called on a resultset prefetching
714 has_many, as such a prefetch implies fetching multiple rows from the database in
715 order to assemble the resulting object.
722 my ($self, $where) = @_;
724 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
727 my $attrs = $self->_resolved_attrs_copy;
729 if (keys %{$attrs->{collapse}}) {
730 $self->throw_exception(
731 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
736 if (defined $attrs->{where}) {
739 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
740 $where, delete $attrs->{where} ]
743 $attrs->{where} = $where;
747 # XXX: Disabled since it doesn't infer uniqueness in all cases
748 # unless ($self->_is_unique_query($attrs->{where})) {
749 # carp "Query not guaranteed to return a single row"
750 # . "; please declare your unique constraints or use search instead";
753 my @data = $self->result_source->storage->select_single(
754 $attrs->{from}, $attrs->{select},
755 $attrs->{where}, $attrs
758 return (@data ? ($self->_construct_object(@data))[0] : undef);
764 # Try to determine if the specified query is guaranteed to be unique, based on
765 # the declared unique constraints.
767 sub _is_unique_query {
768 my ($self, $query) = @_;
770 my $collapsed = $self->_collapse_query($query);
771 my $alias = $self->{attrs}{alias};
773 foreach my $name ($self->result_source->unique_constraint_names) {
774 my @unique_cols = map {
776 } $self->result_source->unique_constraint_columns($name);
778 # Count the values for each unique column
779 my %seen = map { $_ => 0 } @unique_cols;
781 foreach my $key (keys %$collapsed) {
782 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
783 next unless exists $seen{$aliased}; # Additional constraints are okay
784 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
787 # If we get 0 or more than 1 value for a column, it's not necessarily unique
788 return 1 unless grep { $_ != 1 } values %seen;
796 # Recursively collapse the query, accumulating values for each column.
798 sub _collapse_query {
799 my ($self, $query, $collapsed) = @_;
803 if (ref $query eq 'ARRAY') {
804 foreach my $subquery (@$query) {
805 next unless ref $subquery; # -or
806 $collapsed = $self->_collapse_query($subquery, $collapsed);
809 elsif (ref $query eq 'HASH') {
810 if (keys %$query and (keys %$query)[0] eq '-and') {
811 foreach my $subquery (@{$query->{-and}}) {
812 $collapsed = $self->_collapse_query($subquery, $collapsed);
816 foreach my $col (keys %$query) {
817 my $value = $query->{$col};
818 $collapsed->{$col}{$value}++;
830 =item Arguments: $cond?
832 =item Return Value: $resultsetcolumn
836 my $max_length = $rs->get_column('length')->max;
838 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
843 my ($self, $column) = @_;
844 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
852 =item Arguments: $cond, \%attrs?
854 =item Return Value: $resultset (scalar context), @row_objs (list context)
858 # WHERE title LIKE '%blue%'
859 $cd_rs = $rs->search_like({ title => '%blue%'});
861 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
862 that this is simply a convenience method retained for ex Class::DBI users.
863 You most likely want to use L</search> with specific operators.
865 For more information, see L<DBIx::Class::Manual::Cookbook>.
867 This method is deprecated and will be removed in 0.09. Use L</search()>
868 instead. An example conversion is:
870 ->search_like({ foo => 'bar' });
874 ->search({ foo => { like => 'bar' } });
881 'search_like() is deprecated and will be removed in DBIC version 0.09.'
882 .' Instead use ->search({ x => { -like => "y%" } })'
883 .' (note the outer pair of {}s - they are important!)'
885 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
886 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
887 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
888 return $class->search($query, { %$attrs });
895 =item Arguments: $first, $last
897 =item Return Value: $resultset (scalar context), @row_objs (list context)
901 Returns a resultset or object list representing a subset of elements from the
902 resultset slice is called on. Indexes are from 0, i.e., to get the first
905 my ($one, $two, $three) = $rs->slice(0, 2);
910 my ($self, $min, $max) = @_;
911 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
912 $attrs->{offset} = $self->{attrs}{offset} || 0;
913 $attrs->{offset} += $min;
914 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
915 return $self->search(undef(), $attrs);
916 #my $slice = (ref $self)->new($self->result_source, $attrs);
917 #return (wantarray ? $slice->all : $slice);
924 =item Arguments: none
926 =item Return Value: $result?
930 Returns the next element in the resultset (C<undef> is there is none).
932 Can be used to efficiently iterate over records in the resultset:
934 my $rs = $schema->resultset('CD')->search;
935 while (my $cd = $rs->next) {
939 Note that you need to store the resultset object, and call C<next> on it.
940 Calling C<< resultset('Table')->next >> repeatedly will always return the
941 first record from the resultset.
947 if (my $cache = $self->get_cache) {
948 $self->{all_cache_position} ||= 0;
949 return $cache->[$self->{all_cache_position}++];
951 if ($self->{attrs}{cache}) {
952 $self->{all_cache_position} = 1;
953 return ($self->all)[0];
955 if ($self->{stashed_objects}) {
956 my $obj = shift(@{$self->{stashed_objects}});
957 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
961 exists $self->{stashed_row}
962 ? @{delete $self->{stashed_row}}
963 : $self->cursor->next
965 return undef unless (@row);
966 my ($row, @more) = $self->_construct_object(@row);
967 $self->{stashed_objects} = \@more if @more;
971 sub _construct_object {
972 my ($self, @row) = @_;
974 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
976 my @new = $self->result_class->inflate_result($self->result_source, @$info);
977 @new = $self->{_attrs}{record_filter}->(@new)
978 if exists $self->{_attrs}{record_filter};
982 sub _collapse_result {
983 my ($self, $as_proto, $row) = @_;
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 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1251 # same as above but uses a subquery
1253 sub _count_subq_rs {
1254 my ($self, $attrs) = @_;
1256 my $rsrc = $self->result_source;
1257 $attrs ||= $self->_resolved_attrs_copy;
1259 my $sub_attrs = { %$attrs };
1261 # extra selectors do not go in the subquery and there is no point of ordering it
1262 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1264 # if we prefetch, we group_by primary keys only as this is what we would get out
1265 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1266 if ( keys %{$attrs->{collapse}} ) {
1267 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1270 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1272 # this is so that the query can be simplified e.g.
1273 # * non-limiting joins can be pruned
1274 # * ordering can be thrown away in things like Top limit
1275 $sub_attrs->{-for_count_only} = 1;
1277 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1280 -alias => 'count_subq',
1281 -source_handle => $rsrc->handle,
1282 count_subq => $sub_rs->as_query,
1285 # the subquery replaces this
1286 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1288 return $self->_count_rs ($attrs);
1295 =head2 count_literal
1299 =item Arguments: $sql_fragment, @bind_values
1301 =item Return Value: $count
1305 Counts the results in a literal query. Equivalent to calling L</search_literal>
1306 with the passed arguments, then L</count>.
1310 sub count_literal { shift->search_literal(@_)->count; }
1316 =item Arguments: none
1318 =item Return Value: @objects
1322 Returns all elements in the resultset. Called implicitly if the resultset
1323 is returned in list context.
1330 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1333 return @{ $self->get_cache } if $self->get_cache;
1337 if (keys %{$self->_resolved_attrs->{collapse}}) {
1338 # Using $self->cursor->all is really just an optimisation.
1339 # If we're collapsing has_many prefetches it probably makes
1340 # very little difference, and this is cleaner than hacking
1341 # _construct_object to survive the approach
1342 $self->cursor->reset;
1343 my @row = $self->cursor->next;
1345 push(@obj, $self->_construct_object(@row));
1346 @row = (exists $self->{stashed_row}
1347 ? @{delete $self->{stashed_row}}
1348 : $self->cursor->next);
1351 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1354 $self->set_cache(\@obj) if $self->{attrs}{cache};
1363 =item Arguments: none
1365 =item Return Value: $self
1369 Resets the resultset's cursor, so you can iterate through the elements again.
1370 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1377 delete $self->{_attrs} if exists $self->{_attrs};
1378 $self->{all_cache_position} = 0;
1379 $self->cursor->reset;
1387 =item Arguments: none
1389 =item Return Value: $object?
1393 Resets the resultset and returns an object for the first result (if the
1394 resultset returns anything).
1399 return $_[0]->reset->next;
1405 # Determines whether and what type of subquery is required for the $rs operation.
1406 # If grouping is necessary either supplies its own, or verifies the current one
1407 # After all is done delegates to the proper storage method.
1409 sub _rs_update_delete {
1410 my ($self, $op, $values) = @_;
1412 my $rsrc = $self->result_source;
1414 # if a condition exists we need to strip all table qualifiers
1415 # if this is not possible we'll force a subquery below
1416 my $cond = $rsrc->schema->storage->_strip_cond_qualifiers ($self->{cond});
1418 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1419 my $needs_subq = $needs_group_by_subq || (not defined $cond) || $self->_has_resolved_attr(qw/row offset/);
1421 if ($needs_group_by_subq or $needs_subq) {
1423 # make a new $rs selecting only the PKs (that's all we really need)
1424 my $attrs = $self->_resolved_attrs_copy;
1426 delete $attrs->{$_} for qw/collapse select as/;
1427 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1429 if ($needs_group_by_subq) {
1430 # make sure no group_by was supplied, or if there is one - make sure it matches
1431 # the columns compiled above perfectly. Anything else can not be sanely executed
1432 # on most databases so croak right then and there
1434 if (my $g = $attrs->{group_by}) {
1435 my @current_group_by = map
1436 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1441 join ("\x00", sort @current_group_by)
1443 join ("\x00", sort @{$attrs->{columns}} )
1445 $self->throw_exception (
1446 "You have just attempted a $op operation on a resultset which does group_by"
1447 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1448 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1449 . ' kind of queries. Please retry the operation with a modified group_by or'
1450 . ' without using one at all.'
1455 $attrs->{group_by} = $attrs->{columns};
1459 my $subrs = (ref $self)->new($rsrc, $attrs);
1461 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1464 return $rsrc->storage->$op(
1466 $op eq 'update' ? $values : (),
1476 =item Arguments: \%values
1478 =item Return Value: $storage_rv
1482 Sets the specified columns in the resultset to the supplied values in a
1483 single query. Return value will be true if the update succeeded or false
1484 if no records were updated; exact type of success value is storage-dependent.
1489 my ($self, $values) = @_;
1490 $self->throw_exception('Values for update must be a hash')
1491 unless ref $values eq 'HASH';
1493 return $self->_rs_update_delete ('update', $values);
1500 =item Arguments: \%values
1502 =item Return Value: 1
1506 Fetches all objects and updates them one at a time. Note that C<update_all>
1507 will run DBIC cascade triggers, while L</update> will not.
1512 my ($self, $values) = @_;
1513 $self->throw_exception('Values for update_all must be a hash')
1514 unless ref $values eq 'HASH';
1515 foreach my $obj ($self->all) {
1516 $obj->set_columns($values)->update;
1525 =item Arguments: none
1527 =item Return Value: $storage_rv
1531 Deletes the contents of the resultset from its result source. Note that this
1532 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1533 to run. See also L<DBIx::Class::Row/delete>.
1535 Return value will be the amount of rows deleted; exact type of return value
1536 is storage-dependent.
1542 $self->throw_exception('delete does not accept any arguments')
1545 return $self->_rs_update_delete ('delete');
1552 =item Arguments: none
1554 =item Return Value: 1
1558 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1559 will run DBIC cascade triggers, while L</delete> will not.
1565 $self->throw_exception('delete_all does not accept any arguments')
1568 $_->delete for $self->all;
1576 =item Arguments: \@data;
1580 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1581 For the arrayref of hashrefs style each hashref should be a structure suitable
1582 forsubmitting to a $resultset->create(...) method.
1584 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1585 to insert the data, as this is a faster method.
1587 Otherwise, each set of data is inserted into the database using
1588 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1589 accumulated into an array. The array itself, or an array reference
1590 is returned depending on scalar or list context.
1592 Example: Assuming an Artist Class that has many CDs Classes relating:
1594 my $Artist_rs = $schema->resultset("Artist");
1596 ## Void Context Example
1597 $Artist_rs->populate([
1598 { artistid => 4, name => 'Manufactured Crap', cds => [
1599 { title => 'My First CD', year => 2006 },
1600 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1603 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1604 { title => 'My parents sold me to a record company' ,year => 2005 },
1605 { title => 'Why Am I So Ugly?', year => 2006 },
1606 { title => 'I Got Surgery and am now Popular', year => 2007 }
1611 ## Array Context Example
1612 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1613 { name => "Artist One"},
1614 { name => "Artist Two"},
1615 { name => "Artist Three", cds=> [
1616 { title => "First CD", year => 2007},
1617 { title => "Second CD", year => 2008},
1621 print $ArtistOne->name; ## response is 'Artist One'
1622 print $ArtistThree->cds->count ## reponse is '2'
1624 For the arrayref of arrayrefs style, the first element should be a list of the
1625 fieldsnames to which the remaining elements are rows being inserted. For
1628 $Arstist_rs->populate([
1629 [qw/artistid name/],
1630 [100, 'A Formally Unknown Singer'],
1631 [101, 'A singer that jumped the shark two albums ago'],
1632 [102, 'An actually cool singer.'],
1635 Please note an important effect on your data when choosing between void and
1636 wantarray context. Since void context goes straight to C<insert_bulk> in
1637 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1638 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1639 create primary keys for you, you will find that your PKs are empty. In this
1640 case you will have to use the wantarray context in order to create those
1648 # cruft placed in standalone method
1649 my $data = $self->_normalize_populate_args(@_);
1651 if(defined wantarray) {
1653 foreach my $item (@$data) {
1654 push(@created, $self->create($item));
1656 return wantarray ? @created : \@created;
1658 my $first = $data->[0];
1660 # if a column is a registered relationship, and is a non-blessed hash/array, consider
1661 # it relationship data
1662 my (@rels, @columns);
1663 for (keys %$first) {
1664 my $ref = ref $first->{$_};
1665 $self->result_source->has_relationship($_) && ($ref eq 'ARRAY' or $ref eq 'HASH')
1671 my @pks = $self->result_source->primary_columns;
1673 ## do the belongs_to relationships
1674 foreach my $index (0..$#$data) {
1676 # delegate to create() for any dataset without primary keys with specified relationships
1677 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1679 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1680 my @ret = $self->populate($data);
1686 foreach my $rel (@rels) {
1687 next unless ref $data->[$index]->{$rel} eq "HASH";
1688 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1689 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1690 my $related = $result->result_source->_resolve_condition(
1691 $result->result_source->relationship_info($reverse)->{cond},
1696 delete $data->[$index]->{$rel};
1697 $data->[$index] = {%{$data->[$index]}, %$related};
1699 push @columns, keys %$related if $index == 0;
1703 ## inherit the data locked in the conditions of the resultset
1704 my ($rs_data) = $self->_merge_cond_with_data({});
1705 delete @{$rs_data}{@columns};
1706 my @inherit_cols = keys %$rs_data;
1707 my @inherit_data = values %$rs_data;
1709 ## do bulk insert on current row
1710 $self->result_source->storage->insert_bulk(
1711 $self->result_source,
1712 [@columns, @inherit_cols],
1713 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
1716 ## do the has_many relationships
1717 foreach my $item (@$data) {
1719 foreach my $rel (@rels) {
1720 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1722 my $parent = $self->find({map { $_ => $item->{$_} } @pks})
1723 || $self->throw_exception('Cannot find the relating object.');
1725 my $child = $parent->$rel;
1727 my $related = $child->result_source->_resolve_condition(
1728 $parent->result_source->relationship_info($rel)->{cond},
1733 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1734 my @populate = map { {%$_, %$related} } @rows_to_add;
1736 $child->populate( \@populate );
1743 # populate() argumnets went over several incarnations
1744 # What we ultimately support is AoH
1745 sub _normalize_populate_args {
1746 my ($self, $arg) = @_;
1748 if (ref $arg eq 'ARRAY') {
1749 if (ref $arg->[0] eq 'HASH') {
1752 elsif (ref $arg->[0] eq 'ARRAY') {
1754 my @colnames = @{$arg->[0]};
1755 foreach my $values (@{$arg}[1 .. $#$arg]) {
1756 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
1762 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
1769 =item Arguments: none
1771 =item Return Value: $pager
1775 Return Value a L<Data::Page> object for the current resultset. Only makes
1776 sense for queries with a C<page> attribute.
1778 To get the full count of entries for a paged resultset, call
1779 C<total_entries> on the L<Data::Page> object.
1786 return $self->{pager} if $self->{pager};
1788 my $attrs = $self->{attrs};
1789 $self->throw_exception("Can't create pager for non-paged rs")
1790 unless $self->{attrs}{page};
1791 $attrs->{rows} ||= 10;
1793 # throw away the paging flags and re-run the count (possibly
1794 # with a subselect) to get the real total count
1795 my $count_attrs = { %$attrs };
1796 delete $count_attrs->{$_} for qw/rows offset page pager/;
1797 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1799 return $self->{pager} = Data::Page->new(
1802 $self->{attrs}{page}
1810 =item Arguments: $page_number
1812 =item Return Value: $rs
1816 Returns a resultset for the $page_number page of the resultset on which page
1817 is called, where each page contains a number of rows equal to the 'rows'
1818 attribute set on the resultset (10 by default).
1823 my ($self, $page) = @_;
1824 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1831 =item Arguments: \%vals
1833 =item Return Value: $rowobject
1837 Creates a new row object in the resultset's result class and returns
1838 it. The row is not inserted into the database at this point, call
1839 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1840 will tell you whether the row object has been inserted or not.
1842 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1847 my ($self, $values) = @_;
1848 $self->throw_exception( "new_result needs a hash" )
1849 unless (ref $values eq 'HASH');
1851 my ($merged_cond, $cols_from_relations) = $self->_merge_cond_with_data($values);
1855 @$cols_from_relations
1856 ? (-cols_from_relations => $cols_from_relations)
1858 -source_handle => $self->_source_handle,
1859 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1862 return $self->result_class->new(\%new);
1865 # _merge_cond_with_data
1867 # Takes a simple hash of K/V data and returns its copy merged with the
1868 # condition already present on the resultset. Additionally returns an
1869 # arrayref of value/condition names, which were inferred from related
1870 # objects (this is needed for in-memory related objects)
1871 sub _merge_cond_with_data {
1872 my ($self, $data) = @_;
1874 my (%new_data, @cols_from_relations);
1876 my $alias = $self->{attrs}{alias};
1878 if (! defined $self->{cond}) {
1879 # just massage $data below
1881 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
1882 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1883 @cols_from_relations = keys %new_data;
1885 elsif (ref $self->{cond} ne 'HASH') {
1886 $self->throw_exception(
1887 "Can't abstract implicit construct, resultset condition not a hash"
1891 # precendence must be given to passed values over values inherited from
1892 # the cond, so the order here is important.
1893 my $collapsed_cond = $self->_collapse_cond($self->{cond});
1894 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1896 while ( my($col, $value) = each %implied ) {
1897 if (ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '=') {
1898 $new_data{$col} = $value->{'='};
1901 $new_data{$col} = $value if $self->_is_deterministic_value($value);
1907 %{ $self->_remove_alias($data, $alias) },
1910 return (\%new_data, \@cols_from_relations);
1913 # _is_deterministic_value
1915 # Make an effor to strip non-deterministic values from the condition,
1916 # to make sure new_result chokes less
1918 sub _is_deterministic_value {
1921 my $ref_type = ref $value;
1922 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1923 return 1 if Scalar::Util::blessed($value);
1927 # _has_resolved_attr
1929 # determines if the resultset defines at least one
1930 # of the attributes supplied
1932 # used to determine if a subquery is neccessary
1934 # supports some virtual attributes:
1936 # This will scan for any joins being present on the resultset.
1937 # It is not a mere key-search but a deep inspection of {from}
1940 sub _has_resolved_attr {
1941 my ($self, @attr_names) = @_;
1943 my $attrs = $self->_resolved_attrs;
1947 for my $n (@attr_names) {
1948 if (grep { $n eq $_ } (qw/-join/) ) {
1949 $extra_checks{$n}++;
1953 my $attr = $attrs->{$n};
1955 next if not defined $attr;
1957 if (ref $attr eq 'HASH') {
1958 return 1 if keys %$attr;
1960 elsif (ref $attr eq 'ARRAY') {
1968 # a resolved join is expressed as a multi-level from
1970 $extra_checks{-join}
1972 ref $attrs->{from} eq 'ARRAY'
1974 @{$attrs->{from}} > 1
1982 # Recursively collapse the condition.
1984 sub _collapse_cond {
1985 my ($self, $cond, $collapsed) = @_;
1989 if (ref $cond eq 'ARRAY') {
1990 foreach my $subcond (@$cond) {
1991 next unless ref $subcond; # -or
1992 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1995 elsif (ref $cond eq 'HASH') {
1996 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1997 foreach my $subcond (@{$cond->{-and}}) {
1998 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2002 foreach my $col (keys %$cond) {
2003 my $value = $cond->{$col};
2004 $collapsed->{$col} = $value;
2014 # Remove the specified alias from the specified query hash. A copy is made so
2015 # the original query is not modified.
2018 my ($self, $query, $alias) = @_;
2020 my %orig = %{ $query || {} };
2023 foreach my $key (keys %orig) {
2025 $unaliased{$key} = $orig{$key};
2028 $unaliased{$1} = $orig{$key}
2029 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2039 =item Arguments: none
2041 =item Return Value: \[ $sql, @bind ]
2045 Returns the SQL query and bind vars associated with the invocant.
2047 This is generally used as the RHS for a subquery.
2054 my $attrs = $self->_resolved_attrs_copy;
2059 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2060 # $sql also has no wrapping parenthesis in list ctx
2062 my $sqlbind = $self->result_source->storage
2063 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2072 =item Arguments: \%vals, \%attrs?
2074 =item Return Value: $rowobject
2078 my $artist = $schema->resultset('Artist')->find_or_new(
2079 { artist => 'fred' }, { key => 'artists' });
2081 $cd->cd_to_producer->find_or_new({ producer => $producer },
2082 { key => 'primary });
2084 Find an existing record from this resultset, based on its primary
2085 key, or a unique constraint. If none exists, instantiate a new result
2086 object and return it. The object will not be saved into your storage
2087 until you call L<DBIx::Class::Row/insert> on it.
2089 You most likely want this method when looking for existing rows using
2090 a unique constraint that is not the primary key, or looking for
2093 If you want objects to be saved immediately, use L</find_or_create>
2096 B<Note>: Take care when using C<find_or_new> with a table having
2097 columns with default values that you intend to be automatically
2098 supplied by the database (e.g. an auto_increment primary key column).
2099 In normal usage, the value of such columns should NOT be included at
2100 all in the call to C<find_or_new>, even when set to C<undef>.
2106 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2107 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2108 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2111 return $self->new_result($hash);
2118 =item Arguments: \%vals
2120 =item Return Value: a L<DBIx::Class::Row> $object
2124 Attempt to create a single new row or a row with multiple related rows
2125 in the table represented by the resultset (and related tables). This
2126 will not check for duplicate rows before inserting, use
2127 L</find_or_create> to do that.
2129 To create one row for this resultset, pass a hashref of key/value
2130 pairs representing the columns of the table and the values you wish to
2131 store. If the appropriate relationships are set up, foreign key fields
2132 can also be passed an object representing the foreign row, and the
2133 value will be set to its primary key.
2135 To create related objects, pass a hashref of related-object column values
2136 B<keyed on the relationship name>. If the relationship is of type C<multi>
2137 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2138 The process will correctly identify columns holding foreign keys, and will
2139 transparrently populate them from the keys of the corresponding relation.
2140 This can be applied recursively, and will work correctly for a structure
2141 with an arbitrary depth and width, as long as the relationships actually
2142 exists and the correct column data has been supplied.
2145 Instead of hashrefs of plain related data (key/value pairs), you may
2146 also pass new or inserted objects. New objects (not inserted yet, see
2147 L</new>), will be inserted into their appropriate tables.
2149 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2151 Example of creating a new row.
2153 $person_rs->create({
2154 name=>"Some Person",
2155 email=>"somebody@someplace.com"
2158 Example of creating a new row and also creating rows in a related C<has_many>
2159 or C<has_one> resultset. Note Arrayref.
2162 { artistid => 4, name => 'Manufactured Crap', cds => [
2163 { title => 'My First CD', year => 2006 },
2164 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2169 Example of creating a new row and also creating a row in a related
2170 C<belongs_to>resultset. Note Hashref.
2173 title=>"Music for Silly Walks",
2176 name=>"Silly Musician",
2184 When subclassing ResultSet never attempt to override this method. Since
2185 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2186 lot of the internals simply never call it, so your override will be
2187 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2188 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2189 L</create> process you need to intervene.
2196 my ($self, $attrs) = @_;
2197 $self->throw_exception( "create needs a hashref" )
2198 unless ref $attrs eq 'HASH';
2199 return $self->new_result($attrs)->insert;
2202 =head2 find_or_create
2206 =item Arguments: \%vals, \%attrs?
2208 =item Return Value: $rowobject
2212 $cd->cd_to_producer->find_or_create({ producer => $producer },
2213 { key => 'primary' });
2215 Tries to find a record based on its primary key or unique constraints; if none
2216 is found, creates one and returns that instead.
2218 my $cd = $schema->resultset('CD')->find_or_create({
2220 artist => 'Massive Attack',
2221 title => 'Mezzanine',
2225 Also takes an optional C<key> attribute, to search by a specific key or unique
2226 constraint. For example:
2228 my $cd = $schema->resultset('CD')->find_or_create(
2230 artist => 'Massive Attack',
2231 title => 'Mezzanine',
2233 { key => 'cd_artist_title' }
2236 B<Note>: Because find_or_create() reads from the database and then
2237 possibly inserts based on the result, this method is subject to a race
2238 condition. Another process could create a record in the table after
2239 the find has completed and before the create has started. To avoid
2240 this problem, use find_or_create() inside a transaction.
2242 B<Note>: Take care when using C<find_or_create> with a table having
2243 columns with default values that you intend to be automatically
2244 supplied by the database (e.g. an auto_increment primary key column).
2245 In normal usage, the value of such columns should NOT be included at
2246 all in the call to C<find_or_create>, even when set to C<undef>.
2248 See also L</find> and L</update_or_create>. For information on how to declare
2249 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2253 sub find_or_create {
2255 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2256 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2257 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2260 return $self->create($hash);
2263 =head2 update_or_create
2267 =item Arguments: \%col_values, { key => $unique_constraint }?
2269 =item Return Value: $rowobject
2273 $resultset->update_or_create({ col => $val, ... });
2275 First, searches for an existing row matching one of the unique constraints
2276 (including the primary key) on the source of this resultset. If a row is
2277 found, updates it with the other given column values. Otherwise, creates a new
2280 Takes an optional C<key> attribute to search on a specific unique constraint.
2283 # In your application
2284 my $cd = $schema->resultset('CD')->update_or_create(
2286 artist => 'Massive Attack',
2287 title => 'Mezzanine',
2290 { key => 'cd_artist_title' }
2293 $cd->cd_to_producer->update_or_create({
2294 producer => $producer,
2301 If no C<key> is specified, it searches on all unique constraints defined on the
2302 source, including the primary key.
2304 If the C<key> is specified as C<primary>, it searches only on the primary key.
2306 See also L</find> and L</find_or_create>. For information on how to declare
2307 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2309 B<Note>: Take care when using C<update_or_create> with a table having
2310 columns with default values that you intend to be automatically
2311 supplied by the database (e.g. an auto_increment primary key column).
2312 In normal usage, the value of such columns should NOT be included at
2313 all in the call to C<update_or_create>, even when set to C<undef>.
2317 sub update_or_create {
2319 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2320 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2322 my $row = $self->find($cond, $attrs);
2324 $row->update($cond);
2328 return $self->create($cond);
2331 =head2 update_or_new
2335 =item Arguments: \%col_values, { key => $unique_constraint }?
2337 =item Return Value: $rowobject
2341 $resultset->update_or_new({ col => $val, ... });
2343 First, searches for an existing row matching one of the unique constraints
2344 (including the primary key) on the source of this resultset. If a row is
2345 found, updates it with the other given column values. Otherwise, instantiate
2346 a new result object and return it. The object will not be saved into your storage
2347 until you call L<DBIx::Class::Row/insert> on it.
2349 Takes an optional C<key> attribute to search on a specific unique constraint.
2352 # In your application
2353 my $cd = $schema->resultset('CD')->update_or_new(
2355 artist => 'Massive Attack',
2356 title => 'Mezzanine',
2359 { key => 'cd_artist_title' }
2362 if ($cd->in_storage) {
2363 # the cd was updated
2366 # the cd is not yet in the database, let's insert it
2370 B<Note>: Take care when using C<update_or_new> with a table having
2371 columns with default values that you intend to be automatically
2372 supplied by the database (e.g. an auto_increment primary key column).
2373 In normal usage, the value of such columns should NOT be included at
2374 all in the call to C<update_or_new>, even when set to C<undef>.
2376 See also L</find>, L</find_or_create> and L</find_or_new>.
2382 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2383 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2385 my $row = $self->find( $cond, $attrs );
2386 if ( defined $row ) {
2387 $row->update($cond);
2391 return $self->new_result($cond);
2398 =item Arguments: none
2400 =item Return Value: \@cache_objects?
2404 Gets the contents of the cache for the resultset, if the cache is set.
2406 The cache is populated either by using the L</prefetch> attribute to
2407 L</search> or by calling L</set_cache>.
2419 =item Arguments: \@cache_objects
2421 =item Return Value: \@cache_objects
2425 Sets the contents of the cache for the resultset. Expects an arrayref
2426 of objects of the same class as those produced by the resultset. Note that
2427 if the cache is set the resultset will return the cached objects rather
2428 than re-querying the database even if the cache attr is not set.
2430 The contents of the cache can also be populated by using the
2431 L</prefetch> attribute to L</search>.
2436 my ( $self, $data ) = @_;
2437 $self->throw_exception("set_cache requires an arrayref")
2438 if defined($data) && (ref $data ne 'ARRAY');
2439 $self->{all_cache} = $data;
2446 =item Arguments: none
2448 =item Return Value: []
2452 Clears the cache for the resultset.
2457 shift->set_cache(undef);
2464 =item Arguments: none
2466 =item Return Value: true, if the resultset has been paginated
2474 return !!$self->{attrs}{page};
2477 =head2 related_resultset
2481 =item Arguments: $relationship_name
2483 =item Return Value: $resultset
2487 Returns a related resultset for the supplied relationship name.
2489 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2493 sub related_resultset {
2494 my ($self, $rel) = @_;
2496 $self->{related_resultsets} ||= {};
2497 return $self->{related_resultsets}{$rel} ||= do {
2498 my $rsrc = $self->result_source;
2499 my $rel_info = $rsrc->relationship_info($rel);
2501 $self->throw_exception(
2502 "search_related: result source '" . $rsrc->source_name .
2503 "' has no such relationship $rel")
2506 my $attrs = $self->_chain_relationship($rel);
2508 my $join_count = $attrs->{seen_join}{$rel};
2510 my $alias = $self->result_source->storage
2511 ->relname_to_table_alias($rel, $join_count);
2513 # since this is search_related, and we already slid the select window inwards
2514 # (the select/as attrs were deleted in the beginning), we need to flip all
2515 # left joins to inner, so we get the expected results
2516 # read the comment on top of the actual function to see what this does
2517 $attrs->{from} = $rsrc->schema->storage->_straight_join_to_node ($attrs->{from}, $alias);
2520 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2521 delete @{$attrs}{qw(result_class alias)};
2525 if (my $cache = $self->get_cache) {
2526 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2527 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2532 my $rel_source = $rsrc->related_source($rel);
2536 # The reason we do this now instead of passing the alias to the
2537 # search_rs below is that if you wrap/overload resultset on the
2538 # source you need to know what alias it's -going- to have for things
2539 # to work sanely (e.g. RestrictWithObject wants to be able to add
2540 # extra query restrictions, and these may need to be $alias.)
2542 my $rel_attrs = $rel_source->resultset_attributes;
2543 local $rel_attrs->{alias} = $alias;
2545 $rel_source->resultset
2549 where => $attrs->{where},
2552 $new->set_cache($new_cache) if $new_cache;
2557 =head2 current_source_alias
2561 =item Arguments: none
2563 =item Return Value: $source_alias
2567 Returns the current table alias for the result source this resultset is built
2568 on, that will be used in the SQL query. Usually it is C<me>.
2570 Currently the source alias that refers to the result set returned by a
2571 L</search>/L</find> family method depends on how you got to the resultset: it's
2572 C<me> by default, but eg. L</search_related> aliases it to the related result
2573 source name (and keeps C<me> referring to the original result set). The long
2574 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2575 (and make this method unnecessary).
2577 Thus it's currently necessary to use this method in predefined queries (see
2578 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2579 source alias of the current result set:
2581 # in a result set class
2583 my ($self, $user) = @_;
2585 my $me = $self->current_source_alias;
2587 return $self->search(
2588 "$me.modified" => $user->id,
2594 sub current_source_alias {
2597 return ($self->{attrs} || {})->{alias} || 'me';
2600 # This code is called by search_related, and makes sure there
2601 # is clear separation between the joins before, during, and
2602 # after the relationship. This information is needed later
2603 # in order to properly resolve prefetch aliases (any alias
2604 # with a relation_chain_depth less than the depth of the
2605 # current prefetch is not considered)
2607 # The increments happen twice per join. An even number means a
2608 # relationship specified via a search_related, whereas an odd
2609 # number indicates a join/prefetch added via attributes
2611 # Also this code will wrap the current resultset (the one we
2612 # chain to) in a subselect IFF it contains limiting attributes
2613 sub _chain_relationship {
2614 my ($self, $rel) = @_;
2615 my $source = $self->result_source;
2616 my $attrs = { %{$self->{attrs}||{}} };
2618 # we need to take the prefetch the attrs into account before we
2619 # ->_resolve_join as otherwise they get lost - captainL
2620 my $join = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2622 delete @{$attrs}{qw/join prefetch collapse distinct select as columns +select +as +columns/};
2624 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
2627 my @force_subq_attrs = qw/offset rows group_by having/;
2630 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
2632 $self->_has_resolved_attr (@force_subq_attrs)
2634 # Nuke the prefetch (if any) before the new $rs attrs
2635 # are resolved (prefetch is useless - we are wrapping
2636 # a subquery anyway).
2637 my $rs_copy = $self->search;
2638 $rs_copy->{attrs}{join} = $self->_merge_attr (
2639 $rs_copy->{attrs}{join},
2640 delete $rs_copy->{attrs}{prefetch},
2644 -source_handle => $source->handle,
2645 -alias => $attrs->{alias},
2646 $attrs->{alias} => $rs_copy->as_query,
2648 delete @{$attrs}{@force_subq_attrs, 'where'};
2649 $seen->{-relation_chain_depth} = 0;
2651 elsif ($attrs->{from}) { #shallow copy suffices
2652 $from = [ @{$attrs->{from}} ];
2656 -source_handle => $source->handle,
2657 -alias => $attrs->{alias},
2658 $attrs->{alias} => $source->from,
2662 my $jpath = ($seen->{-relation_chain_depth})
2663 ? $from->[-1][0]{-join_path}
2666 my @requested_joins = $source->_resolve_join(
2673 push @$from, @requested_joins;
2675 $seen->{-relation_chain_depth}++;
2677 # if $self already had a join/prefetch specified on it, the requested
2678 # $rel might very well be already included. What we do in this case
2679 # is effectively a no-op (except that we bump up the chain_depth on
2680 # the join in question so we could tell it *is* the search_related)
2683 # we consider the last one thus reverse
2684 for my $j (reverse @requested_joins) {
2685 if ($rel eq $j->[0]{-join_path}[-1]) {
2686 $j->[0]{-relation_chain_depth}++;
2691 # alternative way to scan the entire chain - not backwards compatible
2692 # for my $j (reverse @$from) {
2693 # next unless ref $j eq 'ARRAY';
2694 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2695 # $j->[0]{-relation_chain_depth}++;
2696 # $already_joined++;
2701 unless ($already_joined) {
2702 push @$from, $source->_resolve_join(
2710 $seen->{-relation_chain_depth}++;
2712 return {%$attrs, from => $from, seen_join => $seen};
2715 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2716 sub _resolved_attrs_copy {
2718 return { %{$self->_resolved_attrs (@_)} };
2721 sub _resolved_attrs {
2723 return $self->{_attrs} if $self->{_attrs};
2725 my $attrs = { %{ $self->{attrs} || {} } };
2726 my $source = $self->result_source;
2727 my $alias = $attrs->{alias};
2729 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2732 # build columns (as long as select isn't set) into a set of as/select hashes
2733 unless ( $attrs->{select} ) {
2736 if ( ref $attrs->{columns} eq 'ARRAY' ) {
2737 @cols = @{ delete $attrs->{columns}}
2738 } elsif ( defined $attrs->{columns} ) {
2739 @cols = delete $attrs->{columns}
2741 @cols = $source->columns
2745 if ( ref $_ eq 'HASH' ) {
2748 my $key = /^\Q${alias}.\E(.+)$/
2754 push @colbits, { $key => $value };
2759 # add the additional columns on
2760 foreach (qw{include_columns +columns}) {
2761 if ( $attrs->{$_} ) {
2762 my @list = ( ref($attrs->{$_}) eq 'ARRAY' )
2763 ? @{ delete $attrs->{$_} }
2764 : delete $attrs->{$_};
2766 if ( ref($_) eq 'HASH' ) {
2769 my $key = ( split /\./, $_ )[-1];
2770 my $value = ( /\./ ? $_ : "$alias.$_" );
2771 push @colbits, { $key => $value };
2777 # start with initial select items
2778 if ( $attrs->{select} ) {
2780 ( ref $attrs->{select} eq 'ARRAY' )
2781 ? [ @{ $attrs->{select} } ]
2782 : [ $attrs->{select} ];
2784 if ( $attrs->{as} ) {
2787 ref $attrs->{as} eq 'ARRAY'
2788 ? [ @{ $attrs->{as} } ]
2792 $attrs->{as} = [ map {
2793 m/^\Q${alias}.\E(.+)$/
2796 } @{ $attrs->{select} }
2802 # otherwise we intialise select & as to empty
2803 $attrs->{select} = [];
2807 # now add colbits to select/as
2808 push @{ $attrs->{select} }, map values %{$_}, @colbits;
2809 push @{ $attrs->{as} }, map keys %{$_}, @colbits;
2811 if ( my $adds = delete $attrs->{'+select'} ) {
2812 $adds = [$adds] unless ref $adds eq 'ARRAY';
2813 push @{ $attrs->{select} },
2814 map { /\./ || ref $_ ? $_ : "$alias.$_" } @$adds;
2816 if ( my $adds = delete $attrs->{'+as'} ) {
2817 $adds = [$adds] unless ref $adds eq 'ARRAY';
2818 push @{ $attrs->{as} }, @$adds;
2821 $attrs->{from} ||= [{
2822 -source_handle => $source->handle,
2823 -alias => $self->{attrs}{alias},
2824 $self->{attrs}{alias} => $source->from,
2827 if ( $attrs->{join} || $attrs->{prefetch} ) {
2829 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2830 if ref $attrs->{from} ne 'ARRAY';
2832 my $join = delete $attrs->{join} || {};
2834 if ( defined $attrs->{prefetch} ) {
2835 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2838 $attrs->{from} = # have to copy here to avoid corrupting the original
2840 @{ $attrs->{from} },
2841 $source->_resolve_join(
2844 { %{ $attrs->{seen_join} || {} } },
2845 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
2846 ? $attrs->{from}[-1][0]{-join_path}
2853 if ( defined $attrs->{order_by} ) {
2854 $attrs->{order_by} = (
2855 ref( $attrs->{order_by} ) eq 'ARRAY'
2856 ? [ @{ $attrs->{order_by} } ]
2857 : [ $attrs->{order_by} || () ]
2861 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2862 $attrs->{group_by} = [ $attrs->{group_by} ];
2865 # generate the distinct induced group_by early, as prefetch will be carried via a
2866 # subquery (since a group_by is present)
2867 if (delete $attrs->{distinct}) {
2868 if ($attrs->{group_by}) {
2869 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2872 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2874 # add any order_by parts that are not already present in the group_by
2875 # we need to be careful not to add any named functions/aggregates
2876 # i.e. select => [ ... { count => 'foo', -as 'foocount' } ... ]
2877 my %already_grouped = map { $_ => 1 } (@{$attrs->{group_by}});
2879 my $storage = $self->result_source->schema->storage;
2880 my $rs_column_list = $storage->_resolve_column_info ($attrs->{from});
2881 my @chunks = $storage->sql_maker->_order_by_chunks ($attrs->{order_by});
2883 for my $chunk (map { ref $_ ? @$_ : $_ } (@chunks) ) {
2884 $chunk =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
2885 if ($rs_column_list->{$chunk} && not $already_grouped{$chunk}++) {
2886 push @{$attrs->{group_by}}, $chunk;
2892 $attrs->{collapse} ||= {};
2893 if ( my $prefetch = delete $attrs->{prefetch} ) {
2894 $prefetch = $self->_merge_attr( {}, $prefetch );
2896 my $prefetch_ordering = [];
2898 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2901 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2903 # we need to somehow mark which columns came from prefetch
2904 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2906 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2907 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2909 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2910 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2913 # if both page and offset are specified, produce a combined offset
2914 # even though it doesn't make much sense, this is what pre 081xx has
2916 if (my $page = delete $attrs->{page}) {
2918 ($attrs->{rows} * ($page - 1))
2920 ($attrs->{offset} || 0)
2924 return $self->{_attrs} = $attrs;
2927 sub _joinpath_aliases {
2928 my ($self, $fromspec, $seen) = @_;
2931 return $paths unless ref $fromspec eq 'ARRAY';
2933 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2935 if ($cur_depth % 2) {
2936 $self->throw_exception ("-relation_chain_depth is not even, something went horribly wrong ($cur_depth)");
2939 for my $j (@$fromspec) {
2941 next if ref $j ne 'ARRAY';
2942 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2944 my $jpath = $j->[0]{-join_path};
2947 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth/2 .. $#$jpath]; #only even depths are actual jpath boundaries
2948 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2955 my ($self, $attr) = @_;
2957 if (ref $attr eq 'HASH') {
2958 return $self->_rollout_hash($attr);
2959 } elsif (ref $attr eq 'ARRAY') {
2960 return $self->_rollout_array($attr);
2966 sub _rollout_array {
2967 my ($self, $attr) = @_;
2970 foreach my $element (@{$attr}) {
2971 if (ref $element eq 'HASH') {
2972 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2973 } elsif (ref $element eq 'ARRAY') {
2974 # XXX - should probably recurse here
2975 push( @rolled_array, @{$self->_rollout_array($element)} );
2977 push( @rolled_array, $element );
2980 return \@rolled_array;
2984 my ($self, $attr) = @_;
2987 foreach my $key (keys %{$attr}) {
2988 push( @rolled_array, { $key => $attr->{$key} } );
2990 return \@rolled_array;
2993 sub _calculate_score {
2994 my ($self, $a, $b) = @_;
2996 if (defined $a xor defined $b) {
2999 elsif (not defined $a) {
3003 if (ref $b eq 'HASH') {
3004 my ($b_key) = keys %{$b};
3005 if (ref $a eq 'HASH') {
3006 my ($a_key) = keys %{$a};
3007 if ($a_key eq $b_key) {
3008 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3013 return ($a eq $b_key) ? 1 : 0;
3016 if (ref $a eq 'HASH') {
3017 my ($a_key) = keys %{$a};
3018 return ($b eq $a_key) ? 1 : 0;
3020 return ($b eq $a) ? 1 : 0;
3026 my ($self, $orig, $import) = @_;
3028 return $import unless defined($orig);
3029 return $orig unless defined($import);
3031 $orig = $self->_rollout_attr($orig);
3032 $import = $self->_rollout_attr($import);
3035 foreach my $import_element ( @{$import} ) {
3036 # find best candidate from $orig to merge $b_element into
3037 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3038 foreach my $orig_element ( @{$orig} ) {
3039 my $score = $self->_calculate_score( $orig_element, $import_element );
3040 if ($score > $best_candidate->{score}) {
3041 $best_candidate->{position} = $position;
3042 $best_candidate->{score} = $score;
3046 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3048 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3049 push( @{$orig}, $import_element );
3051 my $orig_best = $orig->[$best_candidate->{position}];
3052 # merge orig_best and b_element together and replace original with merged
3053 if (ref $orig_best ne 'HASH') {
3054 $orig->[$best_candidate->{position}] = $import_element;
3055 } elsif (ref $import_element eq 'HASH') {
3056 my ($key) = keys %{$orig_best};
3057 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3060 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3070 $self->_source_handle($_[0]->handle);
3072 $self->_source_handle->resolve;
3076 =head2 throw_exception
3078 See L<DBIx::Class::Schema/throw_exception> for details.
3082 sub throw_exception {
3085 if (ref $self && $self->_source_handle->schema) {
3086 $self->_source_handle->schema->throw_exception(@_)
3089 DBIx::Class::Exception->throw(@_);
3093 # XXX: FIXME: Attributes docs need clearing up
3097 Attributes are used to refine a ResultSet in various ways when
3098 searching for data. They can be passed to any method which takes an
3099 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3102 These are in no particular order:
3108 =item Value: ( $order_by | \@order_by | \%order_by )
3112 Which column(s) to order the results by.
3114 [The full list of suitable values is documented in
3115 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3118 If a single column name, or an arrayref of names is supplied, the
3119 argument is passed through directly to SQL. The hashref syntax allows
3120 for connection-agnostic specification of ordering direction:
3122 For descending order:
3124 order_by => { -desc => [qw/col1 col2 col3/] }
3126 For explicit ascending order:
3128 order_by => { -asc => 'col' }
3130 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3131 supported, although you are strongly encouraged to use the hashref
3132 syntax as outlined above.
3138 =item Value: \@columns
3142 Shortcut to request a particular set of columns to be retrieved. Each
3143 column spec may be a string (a table column name), or a hash (in which
3144 case the key is the C<as> value, and the value is used as the C<select>
3145 expression). Adds C<me.> onto the start of any column without a C<.> in
3146 it and sets C<select> from that, then auto-populates C<as> from
3147 C<select> as normal. (You may also use the C<cols> attribute, as in
3148 earlier versions of DBIC.)
3154 =item Value: \@columns
3158 Indicates additional columns to be selected from storage. Works the same
3159 as L</columns> but adds columns to the selection. (You may also use the
3160 C<include_columns> attribute, as in earlier versions of DBIC). For
3163 $schema->resultset('CD')->search(undef, {
3164 '+columns' => ['artist.name'],
3168 would return all CDs and include a 'name' column to the information
3169 passed to object inflation. Note that the 'artist' is the name of the
3170 column (or relationship) accessor, and 'name' is the name of the column
3171 accessor in the related table.
3173 =head2 include_columns
3177 =item Value: \@columns
3181 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3187 =item Value: \@select_columns
3191 Indicates which columns should be selected from the storage. You can use
3192 column names, or in the case of RDBMS back ends, function or stored procedure
3195 $rs = $schema->resultset('Employee')->search(undef, {
3198 { count => 'employeeid' },
3203 When you use function/stored procedure names and do not supply an C<as>
3204 attribute, the column names returned are storage-dependent. E.g. MySQL would
3205 return a column named C<count(employeeid)> in the above example.
3207 B<NOTE:> You will almost always need a corresponding 'as' entry when you use
3214 Indicates additional columns to be selected from storage. Works the same as
3215 L</select> but adds columns to the selection.
3223 Indicates additional column names for those added via L</+select>. See L</as>.
3231 =item Value: \@inflation_names
3235 Indicates column names for object inflation. That is, C<as>
3236 indicates the name that the column can be accessed as via the
3237 C<get_column> method (or via the object accessor, B<if one already
3238 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3240 The C<as> attribute is used in conjunction with C<select>,
3241 usually when C<select> contains one or more function or stored
3244 $rs = $schema->resultset('Employee')->search(undef, {
3247 { count => 'employeeid' }
3249 as => ['name', 'employee_count'],
3252 my $employee = $rs->first(); # get the first Employee
3254 If the object against which the search is performed already has an accessor
3255 matching a column name specified in C<as>, the value can be retrieved using
3256 the accessor as normal:
3258 my $name = $employee->name();
3260 If on the other hand an accessor does not exist in the object, you need to
3261 use C<get_column> instead:
3263 my $employee_count = $employee->get_column('employee_count');
3265 You can create your own accessors if required - see
3266 L<DBIx::Class::Manual::Cookbook> for details.
3268 Please note: This will NOT insert an C<AS employee_count> into the SQL
3269 statement produced, it is used for internal access only. Thus
3270 attempting to use the accessor in an C<order_by> clause or similar
3271 will fail miserably.
3273 To get around this limitation, you can supply literal SQL to your
3274 C<select> attibute that contains the C<AS alias> text, eg:
3276 select => [\'myfield AS alias']
3282 =item Value: ($rel_name | \@rel_names | \%rel_names)
3286 Contains a list of relationships that should be joined for this query. For
3289 # Get CDs by Nine Inch Nails
3290 my $rs = $schema->resultset('CD')->search(
3291 { 'artist.name' => 'Nine Inch Nails' },
3292 { join => 'artist' }
3295 Can also contain a hash reference to refer to the other relation's relations.
3298 package MyApp::Schema::Track;
3299 use base qw/DBIx::Class/;
3300 __PACKAGE__->table('track');
3301 __PACKAGE__->add_columns(qw/trackid cd position title/);
3302 __PACKAGE__->set_primary_key('trackid');
3303 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3306 # In your application
3307 my $rs = $schema->resultset('Artist')->search(
3308 { 'track.title' => 'Teardrop' },
3310 join => { cd => 'track' },
3311 order_by => 'artist.name',
3315 You need to use the relationship (not the table) name in conditions,
3316 because they are aliased as such. The current table is aliased as "me", so
3317 you need to use me.column_name in order to avoid ambiguity. For example:
3319 # Get CDs from 1984 with a 'Foo' track
3320 my $rs = $schema->resultset('CD')->search(
3323 'tracks.name' => 'Foo'
3325 { join => 'tracks' }
3328 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3329 similarly for a third time). For e.g.
3331 my $rs = $schema->resultset('Artist')->search({
3332 'cds.title' => 'Down to Earth',
3333 'cds_2.title' => 'Popular',
3335 join => [ qw/cds cds/ ],
3338 will return a set of all artists that have both a cd with title 'Down
3339 to Earth' and a cd with title 'Popular'.
3341 If you want to fetch related objects from other tables as well, see C<prefetch>
3344 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3350 =item Value: ($rel_name | \@rel_names | \%rel_names)
3354 Contains one or more relationships that should be fetched along with
3355 the main query (when they are accessed afterwards the data will
3356 already be available, without extra queries to the database). This is
3357 useful for when you know you will need the related objects, because it
3358 saves at least one query:
3360 my $rs = $schema->resultset('Tag')->search(
3369 The initial search results in SQL like the following:
3371 SELECT tag.*, cd.*, artist.* FROM tag
3372 JOIN cd ON tag.cd = cd.cdid
3373 JOIN artist ON cd.artist = artist.artistid
3375 L<DBIx::Class> has no need to go back to the database when we access the
3376 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3379 Simple prefetches will be joined automatically, so there is no need
3380 for a C<join> attribute in the above search.
3382 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3383 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3384 with an accessor type of 'single' or 'filter'). A more complex example that
3385 prefetches an artists cds, the tracks on those cds, and the tags associted
3386 with that artist is given below (assuming many-to-many from artists to tags):
3388 my $rs = $schema->resultset('Artist')->search(
3392 { cds => 'tracks' },
3393 { artist_tags => 'tags' }
3399 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3400 attributes will be ignored.
3402 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3403 exactly as you might expect.
3409 Prefetch uses the L</cache> to populate the prefetched relationships. This
3410 may or may not be what you want.
3414 If you specify a condition on a prefetched relationship, ONLY those
3415 rows that match the prefetched condition will be fetched into that relationship.
3416 This means that adding prefetch to a search() B<may alter> what is returned by
3417 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3419 my $artist_rs = $schema->resultset('Artist')->search({
3425 my $count = $artist_rs->first->cds->count;
3427 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3429 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3431 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3433 that cmp_ok() may or may not pass depending on the datasets involved. This
3434 behavior may or may not survive the 0.09 transition.
3446 Makes the resultset paged and specifies the page to retrieve. Effectively
3447 identical to creating a non-pages resultset and then calling ->page($page)
3450 If L<rows> attribute is not specified it defaults to 10 rows per page.
3452 When you have a paged resultset, L</count> will only return the number
3453 of rows in the page. To get the total, use the L</pager> and call
3454 C<total_entries> on it.
3464 Specifes the maximum number of rows for direct retrieval or the number of
3465 rows per page if the page attribute or method is used.
3471 =item Value: $offset
3475 Specifies the (zero-based) row number for the first row to be returned, or the
3476 of the first row of the first page if paging is used.
3482 =item Value: \@columns
3486 A arrayref of columns to group by. Can include columns of joined tables.
3488 group_by => [qw/ column1 column2 ... /]
3494 =item Value: $condition
3498 HAVING is a select statement attribute that is applied between GROUP BY and
3499 ORDER BY. It is applied to the after the grouping calculations have been
3502 having => { 'count(employee)' => { '>=', 100 } }
3508 =item Value: (0 | 1)
3512 Set to 1 to group by all columns. If the resultset already has a group_by
3513 attribute, this setting is ignored and an appropriate warning is issued.
3519 Adds to the WHERE clause.
3521 # only return rows WHERE deleted IS NULL for all searches
3522 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3524 Can be overridden by passing C<< { where => undef } >> as an attribute
3531 Set to 1 to cache search results. This prevents extra SQL queries if you
3532 revisit rows in your ResultSet:
3534 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3536 while( my $artist = $resultset->next ) {
3540 $rs->first; # without cache, this would issue a query
3542 By default, searches are not cached.
3544 For more examples of using these attributes, see
3545 L<DBIx::Class::Manual::Cookbook>.
3551 =item Value: ( 'update' | 'shared' )
3555 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT