1 package DBIx::Class::ResultSet;
9 use Carp::Clan qw/^DBIx::Class/;
12 use DBIx::Class::ResultSetColumn;
13 use DBIx::Class::ResultSourceHandle;
16 use base qw/DBIx::Class/;
18 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class _source_handle/);
22 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
26 my $users_rs = $schema->resultset('User');
27 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
28 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
32 A ResultSet is an object which stores a set of conditions representing
33 a query. It is the backbone of DBIx::Class (i.e. the really
34 important/useful bit).
36 No SQL is executed on the database when a ResultSet is created, it
37 just stores all the conditions needed to create the query.
39 A basic ResultSet representing the data of an entire table is returned
40 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
41 L<Source|DBIx::Class::Manual::Glossary/Source> name.
43 my $users_rs = $schema->resultset('User');
45 A new ResultSet is returned from calling L</search> on an existing
46 ResultSet. The new one will contain all the conditions of the
47 original, plus any new conditions added in the C<search> call.
49 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
50 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
53 The query that the ResultSet represents is B<only> executed against
54 the database when these methods are called:
55 L</find> L</next> L</all> L</first> L</single> L</count>
59 =head2 Chaining resultsets
61 Let's say you've got a query that needs to be run to return some data
62 to the user. But, you have an authorization system in place that
63 prevents certain users from seeing certain information. So, you want
64 to construct the basic query in one method, but add constraints to it in
69 my $request = $self->get_request; # Get a request object somehow.
70 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
72 my $cd_rs = $schema->resultset('CD')->search({
73 title => $request->param('title'),
74 year => $request->param('year'),
77 $self->apply_security_policy( $cd_rs );
82 sub apply_security_policy {
91 =head3 Resolving conditions and attributes
93 When a resultset is chained from another resultset, conditions and
94 attributes with the same keys need resolving.
96 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
97 into the existing ones from the original resultset.
99 The L</where>, L</having> attribute, and any search conditions are
100 merged with an SQL C<AND> to the existing condition from the original
103 All other attributes are overridden by any new ones supplied in the
106 =head2 Multiple queries
108 Since a resultset just defines a query, you can do all sorts of
109 things with it with the same object.
111 # Don't hit the DB yet.
112 my $cd_rs = $schema->resultset('CD')->search({
113 title => 'something',
117 # Each of these hits the DB individually.
118 my $count = $cd_rs->count;
119 my $most_recent = $cd_rs->get_column('date_released')->max();
120 my @records = $cd_rs->all;
122 And it's not just limited to SELECT statements.
128 $cd_rs->create({ artist => 'Fred' });
130 Which is the same as:
132 $schema->resultset('CD')->create({
133 title => 'something',
138 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
142 If a resultset is used in a numeric context it returns the L</count>.
143 However, if it is used in a booleand context it is always true. So if
144 you want to check if a resultset has any results use C<if $rs != 0>.
145 C<if $rs> will always be true.
153 =item Arguments: $source, \%$attrs
155 =item Return Value: $rs
159 The resultset constructor. Takes a source object (usually a
160 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
161 L</ATTRIBUTES> below). Does not perform any queries -- these are
162 executed as needed by the other methods.
164 Generally you won't need to construct a resultset manually. You'll
165 automatically get one from e.g. a L</search> called in scalar context:
167 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
169 IMPORTANT: If called on an object, proxies to new_result instead so
171 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
173 will return a CD object, not a ResultSet.
179 return $class->new_result(@_) if ref $class;
181 my ($source, $attrs) = @_;
182 $source = $source->handle
183 unless $source->isa('DBIx::Class::ResultSourceHandle');
184 $attrs = { %{$attrs||{}} };
186 if ($attrs->{page}) {
187 $attrs->{rows} ||= 10;
190 $attrs->{alias} ||= 'me';
192 # Creation of {} and bless separated to mitigate RH perl bug
193 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
195 _source_handle => $source,
196 cond => $attrs->{where},
205 $attrs->{result_class} || $source->resolve->result_class
215 =item Arguments: $cond, \%attrs?
217 =item Return Value: $resultset (scalar context), @row_objs (list context)
221 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
222 my $new_rs = $cd_rs->search({ year => 2005 });
224 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
225 # year = 2005 OR year = 2004
227 If you need to pass in additional attributes but no additional condition,
228 call it as C<search(undef, \%attrs)>.
230 # "SELECT name, artistid FROM $artist_table"
231 my @all_artists = $schema->resultset('Artist')->search(undef, {
232 columns => [qw/name artistid/],
235 For a list of attributes that can be passed to C<search>, see
236 L</ATTRIBUTES>. For more examples of using this function, see
237 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
238 documentation for the first argument, see L<SQL::Abstract>.
240 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
246 my $rs = $self->search_rs( @_ );
247 return (wantarray ? $rs->all : $rs);
254 =item Arguments: $cond, \%attrs?
256 =item Return Value: $resultset
260 This method does the same exact thing as search() except it will
261 always return a resultset, even in list context.
268 # Special-case handling for (undef, undef).
269 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
274 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
275 my $our_attrs = { %{$self->{attrs}} };
276 my $having = delete $our_attrs->{having};
277 my $where = delete $our_attrs->{where};
281 my %safe = (alias => 1, cache => 1);
284 (@_ && defined($_[0])) # @_ == () or (undef)
286 (keys %$attrs # empty attrs or only 'safe' attrs
287 && List::Util::first { !$safe{$_} } keys %$attrs)
289 # no search, effectively just a clone
290 $rows = $self->get_cache;
293 my $new_attrs = { %{$our_attrs}, %{$attrs} };
295 # merge new attrs into inherited
296 foreach my $key (qw/join prefetch +select +as bind/) {
297 next unless exists $attrs->{$key};
298 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
303 (@_ == 1 || ref $_[0] eq "HASH")
305 (ref $_[0] eq 'HASH')
307 (keys %{ $_[0] } > 0)
315 ? $self->throw_exception("Odd number of arguments to search")
322 if (defined $where) {
323 $new_attrs->{where} = (
324 defined $new_attrs->{where}
327 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
328 } $where, $new_attrs->{where}
335 $new_attrs->{where} = (
336 defined $new_attrs->{where}
339 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
340 } $cond, $new_attrs->{where}
346 if (defined $having) {
347 $new_attrs->{having} = (
348 defined $new_attrs->{having}
351 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
352 } $having, $new_attrs->{having}
358 my $rs = (ref $self)->new($self->result_source, $new_attrs);
360 $rs->set_cache($rows);
365 =head2 search_literal
369 =item Arguments: $sql_fragment, @bind_values
371 =item Return Value: $resultset (scalar context), @row_objs (list context)
375 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
376 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
378 Pass a literal chunk of SQL to be added to the conditional part of the
381 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
382 only be used in that context. C<search_literal> is a convenience method.
383 It is equivalent to calling $schema->search(\[]), but if you want to ensure
384 columns are bound correctly, use C<search>.
386 Example of how to use C<search> instead of C<search_literal>
388 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
389 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
392 See L<DBIx::Class::Manual::Cookbook/Searching> and
393 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
394 require C<search_literal>.
399 my ($self, $sql, @bind) = @_;
401 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
404 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
411 =item Arguments: @values | \%cols, \%attrs?
413 =item Return Value: $row_object | undef
417 Finds a row based on its primary key or unique constraint. For example, to find
418 a row by its primary key:
420 my $cd = $schema->resultset('CD')->find(5);
422 You can also find a row by a specific unique constraint using the C<key>
423 attribute. For example:
425 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
426 key => 'cd_artist_title'
429 Additionally, you can specify the columns explicitly by name:
431 my $cd = $schema->resultset('CD')->find(
433 artist => 'Massive Attack',
434 title => 'Mezzanine',
436 { key => 'cd_artist_title' }
439 If the C<key> is specified as C<primary>, it searches only on the primary key.
441 If no C<key> is specified, it searches on all unique constraints defined on the
442 source for which column data is provided, including the primary key.
444 If your table does not have a primary key, you B<must> provide a value for the
445 C<key> attribute matching one of the unique constraints on the source.
447 In addition to C<key>, L</find> recognizes and applies standard
448 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
450 Note: If your query does not return only one row, a warning is generated:
452 Query returned more than one row
454 See also L</find_or_create> and L</update_or_create>. For information on how to
455 declare unique constraints, see
456 L<DBIx::Class::ResultSource/add_unique_constraint>.
462 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
464 # Default to the primary key, but allow a specific key
465 my @cols = exists $attrs->{key}
466 ? $self->result_source->unique_constraint_columns($attrs->{key})
467 : $self->result_source->primary_columns;
468 $self->throw_exception(
469 "Can't find unless a primary key is defined or unique constraint is specified"
472 # Parse out a hashref from input
474 if (ref $_[0] eq 'HASH') {
475 $input_query = { %{$_[0]} };
477 elsif (@_ == @cols) {
479 @{$input_query}{@cols} = @_;
482 # Compatibility: Allow e.g. find(id => $value)
483 carp "Find by key => value deprecated; please use a hashref instead";
487 my (%related, $info);
489 KEY: foreach my $key (keys %$input_query) {
490 if (ref($input_query->{$key})
491 && ($info = $self->result_source->relationship_info($key))) {
492 my $val = delete $input_query->{$key};
493 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
494 my $rel_q = $self->result_source->_resolve_condition(
495 $info->{cond}, $val, $key
497 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
498 @related{keys %$rel_q} = values %$rel_q;
501 if (my @keys = keys %related) {
502 @{$input_query}{@keys} = values %related;
506 # Build the final query: Default to the disjunction of the unique queries,
507 # but allow the input query in case the ResultSet defines the query or the
508 # user is abusing find
509 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
511 if (exists $attrs->{key}) {
512 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
513 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
514 $query = $self->_add_alias($unique_query, $alias);
516 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
517 # This means that we got here after a merger of relationship conditions
518 # in ::Relationship::Base::search_related (the row method), and furthermore
519 # the relationship is of the 'single' type. This means that the condition
520 # provided by the relationship (already attached to $self) is sufficient,
521 # as there can be only one row in the databse that would satisfy the
525 my @unique_queries = $self->_unique_queries($input_query, $attrs);
526 $query = @unique_queries
527 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
528 : $self->_add_alias($input_query, $alias);
532 my $rs = $self->search ($query, $attrs);
533 if (keys %{$rs->_resolved_attrs->{collapse}}) {
535 carp "Query returned more than one row" if $rs->next;
545 # Add the specified alias to the specified query hash. A copy is made so the
546 # original query is not modified.
549 my ($self, $query, $alias) = @_;
551 my %aliased = %$query;
552 foreach my $col (grep { ! m/\./ } keys %aliased) {
553 $aliased{"$alias.$col"} = delete $aliased{$col};
561 # Build a list of queries which satisfy unique constraints.
563 sub _unique_queries {
564 my ($self, $query, $attrs) = @_;
566 my @constraint_names = exists $attrs->{key}
568 : $self->result_source->unique_constraint_names;
570 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
571 my $num_where = scalar keys %$where;
574 foreach my $name (@constraint_names) {
575 my @unique_cols = $self->result_source->unique_constraint_columns($name);
576 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
578 my $num_cols = scalar @unique_cols;
579 my $num_query = scalar keys %$unique_query;
581 my $total = $num_query + $num_where;
582 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
583 # The query is either unique on its own or is unique in combination with
584 # the existing where clause
585 push @unique_queries, $unique_query;
589 return @unique_queries;
592 # _build_unique_query
594 # Constrain the specified query hash based on the specified column names.
596 sub _build_unique_query {
597 my ($self, $query, $unique_cols) = @_;
600 map { $_ => $query->{$_} }
601 grep { exists $query->{$_} }
606 =head2 search_related
610 =item Arguments: $rel, $cond, \%attrs?
612 =item Return Value: $new_resultset
616 $new_rs = $cd_rs->search_related('artist', {
620 Searches the specified relationship, optionally specifying a condition and
621 attributes for matching records. See L</ATTRIBUTES> for more information.
626 return shift->related_resultset(shift)->search(@_);
629 =head2 search_related_rs
631 This method works exactly the same as search_related, except that
632 it guarantees a restultset, even in list context.
636 sub search_related_rs {
637 return shift->related_resultset(shift)->search_rs(@_);
644 =item Arguments: none
646 =item Return Value: $cursor
650 Returns a storage-driven cursor to the given resultset. See
651 L<DBIx::Class::Cursor> for more information.
658 my $attrs = $self->_resolved_attrs_copy;
660 return $self->{cursor}
661 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
662 $attrs->{where},$attrs);
669 =item Arguments: $cond?
671 =item Return Value: $row_object?
675 my $cd = $schema->resultset('CD')->single({ year => 2001 });
677 Inflates the first result without creating a cursor if the resultset has
678 any records in it; if not returns nothing. Used by L</find> as a lean version of
681 While this method can take an optional search condition (just like L</search>)
682 being a fast-code-path it does not recognize search attributes. If you need to
683 add extra joins or similar, call L</search> and then chain-call L</single> on the
684 L<DBIx::Class::ResultSet> returned.
690 As of 0.08100, this method enforces the assumption that the preceeding
691 query returns only one row. If more than one row is returned, you will receive
694 Query returned more than one row
696 In this case, you should be using L</next> or L</find> instead, or if you really
697 know what you are doing, use the L</rows> attribute to explicitly limit the size
700 This method will also throw an exception if it is called on a resultset prefetching
701 has_many, as such a prefetch implies fetching multiple rows from the database in
702 order to assemble the resulting object.
709 my ($self, $where) = @_;
711 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
714 my $attrs = $self->_resolved_attrs_copy;
716 if (keys %{$attrs->{collapse}}) {
717 $self->throw_exception(
718 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
723 if (defined $attrs->{where}) {
726 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
727 $where, delete $attrs->{where} ]
730 $attrs->{where} = $where;
734 # XXX: Disabled since it doesn't infer uniqueness in all cases
735 # unless ($self->_is_unique_query($attrs->{where})) {
736 # carp "Query not guaranteed to return a single row"
737 # . "; please declare your unique constraints or use search instead";
740 my @data = $self->result_source->storage->select_single(
741 $attrs->{from}, $attrs->{select},
742 $attrs->{where}, $attrs
745 return (@data ? ($self->_construct_object(@data))[0] : undef);
751 # Try to determine if the specified query is guaranteed to be unique, based on
752 # the declared unique constraints.
754 sub _is_unique_query {
755 my ($self, $query) = @_;
757 my $collapsed = $self->_collapse_query($query);
758 my $alias = $self->{attrs}{alias};
760 foreach my $name ($self->result_source->unique_constraint_names) {
761 my @unique_cols = map {
763 } $self->result_source->unique_constraint_columns($name);
765 # Count the values for each unique column
766 my %seen = map { $_ => 0 } @unique_cols;
768 foreach my $key (keys %$collapsed) {
769 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
770 next unless exists $seen{$aliased}; # Additional constraints are okay
771 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
774 # If we get 0 or more than 1 value for a column, it's not necessarily unique
775 return 1 unless grep { $_ != 1 } values %seen;
783 # Recursively collapse the query, accumulating values for each column.
785 sub _collapse_query {
786 my ($self, $query, $collapsed) = @_;
790 if (ref $query eq 'ARRAY') {
791 foreach my $subquery (@$query) {
792 next unless ref $subquery; # -or
793 $collapsed = $self->_collapse_query($subquery, $collapsed);
796 elsif (ref $query eq 'HASH') {
797 if (keys %$query and (keys %$query)[0] eq '-and') {
798 foreach my $subquery (@{$query->{-and}}) {
799 $collapsed = $self->_collapse_query($subquery, $collapsed);
803 foreach my $col (keys %$query) {
804 my $value = $query->{$col};
805 $collapsed->{$col}{$value}++;
817 =item Arguments: $cond?
819 =item Return Value: $resultsetcolumn
823 my $max_length = $rs->get_column('length')->max;
825 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
830 my ($self, $column) = @_;
831 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
839 =item Arguments: $cond, \%attrs?
841 =item Return Value: $resultset (scalar context), @row_objs (list context)
845 # WHERE title LIKE '%blue%'
846 $cd_rs = $rs->search_like({ title => '%blue%'});
848 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
849 that this is simply a convenience method retained for ex Class::DBI users.
850 You most likely want to use L</search> with specific operators.
852 For more information, see L<DBIx::Class::Manual::Cookbook>.
854 This method is deprecated and will be removed in 0.09. Use L</search()>
855 instead. An example conversion is:
857 ->search_like({ foo => 'bar' });
861 ->search({ foo => { like => 'bar' } });
868 'search_like() is deprecated and will be removed in DBIC version 0.09.'
869 .' Instead use ->search({ x => { -like => "y%" } })'
870 .' (note the outer pair of {}s - they are important!)'
872 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
873 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
874 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
875 return $class->search($query, { %$attrs });
882 =item Arguments: $first, $last
884 =item Return Value: $resultset (scalar context), @row_objs (list context)
888 Returns a resultset or object list representing a subset of elements from the
889 resultset slice is called on. Indexes are from 0, i.e., to get the first
892 my ($one, $two, $three) = $rs->slice(0, 2);
897 my ($self, $min, $max) = @_;
898 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
899 $attrs->{offset} = $self->{attrs}{offset} || 0;
900 $attrs->{offset} += $min;
901 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
902 return $self->search(undef(), $attrs);
903 #my $slice = (ref $self)->new($self->result_source, $attrs);
904 #return (wantarray ? $slice->all : $slice);
911 =item Arguments: none
913 =item Return Value: $result?
917 Returns the next element in the resultset (C<undef> is there is none).
919 Can be used to efficiently iterate over records in the resultset:
921 my $rs = $schema->resultset('CD')->search;
922 while (my $cd = $rs->next) {
926 Note that you need to store the resultset object, and call C<next> on it.
927 Calling C<< resultset('Table')->next >> repeatedly will always return the
928 first record from the resultset.
934 if (my $cache = $self->get_cache) {
935 $self->{all_cache_position} ||= 0;
936 return $cache->[$self->{all_cache_position}++];
938 if ($self->{attrs}{cache}) {
939 $self->{all_cache_position} = 1;
940 return ($self->all)[0];
942 if ($self->{stashed_objects}) {
943 my $obj = shift(@{$self->{stashed_objects}});
944 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
948 exists $self->{stashed_row}
949 ? @{delete $self->{stashed_row}}
950 : $self->cursor->next
952 return undef unless (@row);
953 my ($row, @more) = $self->_construct_object(@row);
954 $self->{stashed_objects} = \@more if @more;
958 sub _construct_object {
959 my ($self, @row) = @_;
960 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
961 my @new = $self->result_class->inflate_result($self->result_source, @$info);
962 @new = $self->{_attrs}{record_filter}->(@new)
963 if exists $self->{_attrs}{record_filter};
967 sub _collapse_result {
968 my ($self, $as_proto, $row) = @_;
972 # 'foo' => [ undef, 'foo' ]
973 # 'foo.bar' => [ 'foo', 'bar' ]
974 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
976 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
978 my %collapse = %{$self->{_attrs}{collapse}||{}};
982 # if we're doing collapsing (has_many prefetch) we need to grab records
983 # until the PK changes, so fill @pri_index. if not, we leave it empty so
984 # we know we don't have to bother.
986 # the reason for not using the collapse stuff directly is because if you
987 # had for e.g. two artists in a row with no cds, the collapse info for
988 # both would be NULL (undef) so you'd lose the second artist
990 # store just the index so we can check the array positions from the row
991 # without having to contruct the full hash
993 if (keys %collapse) {
994 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
995 foreach my $i (0 .. $#construct_as) {
996 next if defined($construct_as[$i][0]); # only self table
997 if (delete $pri{$construct_as[$i][1]}) {
998 push(@pri_index, $i);
1000 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1004 # no need to do an if, it'll be empty if @pri_index is empty anyway
1006 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1010 do { # no need to check anything at the front, we always want the first row
1014 foreach my $this_as (@construct_as) {
1015 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1018 push(@const_rows, \%const);
1020 } until ( # no pri_index => no collapse => drop straight out
1023 do { # get another row, stash it, drop out if different PK
1025 @copy = $self->cursor->next;
1026 $self->{stashed_row} = \@copy;
1028 # last thing in do block, counts as true if anything doesn't match
1030 # check xor defined first for NULL vs. NOT NULL then if one is
1031 # defined the other must be so check string equality
1034 (defined $pri_vals{$_} ^ defined $copy[$_])
1035 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1040 my $alias = $self->{attrs}{alias};
1047 foreach my $const (@const_rows) {
1048 scalar @const_keys or do {
1049 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1051 foreach my $key (@const_keys) {
1054 my @parts = split(/\./, $key);
1056 my $data = $const->{$key};
1057 foreach my $p (@parts) {
1058 $target = $target->[1]->{$p} ||= [];
1060 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1061 # collapsing at this point and on final part
1062 my $pos = $collapse_pos{$cur};
1063 CK: foreach my $ck (@ckey) {
1064 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1065 $collapse_pos{$cur} = $data;
1066 delete @collapse_pos{ # clear all positioning for sub-entries
1067 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1074 if (exists $collapse{$cur}) {
1075 $target = $target->[-1];
1078 $target->[0] = $data;
1080 $info->[0] = $const->{$key};
1088 =head2 result_source
1092 =item Arguments: $result_source?
1094 =item Return Value: $result_source
1098 An accessor for the primary ResultSource object from which this ResultSet
1105 =item Arguments: $result_class?
1107 =item Return Value: $result_class
1111 An accessor for the class to use when creating row objects. Defaults to
1112 C<< result_source->result_class >> - which in most cases is the name of the
1113 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1115 Note that changing the result_class will also remove any components
1116 that were originally loaded in the source class via
1117 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1118 in the original source class will not run.
1123 my ($self, $result_class) = @_;
1124 if ($result_class) {
1125 $self->ensure_class_loaded($result_class);
1126 $self->_result_class($result_class);
1128 $self->_result_class;
1135 =item Arguments: $cond, \%attrs??
1137 =item Return Value: $count
1141 Performs an SQL C<COUNT> with the same query as the resultset was built
1142 with to find the number of elements. Passing arguments is equivalent to
1143 C<< $rs->search ($cond, \%attrs)->count >>
1149 return $self->search(@_)->count if @_ and defined $_[0];
1150 return scalar @{ $self->get_cache } if $self->get_cache;
1152 my $attrs = $self->_resolved_attrs_copy;
1154 # this is a little optimization - it is faster to do the limit
1155 # adjustments in software, instead of a subquery
1156 my $rows = delete $attrs->{rows};
1157 my $offset = delete $attrs->{offset};
1160 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1161 $crs = $self->_count_subq_rs ($attrs);
1164 $crs = $self->_count_rs ($attrs);
1166 my $count = $crs->next;
1168 $count -= $offset if $offset;
1169 $count = $rows if $rows and $rows < $count;
1170 $count = 0 if ($count < 0);
1179 =item Arguments: $cond, \%attrs??
1181 =item Return Value: $count_rs
1185 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1186 This can be very handy for subqueries:
1188 ->search( { amount => $some_rs->count_rs->as_query } )
1190 As with regular resultsets the SQL query will be executed only after
1191 the resultset is accessed via L</next> or L</all>. That would return
1192 the same single value obtainable via L</count>.
1198 return $self->search(@_)->count_rs if @_;
1200 # this may look like a lack of abstraction (count() does about the same)
1201 # but in fact an _rs *must* use a subquery for the limits, as the
1202 # software based limiting can not be ported if this $rs is to be used
1203 # in a subquery itself (i.e. ->as_query)
1204 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1205 return $self->_count_subq_rs;
1208 return $self->_count_rs;
1213 # returns a ResultSetColumn object tied to the count query
1216 my ($self, $attrs) = @_;
1218 my $rsrc = $self->result_source;
1219 $attrs ||= $self->_resolved_attrs;
1221 my $tmp_attrs = { %$attrs };
1223 # take off any limits, record_filter is cdbi, and no point of ordering a count
1224 delete $tmp_attrs->{$_} for (qw/select as rows offset order_by record_filter/);
1226 # overwrite the selector (supplied by the storage)
1227 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $tmp_attrs);
1228 $tmp_attrs->{as} = 'count';
1230 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1236 # same as above but uses a subquery
1238 sub _count_subq_rs {
1239 my ($self, $attrs) = @_;
1241 my $rsrc = $self->result_source;
1242 $attrs ||= $self->_resolved_attrs_copy;
1244 my $sub_attrs = { %$attrs };
1246 # extra selectors do not go in the subquery and there is no point of ordering it
1247 delete $sub_attrs->{$_} for qw/collapse prefetch_select select as order_by/;
1249 # if we prefetch, we group_by primary keys only as this is what we would get out of the rs via ->next/->all
1250 # clobber old group_by regardless
1251 if ( keys %{$attrs->{collapse}} ) {
1252 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } ($rsrc->primary_columns) ]
1255 $sub_attrs->{select} = $rsrc->storage->_subq_count_select ($rsrc, $sub_attrs);
1257 # this is so that ordering can be thrown away in things like Top limit
1258 $sub_attrs->{-for_count_only} = 1;
1260 my $sub_rs = $rsrc->resultset_class->new ($rsrc, $sub_attrs);
1262 -alias => 'count_subq',
1263 -source_handle => $rsrc->handle,
1264 count_subq => $sub_rs->as_query,
1267 # the subquery replaces this
1268 delete $attrs->{$_} for qw/where bind collapse group_by having having_bind rows offset/;
1270 return $self->_count_rs ($attrs);
1278 =head2 count_literal
1282 =item Arguments: $sql_fragment, @bind_values
1284 =item Return Value: $count
1288 Counts the results in a literal query. Equivalent to calling L</search_literal>
1289 with the passed arguments, then L</count>.
1293 sub count_literal { shift->search_literal(@_)->count; }
1299 =item Arguments: none
1301 =item Return Value: @objects
1305 Returns all elements in the resultset. Called implicitly if the resultset
1306 is returned in list context.
1313 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1316 return @{ $self->get_cache } if $self->get_cache;
1320 if (keys %{$self->_resolved_attrs->{collapse}}) {
1321 # Using $self->cursor->all is really just an optimisation.
1322 # If we're collapsing has_many prefetches it probably makes
1323 # very little difference, and this is cleaner than hacking
1324 # _construct_object to survive the approach
1325 $self->cursor->reset;
1326 my @row = $self->cursor->next;
1328 push(@obj, $self->_construct_object(@row));
1329 @row = (exists $self->{stashed_row}
1330 ? @{delete $self->{stashed_row}}
1331 : $self->cursor->next);
1334 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1337 $self->set_cache(\@obj) if $self->{attrs}{cache};
1345 =item Arguments: none
1347 =item Return Value: $self
1351 Resets the resultset's cursor, so you can iterate through the elements again.
1352 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1359 delete $self->{_attrs} if exists $self->{_attrs};
1360 $self->{all_cache_position} = 0;
1361 $self->cursor->reset;
1369 =item Arguments: none
1371 =item Return Value: $object?
1375 Resets the resultset and returns an object for the first result (if the
1376 resultset returns anything).
1381 return $_[0]->reset->next;
1387 # Determines whether and what type of subquery is required for the $rs operation.
1388 # If grouping is necessary either supplies its own, or verifies the current one
1389 # After all is done delegates to the proper storage method.
1391 sub _rs_update_delete {
1392 my ($self, $op, $values) = @_;
1394 my $rsrc = $self->result_source;
1396 my $needs_group_by_subq = $self->_has_resolved_attr (qw/collapse group_by -join/);
1397 my $needs_subq = $self->_has_resolved_attr (qw/row offset/);
1399 if ($needs_group_by_subq or $needs_subq) {
1401 # make a new $rs selecting only the PKs (that's all we really need)
1402 my $attrs = $self->_resolved_attrs_copy;
1404 delete $attrs->{$_} for qw/collapse select as/;
1405 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } ($self->result_source->primary_columns) ];
1407 if ($needs_group_by_subq) {
1408 # make sure no group_by was supplied, or if there is one - make sure it matches
1409 # the columns compiled above perfectly. Anything else can not be sanely executed
1410 # on most databases so croak right then and there
1412 if (my $g = $attrs->{group_by}) {
1413 my @current_group_by = map
1414 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1415 (ref $g eq 'ARRAY' ? @$g : $g );
1418 join ("\x00", sort @current_group_by)
1420 join ("\x00", sort @{$attrs->{columns}} )
1422 $self->throw_exception (
1423 "You have just attempted a $op operation on a resultset which does group_by"
1424 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1425 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1426 . ' kind of queries. Please retry the operation with a modified group_by or'
1427 . ' without using one at all.'
1432 $attrs->{group_by} = $attrs->{columns};
1436 my $subrs = (ref $self)->new($rsrc, $attrs);
1438 return $self->result_source->storage->_subq_update_delete($subrs, $op, $values);
1441 return $rsrc->storage->$op(
1443 $op eq 'update' ? $values : (),
1444 $self->_cond_for_update_delete,
1450 # _cond_for_update_delete
1452 # update/delete require the condition to be modified to handle
1453 # the differing SQL syntax available. This transforms the $self->{cond}
1454 # appropriately, returning the new condition.
1456 sub _cond_for_update_delete {
1457 my ($self, $full_cond) = @_;
1460 $full_cond ||= $self->{cond};
1461 # No-op. No condition, we're updating/deleting everything
1462 return $cond unless ref $full_cond;
1464 if (ref $full_cond eq 'ARRAY') {
1468 foreach my $key (keys %{$_}) {
1470 $hash{$1} = $_->{$key};
1476 elsif (ref $full_cond eq 'HASH') {
1477 if ((keys %{$full_cond})[0] eq '-and') {
1479 my @cond = @{$full_cond->{-and}};
1480 for (my $i = 0; $i < @cond; $i++) {
1481 my $entry = $cond[$i];
1483 if (ref $entry eq 'HASH') {
1484 $hash = $self->_cond_for_update_delete($entry);
1487 $entry =~ /([^.]+)$/;
1488 $hash->{$1} = $cond[++$i];
1490 push @{$cond->{-and}}, $hash;
1494 foreach my $key (keys %{$full_cond}) {
1496 $cond->{$1} = $full_cond->{$key};
1501 $self->throw_exception("Can't update/delete on resultset with condition unless hash or array");
1512 =item Arguments: \%values
1514 =item Return Value: $storage_rv
1518 Sets the specified columns in the resultset to the supplied values in a
1519 single query. Return value will be true if the update succeeded or false
1520 if no records were updated; exact type of success value is storage-dependent.
1525 my ($self, $values) = @_;
1526 $self->throw_exception('Values for update must be a hash')
1527 unless ref $values eq 'HASH';
1529 return $self->_rs_update_delete ('update', $values);
1536 =item Arguments: \%values
1538 =item Return Value: 1
1542 Fetches all objects and updates them one at a time. Note that C<update_all>
1543 will run DBIC cascade triggers, while L</update> will not.
1548 my ($self, $values) = @_;
1549 $self->throw_exception('Values for update_all must be a hash')
1550 unless ref $values eq 'HASH';
1551 foreach my $obj ($self->all) {
1552 $obj->set_columns($values)->update;
1561 =item Arguments: none
1563 =item Return Value: $storage_rv
1567 Deletes the contents of the resultset from its result source. Note that this
1568 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1569 to run. See also L<DBIx::Class::Row/delete>.
1571 Return value will be the amount of rows deleted; exact type of return value
1572 is storage-dependent.
1578 $self->throw_exception('delete does not accept any arguments')
1581 return $self->_rs_update_delete ('delete');
1588 =item Arguments: none
1590 =item Return Value: 1
1594 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1595 will run DBIC cascade triggers, while L</delete> will not.
1601 $self->throw_exception('delete_all does not accept any arguments')
1604 $_->delete for $self->all;
1612 =item Arguments: \@data;
1616 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1617 For the arrayref of hashrefs style each hashref should be a structure suitable
1618 forsubmitting to a $resultset->create(...) method.
1620 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1621 to insert the data, as this is a faster method.
1623 Otherwise, each set of data is inserted into the database using
1624 L<DBIx::Class::ResultSet/create>, and the resulting objects are
1625 accumulated into an array. The array itself, or an array reference
1626 is returned depending on scalar or list context.
1628 Example: Assuming an Artist Class that has many CDs Classes relating:
1630 my $Artist_rs = $schema->resultset("Artist");
1632 ## Void Context Example
1633 $Artist_rs->populate([
1634 { artistid => 4, name => 'Manufactured Crap', cds => [
1635 { title => 'My First CD', year => 2006 },
1636 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1639 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1640 { title => 'My parents sold me to a record company' ,year => 2005 },
1641 { title => 'Why Am I So Ugly?', year => 2006 },
1642 { title => 'I Got Surgery and am now Popular', year => 2007 }
1647 ## Array Context Example
1648 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1649 { name => "Artist One"},
1650 { name => "Artist Two"},
1651 { name => "Artist Three", cds=> [
1652 { title => "First CD", year => 2007},
1653 { title => "Second CD", year => 2008},
1657 print $ArtistOne->name; ## response is 'Artist One'
1658 print $ArtistThree->cds->count ## reponse is '2'
1660 For the arrayref of arrayrefs style, the first element should be a list of the
1661 fieldsnames to which the remaining elements are rows being inserted. For
1664 $Arstist_rs->populate([
1665 [qw/artistid name/],
1666 [100, 'A Formally Unknown Singer'],
1667 [101, 'A singer that jumped the shark two albums ago'],
1668 [102, 'An actually cool singer.'],
1671 Please note an important effect on your data when choosing between void and
1672 wantarray context. Since void context goes straight to C<insert_bulk> in
1673 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1674 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1675 create primary keys for you, you will find that your PKs are empty. In this
1676 case you will have to use the wantarray context in order to create those
1682 my $self = shift @_;
1683 my $data = ref $_[0][0] eq 'HASH'
1684 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1685 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1687 if(defined wantarray) {
1689 foreach my $item (@$data) {
1690 push(@created, $self->create($item));
1692 return wantarray ? @created : \@created;
1694 my ($first, @rest) = @$data;
1696 my @names = grep {!ref $first->{$_}} keys %$first;
1697 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1698 my @pks = $self->result_source->primary_columns;
1700 ## do the belongs_to relationships
1701 foreach my $index (0..$#$data) {
1703 # delegate to create() for any dataset without primary keys with specified relationships
1704 if (grep { !defined $data->[$index]->{$_} } @pks ) {
1706 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
1707 my @ret = $self->populate($data);
1713 foreach my $rel (@rels) {
1714 next unless ref $data->[$index]->{$rel} eq "HASH";
1715 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1716 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1717 my $related = $result->result_source->_resolve_condition(
1718 $result->result_source->relationship_info($reverse)->{cond},
1723 delete $data->[$index]->{$rel};
1724 $data->[$index] = {%{$data->[$index]}, %$related};
1726 push @names, keys %$related if $index == 0;
1730 ## do bulk insert on current row
1731 my @values = map { [ @$_{@names} ] } @$data;
1733 $self->result_source->storage->insert_bulk(
1734 $self->result_source,
1739 ## do the has_many relationships
1740 foreach my $item (@$data) {
1742 foreach my $rel (@rels) {
1743 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1745 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1746 || $self->throw_exception('Cannot find the relating object.');
1748 my $child = $parent->$rel;
1750 my $related = $child->result_source->_resolve_condition(
1751 $parent->result_source->relationship_info($rel)->{cond},
1756 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1757 my @populate = map { {%$_, %$related} } @rows_to_add;
1759 $child->populate( \@populate );
1765 =head2 _normalize_populate_args ($args)
1767 Private method used by L</populate> to normalize its incoming arguments. Factored
1768 out in case you want to subclass and accept new argument structures to the
1769 L</populate> method.
1773 sub _normalize_populate_args {
1774 my ($self, $data) = @_;
1775 my @names = @{shift(@$data)};
1776 my @results_to_create;
1777 foreach my $datum (@$data) {
1778 my %result_to_create;
1779 foreach my $index (0..$#names) {
1780 $result_to_create{$names[$index]} = $$datum[$index];
1782 push @results_to_create, \%result_to_create;
1784 return \@results_to_create;
1791 =item Arguments: none
1793 =item Return Value: $pager
1797 Return Value a L<Data::Page> object for the current resultset. Only makes
1798 sense for queries with a C<page> attribute.
1800 To get the full count of entries for a paged resultset, call
1801 C<total_entries> on the L<Data::Page> object.
1808 return $self->{pager} if $self->{pager};
1810 my $attrs = $self->{attrs};
1811 $self->throw_exception("Can't create pager for non-paged rs")
1812 unless $self->{attrs}{page};
1813 $attrs->{rows} ||= 10;
1815 # throw away the paging flags and re-run the count (possibly
1816 # with a subselect) to get the real total count
1817 my $count_attrs = { %$attrs };
1818 delete $count_attrs->{$_} for qw/rows offset page pager/;
1819 my $total_count = (ref $self)->new($self->result_source, $count_attrs)->count;
1821 return $self->{pager} = Data::Page->new(
1824 $self->{attrs}{page}
1832 =item Arguments: $page_number
1834 =item Return Value: $rs
1838 Returns a resultset for the $page_number page of the resultset on which page
1839 is called, where each page contains a number of rows equal to the 'rows'
1840 attribute set on the resultset (10 by default).
1845 my ($self, $page) = @_;
1846 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1853 =item Arguments: \%vals
1855 =item Return Value: $rowobject
1859 Creates a new row object in the resultset's result class and returns
1860 it. The row is not inserted into the database at this point, call
1861 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1862 will tell you whether the row object has been inserted or not.
1864 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1869 my ($self, $values) = @_;
1870 $self->throw_exception( "new_result needs a hash" )
1871 unless (ref $values eq 'HASH');
1874 my $alias = $self->{attrs}{alias};
1877 defined $self->{cond}
1878 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1880 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1881 $new{-from_resultset} = [ keys %new ] if keys %new;
1883 $self->throw_exception(
1884 "Can't abstract implicit construct, condition not a hash"
1885 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1887 my $collapsed_cond = (
1889 ? $self->_collapse_cond($self->{cond})
1893 # precendence must be given to passed values over values inherited from
1894 # the cond, so the order here is important.
1895 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{$col} = $value->{'='};
1901 $new{$col} = $value if $self->_is_deterministic_value($value);
1907 %{ $self->_remove_alias($values, $alias) },
1908 -source_handle => $self->_source_handle,
1909 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1912 return $self->result_class->new(\%new);
1915 # _is_deterministic_value
1917 # Make an effor to strip non-deterministic values from the condition,
1918 # to make sure new_result chokes less
1920 sub _is_deterministic_value {
1923 my $ref_type = ref $value;
1924 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1925 return 1 if Scalar::Util::blessed($value);
1929 # _has_resolved_attr
1931 # determines if the resultset defines at least one
1932 # of the attributes supplied
1934 # used to determine if a subquery is neccessary
1936 sub _has_resolved_attr {
1937 my ($self, @attr_names) = @_;
1939 my $attrs = $self->_resolved_attrs;
1943 for my $n (@attr_names) {
1944 ++$join_check_req if $n eq '-join';
1946 my $attr = $attrs->{$n};
1948 next if not defined $attr;
1950 if (ref $attr eq 'HASH') {
1951 return 1 if keys %$attr;
1953 elsif (ref $attr eq 'ARRAY') {
1961 # a resolved join is expressed as a multi-level from
1965 ref $attrs->{from} eq 'ARRAY'
1967 @{$attrs->{from}} > 1
1975 # Recursively collapse the condition.
1977 sub _collapse_cond {
1978 my ($self, $cond, $collapsed) = @_;
1982 if (ref $cond eq 'ARRAY') {
1983 foreach my $subcond (@$cond) {
1984 next unless ref $subcond; # -or
1985 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1988 elsif (ref $cond eq 'HASH') {
1989 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1990 foreach my $subcond (@{$cond->{-and}}) {
1991 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1995 foreach my $col (keys %$cond) {
1996 my $value = $cond->{$col};
1997 $collapsed->{$col} = $value;
2007 # Remove the specified alias from the specified query hash. A copy is made so
2008 # the original query is not modified.
2011 my ($self, $query, $alias) = @_;
2013 my %orig = %{ $query || {} };
2016 foreach my $key (keys %orig) {
2018 $unaliased{$key} = $orig{$key};
2021 $unaliased{$1} = $orig{$key}
2022 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2028 =head2 as_query (EXPERIMENTAL)
2032 =item Arguments: none
2034 =item Return Value: \[ $sql, @bind ]
2038 Returns the SQL query and bind vars associated with the invocant.
2040 This is generally used as the RHS for a subquery.
2042 B<NOTE>: This feature is still experimental.
2049 my $attrs = $self->_resolved_attrs_copy;
2054 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2055 # $sql also has no wrapping parenthesis in list ctx
2057 my $sqlbind = $self->result_source->storage
2058 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2067 =item Arguments: \%vals, \%attrs?
2069 =item Return Value: $rowobject
2073 my $artist = $schema->resultset('Artist')->find_or_new(
2074 { artist => 'fred' }, { key => 'artists' });
2076 $cd->cd_to_producer->find_or_new({ producer => $producer },
2077 { key => 'primary });
2079 Find an existing record from this resultset, based on its primary
2080 key, or a unique constraint. If none exists, instantiate a new result
2081 object and return it. The object will not be saved into your storage
2082 until you call L<DBIx::Class::Row/insert> on it.
2084 You most likely want this method when looking for existing rows using
2085 a unique constraint that is not the primary key, or looking for
2088 If you want objects to be saved immediately, use L</find_or_create> instead.
2090 B<Note>: C<find_or_new> is probably not what you want when creating a
2091 new row in a table that uses primary keys supplied by the
2092 database. Passing in a primary key column with a value of I<undef>
2093 will cause L</find> to attempt to search for a row with a value of
2100 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2101 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2102 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2105 return $self->new_result($hash);
2112 =item Arguments: \%vals
2114 =item Return Value: a L<DBIx::Class::Row> $object
2118 Attempt to create a single new row or a row with multiple related rows
2119 in the table represented by the resultset (and related tables). This
2120 will not check for duplicate rows before inserting, use
2121 L</find_or_create> to do that.
2123 To create one row for this resultset, pass a hashref of key/value
2124 pairs representing the columns of the table and the values you wish to
2125 store. If the appropriate relationships are set up, foreign key fields
2126 can also be passed an object representing the foreign row, and the
2127 value will be set to its primary key.
2129 To create related objects, pass a hashref for the value if the related
2130 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
2131 and use the name of the relationship as the key. (NOT the name of the field,
2132 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
2133 of hashrefs containing the data for each of the rows to create in the foreign
2134 tables, again using the relationship name as the key.
2136 Instead of hashrefs of plain related data (key/value pairs), you may
2137 also pass new or inserted objects. New objects (not inserted yet, see
2138 L</new>), will be inserted into their appropriate tables.
2140 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2142 Example of creating a new row.
2144 $person_rs->create({
2145 name=>"Some Person",
2146 email=>"somebody@someplace.com"
2149 Example of creating a new row and also creating rows in a related C<has_many>
2150 or C<has_one> resultset. Note Arrayref.
2153 { artistid => 4, name => 'Manufactured Crap', cds => [
2154 { title => 'My First CD', year => 2006 },
2155 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2160 Example of creating a new row and also creating a row in a related
2161 C<belongs_to>resultset. Note Hashref.
2164 title=>"Music for Silly Walks",
2167 name=>"Silly Musician",
2174 my ($self, $attrs) = @_;
2175 $self->throw_exception( "create needs a hashref" )
2176 unless ref $attrs eq 'HASH';
2177 return $self->new_result($attrs)->insert;
2180 =head2 find_or_create
2184 =item Arguments: \%vals, \%attrs?
2186 =item Return Value: $rowobject
2190 $cd->cd_to_producer->find_or_create({ producer => $producer },
2191 { key => 'primary' });
2193 Tries to find a record based on its primary key or unique constraints; if none
2194 is found, creates one and returns that instead.
2196 my $cd = $schema->resultset('CD')->find_or_create({
2198 artist => 'Massive Attack',
2199 title => 'Mezzanine',
2203 Also takes an optional C<key> attribute, to search by a specific key or unique
2204 constraint. For example:
2206 my $cd = $schema->resultset('CD')->find_or_create(
2208 artist => 'Massive Attack',
2209 title => 'Mezzanine',
2211 { key => 'cd_artist_title' }
2214 B<Note>: Because find_or_create() reads from the database and then
2215 possibly inserts based on the result, this method is subject to a race
2216 condition. Another process could create a record in the table after
2217 the find has completed and before the create has started. To avoid
2218 this problem, use find_or_create() inside a transaction.
2220 B<Note>: C<find_or_create> is probably not what you want when creating
2221 a new row in a table that uses primary keys supplied by the
2222 database. Passing in a primary key column with a value of I<undef>
2223 will cause L</find> to attempt to search for a row with a value of
2226 See also L</find> and L</update_or_create>. For information on how to declare
2227 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2231 sub find_or_create {
2233 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2234 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2235 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2238 return $self->create($hash);
2241 =head2 update_or_create
2245 =item Arguments: \%col_values, { key => $unique_constraint }?
2247 =item Return Value: $rowobject
2251 $resultset->update_or_create({ col => $val, ... });
2253 First, searches for an existing row matching one of the unique constraints
2254 (including the primary key) on the source of this resultset. If a row is
2255 found, updates it with the other given column values. Otherwise, creates a new
2258 Takes an optional C<key> attribute to search on a specific unique constraint.
2261 # In your application
2262 my $cd = $schema->resultset('CD')->update_or_create(
2264 artist => 'Massive Attack',
2265 title => 'Mezzanine',
2268 { key => 'cd_artist_title' }
2271 $cd->cd_to_producer->update_or_create({
2272 producer => $producer,
2279 If no C<key> is specified, it searches on all unique constraints defined on the
2280 source, including the primary key.
2282 If the C<key> is specified as C<primary>, it searches only on the primary key.
2284 See also L</find> and L</find_or_create>. For information on how to declare
2285 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2287 B<Note>: C<update_or_create> is probably not what you want when
2288 looking for a row in a table that uses primary keys supplied by the
2289 database, unless you actually have a key value. Passing in a primary
2290 key column with a value of I<undef> will cause L</find> to attempt to
2291 search for a row with a value of I<NULL>.
2295 sub update_or_create {
2297 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2298 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2300 my $row = $self->find($cond, $attrs);
2302 $row->update($cond);
2306 return $self->create($cond);
2309 =head2 update_or_new
2313 =item Arguments: \%col_values, { key => $unique_constraint }?
2315 =item Return Value: $rowobject
2319 $resultset->update_or_new({ col => $val, ... });
2321 First, searches for an existing row matching one of the unique constraints
2322 (including the primary key) on the source of this resultset. If a row is
2323 found, updates it with the other given column values. Otherwise, instantiate
2324 a new result object and return it. The object will not be saved into your storage
2325 until you call L<DBIx::Class::Row/insert> on it.
2327 Takes an optional C<key> attribute to search on a specific unique constraint.
2330 # In your application
2331 my $cd = $schema->resultset('CD')->update_or_new(
2333 artist => 'Massive Attack',
2334 title => 'Mezzanine',
2337 { key => 'cd_artist_title' }
2340 if ($cd->in_storage) {
2341 # the cd was updated
2344 # the cd is not yet in the database, let's insert it
2348 See also L</find>, L</find_or_create> and L<find_or_new>.
2354 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2355 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2357 my $row = $self->find( $cond, $attrs );
2358 if ( defined $row ) {
2359 $row->update($cond);
2363 return $self->new_result($cond);
2370 =item Arguments: none
2372 =item Return Value: \@cache_objects?
2376 Gets the contents of the cache for the resultset, if the cache is set.
2378 The cache is populated either by using the L</prefetch> attribute to
2379 L</search> or by calling L</set_cache>.
2391 =item Arguments: \@cache_objects
2393 =item Return Value: \@cache_objects
2397 Sets the contents of the cache for the resultset. Expects an arrayref
2398 of objects of the same class as those produced by the resultset. Note that
2399 if the cache is set the resultset will return the cached objects rather
2400 than re-querying the database even if the cache attr is not set.
2402 The contents of the cache can also be populated by using the
2403 L</prefetch> attribute to L</search>.
2408 my ( $self, $data ) = @_;
2409 $self->throw_exception("set_cache requires an arrayref")
2410 if defined($data) && (ref $data ne 'ARRAY');
2411 $self->{all_cache} = $data;
2418 =item Arguments: none
2420 =item Return Value: []
2424 Clears the cache for the resultset.
2429 shift->set_cache(undef);
2432 =head2 related_resultset
2436 =item Arguments: $relationship_name
2438 =item Return Value: $resultset
2442 Returns a related resultset for the supplied relationship name.
2444 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2448 sub related_resultset {
2449 my ($self, $rel) = @_;
2451 $self->{related_resultsets} ||= {};
2452 return $self->{related_resultsets}{$rel} ||= do {
2453 my $rel_info = $self->result_source->relationship_info($rel);
2455 $self->throw_exception(
2456 "search_related: result source '" . $self->result_source->source_name .
2457 "' has no such relationship $rel")
2460 my ($from,$seen) = $self->_chain_relationship($rel);
2462 my $join_count = $seen->{$rel};
2463 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2465 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2466 my %attrs = %{$self->{attrs}||{}};
2467 delete @attrs{qw(result_class alias)};
2471 if (my $cache = $self->get_cache) {
2472 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2473 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2478 my $rel_source = $self->result_source->related_source($rel);
2482 # The reason we do this now instead of passing the alias to the
2483 # search_rs below is that if you wrap/overload resultset on the
2484 # source you need to know what alias it's -going- to have for things
2485 # to work sanely (e.g. RestrictWithObject wants to be able to add
2486 # extra query restrictions, and these may need to be $alias.)
2488 my $attrs = $rel_source->resultset_attributes;
2489 local $attrs->{alias} = $alias;
2491 $rel_source->resultset
2499 where => $self->{cond},
2504 $new->set_cache($new_cache) if $new_cache;
2509 =head2 current_source_alias
2513 =item Arguments: none
2515 =item Return Value: $source_alias
2519 Returns the current table alias for the result source this resultset is built
2520 on, that will be used in the SQL query. Usually it is C<me>.
2522 Currently the source alias that refers to the result set returned by a
2523 L</search>/L</find> family method depends on how you got to the resultset: it's
2524 C<me> by default, but eg. L</search_related> aliases it to the related result
2525 source name (and keeps C<me> referring to the original result set). The long
2526 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2527 (and make this method unnecessary).
2529 Thus it's currently necessary to use this method in predefined queries (see
2530 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2531 source alias of the current result set:
2533 # in a result set class
2535 my ($self, $user) = @_;
2537 my $me = $self->current_source_alias;
2539 return $self->search(
2540 "$me.modified" => $user->id,
2546 sub current_source_alias {
2549 return ($self->{attrs} || {})->{alias} || 'me';
2552 # This code is called by search_related, and makes sure there
2553 # is clear separation between the joins before, during, and
2554 # after the relationship. This information is needed later
2555 # in order to properly resolve prefetch aliases (any alias
2556 # with a relation_chain_depth less than the depth of the
2557 # current prefetch is not considered)
2558 sub _chain_relationship {
2559 my ($self, $rel) = @_;
2560 my $source = $self->result_source;
2561 my $attrs = $self->{attrs};
2567 -source_handle => $source->handle,
2568 -alias => $attrs->{alias},
2569 $attrs->{alias} => $source->from,
2573 my $seen = { %{$attrs->{seen_join} || {} } };
2575 # we need to take the prefetch the attrs into account before we
2576 # ->_resolve_join as otherwise they get lost - captainL
2577 my $merged = $self->_merge_attr( $attrs->{join}, $attrs->{prefetch} );
2579 my @requested_joins = $source->_resolve_join($merged, $attrs->{alias}, $seen);
2581 push @$from, @requested_joins;
2583 ++$seen->{-relation_chain_depth};
2585 # if $self already had a join/prefetch specified on it, the requested
2586 # $rel might very well be already included. What we do in this case
2587 # is effectively a no-op (except that we bump up the chain_depth on
2588 # the join in question so we could tell it *is* the search_related)
2591 # we consider the last one thus reverse
2592 for my $j (reverse @requested_joins) {
2593 if ($rel eq $j->[0]{-join_path}[-1]) {
2594 $j->[0]{-relation_chain_depth}++;
2599 unless ($already_joined) {
2600 push @$from, $source->_resolve_join($rel, $attrs->{alias}, $seen);
2603 ++$seen->{-relation_chain_depth};
2605 return ($from,$seen);
2608 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
2609 sub _resolved_attrs_copy {
2611 return { %{$self->_resolved_attrs (@_)} };
2614 sub _resolved_attrs {
2616 return $self->{_attrs} if $self->{_attrs};
2618 my $attrs = { %{ $self->{attrs} || {} } };
2619 my $source = $self->result_source;
2620 my $alias = $attrs->{alias};
2622 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2625 # build columns (as long as select isn't set) into a set of as/select hashes
2626 unless ( $attrs->{select} ) {
2628 ( ref($_) eq 'HASH' )
2632 /^\Q${alias}.\E(.+)$/
2643 } ( ref($attrs->{columns}) eq 'ARRAY' ) ? @{ delete $attrs->{columns}} : (delete $attrs->{columns} || $source->columns );
2645 # add the additional columns on
2646 foreach ( 'include_columns', '+columns' ) {
2647 push @colbits, map {
2648 ( ref($_) eq 'HASH' )
2650 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2651 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2654 # start with initial select items
2655 if ( $attrs->{select} ) {
2657 ( ref $attrs->{select} eq 'ARRAY' )
2658 ? [ @{ $attrs->{select} } ]
2659 : [ $attrs->{select} ];
2663 ref $attrs->{as} eq 'ARRAY'
2664 ? [ @{ $attrs->{as} } ]
2667 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2672 # otherwise we intialise select & as to empty
2673 $attrs->{select} = [];
2677 # now add colbits to select/as
2678 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2679 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2682 if ( $adds = delete $attrs->{'+select'} ) {
2683 $adds = [$adds] unless ref $adds eq 'ARRAY';
2685 @{ $attrs->{select} },
2686 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2689 if ( $adds = delete $attrs->{'+as'} ) {
2690 $adds = [$adds] unless ref $adds eq 'ARRAY';
2691 push( @{ $attrs->{as} }, @$adds );
2694 $attrs->{from} ||= [ {
2695 -source_handle => $source->handle,
2696 -alias => $self->{attrs}{alias},
2697 $self->{attrs}{alias} => $source->from,
2700 if ( $attrs->{join} || $attrs->{prefetch} ) {
2702 $self->throw_exception ('join/prefetch can not be used with a literal scalarref {from}')
2703 if ref $attrs->{from} ne 'ARRAY';
2705 my $join = delete $attrs->{join} || {};
2707 if ( defined $attrs->{prefetch} ) {
2708 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2711 $attrs->{from} = # have to copy here to avoid corrupting the original
2713 @{ $attrs->{from} },
2714 $source->_resolve_join(
2715 $join, $alias, { %{ $attrs->{seen_join} || {} } }
2720 if ( $attrs->{order_by} ) {
2721 $attrs->{order_by} = (
2722 ref( $attrs->{order_by} ) eq 'ARRAY'
2723 ? [ @{ $attrs->{order_by} } ]
2724 : [ $attrs->{order_by} ]
2728 if ($attrs->{group_by} and ! ref $attrs->{group_by}) {
2729 $attrs->{group_by} = [ $attrs->{group_by} ];
2732 # If the order_by is otherwise empty - we will use this for TOP limit
2733 # emulation and the like.
2734 # Although this is needed only if the order_by is not defined, it is
2735 # actually cheaper to just populate this rather than properly examining
2736 # order_by (stuf like [ {} ] and the like)
2737 my $prefix = $alias . ($source->schema->storage->sql_maker->{name_sep} || '.');
2738 $attrs->{_virtual_order_by} = [
2739 map { $prefix . $_ } ($source->primary_columns)
2742 $attrs->{collapse} ||= {};
2743 if ( my $prefetch = delete $attrs->{prefetch} ) {
2744 $prefetch = $self->_merge_attr( {}, $prefetch );
2746 my $prefetch_ordering = [];
2748 my $join_map = $self->_joinpath_aliases ($attrs->{from}, $attrs->{seen_join});
2751 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
2753 $attrs->{prefetch_select} = [ map { $_->[0] } @prefetch ];
2754 push @{ $attrs->{select} }, @{$attrs->{prefetch_select}};
2755 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
2757 push( @{ $attrs->{order_by} }, @$prefetch_ordering );
2758 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
2762 if (delete $attrs->{distinct}) {
2763 $attrs->{group_by} ||= [ grep { !ref($_) || (ref($_) ne 'HASH') } @{$attrs->{select}} ];
2766 # if both page and offset are specified, produce a combined offset
2767 # even though it doesn't make much sense, this is what pre 081xx has
2769 if (my $page = delete $attrs->{page}) {
2770 $attrs->{offset} = ($attrs->{rows} * ($page - 1)) +
2771 ($attrs->{offset} || 0);
2774 return $self->{_attrs} = $attrs;
2777 sub _joinpath_aliases {
2778 my ($self, $fromspec, $seen) = @_;
2781 return $paths unless ref $fromspec eq 'ARRAY';
2783 for my $j (@$fromspec) {
2785 next if ref $j ne 'ARRAY';
2786 next if $j->[0]{-relation_chain_depth} < ( $seen->{-relation_chain_depth} || 0);
2789 $p = $p->{$_} ||= {} for @{$j->[0]{-join_path}};
2790 push @{$p->{-join_aliases} }, $j->[0]{-alias};
2797 my ($self, $attr) = @_;
2799 if (ref $attr eq 'HASH') {
2800 return $self->_rollout_hash($attr);
2801 } elsif (ref $attr eq 'ARRAY') {
2802 return $self->_rollout_array($attr);
2808 sub _rollout_array {
2809 my ($self, $attr) = @_;
2812 foreach my $element (@{$attr}) {
2813 if (ref $element eq 'HASH') {
2814 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2815 } elsif (ref $element eq 'ARRAY') {
2816 # XXX - should probably recurse here
2817 push( @rolled_array, @{$self->_rollout_array($element)} );
2819 push( @rolled_array, $element );
2822 return \@rolled_array;
2826 my ($self, $attr) = @_;
2829 foreach my $key (keys %{$attr}) {
2830 push( @rolled_array, { $key => $attr->{$key} } );
2832 return \@rolled_array;
2835 sub _calculate_score {
2836 my ($self, $a, $b) = @_;
2838 if (ref $b eq 'HASH') {
2839 my ($b_key) = keys %{$b};
2840 if (ref $a eq 'HASH') {
2841 my ($a_key) = keys %{$a};
2842 if ($a_key eq $b_key) {
2843 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2848 return ($a eq $b_key) ? 1 : 0;
2851 if (ref $a eq 'HASH') {
2852 my ($a_key) = keys %{$a};
2853 return ($b eq $a_key) ? 1 : 0;
2855 return ($b eq $a) ? 1 : 0;
2861 my ($self, $orig, $import) = @_;
2863 return $import unless defined($orig);
2864 return $orig unless defined($import);
2866 $orig = $self->_rollout_attr($orig);
2867 $import = $self->_rollout_attr($import);
2870 foreach my $import_element ( @{$import} ) {
2871 # find best candidate from $orig to merge $b_element into
2872 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2873 foreach my $orig_element ( @{$orig} ) {
2874 my $score = $self->_calculate_score( $orig_element, $import_element );
2875 if ($score > $best_candidate->{score}) {
2876 $best_candidate->{position} = $position;
2877 $best_candidate->{score} = $score;
2881 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
2883 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
2884 push( @{$orig}, $import_element );
2886 my $orig_best = $orig->[$best_candidate->{position}];
2887 # merge orig_best and b_element together and replace original with merged
2888 if (ref $orig_best ne 'HASH') {
2889 $orig->[$best_candidate->{position}] = $import_element;
2890 } elsif (ref $import_element eq 'HASH') {
2891 my ($key) = keys %{$orig_best};
2892 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
2895 $seen_keys->{$import_key} = 1; # don't merge the same key twice
2905 $self->_source_handle($_[0]->handle);
2907 $self->_source_handle->resolve;
2911 =head2 throw_exception
2913 See L<DBIx::Class::Schema/throw_exception> for details.
2917 sub throw_exception {
2919 if (ref $self && $self->_source_handle->schema) {
2920 $self->_source_handle->schema->throw_exception(@_)
2927 # XXX: FIXME: Attributes docs need clearing up
2931 Attributes are used to refine a ResultSet in various ways when
2932 searching for data. They can be passed to any method which takes an
2933 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
2936 These are in no particular order:
2942 =item Value: ( $order_by | \@order_by | \%order_by )
2946 Which column(s) to order the results by. If a single column name, or
2947 an arrayref of names is supplied, the argument is passed through
2948 directly to SQL. The hashref syntax allows for connection-agnostic
2949 specification of ordering direction:
2951 For descending order:
2953 order_by => { -desc => [qw/col1 col2 col3/] }
2955 For explicit ascending order:
2957 order_by => { -asc => 'col' }
2959 The old scalarref syntax (i.e. order_by => \'year DESC') is still
2960 supported, although you are strongly encouraged to use the hashref
2961 syntax as outlined above.
2967 =item Value: \@columns
2971 Shortcut to request a particular set of columns to be retrieved. Each
2972 column spec may be a string (a table column name), or a hash (in which
2973 case the key is the C<as> value, and the value is used as the C<select>
2974 expression). Adds C<me.> onto the start of any column without a C<.> in
2975 it and sets C<select> from that, then auto-populates C<as> from
2976 C<select> as normal. (You may also use the C<cols> attribute, as in
2977 earlier versions of DBIC.)
2983 =item Value: \@columns
2987 Indicates additional columns to be selected from storage. Works the same
2988 as L</columns> but adds columns to the selection. (You may also use the
2989 C<include_columns> attribute, as in earlier versions of DBIC). For
2992 $schema->resultset('CD')->search(undef, {
2993 '+columns' => ['artist.name'],
2997 would return all CDs and include a 'name' column to the information
2998 passed to object inflation. Note that the 'artist' is the name of the
2999 column (or relationship) accessor, and 'name' is the name of the column
3000 accessor in the related table.
3002 =head2 include_columns
3006 =item Value: \@columns
3010 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3016 =item Value: \@select_columns
3020 Indicates which columns should be selected from the storage. You can use
3021 column names, or in the case of RDBMS back ends, function or stored procedure
3024 $rs = $schema->resultset('Employee')->search(undef, {
3027 { count => 'employeeid' },
3032 When you use function/stored procedure names and do not supply an C<as>
3033 attribute, the column names returned are storage-dependent. E.g. MySQL would
3034 return a column named C<count(employeeid)> in the above example.
3040 Indicates additional columns to be selected from storage. Works the same as
3041 L</select> but adds columns to the selection.
3049 Indicates additional column names for those added via L</+select>. See L</as>.
3057 =item Value: \@inflation_names
3061 Indicates column names for object inflation. That is, C<as>
3062 indicates the name that the column can be accessed as via the
3063 C<get_column> method (or via the object accessor, B<if one already
3064 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
3066 The C<as> attribute is used in conjunction with C<select>,
3067 usually when C<select> contains one or more function or stored
3070 $rs = $schema->resultset('Employee')->search(undef, {
3073 { count => 'employeeid' }
3075 as => ['name', 'employee_count'],
3078 my $employee = $rs->first(); # get the first Employee
3080 If the object against which the search is performed already has an accessor
3081 matching a column name specified in C<as>, the value can be retrieved using
3082 the accessor as normal:
3084 my $name = $employee->name();
3086 If on the other hand an accessor does not exist in the object, you need to
3087 use C<get_column> instead:
3089 my $employee_count = $employee->get_column('employee_count');
3091 You can create your own accessors if required - see
3092 L<DBIx::Class::Manual::Cookbook> for details.
3094 Please note: This will NOT insert an C<AS employee_count> into the SQL
3095 statement produced, it is used for internal access only. Thus
3096 attempting to use the accessor in an C<order_by> clause or similar
3097 will fail miserably.
3099 To get around this limitation, you can supply literal SQL to your
3100 C<select> attibute that contains the C<AS alias> text, eg:
3102 select => [\'myfield AS alias']
3108 =item Value: ($rel_name | \@rel_names | \%rel_names)
3112 Contains a list of relationships that should be joined for this query. For
3115 # Get CDs by Nine Inch Nails
3116 my $rs = $schema->resultset('CD')->search(
3117 { 'artist.name' => 'Nine Inch Nails' },
3118 { join => 'artist' }
3121 Can also contain a hash reference to refer to the other relation's relations.
3124 package MyApp::Schema::Track;
3125 use base qw/DBIx::Class/;
3126 __PACKAGE__->table('track');
3127 __PACKAGE__->add_columns(qw/trackid cd position title/);
3128 __PACKAGE__->set_primary_key('trackid');
3129 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3132 # In your application
3133 my $rs = $schema->resultset('Artist')->search(
3134 { 'track.title' => 'Teardrop' },
3136 join => { cd => 'track' },
3137 order_by => 'artist.name',
3141 You need to use the relationship (not the table) name in conditions,
3142 because they are aliased as such. The current table is aliased as "me", so
3143 you need to use me.column_name in order to avoid ambiguity. For example:
3145 # Get CDs from 1984 with a 'Foo' track
3146 my $rs = $schema->resultset('CD')->search(
3149 'tracks.name' => 'Foo'
3151 { join => 'tracks' }
3154 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3155 similarly for a third time). For e.g.
3157 my $rs = $schema->resultset('Artist')->search({
3158 'cds.title' => 'Down to Earth',
3159 'cds_2.title' => 'Popular',
3161 join => [ qw/cds cds/ ],
3164 will return a set of all artists that have both a cd with title 'Down
3165 to Earth' and a cd with title 'Popular'.
3167 If you want to fetch related objects from other tables as well, see C<prefetch>
3170 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
3176 =item Value: ($rel_name | \@rel_names | \%rel_names)
3180 Contains one or more relationships that should be fetched along with
3181 the main query (when they are accessed afterwards the data will
3182 already be available, without extra queries to the database). This is
3183 useful for when you know you will need the related objects, because it
3184 saves at least one query:
3186 my $rs = $schema->resultset('Tag')->search(
3195 The initial search results in SQL like the following:
3197 SELECT tag.*, cd.*, artist.* FROM tag
3198 JOIN cd ON tag.cd = cd.cdid
3199 JOIN artist ON cd.artist = artist.artistid
3201 L<DBIx::Class> has no need to go back to the database when we access the
3202 C<cd> or C<artist> relationships, which saves us two SQL statements in this
3205 Simple prefetches will be joined automatically, so there is no need
3206 for a C<join> attribute in the above search.
3208 C<prefetch> can be used with the following relationship types: C<belongs_to>,
3209 C<has_one> (or if you're using C<add_relationship>, any relationship declared
3210 with an accessor type of 'single' or 'filter'). A more complex example that
3211 prefetches an artists cds, the tracks on those cds, and the tags associted
3212 with that artist is given below (assuming many-to-many from artists to tags):
3214 my $rs = $schema->resultset('Artist')->search(
3218 { cds => 'tracks' },
3219 { artist_tags => 'tags' }
3225 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
3226 attributes will be ignored.
3236 Makes the resultset paged and specifies the page to retrieve. Effectively
3237 identical to creating a non-pages resultset and then calling ->page($page)
3240 If L<rows> attribute is not specified it defaults to 10 rows per page.
3242 When you have a paged resultset, L</count> will only return the number
3243 of rows in the page. To get the total, use the L</pager> and call
3244 C<total_entries> on it.
3254 Specifes the maximum number of rows for direct retrieval or the number of
3255 rows per page if the page attribute or method is used.
3261 =item Value: $offset
3265 Specifies the (zero-based) row number for the first row to be returned, or the
3266 of the first row of the first page if paging is used.
3272 =item Value: \@columns
3276 A arrayref of columns to group by. Can include columns of joined tables.
3278 group_by => [qw/ column1 column2 ... /]
3284 =item Value: $condition
3288 HAVING is a select statement attribute that is applied between GROUP BY and
3289 ORDER BY. It is applied to the after the grouping calculations have been
3292 having => { 'count(employee)' => { '>=', 100 } }
3298 =item Value: (0 | 1)
3302 Set to 1 to group by all columns.
3308 Adds to the WHERE clause.
3310 # only return rows WHERE deleted IS NULL for all searches
3311 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
3313 Can be overridden by passing C<{ where => undef }> as an attribute
3320 Set to 1 to cache search results. This prevents extra SQL queries if you
3321 revisit rows in your ResultSet:
3323 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
3325 while( my $artist = $resultset->next ) {
3329 $rs->first; # without cache, this would issue a query
3331 By default, searches are not cached.
3333 For more examples of using these attributes, see
3334 L<DBIx::Class::Manual::Cookbook>.
3340 =item Value: \@from_clause
3344 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
3345 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
3348 NOTE: Use this on your own risk. This allows you to shoot off your foot!
3350 C<join> will usually do what you need and it is strongly recommended that you
3351 avoid using C<from> unless you cannot achieve the desired result using C<join>.
3352 And we really do mean "cannot", not just tried and failed. Attempting to use
3353 this because you're having problems with C<join> is like trying to use x86
3354 ASM because you've got a syntax error in your C. Trust us on this.
3356 Now, if you're still really, really sure you need to use this (and if you're
3357 not 100% sure, ask the mailing list first), here's an explanation of how this
3360 The syntax is as follows -
3363 { <alias1> => <table1> },
3365 { <alias2> => <table2>, -join_type => 'inner|left|right' },
3366 [], # nested JOIN (optional)
3367 { <table1.column1> => <table2.column2>, ... (more conditions) },
3369 # More of the above [ ] may follow for additional joins
3376 ON <table1.column1> = <table2.column2>
3377 <more joins may follow>
3379 An easy way to follow the examples below is to remember the following:
3381 Anything inside "[]" is a JOIN
3382 Anything inside "{}" is a condition for the enclosing JOIN
3384 The following examples utilize a "person" table in a family tree application.
3385 In order to express parent->child relationships, this table is self-joined:
3387 # Person->belongs_to('father' => 'Person');
3388 # Person->belongs_to('mother' => 'Person');
3390 C<from> can be used to nest joins. Here we return all children with a father,
3391 then search against all mothers of those children:
3393 $rs = $schema->resultset('Person')->search(
3396 alias => 'mother', # alias columns in accordance with "from"
3398 { mother => 'person' },
3401 { child => 'person' },
3403 { father => 'person' },
3404 { 'father.person_id' => 'child.father_id' }
3407 { 'mother.person_id' => 'child.mother_id' }
3414 # SELECT mother.* FROM person mother
3417 # JOIN person father
3418 # ON ( father.person_id = child.father_id )
3420 # ON ( mother.person_id = child.mother_id )
3422 The type of any join can be controlled manually. To search against only people
3423 with a father in the person table, we could explicitly use C<INNER JOIN>:
3425 $rs = $schema->resultset('Person')->search(
3428 alias => 'child', # alias columns in accordance with "from"
3430 { child => 'person' },
3432 { father => 'person', -join_type => 'inner' },
3433 { 'father.id' => 'child.father_id' }
3440 # SELECT child.* FROM person child
3441 # INNER JOIN person father ON child.father_id = father.id
3443 You can select from a subquery by passing a resultset to from as follows.
3445 $schema->resultset('Artist')->search(
3447 { alias => 'artist2',
3448 from => [ { artist2 => $artist_rs->as_query } ],
3451 # and you'll get sql like this..
3452 # SELECT artist2.artistid, artist2.name, artist2.rank, artist2.charfield FROM
3453 # ( SELECT me.artistid, me.name, me.rank, me.charfield FROM artists me ) artist2
3455 If you need to express really complex joins, you
3456 can supply literal SQL to C<from> via a scalar reference. In this case
3457 the contents of the scalar will replace the table name associated with the
3460 WARNING: This technique might very well not work as expected on chained
3461 searches - you have been warned.
3463 # Assuming the Event resultsource is defined as:
3465 MySchema::Event->add_columns (
3468 is_auto_increment => 1,
3477 MySchema::Event->set_primary_key ('sequence');
3479 # This will get back the latest event for every location. The column
3480 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3481 # combo to limit the resultset
3483 $rs = $schema->resultset('Event');
3484 $table = $rs->result_source->name;
3485 $latest = $rs->search (
3488 (SELECT e1.* FROM $table e1
3490 ON e1.location = e2.location
3491 AND e1.sequence < e2.sequence
3492 WHERE e2.sequence is NULL
3497 # Equivalent SQL (with the DBIC chunks added):
3499 SELECT me.sequence, me.location, me.type FROM
3500 (SELECT e1.* FROM events e1
3502 ON e1.location = e2.location
3503 AND e1.sequence < e2.sequence
3504 WHERE e2.sequence is NULL
3511 =item Value: ( 'update' | 'shared' )
3515 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT