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;
573 my (@unique_queries, %seen_column_combinations);
574 foreach my $name (@constraint_names) {
575 my @constraint_cols = $self->result_source->unique_constraint_columns($name);
577 my $constraint_sig = join "\x00", sort @constraint_cols;
578 next if $seen_column_combinations{$constraint_sig}++;
580 my $unique_query = $self->_build_unique_query($query, \@constraint_cols);
582 my $num_cols = scalar @constraint_cols;
583 my $num_query = scalar keys %$unique_query;
585 my $total = $num_query + $num_where;
586 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
587 # The query is either unique on its own or is unique in combination with
588 # the existing where clause
589 push @unique_queries, $unique_query;
593 return @unique_queries;
596 # _build_unique_query
598 # Constrain the specified query hash based on the specified column names.
600 sub _build_unique_query {
601 my ($self, $query, $unique_cols) = @_;
604 map { $_ => $query->{$_} }
605 grep { exists $query->{$_} }
610 =head2 search_related
614 =item Arguments: $rel, $cond, \%attrs?
616 =item Return Value: $new_resultset
620 $new_rs = $cd_rs->search_related('artist', {
624 Searches the specified relationship, optionally specifying a condition and
625 attributes for matching records. See L</ATTRIBUTES> for more information.
630 return shift->related_resultset(shift)->search(@_);
633 =head2 search_related_rs
635 This method works exactly the same as search_related, except that
636 it guarantees a restultset, even in list context.
640 sub search_related_rs {
641 return shift->related_resultset(shift)->search_rs(@_);
648 =item Arguments: none
650 =item Return Value: $cursor
654 Returns a storage-driven cursor to the given resultset. See
655 L<DBIx::Class::Cursor> for more information.
662 my $attrs = $self->_resolved_attrs_copy;
664 return $self->{cursor}
665 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
666 $attrs->{where},$attrs);
673 =item Arguments: $cond?
675 =item Return Value: $row_object?
679 my $cd = $schema->resultset('CD')->single({ year => 2001 });
681 Inflates the first result without creating a cursor if the resultset has
682 any records in it; if not returns nothing. Used by L</find> as a lean version of
685 While this method can take an optional search condition (just like L</search>)
686 being a fast-code-path it does not recognize search attributes. If you need to
687 add extra joins or similar, call L</search> and then chain-call L</single> on the
688 L<DBIx::Class::ResultSet> returned.
694 As of 0.08100, this method enforces the assumption that the preceeding
695 query returns only one row. If more than one row is returned, you will receive
698 Query returned more than one row
700 In this case, you should be using L</next> or L</find> instead, or if you really
701 know what you are doing, use the L</rows> attribute to explicitly limit the size
704 This method will also throw an exception if it is called on a resultset prefetching
705 has_many, as such a prefetch implies fetching multiple rows from the database in
706 order to assemble the resulting object.
713 my ($self, $where) = @_;
715 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
718 my $attrs = $self->_resolved_attrs_copy;
720 if (keys %{$attrs->{collapse}}) {
721 $self->throw_exception(
722 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
727 if (defined $attrs->{where}) {
730 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
731 $where, delete $attrs->{where} ]
734 $attrs->{where} = $where;
738 # XXX: Disabled since it doesn't infer uniqueness in all cases
739 # unless ($self->_is_unique_query($attrs->{where})) {
740 # carp "Query not guaranteed to return a single row"
741 # . "; please declare your unique constraints or use search instead";
744 my @data = $self->result_source->storage->select_single(
745 $attrs->{from}, $attrs->{select},
746 $attrs->{where}, $attrs
749 return (@data ? ($self->_construct_object(@data))[0] : undef);
755 # Try to determine if the specified query is guaranteed to be unique, based on
756 # the declared unique constraints.
758 sub _is_unique_query {
759 my ($self, $query) = @_;
761 my $collapsed = $self->_collapse_query($query);
762 my $alias = $self->{attrs}{alias};
764 foreach my $name ($self->result_source->unique_constraint_names) {
765 my @unique_cols = map {
767 } $self->result_source->unique_constraint_columns($name);
769 # Count the values for each unique column
770 my %seen = map { $_ => 0 } @unique_cols;
772 foreach my $key (keys %$collapsed) {
773 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
774 next unless exists $seen{$aliased}; # Additional constraints are okay
775 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
778 # If we get 0 or more than 1 value for a column, it's not necessarily unique
779 return 1 unless grep { $_ != 1 } values %seen;
787 # Recursively collapse the query, accumulating values for each column.
789 sub _collapse_query {
790 my ($self, $query, $collapsed) = @_;
794 if (ref $query eq 'ARRAY') {
795 foreach my $subquery (@$query) {
796 next unless ref $subquery; # -or
797 $collapsed = $self->_collapse_query($subquery, $collapsed);
800 elsif (ref $query eq 'HASH') {
801 if (keys %$query and (keys %$query)[0] eq '-and') {
802 foreach my $subquery (@{$query->{-and}}) {
803 $collapsed = $self->_collapse_query($subquery, $collapsed);
807 foreach my $col (keys %$query) {
808 my $value = $query->{$col};
809 $collapsed->{$col}{$value}++;
821 =item Arguments: $cond?
823 =item Return Value: $resultsetcolumn
827 my $max_length = $rs->get_column('length')->max;
829 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
834 my ($self, $column) = @_;
835 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
843 =item Arguments: $cond, \%attrs?
845 =item Return Value: $resultset (scalar context), @row_objs (list context)
849 # WHERE title LIKE '%blue%'
850 $cd_rs = $rs->search_like({ title => '%blue%'});
852 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
853 that this is simply a convenience method retained for ex Class::DBI users.
854 You most likely want to use L</search> with specific operators.
856 For more information, see L<DBIx::Class::Manual::Cookbook>.
858 This method is deprecated and will be removed in 0.09. Use L</search()>
859 instead. An example conversion is:
861 ->search_like({ foo => 'bar' });
865 ->search({ foo => { like => 'bar' } });
872 'search_like() is deprecated and will be removed in DBIC version 0.09.'
873 .' Instead use ->search({ x => { -like => "y%" } })'
874 .' (note the outer pair of {}s - they are important!)'
876 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
877 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
878 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
879 return $class->search($query, { %$attrs });
886 =item Arguments: $first, $last
888 =item Return Value: $resultset (scalar context), @row_objs (list context)
892 Returns a resultset or object list representing a subset of elements from the
893 resultset slice is called on. Indexes are from 0, i.e., to get the first
896 my ($one, $two, $three) = $rs->slice(0, 2);
901 my ($self, $min, $max) = @_;
902 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
903 $attrs->{offset} = $self->{attrs}{offset} || 0;
904 $attrs->{offset} += $min;
905 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
906 return $self->search(undef(), $attrs);
907 #my $slice = (ref $self)->new($self->result_source, $attrs);
908 #return (wantarray ? $slice->all : $slice);
915 =item Arguments: none
917 =item Return Value: $result?
921 Returns the next element in the resultset (C<undef> is there is none).
923 Can be used to efficiently iterate over records in the resultset:
925 my $rs = $schema->resultset('CD')->search;
926 while (my $cd = $rs->next) {
930 Note that you need to store the resultset object, and call C<next> on it.
931 Calling C<< resultset('Table')->next >> repeatedly will always return the
932 first record from the resultset.
938 if (my $cache = $self->get_cache) {
939 $self->{all_cache_position} ||= 0;
940 return $cache->[$self->{all_cache_position}++];
942 if ($self->{attrs}{cache}) {
943 $self->{all_cache_position} = 1;
944 return ($self->all)[0];
946 if ($self->{stashed_objects}) {
947 my $obj = shift(@{$self->{stashed_objects}});
948 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
952 exists $self->{stashed_row}
953 ? @{delete $self->{stashed_row}}
954 : $self->cursor->next
956 return undef unless (@row);
957 my ($row, @more) = $self->_construct_object(@row);
958 $self->{stashed_objects} = \@more if @more;
962 sub _construct_object {
963 my ($self, @row) = @_;
965 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
967 my @new = $self->result_class->inflate_result($self->result_source, @$info);
968 @new = $self->{_attrs}{record_filter}->(@new)
969 if exists $self->{_attrs}{record_filter};
973 sub _collapse_result {
974 my ($self, $as_proto, $row) = @_;
976 # if the first row that ever came in is totally empty - this means we got
977 # hit by a smooth^Wempty left-joined resultset. Just noop in that case
978 # instead of producing a {}
987 return undef unless $has_def;
991 # 'foo' => [ undef, 'foo' ]
992 # 'foo.bar' => [ 'foo', 'bar' ]
993 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
995 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
997 my %collapse = %{$self->{_attrs}{collapse}||{}};
1001 # if we're doing collapsing (has_many prefetch) we need to grab records
1002 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1003 # we know we don't have to bother.
1005 # the reason for not using the collapse stuff directly is because if you
1006 # had for e.g. two artists in a row with no cds, the collapse info for
1007 # both would be NULL (undef) so you'd lose the second artist
1009 # store just the index so we can check the array positions from the row
1010 # without having to contruct the full hash
1012 if (keys %collapse) {
1013 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
1014 foreach my $i (0 .. $#construct_as) {
1015 next if defined($construct_as[$i][0]); # only self table
1016 if (delete $pri{$construct_as[$i][1]}) {
1017 push(@pri_index, $i);
1019 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1023 # no need to do an if, it'll be empty if @pri_index is empty anyway
1025 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1029 do { # no need to check anything at the front, we always want the first row
1033 foreach my $this_as (@construct_as) {
1034 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1037 push(@const_rows, \%const);
1039 } until ( # no pri_index => no collapse => drop straight out
1042 do { # get another row, stash it, drop out if different PK
1044 @copy = $self->cursor->next;
1045 $self->{stashed_row} = \@copy;
1047 # last thing in do block, counts as true if anything doesn't match
1049 # check xor defined first for NULL vs. NOT NULL then if one is
1050 # defined the other must be so check string equality
1053 (defined $pri_vals{$_} ^ defined $copy[$_])
1054 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1059 my $alias = $self->{attrs}{alias};
1066 foreach my $const (@const_rows) {
1067 scalar @const_keys or do {
1068 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1070 foreach my $key (@const_keys) {
1073 my @parts = split(/\./, $key);
1075 my $data = $const->{$key};
1076 foreach my $p (@parts) {
1077 $target = $target->[1]->{$p} ||= [];
1079 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1080 # collapsing at this point and on final part
1081 my $pos = $collapse_pos{$cur};
1082 CK: foreach my $ck (@ckey) {
1083 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1084 $collapse_pos{$cur} = $data;
1085 delete @collapse_pos{ # clear all positioning for sub-entries
1086 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1093 if (exists $collapse{$cur}) {
1094 $target = $target->[-1];
1097 $target->[0] = $data;
1099 $info->[0] = $const->{$key};
1107 =head2 result_source
1111 =item Arguments: $result_source?
1113 =item Return Value: $result_source
1117 An accessor for the primary ResultSource object from which this ResultSet
1124 =item Arguments: $result_class?
1126 =item Return Value: $result_class
1130 An accessor for the class to use when creating row objects. Defaults to
1131 C<< result_source->result_class >> - which in most cases is the name of the
1132 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1134 Note that changing the result_class will also remove any components
1135 that were originally loaded in the source class via
1136 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1137 in the original source class will not run.
1142 my ($self, $result_class) = @_;
1143 if ($result_class) {
1144 $self->ensure_class_loaded($result_class);
1145 $self->_result_class($result_class);
1147 $self->_result_class;
1154 =item Arguments: $cond, \%attrs??
1156 =item Return Value: $count
1160 Performs an SQL C<COUNT> with the same query as the resultset was built
1161 with to find the number of elements. Passing arguments is equivalent to
1162 C<< $rs->search ($cond, \%attrs)->count >>
1168 return $self->search(@_)->count if @_ and defined $_[0];
1169 return scalar @{ $self->get_cache } if $self->get_cache;
1171 my $attrs = $self->_resolved_attrs_copy;
1173 # this is a little optimization - it is faster to do the limit
1174 # adjustments in software, instead of a subquery
1175 my $rows = delete $attrs->{rows};
1176 my $offset = delete $attrs->{offset};
1179 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1180 $crs = $self->_count_subq_rs ($attrs);
1183 $crs = $self->_count_rs ($attrs);
1185 my $count = $crs->next;
1187 $count -= $offset if $offset;
1188 $count = $rows if $rows and $rows < $count;
1189 $count = 0 if ($count < 0);
1198 =item Arguments: $cond, \%attrs??
1200 =item Return Value: $count_rs
1204 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1205 This can be very handy for subqueries:
1207 ->search( { amount => $some_rs->count_rs->as_query } )
1209 As with regular resultsets the SQL query will be executed only after
1210 the resultset is accessed via L</next> or L</all>. That would return
1211 the same single value obtainable via L</count>.
1217 return $self->search(@_)->count_rs if @_;
1219 # this may look like a lack of abstraction (count() does about the same)
1220 # but in fact an _rs *must* use a subquery for the limits, as the
1221 # software based limiting can not be ported if this $rs is to be used
1222 # in a subquery itself (i.e. ->as_query)
1223 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1224 return $self->_count_subq_rs;
1227 return $self->_count_rs;
1232 # returns a ResultSetColumn object tied to the count query
1235 my ($self, $attrs) = @_;
1237 my $rsrc = $self->result_source;
1238 $attrs ||= $self->_resolved_attrs;
1240 my $tmp_attrs = { %$attrs };
1242 # take off any limits, record_filter is cdbi, and no point of ordering a count
1243 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1245 # overwrite the selector (supplied by the storage)
1246 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1247 $tmp_attrs->{as} = 'count';
1249 # read the comment on top of the actual function to see what this does
1250 $tmp_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1251 $tmp_attrs->{from}, $tmp_attrs->{alias}
1254 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1260 # same as above but uses a subquery
1262 sub _count_subq_rs {
1263 my ($self, $attrs) = @_;
1265 my $rsrc = $self->result_source;
1266 $attrs ||= $self->_resolved_attrs_copy;
1268 my $sub_attrs = { %$attrs };
1270 # extra selectors do not go in the subquery and there is no point of ordering it
1271 delete $sub_attrs->{$_} for qw/collapse select _prefetch_select as order_by/;
1273 # if we prefetch, we group_by primary keys only as this is what we would get out
1274 # of the rs via ->next/->all. We DO WANT to clobber old group_by regardless
1275 if ( keys %{$attrs->{collapse}} ) {
1276 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1279 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1281 # read the comment on top of the actual function to see what this does
1282 $sub_attrs->{from} = $self->_switch_to_inner_join_if_needed (
1283 $sub_attrs->{from}, $sub_attrs->{alias}
1286 # this is so that ordering can be thrown away in things like Top limit
1287 $sub_attrs->{-for_count_only} = 1;
1289 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1292 -alias => 'count_subq',
1293 -source_handle => $rsrc->handle,
1294 count_subq => $sub_rs->as_query,
1297 # the subquery replaces this
1298 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1300 return $self->_count_rs ($attrs);
1304 # The DBIC relationship chaining implementation is pretty simple - every
1305 # new related_relationship is pushed onto the {from} stack, and the {select}
1306 # window simply slides further in. This means that when we count somewhere
1307 # in the middle, we got to make sure that everything in the join chain is an
1308 # actual inner join, otherwise the count will come back with unpredictable
1309 # results (a resultset may be generated with _some_ rows regardless of if
1310 # the relation which the $rs currently selects has rows or not). E.g.
1311 # $artist_rs->cds->count - normally generates:
1312 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
1313 # which actually returns the number of artists * (number of cds || 1)
1315 # So what we do here is crawl {from}, determine if the current alias is at
1316 # the top of the stack, and if not - make sure the chain is inner-joined down
1319 sub _switch_to_inner_join_if_needed {
1320 my ($self, $from, $alias) = @_;
1322 # subqueries and other oddness is naturally not supported
1324 ref $from ne 'ARRAY'
1328 ref $from->[0] ne 'HASH'
1330 ! $from->[0]{-alias}
1332 $from->[0]{-alias} eq $alias
1337 for my $j (@{$from}[1 .. $#$from]) {
1338 if ($j->[0]{-alias} eq $alias) {
1339 $switch_branch = $j->[0]{-join_path};
1344 # something else went wrong
1345 return $from unless $switch_branch;
1347 # So it looks like we will have to switch some stuff around.
1348 # local() is useless here as we will be leaving the scope
1349 # anyway, and deep cloning is just too fucking expensive
1350 # So replace the inner hashref manually
1351 my @new_from = ($from->[0]);
1352 my $sw_idx = { map { $_ => 1 } @$switch_branch };
1354 for my $j (@{$from}[1 .. $#$from]) {
1355 my $jalias = $j->[0]{-alias};
1357 if ($sw_idx->{$jalias}) {
1358 my %attrs = %{$j->[0]};
1359 delete $attrs{-join_type};
1378 =head2 count_literal
1382 =item Arguments: $sql_fragment, @bind_values
1384 =item Return Value: $count
1388 Counts the results in a literal query. Equivalent to calling L</search_literal>
1389 with the passed arguments, then L</count>.
1393 sub count_literal { shift->search_literal(@_)->count; }
1399 =item Arguments: none
1401 =item Return Value: @objects
1405 Returns all elements in the resultset. Called implicitly if the resultset
1406 is returned in list context.
1413 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1416 return @{ $self->get_cache } if $self->get_cache;
1420 if (keys %{$self->_resolved_attrs->{collapse}}) {
1421 # Using $self->cursor->all is really just an optimisation.
1422 # If we're collapsing has_many prefetches it probably makes
1423 # very little difference, and this is cleaner than hacking
1424 # _construct_object to survive the approach
1425 $self->cursor->reset;
1426 my @row = $self->cursor->next;
1428 push(@obj, $self->_construct_object(@row));
1429 @row = (exists $self->{stashed_row}
1430 ? @{delete $self->{stashed_row}}
1431 : $self->cursor->next);
1434 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1437 $self->set_cache(\@obj) if $self->{attrs}{cache};
1446 =item Arguments: none
1448 =item Return Value: $self
1452 Resets the resultset's cursor, so you can iterate through the elements again.
1453 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1460 delete $self->{_attrs} if exists $self->{_attrs};
1461 $self->{all_cache_position} = 0;
1462 $self->cursor->reset;
1470 =item Arguments: none
1472 =item Return Value: $object?
1476 Resets the resultset and returns an object for the first result (if the
1477 resultset returns anything).
1482 return $_[0]->reset->next;
1488 # Determines whether and what type of subquery is required for the $rs operation.
1489 # If grouping is necessary either supplies its own, or verifies the current one
1490 # After all is done delegates to the proper storage method.
1492 sub _rs_update_delete {
1493 my ($self, $op, $values) = @_;
1495 my $rsrc = $self->result_source;
1497 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1498 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1500 if ($needs_group_by_subq or $needs_subq) {
1502 # make a new $rs selecting only the PKs (that's all we really need)
1503 my $attrs = $self->_resolved_attrs_copy;
1505 delete $attrs->{$_} for qw/collapse select as/;
1506 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1508 if ($needs_group_by_subq) {
1509 # make sure no group_by was supplied, or if there is one - make sure it matches
1510 # the columns compiled above perfectly. Anything else can not be sanely executed
1511 # on most databases so croak right then and there
1513 if (my $g = $attrs->{group_by}) {
1514 my @current_group_by = map
1515 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1520 join ("\x00", sort @current_group_by)
1522 join ("\x00", sort @{$attrs->{columns}} )
1524 $self->throw_exception (
1525 "You have just attempted a $op operation on a resultset which does group_by"
1526 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1527 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1528 . ' kind of queries. Please retry the operation with a modified group_by or'
1529 . ' without using one at all.'
1534 $attrs->{group_by} = $attrs->{columns};
1538 my $subrs = (ref $self)->new($rsrc, $attrs);
1540 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1543 return $rsrc->storage->$op(
1545 $op eq 'update' ? $values : (),
1546 $self->_cond_for_update_delete,
1552 # _cond_for_update_delete
1554 # update/delete require the condition to be modified to handle
1555 # the differing SQL syntax available. This transforms the $self->{cond}
1556 # appropriately, returning the new condition.
1558 sub _cond_for_update_delete {
1559 my ($self, $full_cond) = @_;
1562 $full_cond ||= $self->{cond};
1563 # No-op. No condition, we're updating/deleting everything
1564 return $cond unless ref $full_cond;
1566 if (ref $full_cond eq 'ARRAY') {
1570 foreach my $key (keys %{$_}) {
1572 $hash{$1} = $_->{$key};
1578 elsif (ref $full_cond eq 'HASH') {
1579 if ((keys %{$full_cond})[0] eq '-and') {
1581 my @cond = @{$full_cond->{-and}};
1582 for (my $i = 0; $i < @cond; $i++) {
1583 my $entry = $cond[$i];
1585 if (ref $entry eq 'HASH') {
1586 $hash = $self->_cond_for_update_delete($entry);
1589 $entry =~ /([^.]+)$/;
1590 $hash->{$1} = $cond[++$i];
1592 push @{$cond->{-and}}, $hash;
1596 foreach my $key (keys %{$full_cond}) {
1598 $cond->{$1} = $full_cond->{$key};
1603 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1614 =item Arguments: \%values
1616 =item Return Value: $storage_rv
1620 Sets the specified columns in the resultset to the supplied values in a
1621 single query. Return value will be true if the update succeeded or false
1622 if no records were updated; exact type of success value is storage-dependent.
1627 my ($self, $values) = @_;
1628 $self->throw_exception('Values for update must be a hash')
1629 unless ref $values eq 'HASH';
1631 return $self->_rs_update_delete ('update', $values);
1638 =item Arguments: \%values
1640 =item Return Value: 1
1644 Fetches all objects and updates them one at a time. Note that C<update_all>
1645 will run DBIC cascade triggers, while L</update> will not.
1650 my ($self, $values) = @_;
1651 $self->throw_exception('Values for update_all must be a hash')
1652 unless ref $values eq 'HASH';
1653 foreach my $obj ($self->all) {
1654 $obj->set_columns($values)->update;
1663 =item Arguments: none
1665 =item Return Value: $storage_rv
1669 Deletes the contents of the resultset from its result source. Note that this
1670 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1671 to run. See also L<DBIx::Class::Row/delete>.
1673 Return value will be the amount of rows deleted; exact type of return value
1674 is storage-dependent.
1680 $self->throw_exception('delete does not accept any arguments')
1683 return $self->_rs_update_delete ('delete');
1690 =item Arguments: none
1692 =item Return Value: 1
1696 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1697 will run DBIC cascade triggers, while L</delete> will not.
1703 $self->throw_exception('delete_all does not accept any arguments')
1706 $_->delete for $self->all;
1714 =item Arguments: \@data;
1718 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1719 For the arrayref of hashrefs style each hashref should be a structure suitable
1720 forsubmitting to a $resultset->create(...) method.
1722 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1723 to insert the data, as this is a faster method.
1725 Otherwise, each set of data is inserted into the database using
1726 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1727 accumulated into an array. The array itself, or an array reference
1728 is returned depending on scalar or list context.
1730 Example: Assuming an Artist Class that has many CDs Classes relating:
1732 my $Artist_rs = $schema->resultset("Artist");
1734 ## Void Context Example
1735 $Artist_rs->populate([
1736 { artistid => 4, name => 'Manufactured Crap', cds => [
1737 { title => 'My First CD', year => 2006 },
1738 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1741 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1742 { title => 'My parents sold me to a record company' ,year => 2005 },
1743 { title => 'Why Am I So Ugly?', year => 2006 },
1744 { title => 'I Got Surgery and am now Popular', year => 2007 }
1749 ## Array Context Example
1750 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1751 { name => "Artist One"},
1752 { name => "Artist Two"},
1753 { name => "Artist Three", cds=> [
1754 { title => "First CD", year => 2007},
1755 { title => "Second CD", year => 2008},
1759 print $ArtistOne->name; ## response is 'Artist One'
1760 print $ArtistThree->cds->count ## reponse is '2'
1762 For the arrayref of arrayrefs style, the first element should be a list of the
1763 fieldsnames to which the remaining elements are rows being inserted. For
1766 $Arstist_rs->populate([
1767 [qw/artistid name/],
1768 [100, 'A Formally Unknown Singer'],
1769 [101, 'A singer that jumped the shark two albums ago'],
1770 [102, 'An actually cool singer.'],
1773 Please note an important effect on your data when choosing between void and
1774 wantarray context. Since void context goes straight to C<insert_bulk> in
1775 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1776 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1777 create primary keys for you, you will find that your PKs are empty. In this
1778 case you will have to use the wantarray context in order to create those
1784 my $self = shift @_;
1785 my $data = ref $_[0][0] eq 'HASH'
1786 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1787 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1789 if(defined wantarray) {
1791 foreach my $item (@$data) {
1792 push(@created, $self->create($item));
1794 return wantarray ? @created : \@created;
1796 my ($first, @rest) = @$data;
1798 my @names = grep {!ref $first->{$_}} keys %$first;
1799 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1800 my @pks = $self->result_source->primary_columns;
1802 ## do the belongs_to relationships
1803 foreach my $index (0..$#$data) {
1805 # delegate to create() for any dataset without primary keys with specified relationships
1806 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1808 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1809 my @ret = $self->populate($data);
1815 foreach my $rel (@rels) {
1816 next unless ref $data->[$index]->{$rel} eq "HASH";
1817 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1818 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1819 my $related = $result->result_source->_resolve_condition(
1820 $result->result_source->relationship_info($reverse)->{cond},
1825 delete $data->[$index]->{$rel};
1826 $data->[$index] = {%{$data->[$index]}, %$related};
1828 push @names, keys %$related if $index == 0;
1832 ## do bulk insert on current row
1833 my @values = map { [ @$_{@names} ] } @$data;
1835 $self->result_source->storage->insert_bulk(
1836 $self->result_source,
1841 ## do the has_many relationships
1842 foreach my $item (@$data) {
1844 foreach my $rel (@rels) {
1845 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1847 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1848 || $self->throw_exception('Cannot find the relating object.');
1850 my $child = $parent->$rel;
1852 my $related = $child->result_source->_resolve_condition(
1853 $parent->result_source->relationship_info($rel)->{cond},
1858 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1859 my @populate = map { {%$_, %$related} } @rows_to_add;
1861 $child->populate( \@populate );
1867 =head2 _normalize_populate_args ($args)
1869 Private method used by L</populate> to normalize its incoming arguments. Factored
1870 out in case you want to subclass and accept new argument structures to the
1871 L</populate> method.
1875 sub _normalize_populate_args {
1876 my ($self, $data) = @_;
1877 my @names = @{shift(@$data)};
1878 my @results_to_create;
1879 foreach my $datum (@$data) {
1880 my %result_to_create;
1881 foreach my $index (0..$#names) {
1882 $result_to_create{$names[$index]} = $$datum[$index];
1884 push @results_to_create, \%result_to_create;
1886 return \@results_to_create;
1893 =item Arguments: none
1895 =item Return Value: $pager
1899 Return Value a L<Data::Page> object for the current resultset. Only makes
1900 sense for queries with a C<page> attribute.
1902 To get the full count of entries for a paged resultset, call
1903 C<total_entries> on the L<Data::Page> object.
1910 return $self->{pager} if $self->{pager};
1912 my $attrs = $self->{attrs};
1913 $self->throw_exception("Can't create pager for non-paged rs")
1914 unless $self->{attrs}{page};
1915 $attrs->{rows} ||= 10;
1917 # throw away the paging flags and re-run the count (possibly
1918 # with a subselect) to get the real total count
1919 my $count_attrs = { %$attrs };
1920 delete $count_attrs->{$_} for qw/rows offset page pager/;
1921 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1923 return $self->{pager} = Data::Page->new(
1926 $self->{attrs}{page}
1934 =item Arguments: $page_number
1936 =item Return Value: $rs
1940 Returns a resultset for the $page_number page of the resultset on which page
1941 is called, where each page contains a number of rows equal to the 'rows'
1942 attribute set on the resultset (10 by default).
1947 my ($self, $page) = @_;
1948 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1955 =item Arguments: \%vals
1957 =item Return Value: $rowobject
1961 Creates a new row object in the resultset's result class and returns
1962 it. The row is not inserted into the database at this point, call
1963 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1964 will tell you whether the row object has been inserted or not.
1966 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1971 my ($self, $values) = @_;
1972 $self->throw_exception( "new_result needs a hash" )
1973 unless (ref $values eq 'HASH');
1976 my $alias = $self->{attrs}{alias};
1979 defined $self->{cond}
1980 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1982 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1983 $new{-from_resultset} = [ keys %new ] if keys %new;
1985 $self->throw_exception(
1986 "Can't abstract implicit construct, condition not a hash"
1987 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1989 my $collapsed_cond = (
1991 ? $self->_collapse_cond($self->{cond})
1995 # precendence must be given to passed values over values inherited from
1996 # the cond, so the order here is important.
1997 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1998 while( my($col,$value) = each %implied ){
1999 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
2000 $new{$col} = $value->{'='};
2003 $new{$col} = $value if $self->_is_deterministic_value($value);
2009 %{ $self->_remove_alias($values, $alias) },
2010 -source_handle => $self->_source_handle,
2011 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2014 return $self->result_class->new(\%new);
2017 # _is_deterministic_value
2019 # Make an effor to strip non-deterministic values from the condition,
2020 # to make sure new_result chokes less
2022 sub _is_deterministic_value {
2025 my $ref_type = ref $value;
2026 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
2027 return 1 if Scalar::Util::blessed($value);
2031 # _has_resolved_attr
2033 # determines if the resultset defines at least one
2034 # of the attributes supplied
2036 # used to determine if a subquery is neccessary
2038 # supports some virtual attributes:
2040 # This will scan for any joins being present on the resultset.
2041 # It is not a mere key-search but a deep inspection of {from}
2044 sub _has_resolved_attr {
2045 my ($self, @attr_names) = @_;
2047 my $attrs = $self->_resolved_attrs;
2051 for my $n (@attr_names) {
2052 if (grep { $n eq $_ } (qw/-join/) ) {
2053 $extra_checks{$n}++;
2057 my $attr = $attrs->{$n};
2059 next if not defined $attr;
2061 if (ref $attr eq 'HASH') {
2062 return 1 if keys %$attr;
2064 elsif (ref $attr eq 'ARRAY') {
2072 # a resolved join is expressed as a multi-level from
2074 $extra_checks{-join}
2076 ref $attrs->{from} eq 'ARRAY'
2078 @{$attrs->{from}} > 1
2086 # Recursively collapse the condition.
2088 sub _collapse_cond {
2089 my ($self, $cond, $collapsed) = @_;
2093 if (ref $cond eq 'ARRAY') {
2094 foreach my $subcond (@$cond) {
2095 next unless ref $subcond; # -or
2096 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2099 elsif (ref $cond eq 'HASH') {
2100 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2101 foreach my $subcond (@{$cond->{-and}}) {
2102 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2106 foreach my $col (keys %$cond) {
2107 my $value = $cond->{$col};
2108 $collapsed->{$col} = $value;
2118 # Remove the specified alias from the specified query hash. A copy is made so
2119 # the original query is not modified.
2122 my ($self, $query, $alias) = @_;
2124 my %orig = %{ $query || {} };
2127 foreach my $key (keys %orig) {
2129 $unaliased{$key} = $orig{$key};
2132 $unaliased{$1} = $orig{$key}
2133 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2139 =head2 as_query (EXPERIMENTAL)
2143 =item Arguments: none
2145 =item Return Value: \[ $sql, @bind ]
2149 Returns the SQL query and bind vars associated with the invocant.
2151 This is generally used as the RHS for a subquery.
2153 B<NOTE>: This feature is still experimental.
2160 my $attrs = $self->_resolved_attrs_copy;
2165 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2166 # $sql also has no wrapping parenthesis in list ctx
2168 my $sqlbind = $self->result_source->storage
2169 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2178 =item Arguments: \%vals, \%attrs?
2180 =item Return Value: $rowobject
2184 my $artist = $schema->resultset('Artist')->find_or_new(
2185 { artist => 'fred' }, { key => 'artists' });
2187 $cd->cd_to_producer->find_or_new({ producer => $producer },
2188 { key => 'primary });
2190 Find an existing record from this resultset, based on its primary
2191 key, or a unique constraint. If none exists, instantiate a new result
2192 object and return it. The object will not be saved into your storage
2193 until you call L<DBIx::Class::Row/insert> on it.
2195 You most likely want this method when looking for existing rows using
2196 a unique constraint that is not the primary key, or looking for
2199 If you want objects to be saved immediately, use L</find_or_create>
2202 B<Note>: Take care when using C<find_or_new> with a table having
2203 columns with default values that you intend to be automatically
2204 supplied by the database (e.g. an auto_increment primary key column).
2205 In normal usage, the value of such columns should NOT be included at
2206 all in the call to C<find_or_new>, even when set to C<undef>.
2212 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2213 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2214 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2217 return $self->new_result($hash);
2224 =item Arguments: \%vals
2226 =item Return Value: a L<DBIx::Class::Row> $object
2230 Attempt to create a single new row or a row with multiple related rows
2231 in the table represented by the resultset (and related tables). This
2232 will not check for duplicate rows before inserting, use
2233 L</find_or_create> to do that.
2235 To create one row for this resultset, pass a hashref of key/value
2236 pairs representing the columns of the table and the values you wish to
2237 store. If the appropriate relationships are set up, foreign key fields
2238 can also be passed an object representing the foreign row, and the
2239 value will be set to its primary key.
2241 To create related objects, pass a hashref of related-object column values
2242 B<keyed on the relationship name>. If the relationship is of type C<multi>
2243 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2244 The process will correctly identify columns holding foreign keys, and will
2245 transparrently populate them from the keys of the corresponding relation.
2246 This can be applied recursively, and will work correctly for a structure
2247 with an arbitrary depth and width, as long as the relationships actually
2248 exists and the correct column data has been supplied.
2251 Instead of hashrefs of plain related data (key/value pairs), you may
2252 also pass new or inserted objects. New objects (not inserted yet, see
2253 L</new>), will be inserted into their appropriate tables.
2255 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2257 Example of creating a new row.
2259 $person_rs->create({
2260 name=>"Some Person",
2261 email=>"somebody@someplace.com"
2264 Example of creating a new row and also creating rows in a related C<has_many>
2265 or C<has_one> resultset. Note Arrayref.
2268 { artistid => 4, name => 'Manufactured Crap', cds => [
2269 { title => 'My First CD', year => 2006 },
2270 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2275 Example of creating a new row and also creating a row in a related
2276 C<belongs_to>resultset. Note Hashref.
2279 title=>"Music for Silly Walks",
2282 name=>"Silly Musician",
2290 When subclassing ResultSet never attempt to override this method. Since
2291 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2292 lot of the internals simply never call it, so your override will be
2293 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2294 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2295 L</create> process you need to intervene.
2302 my ($self, $attrs) = @_;
2303 $self->throw_exception( "create needs a hashref" )
2304 unless ref $attrs eq 'HASH';
2305 return $self->new_result($attrs)->insert;
2308 =head2 find_or_create
2312 =item Arguments: \%vals, \%attrs?
2314 =item Return Value: $rowobject
2318 $cd->cd_to_producer->find_or_create({ producer => $producer },
2319 { key => 'primary' });
2321 Tries to find a record based on its primary key or unique constraints; if none
2322 is found, creates one and returns that instead.
2324 my $cd = $schema->resultset('CD')->find_or_create({
2326 artist => 'Massive Attack',
2327 title => 'Mezzanine',
2331 Also takes an optional C<key> attribute, to search by a specific key or unique
2332 constraint. For example:
2334 my $cd = $schema->resultset('CD')->find_or_create(
2336 artist => 'Massive Attack',
2337 title => 'Mezzanine',
2339 { key => 'cd_artist_title' }
2342 B<Note>: Because find_or_create() reads from the database and then
2343 possibly inserts based on the result, this method is subject to a race
2344 condition. Another process could create a record in the table after
2345 the find has completed and before the create has started. To avoid
2346 this problem, use find_or_create() inside a transaction.
2348 B<Note>: Take care when using C<find_or_create> with a table having
2349 columns with default values that you intend to be automatically
2350 supplied by the database (e.g. an auto_increment primary key column).
2351 In normal usage, the value of such columns should NOT be included at
2352 all in the call to C<find_or_create>, even when set to C<undef>.
2354 See also L</find> and L</update_or_create>. For information on how to declare
2355 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2359 sub find_or_create {
2361 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2362 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2363 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2366 return $self->create($hash);
2369 =head2 update_or_create
2373 =item Arguments: \%col_values, { key => $unique_constraint }?
2375 =item Return Value: $rowobject
2379 $resultset->update_or_create({ col => $val, ... });
2381 First, searches for an existing row matching one of the unique constraints
2382 (including the primary key) on the source of this resultset. If a row is
2383 found, updates it with the other given column values. Otherwise, creates a new
2386 Takes an optional C<key> attribute to search on a specific unique constraint.
2389 # In your application
2390 my $cd = $schema->resultset('CD')->update_or_create(
2392 artist => 'Massive Attack',
2393 title => 'Mezzanine',
2396 { key => 'cd_artist_title' }
2399 $cd->cd_to_producer->update_or_create({
2400 producer => $producer,
2407 If no C<key> is specified, it searches on all unique constraints defined on the
2408 source, including the primary key.
2410 If the C<key> is specified as C<primary>, it searches only on the primary key.
2412 See also L</find> and L</find_or_create>. For information on how to declare
2413 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2415 B<Note>: Take care when using C<update_or_create> with a table having
2416 columns with default values that you intend to be automatically
2417 supplied by the database (e.g. an auto_increment primary key column).
2418 In normal usage, the value of such columns should NOT be included at
2419 all in the call to C<update_or_create>, even when set to C<undef>.
2423 sub update_or_create {
2425 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2426 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2428 my $row = $self->find($cond, $attrs);
2430 $row->update($cond);
2434 return $self->create($cond);
2437 =head2 update_or_new
2441 =item Arguments: \%col_values, { key => $unique_constraint }?
2443 =item Return Value: $rowobject
2447 $resultset->update_or_new({ col => $val, ... });
2449 First, searches for an existing row matching one of the unique constraints
2450 (including the primary key) on the source of this resultset. If a row is
2451 found, updates it with the other given column values. Otherwise, instantiate
2452 a new result object and return it. The object will not be saved into your storage
2453 until you call L<DBIx::Class::Row/insert> on it.
2455 Takes an optional C<key> attribute to search on a specific unique constraint.
2458 # In your application
2459 my $cd = $schema->resultset('CD')->update_or_new(
2461 artist => 'Massive Attack',
2462 title => 'Mezzanine',
2465 { key => 'cd_artist_title' }
2468 if ($cd->in_storage) {
2469 # the cd was updated
2472 # the cd is not yet in the database, let's insert it
2476 B<Note>: Take care when using C<update_or_new> with a table having
2477 columns with default values that you intend to be automatically
2478 supplied by the database (e.g. an auto_increment primary key column).
2479 In normal usage, the value of such columns should NOT be included at
2480 all in the call to C<update_or_new>, even when set to C<undef>.
2482 See also L</find>, L</find_or_create> and L</find_or_new>.
2488 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2489 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2491 my $row = $self->find( $cond, $attrs );
2492 if ( defined $row ) {
2493 $row->update($cond);
2497 return $self->new_result($cond);
2504 =item Arguments: none
2506 =item Return Value: \@cache_objects?
2510 Gets the contents of the cache for the resultset, if the cache is set.
2512 The cache is populated either by using the L</prefetch> attribute to
2513 L</search> or by calling L</set_cache>.
2525 =item Arguments: \@cache_objects
2527 =item Return Value: \@cache_objects
2531 Sets the contents of the cache for the resultset. Expects an arrayref
2532 of objects of the same class as those produced by the resultset. Note that
2533 if the cache is set the resultset will return the cached objects rather
2534 than re-querying the database even if the cache attr is not set.
2536 The contents of the cache can also be populated by using the
2537 L</prefetch> attribute to L</search>.
2542 my ( $self, $data ) = @_;
2543 $self->throw_exception("set_cache requires an arrayref")
2544 if defined($data) && (ref $data ne 'ARRAY');
2545 $self->{all_cache} = $data;
2552 =item Arguments: none
2554 =item Return Value: []
2558 Clears the cache for the resultset.
2563 shift->set_cache(undef);
2566 =head2 related_resultset
2570 =item Arguments: $relationship_name
2572 =item Return Value: $resultset
2576 Returns a related resultset for the supplied relationship name.
2578 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2582 sub related_resultset {
2583 my ($self, $rel) = @_;
2585 $self->{related_resultsets} ||= {};
2586 return $self->{related_resultsets}{$rel} ||= do {
2587 my $rel_info = $self->result_source->relationship_info($rel);
2589 $self->throw_exception(
2590 "search_related: result source '" . $self->result_source->source_name .
2591 "' has no such relationship $rel")
2594 my ($from,$seen) = $self->_chain_relationship($rel);
2596 my $join_count = $seen->{$rel};
2597 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2599 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2600 my %attrs = %{$self->{attrs}||{}};
2601 delete @attrs{qw(result_class alias)};
2605 if (my $cache = $self->get_cache) {
2606 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2607 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2612 my $rel_source = $self->result_source->related_source($rel);
2616 # The reason we do this now instead of passing the alias to the
2617 # search_rs below is that if you wrap/overload resultset on the
2618 # source you need to know what alias it's -going- to have for things
2619 # to work sanely (e.g. RestrictWithObject wants to be able to add
2620 # extra query restrictions, and these may need to be $alias.)
2622 my $attrs = $rel_source->resultset_attributes;
2623 local $attrs->{alias} = $alias;
2625 $rel_source->resultset
2633 where => $self->{cond},
2638 $new->set_cache($new_cache) if $new_cache;
2643 =head2 current_source_alias
2647 =item Arguments: none
2649 =item Return Value: $source_alias
2653 Returns the current table alias for the result source this resultset is built
2654 on, that will be used in the SQL query. Usually it is C<me>.
2656 Currently the source alias that refers to the result set returned by a
2657 L</search>/L</find> family method depends on how you got to the resultset: it's
2658 C<me> by default, but eg. L</search_related> aliases it to the related result
2659 source name (and keeps C<me> referring to the original result set). The long
2660 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2661 (and make this method unnecessary).
2663 Thus it's currently necessary to use this method in predefined queries (see
2664 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2665 source alias of the current result set:
2667 # in a result set class
2669 my ($self, $user) = @_;
2671 my $me = $self->current_source_alias;
2673 return $self->search(
2674 "$me.modified" => $user->id,
2680 sub current_source_alias {
2683 return ($self->{attrs} || {})->{alias} || 'me';
2686 # This code is called by search_related, and makes sure there
2687 # is clear separation between the joins before, during, and
2688 # after the relationship. This information is needed later
2689 # in order to properly resolve prefetch aliases (any alias
2690 # with a relation_chain_depth less than the depth of the
2691 # current prefetch is not considered)
2693 # The increments happen in 1/2s to make it easier to correlate the
2694 # join depth with the join path. An integer means a relationship
2695 # specified via a search_related, whereas a fraction means an added
2696 # join/prefetch via attributes
2697 sub _chain_relationship {
2698 my ($self, $rel) = @_;
2699 my $source = $self->result_source;
2700 my $attrs = $self->{attrs};
2706 -source_handle => $source->handle,
2707 -alias => $attrs->{alias},
2708 $attrs->{alias} => $source->from,
2712 my $seen = { %{$attrs->{seen_join} || {} } };
2713 my $jpath = ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2714 ? $from->[-1][0]{-join_path}
2718 # we need to take the prefetch the attrs into account before we
2719 # ->_resolve_join as otherwise they get lost - captainL
2720 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2722 my @requested_joins = $source->_resolve_join(
2729 push @$from, @requested_joins;
2731 $seen->{-relation_chain_depth} += 0.5;
2733 # if $self already had a join/prefetch specified on it, the requested
2734 # $rel might very well be already included. What we do in this case
2735 # is effectively a no-op (except that we bump up the chain_depth on
2736 # the join in question so we could tell it *is* the search_related)
2740 # we consider the last one thus reverse
2741 for my $j (reverse @requested_joins) {
2742 if ($rel eq $j->[0]{-join_path}[-1]) {
2743 $j->[0]{-relation_chain_depth} += 0.5;
2749 # alternative way to scan the entire chain - not backwards compatible
2750 # for my $j (reverse @$from) {
2751 # next unless ref $j eq 'ARRAY';
2752 # if ($j->[0]{-join_path} && $j->[0]{-join_path}[-1] eq $rel) {
2753 # $j->[0]{-relation_chain_depth} += 0.5;
2754 # $already_joined++;
2759 unless ($already_joined) {
2760 push @$from, $source->_resolve_join(
2768 $seen->{-relation_chain_depth} += 0.5;
2770 return ($from,$seen);
2773 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2774 sub _resolved_attrs_copy {
2776 return { %{$self->_resolved_attrs (@_)} };
2779 sub _resolved_attrs {
2781 return $self->{_attrs} if $self->{_attrs};
2783 my $attrs = { %{ $self->{attrs} || {} } };
2784 my $source = $self->result_source;
2785 my $alias = $attrs->{alias};
2787 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2790 # build columns (as long as select isn't set) into a set of as/select hashes
2791 unless ( $attrs->{select} ) {
2793 my @cols = ( ref($attrs->{columns}) eq 'ARRAY' )
2794 ? @{ delete $attrs->{columns}}
2796 ( delete $attrs->{columns} )
2798 $source->storage->_order_select_columns(
2800 [ $source->columns ],
2806 ( ref($_) eq 'HASH' )
2810 /^\Q${alias}.\E(.+)$/
2824 # add the additional columns on
2825 foreach ( 'include_columns', '+columns' ) {
2826 push @colbits, map {
2827 ( ref($_) eq 'HASH' )
2829 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2830 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2833 # start with initial select items
2834 if ( $attrs->{select} ) {
2836 ( ref $attrs->{select} eq 'ARRAY' )
2837 ? [ @{ $attrs->{select} } ]
2838 : [ $attrs->{select} ];
2842 ref $attrs->{as} eq 'ARRAY'
2843 ? [ @{ $attrs->{as} } ]
2846 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2851 # otherwise we intialise select & as to empty
2852 $attrs->{select} = [];
2856 # now add colbits to select/as
2857 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2858 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2861 if ( $adds = delete $attrs->{'+select'} ) {
2862 $adds = [$adds] unless ref $adds eq 'ARRAY';
2864 @{ $attrs->{select} },
2865 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2868 if ( $adds = delete $attrs->{'+as'} ) {
2869 $adds = [$adds] unless ref $adds eq 'ARRAY';
2870 push( @{ $attrs->{as} }, @$adds );
2873 $attrs->{from} ||= [ {
2874 -source_handle => $source->handle,
2875 -alias => $self->{attrs}{alias},
2876 $self->{attrs}{alias} => $source->from,
2879 if ( $attrs->{join} || $attrs->{prefetch} ) {
2881 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
2882 if ref $attrs->{from} ne 'ARRAY';
2884 my $join = delete $attrs->{join} || {};
2886 if ( defined $attrs->{prefetch} ) {
2887 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2890 $attrs->{from} = # have to copy here to avoid corrupting the original
2892 @{ $attrs->{from} },
2893 $source->_resolve_join(
2896 { %{ $attrs->{seen_join} || {} } },
2897 ($attrs->{seen_join} && keys %{$attrs->{seen_join}})
2898 ? $attrs->{from}[-1][0]{-join_path}
2905 if ( defined $attrs->{order_by} ) {
2906 $attrs->{order_by} = (
2907 ref( $attrs->{order_by} ) eq 'ARRAY'
2908 ? [ @{ $attrs->{order_by} } ]
2909 : [ $attrs->{order_by} || () ]
2913 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
2914 $attrs->{group_by} = [ $attrs->{group_by} ];
2917 # generate the distinct induced group_by early, as prefetch will be carried via a
2918 # subquery (since a group_by is present)
2919 if (delete $attrs->{distinct}) {
2920 if ($attrs->{group_by}) {
2921 carp ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
2924 $attrs->{group_by} = [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2928 $attrs->{collapse} ||= {};
2929 if ( my $prefetch = delete $attrs->{prefetch} ) {
2930 $prefetch = $self->_merge_attr( {}, $prefetch );
2932 my $prefetch_ordering = [];
2934 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2937 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2939 # we need to somehow mark which columns came from prefetch
2940 $attrs->{_prefetch_select} = [ map { $_->[0] } @prefetch ];
2942 push @{ $attrs->{select} }, @{$attrs->{_prefetch_select}};
2943 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2945 push( @{$attrs->{order_by}}, @$prefetch_ordering );
2946 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2949 # if both page and offset are specified, produce a combined offset
2950 # even though it doesn't make much sense, this is what pre 081xx has
2952 if (my $page = delete $attrs->{page}) {
2954 ($attrs->{rows} * ($page - 1))
2956 ($attrs->{offset} || 0)
2960 return $self->{_attrs} = $attrs;
2963 sub _joinpath_aliases {
2964 my ($self, $fromspec, $seen) = @_;
2967 return $paths unless ref $fromspec eq 'ARRAY';
2969 my $cur_depth = $seen->{-relation_chain_depth} || 0;
2971 if (int ($cur_depth) != $cur_depth) {
2972 $self->throw_exception ("-relation_chain_depth is not an integer, something went horribly wrong ($cur_depth)");
2975 for my $j (@$fromspec) {
2977 next if ref $j ne 'ARRAY';
2978 next if ($j->[0]{-relation_chain_depth} || 0) < $cur_depth;
2980 my $jpath = $j->[0]{-join_path};
2983 $p = $p->{$_} ||= {} for @{$jpath}[$cur_depth .. $#$jpath];
2984 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2991 my ($self, $attr) = @_;
2993 if (ref $attr eq 'HASH') {
2994 return $self->_rollout_hash($attr);
2995 } elsif (ref $attr eq 'ARRAY') {
2996 return $self->_rollout_array($attr);
3002 sub _rollout_array {
3003 my ($self, $attr) = @_;
3006 foreach my $element (@{$attr}) {
3007 if (ref $element eq 'HASH') {
3008 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3009 } elsif (ref $element eq 'ARRAY') {
3010 # XXX - should probably recurse here
3011 push( @rolled_array, @{$self->_rollout_array($element)} );
3013 push( @rolled_array, $element );
3016 return \@rolled_array;
3020 my ($self, $attr) = @_;
3023 foreach my $key (keys %{$attr}) {
3024 push( @rolled_array, { $key => $attr->{$key} } );
3026 return \@rolled_array;
3029 sub _calculate_score {
3030 my ($self, $a, $b) = @_;
3032 if (defined $a xor defined $b) {
3035 elsif (not defined $a) {
3039 if (ref $b eq 'HASH') {
3040 my ($b_key) = keys %{$b};
3041 if (ref $a eq 'HASH') {
3042 my ($a_key) = keys %{$a};
3043 if ($a_key eq $b_key) {
3044 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3049 return ($a eq $b_key) ? 1 : 0;
3052 if (ref $a eq 'HASH') {
3053 my ($a_key) = keys %{$a};
3054 return ($b eq $a_key) ? 1 : 0;
3056 return ($b eq $a) ? 1 : 0;
3062 my ($self, $orig, $import) = @_;
3064 return $import unless defined($orig);
3065 return $orig unless defined($import);
3067 $orig = $self->_rollout_attr($orig);
3068 $import = $self->_rollout_attr($import);
3071 foreach my $import_element ( @{$import} ) {
3072 # find best candidate from $orig to merge $b_element into
3073 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3074 foreach my $orig_element ( @{$orig} ) {
3075 my $score = $self->_calculate_score( $orig_element, $import_element );
3076 if ($score > $best_candidate->{score}) {
3077 $best_candidate->{position} = $position;
3078 $best_candidate->{score} = $score;
3082 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3084 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3085 push( @{$orig}, $import_element );
3087 my $orig_best = $orig->[$best_candidate->{position}];
3088 # merge orig_best and b_element together and replace original with merged
3089 if (ref $orig_best ne 'HASH') {
3090 $orig->[$best_candidate->{position}] = $import_element;
3091 } elsif (ref $import_element eq 'HASH') {
3092 my ($key) = keys %{$orig_best};
3093 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
3096 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3106 $self->_source_handle($_[0]->handle);
3108 $self->_source_handle->resolve;
3112 =head2 throw_exception
3114 See L<DBIx::Class::Schema/throw_exception> for details.
3118 sub throw_exception {
3120 if (ref $self && $self->_source_handle->schema) {
3121 $self->_source_handle->schema->throw_exception(@_)
3128 # XXX: FIXME: Attributes docs need clearing up
3132 Attributes are used to refine a ResultSet in various ways when
3133 searching for data. They can be passed to any method which takes an
3134 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3137 These are in no particular order:
3143 =item Value: ( $order_by | \@order_by | \%order_by )
3147 Which column(s) to order the results by.
3149 [The full list of suitable values is documented in
3150 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3153 If a single column name, or an arrayref of names is supplied, the
3154 argument is passed through directly to SQL. The hashref syntax allows
3155 for connection-agnostic specification of ordering direction:
3157 For descending order:
3159 order_by => { -desc => [qw/col1 col2 col3/] }
3161 For explicit ascending order:
3163 order_by => { -asc => 'col' }
3165 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3166 supported, although you are strongly encouraged to use the hashref
3167 syntax as outlined above.
3173 =item Value: \@columns
3177 Shortcut to request a particular set of columns to be retrieved. Each
3178 column spec may be a string (a table column name), or a hash (in which
3179 case the key is the C<as> value, and the value is used as the C<select>
3180 expression). Adds C<me.> onto the start of any column without a C<.> in
3181 it and sets C<select> from that, then auto-populates C<as> from
3182 C<select> as normal. (You may also use the C<cols> attribute, as in
3183 earlier versions of DBIC.)
3189 =item Value: \@columns
3193 Indicates additional columns to be selected from storage. Works the same
3194 as L</columns> but adds columns to the selection. (You may also use the
3195 C<include_columns> attribute, as in earlier versions of DBIC). For
3198 $schema->resultset('CD')->search(undef, {
3199 '+columns' => ['artist.name'],
3203 would return all CDs and include a 'name' column to the information
3204 passed to object inflation. Note that the 'artist' is the name of the
3205 column (or relationship) accessor, and 'name' is the name of the column
3206 accessor in the related table.
3208 =head2 include_columns
3212 =item Value: \@columns
3216 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3222 =item Value: \@select_columns
3226 Indicates which columns should be selected from the storage. You can use
3227 column names, or in the case of RDBMS back ends, function or stored procedure
3230 $rs = $schema->resultset('Employee')->search(undef, {
3233 { count => 'employeeid' },
3238 When you use function/stored procedure names and do not supply an C<as>
3239 attribute, the column names returned are storage-dependent. E.g. MySQL would
3240 return a column named C<count(employeeid)> in the above example.
3246 Indicates additional columns to be selected from storage. Works the same as
3247 L</select> but adds columns to the selection.
3255 Indicates additional column names for those added via L</+select>. See L</as>.
3263 =item Value: \@inflation_names
3267 Indicates column names for object inflation. That is, C<as>
3268 indicates the name that the column can be accessed as via the
3269 C<get_column> method (or via the object accessor, B<if one already
3270 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3272 The C<as> attribute is used in conjunction with C<select>,
3273 usually when C<select> contains one or more function or stored
3276 $rs = $schema->resultset('Employee')->search(undef, {
3279 { count => 'employeeid' }
3281 as => ['name', 'employee_count'],
3284 my $employee = $rs->first(); # get the first Employee
3286 If the object against which the search is performed already has an accessor
3287 matching a column name specified in C<as>, the value can be retrieved using
3288 the accessor as normal:
3290 my $name = $employee->name();
3292 If on the other hand an accessor does not exist in the object, you need to
3293 use C<get_column> instead:
3295 my $employee_count = $employee->get_column('employee_count');
3297 You can create your own accessors if required - see
3298 L<DBIx::Class::Manual::Cookbook> for details.
3300 Please note: This will NOT insert an C<AS employee_count> into the SQL
3301 statement produced, it is used for internal access only. Thus
3302 attempting to use the accessor in an C<order_by> clause or similar
3303 will fail miserably.
3305 To get around this limitation, you can supply literal SQL to your
3306 C<select> attibute that contains the C<AS alias> text, eg:
3308 select => [\'myfield AS alias']
3314 =item Value: ($rel_name | \@rel_names | \%rel_names)
3318 Contains a list of relationships that should be joined for this query. For
3321 # Get CDs by Nine Inch Nails
3322 my $rs = $schema->resultset('CD')->search(
3323 { 'artist.name' => 'Nine Inch Nails' },
3324 { join => 'artist' }
3327 Can also contain a hash reference to refer to the other relation's relations.
3330 package MyApp::Schema::Track;
3331 use base qw/DBIx::Class/;
3332 __PACKAGE__->table('track');
3333 __PACKAGE__->add_columns(qw/trackid cd position title/);
3334 __PACKAGE__->set_primary_key('trackid');
3335 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3338 # In your application
3339 my $rs = $schema->resultset('Artist')->search(
3340 { 'track.title' => 'Teardrop' },
3342 join => { cd => 'track' },
3343 order_by => 'artist.name',
3347 You need to use the relationship (not the table) name in conditions,
3348 because they are aliased as such. The current table is aliased as "me", so
3349 you need to use me.column_name in order to avoid ambiguity. For example:
3351 # Get CDs from 1984 with a 'Foo' track
3352 my $rs = $schema->resultset('CD')->search(
3355 'tracks.name' => 'Foo'
3357 { join => 'tracks' }
3360 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3361 similarly for a third time). For e.g.
3363 my $rs = $schema->resultset('Artist')->search({
3364 'cds.title' => 'Down to Earth',
3365 'cds_2.title' => 'Popular',
3367 join => [ qw/cds cds/ ],
3370 will return a set of all artists that have both a cd with title 'Down
3371 to Earth' and a cd with title 'Popular'.
3373 If you want to fetch related objects from other tables as well, see C<prefetch>
3376 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3382 =item Value: ($rel_name | \@rel_names | \%rel_names)
3386 Contains one or more relationships that should be fetched along with
3387 the main query (when they are accessed afterwards the data will
3388 already be available, without extra queries to the database). This is
3389 useful for when you know you will need the related objects, because it
3390 saves at least one query:
3392 my $rs = $schema->resultset('Tag')->search(
3401 The initial search results in SQL like the following:
3403 SELECT tag.*, cd.*, artist.* FROM tag
3404 JOIN cd ON tag.cd = cd.cdid
3405 JOIN artist ON cd.artist = artist.artistid
3407 L<DBIx::Class> has no need to go back to the database when we access the
3408 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3411 Simple prefetches will be joined automatically, so there is no need
3412 for a C<join> attribute in the above search.
3414 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3415 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3416 with an accessor type of 'single' or 'filter'). A more complex example that
3417 prefetches an artists cds, the tracks on those cds, and the tags associted
3418 with that artist is given below (assuming many-to-many from artists to tags):
3420 my $rs = $schema->resultset('Artist')->search(
3424 { cds => 'tracks' },
3425 { artist_tags => 'tags' }
3431 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3432 attributes will be ignored.
3434 B<CAVEATs>: Prefetch does a lot of deep magic. As such, it may not behave
3435 exactly as you might expect.
3441 Prefetch uses the L</cache> to populate the prefetched relationships. This
3442 may or may not be what you want.
3446 If you specify a condition on a prefetched relationship, ONLY those
3447 rows that match the prefetched condition will be fetched into that relationship.
3448 This means that adding prefetch to a search() B<may alter> what is returned by
3449 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
3451 my $artist_rs = $schema->resultset('Artist')->search({
3457 my $count = $artist_rs->first->cds->count;
3459 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
3461 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
3463 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
3465 that cmp_ok() may or may not pass depending on the datasets involved. This
3466 behavior may or may not survive the 0.09 transition.
3478 Makes the resultset paged and specifies the page to retrieve. Effectively
3479 identical to creating a non-pages resultset and then calling ->page($page)
3482 If L<rows> attribute is not specified it defaults to 10 rows per page.
3484 When you have a paged resultset, L</count> will only return the number
3485 of rows in the page. To get the total, use the L</pager> and call
3486 C<total_entries> on it.
3496 Specifes the maximum number of rows for direct retrieval or the number of
3497 rows per page if the page attribute or method is used.
3503 =item Value: $offset
3507 Specifies the (zero-based) row number for the first row to be returned, or the
3508 of the first row of the first page if paging is used.
3514 =item Value: \@columns
3518 A arrayref of columns to group by. Can include columns of joined tables.
3520 group_by => [qw/ column1 column2 ... /]
3526 =item Value: $condition
3530 HAVING is a select statement attribute that is applied between GROUP BY and
3531 ORDER BY. It is applied to the after the grouping calculations have been
3534 having => { 'count(employee)' => { '>=', 100 } }
3540 =item Value: (0 | 1)
3544 Set to 1 to group by all columns. If the resultset already has a group_by
3545 attribute, this setting is ignored and an appropriate warning is issued.
3551 Adds to the WHERE clause.
3553 # only return rows WHERE deleted IS NULL for all searches
3554 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3556 Can be overridden by passing C<{ where => undef }> as an attribute
3563 Set to 1 to cache search results. This prevents extra SQL queries if you
3564 revisit rows in your ResultSet:
3566 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3568 while( my $artist = $resultset->next ) {
3572 $rs->first; # without cache, this would issue a query
3574 By default, searches are not cached.
3576 For more examples of using these attributes, see
3577 L<DBIx::Class::Manual::Cookbook>.
3583 =item Value: \@from_clause
3587 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
3588 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
3591 NOTE: Use this on your own risk. This allows you to shoot off your foot!
3593 C<join> will usually do what you need and it is strongly recommended that you
3594 avoid using C<from> unless you cannot achieve the desired result using C<join>.
3595 And we really do mean "cannot", not just tried and failed. Attempting to use
3596 this because you're having problems with C<join> is like trying to use x86
3597 ASM because you've got a syntax error in your C. Trust us on this.
3599 Now, if you're still really, really sure you need to use this (and if you're
3600 not 100% sure, ask the mailing list first), here's an explanation of how this
3603 The syntax is as follows -
3606 { <alias1> => <table1> },
3608 { <alias2> => <table2>, -join_type => 'inner|left|right' },
3609 [], # nested JOIN (optional)
3610 { <table1.column1> => <table2.column2>, ... (more conditions) },
3612 # More of the above [ ] may follow for additional joins
3619 ON <table1.column1> = <table2.column2>
3620 <more joins may follow>
3622 An easy way to follow the examples below is to remember the following:
3624 Anything inside "[]" is a JOIN
3625 Anything inside "{}" is a condition for the enclosing JOIN
3627 The following examples utilize a "person" table in a family tree application.
3628 In order to express parent->child relationships, this table is self-joined:
3630 # Person->belongs_to('father' => 'Person');
3631 # Person->belongs_to('mother' => 'Person');
3633 C<from> can be used to nest joins. Here we return all children with a father,
3634 then search against all mothers of those children:
3636 $rs = $schema->resultset('Person')->search(
3639 alias => 'mother', # alias columns in accordance with "from"
3641 { mother => 'person' },
3644 { child => 'person' },
3646 { father => 'person' },
3647 { 'father.person_id' => 'child.father_id' }
3650 { 'mother.person_id' => 'child.mother_id' }
3657 # SELECT mother.* FROM person mother
3660 # JOIN person father
3661 # ON ( father.person_id = child.father_id )
3663 # ON ( mother.person_id = child.mother_id )
3665 The type of any join can be controlled manually. To search against only people
3666 with a father in the person table, we could explicitly use C<INNER JOIN>:
3668 $rs = $schema->resultset('Person')->search(
3671 alias => 'child', # alias columns in accordance with "from"
3673 { child => 'person' },
3675 { father => 'person', -join_type => 'inner' },
3676 { 'father.id' => 'child.father_id' }
3683 # SELECT child.* FROM person child
3684 # INNER JOIN person father ON child.father_id = father.id
3686 You can select from a subquery by passing a resultset to from as follows.
3688 $schema->resultset('Artist')->search(
3690 { alias => 'artist2',
3691 from => [ { artist2 => $artist_rs->as_query } ],
3694 # and you'll get sql like this..
3695 # SELECT artist2.artistid, artist2.name, artist2.rank, artist2.charfield FROM
3696 # ( SELECT me.artistid, me.name, me.rank, me.charfield FROM artists me ) artist2
3698 If you need to express really complex joins, you
3699 can supply literal SQL to C<from> via a scalar reference. In this case
3700 the contents of the scalar will replace the table name associated with the
3703 WARNING: This technique might very well not work as expected on chained
3704 searches - you have been warned.
3706 # Assuming the Event resultsource is defined as:
3708 MySchema::Event->add_columns (
3711 is_auto_increment => 1,
3720 MySchema::Event->set_primary_key ('sequence');
3722 # This will get back the latest event for every location. The column
3723 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3724 # combo to limit the resultset
3726 $rs = $schema->resultset('Event');
3727 $table = $rs->result_source->name;
3728 $latest = $rs->search (
3731 (SELECT e1.* FROM $table e1
3733 ON e1.location = e2.location
3734 AND e1.sequence < e2.sequence
3735 WHERE e2.sequence is NULL
3740 # Equivalent SQL (with the DBIC chunks added):
3742 SELECT me.sequence, me.location, me.type FROM
3743 (SELECT e1.* FROM events e1
3745 ON e1.location = e2.location
3746 AND e1.sequence < e2.sequence
3747 WHERE e2.sequence is NULL
3754 =item Value: ( 'update' | 'shared' )
3758 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT