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 is also an iterator. L</next> is used to return all the
50 L<DBIx::Class::Row>s the ResultSet represents.
52 The query that the ResultSet represents is B<only> executed against
53 the database when these methods are called:
73 =head2 Chaining resultsets
75 Let's say you've got a query that needs to be run to return some data
76 to the user. But, you have an authorization system in place that
77 prevents certain users from seeing certain information. So, you want
78 to construct the basic query in one method, but add constraints to it in
83 my $request = $self->get_request; # Get a request object somehow.
84 my $schema = $self->get_schema; # Get the DBIC schema object somehow.
86 my $cd_rs = $schema->resultset('CD')->search({
87 title => $request->param('title'),
88 year => $request->param('year'),
91 $self->apply_security_policy( $cd_rs );
96 sub apply_security_policy {
105 =head2 Multiple queries
107 Since a resultset just defines a query, you can do all sorts of
108 things with it with the same object.
110 # Don't hit the DB yet.
111 my $cd_rs = $schema->resultset('CD')->search({
112 title => 'something',
116 # Each of these hits the DB individually.
117 my $count = $cd_rs->count;
118 my $most_recent = $cd_rs->get_column('date_released')->max();
119 my @records = $cd_rs->all;
121 And it's not just limited to SELECT statements.
127 $cd_rs->create({ artist => 'Fred' });
129 Which is the same as:
131 $schema->resultset('CD')->create({
132 title => 'something',
137 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
141 If a resultset is used in a numeric context it returns the L</count>.
142 However, if it is used in a booleand context it is always true. So if
143 you want to check if a resultset has any results use C<if $rs != 0>.
144 C<if $rs> will always be true.
152 =item Arguments: $source, \%$attrs
154 =item Return Value: $rs
158 The resultset constructor. Takes a source object (usually a
159 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
160 L</ATTRIBUTES> below). Does not perform any queries -- these are
161 executed as needed by the other methods.
163 Generally you won't need to construct a resultset manually. You'll
164 automatically get one from e.g. a L</search> called in scalar context:
166 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
168 IMPORTANT: If called on an object, proxies to new_result instead so
170 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
172 will return a CD object, not a ResultSet.
178 return $class->new_result(@_) if ref $class;
180 my ($source, $attrs) = @_;
181 $source = $source->handle
182 unless $source->isa('DBIx::Class::ResultSourceHandle');
183 $attrs = { %{$attrs||{}} };
185 if ($attrs->{page}) {
186 $attrs->{rows} ||= 10;
189 $attrs->{alias} ||= 'me';
191 # Creation of {} and bless separated to mitigate RH perl bug
192 # see https://bugzilla.redhat.com/show_bug.cgi?id=196836
194 _source_handle => $source,
195 cond => $attrs->{where},
204 $attrs->{result_class} || $source->resolve->result_class
214 =item Arguments: $cond, \%attrs?
216 =item Return Value: $resultset (scalar context), @row_objs (list context)
220 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
221 my $new_rs = $cd_rs->search({ year => 2005 });
223 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
224 # year = 2005 OR year = 2004
226 If you need to pass in additional attributes but no additional condition,
227 call it as C<search(undef, \%attrs)>.
229 # "SELECT name, artistid FROM $artist_table"
230 my @all_artists = $schema->resultset('Artist')->search(undef, {
231 columns => [qw/name artistid/],
234 For a list of attributes that can be passed to C<search>, see
235 L</ATTRIBUTES>. For more examples of using this function, see
236 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
237 documentation for the first argument, see L<SQL::Abstract>.
239 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
245 my $rs = $self->search_rs( @_ );
246 return (wantarray ? $rs->all : $rs);
253 =item Arguments: $cond, \%attrs?
255 =item Return Value: $resultset
259 This method does the same exact thing as search() except it will
260 always return a resultset, even in list context.
268 $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
269 my $our_attrs = { %{$self->{attrs}} };
270 my $having = delete $our_attrs->{having};
271 my $where = delete $our_attrs->{where};
275 my %safe = (alias => 1, cache => 1);
278 (@_ && defined($_[0])) # @_ == () or (undef)
280 (keys %$attrs # empty attrs or only 'safe' attrs
281 && List::Util::first { !$safe{$_} } keys %$attrs)
283 # no search, effectively just a clone
284 $rows = $self->get_cache;
287 my $new_attrs = { %{$our_attrs}, %{$attrs} };
289 # merge new attrs into inherited
290 foreach my $key (qw/join prefetch +select +as/) {
291 next unless exists $attrs->{$key};
292 $new_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, $attrs->{$key});
297 (@_ == 1 || ref $_[0] eq "HASH")
299 (ref $_[0] eq 'HASH')
301 (keys %{ $_[0] } > 0)
309 ? $self->throw_exception("Odd number of arguments to search")
316 if (defined $where) {
317 $new_attrs->{where} = (
318 defined $new_attrs->{where}
321 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
322 } $where, $new_attrs->{where}
329 $new_attrs->{where} = (
330 defined $new_attrs->{where}
333 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
334 } $cond, $new_attrs->{where}
340 if (defined $having) {
341 $new_attrs->{having} = (
342 defined $new_attrs->{having}
345 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
346 } $having, $new_attrs->{having}
352 my $rs = (ref $self)->new($self->result_source, $new_attrs);
354 $rs->set_cache($rows);
359 =head2 search_literal
363 =item Arguments: $sql_fragment, @bind_values
365 =item Return Value: $resultset (scalar context), @row_objs (list context)
369 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
370 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
372 Pass a literal chunk of SQL to be added to the conditional part of the
375 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
376 only be used in that context. There are known problems using C<search_literal>
377 in chained queries; it can result in bind values in the wrong order. See
378 L<DBIx::Class::Manual::Cookbook/Searching> and
379 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
380 require C<search_literal>.
385 my ($self, $cond, @vals) = @_;
386 my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
387 $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
388 return $self->search(\$cond, $attrs);
395 =item Arguments: @values | \%cols, \%attrs?
397 =item Return Value: $row_object | undef
401 Finds a row based on its primary key or unique constraint. For example, to find
402 a row by its primary key:
404 my $cd = $schema->resultset('CD')->find(5);
406 You can also find a row by a specific unique constraint using the C<key>
407 attribute. For example:
409 my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
410 key => 'cd_artist_title'
413 Additionally, you can specify the columns explicitly by name:
415 my $cd = $schema->resultset('CD')->find(
417 artist => 'Massive Attack',
418 title => 'Mezzanine',
420 { key => 'cd_artist_title' }
423 If the C<key> is specified as C<primary>, it searches only on the primary key.
425 If no C<key> is specified, it searches on all unique constraints defined on the
426 source for which column data is provided, including the primary key.
428 If your table does not have a primary key, you B<must> provide a value for the
429 C<key> attribute matching one of the unique constraints on the source.
431 In addition to C<key>, L</find> recognizes and applies standard
432 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
434 Note: If your query does not return only one row, a warning is generated:
436 Query returned more than one row
438 See also L</find_or_create> and L</update_or_create>. For information on how to
439 declare unique constraints, see
440 L<DBIx::Class::ResultSource/add_unique_constraint>.
446 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
448 # Default to the primary key, but allow a specific key
449 my @cols = exists $attrs->{key}
450 ? $self->result_source->unique_constraint_columns($attrs->{key})
451 : $self->result_source->primary_columns;
452 $self->throw_exception(
453 "Can't find unless a primary key is defined or unique constraint is specified"
456 # Parse out a hashref from input
458 if (ref $_[0] eq 'HASH') {
459 $input_query = { %{$_[0]} };
461 elsif (@_ == @cols) {
463 @{$input_query}{@cols} = @_;
466 # Compatibility: Allow e.g. find(id => $value)
467 carp "Find by key => value deprecated; please use a hashref instead";
471 my (%related, $info);
473 KEY: foreach my $key (keys %$input_query) {
474 if (ref($input_query->{$key})
475 && ($info = $self->result_source->relationship_info($key))) {
476 my $val = delete $input_query->{$key};
477 next KEY if (ref($val) eq 'ARRAY'); # has_many for multi_create
478 my $rel_q = $self->result_source->resolve_condition(
479 $info->{cond}, $val, $key
481 die "Can't handle OR join condition in find" if ref($rel_q) eq 'ARRAY';
482 @related{keys %$rel_q} = values %$rel_q;
485 if (my @keys = keys %related) {
486 @{$input_query}{@keys} = values %related;
490 # Build the final query: Default to the disjunction of the unique queries,
491 # but allow the input query in case the ResultSet defines the query or the
492 # user is abusing find
493 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
495 if (exists $attrs->{key}) {
496 my @unique_cols = $self->result_source->unique_constraint_columns($attrs->{key});
497 my $unique_query = $self->_build_unique_query($input_query, \@unique_cols);
498 $query = $self->_add_alias($unique_query, $alias);
501 my @unique_queries = $self->_unique_queries($input_query, $attrs);
502 $query = @unique_queries
503 ? [ map { $self->_add_alias($_, $alias) } @unique_queries ]
504 : $self->_add_alias($input_query, $alias);
509 my $rs = $self->search($query, $attrs);
510 if (keys %{$rs->_resolved_attrs->{collapse}}) {
512 carp "Query returned more than one row" if $rs->next;
520 if (keys %{$self->_resolved_attrs->{collapse}}) {
521 my $rs = $self->search($query);
523 carp "Query returned more than one row" if $rs->next;
527 return $self->single($query);
534 # Add the specified alias to the specified query hash. A copy is made so the
535 # original query is not modified.
538 my ($self, $query, $alias) = @_;
540 my %aliased = %$query;
541 foreach my $col (grep { ! m/\./ } keys %aliased) {
542 $aliased{"$alias.$col"} = delete $aliased{$col};
550 # Build a list of queries which satisfy unique constraints.
552 sub _unique_queries {
553 my ($self, $query, $attrs) = @_;
555 my @constraint_names = exists $attrs->{key}
557 : $self->result_source->unique_constraint_names;
559 my $where = $self->_collapse_cond($self->{attrs}{where} || {});
560 my $num_where = scalar keys %$where;
563 foreach my $name (@constraint_names) {
564 my @unique_cols = $self->result_source->unique_constraint_columns($name);
565 my $unique_query = $self->_build_unique_query($query, \@unique_cols);
567 my $num_cols = scalar @unique_cols;
568 my $num_query = scalar keys %$unique_query;
570 my $total = $num_query + $num_where;
571 if ($num_query && ($num_query == $num_cols || $total == $num_cols)) {
572 # The query is either unique on its own or is unique in combination with
573 # the existing where clause
574 push @unique_queries, $unique_query;
578 return @unique_queries;
581 # _build_unique_query
583 # Constrain the specified query hash based on the specified column names.
585 sub _build_unique_query {
586 my ($self, $query, $unique_cols) = @_;
589 map { $_ => $query->{$_} }
590 grep { exists $query->{$_} }
595 =head2 search_related
599 =item Arguments: $rel, $cond, \%attrs?
601 =item Return Value: $new_resultset
605 $new_rs = $cd_rs->search_related('artist', {
609 Searches the specified relationship, optionally specifying a condition and
610 attributes for matching records. See L</ATTRIBUTES> for more information.
615 return shift->related_resultset(shift)->search(@_);
618 =head2 search_related_rs
620 This method works exactly the same as search_related, except that
621 it guarantees a restultset, even in list context.
625 sub search_related_rs {
626 return shift->related_resultset(shift)->search_rs(@_);
633 =item Arguments: none
635 =item Return Value: $cursor
639 Returns a storage-driven cursor to the given resultset. See
640 L<DBIx::Class::Cursor> for more information.
647 my $attrs = { %{$self->_resolved_attrs} };
648 return $self->{cursor}
649 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
650 $attrs->{where},$attrs);
657 =item Arguments: $cond?
659 =item Return Value: $row_object?
663 my $cd = $schema->resultset('CD')->single({ year => 2001 });
665 Inflates the first result without creating a cursor if the resultset has
666 any records in it; if not returns nothing. Used by L</find> as a lean version of
669 While this method can take an optional search condition (just like L</search>)
670 being a fast-code-path it does not recognize search attributes. If you need to
671 add extra joins or similar, call L</search> and then chain-call L</single> on the
672 L<DBIx::Class::ResultSet> returned.
678 As of 0.08100, this method enforces the assumption that the preceeding
679 query returns only one row. If more than one row is returned, you will receive
682 Query returned more than one row
684 In this case, you should be using L</first> or L</find> instead, or if you really
685 know what you are doing, use the L</rows> attribute to explicitly limit the size
693 my ($self, $where) = @_;
695 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
698 my $attrs = { %{$self->_resolved_attrs} };
700 if (defined $attrs->{where}) {
703 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
704 $where, delete $attrs->{where} ]
707 $attrs->{where} = $where;
711 # XXX: Disabled since it doesn't infer uniqueness in all cases
712 # unless ($self->_is_unique_query($attrs->{where})) {
713 # carp "Query not guaranteed to return a single row"
714 # . "; please declare your unique constraints or use search instead";
717 my @data = $self->result_source->storage->select_single(
718 $attrs->{from}, $attrs->{select},
719 $attrs->{where}, $attrs
722 return (@data ? ($self->_construct_object(@data))[0] : undef);
727 # Try to determine if the specified query is guaranteed to be unique, based on
728 # the declared unique constraints.
730 sub _is_unique_query {
731 my ($self, $query) = @_;
733 my $collapsed = $self->_collapse_query($query);
734 my $alias = $self->{attrs}{alias};
736 foreach my $name ($self->result_source->unique_constraint_names) {
737 my @unique_cols = map {
739 } $self->result_source->unique_constraint_columns($name);
741 # Count the values for each unique column
742 my %seen = map { $_ => 0 } @unique_cols;
744 foreach my $key (keys %$collapsed) {
745 my $aliased = $key =~ /\./ ? $key : "$alias.$key";
746 next unless exists $seen{$aliased}; # Additional constraints are okay
747 $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
750 # If we get 0 or more than 1 value for a column, it's not necessarily unique
751 return 1 unless grep { $_ != 1 } values %seen;
759 # Recursively collapse the query, accumulating values for each column.
761 sub _collapse_query {
762 my ($self, $query, $collapsed) = @_;
766 if (ref $query eq 'ARRAY') {
767 foreach my $subquery (@$query) {
768 next unless ref $subquery; # -or
769 # warn "ARRAY: " . Dumper $subquery;
770 $collapsed = $self->_collapse_query($subquery, $collapsed);
773 elsif (ref $query eq 'HASH') {
774 if (keys %$query and (keys %$query)[0] eq '-and') {
775 foreach my $subquery (@{$query->{-and}}) {
776 # warn "HASH: " . Dumper $subquery;
777 $collapsed = $self->_collapse_query($subquery, $collapsed);
781 # warn "LEAF: " . Dumper $query;
782 foreach my $col (keys %$query) {
783 my $value = $query->{$col};
784 $collapsed->{$col}{$value}++;
796 =item Arguments: $cond?
798 =item Return Value: $resultsetcolumn
802 my $max_length = $rs->get_column('length')->max;
804 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
809 my ($self, $column) = @_;
810 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
818 =item Arguments: $cond, \%attrs?
820 =item Return Value: $resultset (scalar context), @row_objs (list context)
824 # WHERE title LIKE '%blue%'
825 $cd_rs = $rs->search_like({ title => '%blue%'});
827 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
828 that this is simply a convenience method retained for ex Class::DBI users.
829 You most likely want to use L</search> with specific operators.
831 For more information, see L<DBIx::Class::Manual::Cookbook>.
837 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
838 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
839 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
840 return $class->search($query, { %$attrs });
847 =item Arguments: $first, $last
849 =item Return Value: $resultset (scalar context), @row_objs (list context)
853 Returns a resultset or object list representing a subset of elements from the
854 resultset slice is called on. Indexes are from 0, i.e., to get the first
857 my ($one, $two, $three) = $rs->slice(0, 2);
862 my ($self, $min, $max) = @_;
863 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
864 $attrs->{offset} = $self->{attrs}{offset} || 0;
865 $attrs->{offset} += $min;
866 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
867 return $self->search(undef(), $attrs);
868 #my $slice = (ref $self)->new($self->result_source, $attrs);
869 #return (wantarray ? $slice->all : $slice);
876 =item Arguments: none
878 =item Return Value: $result?
882 Returns the next element in the resultset (C<undef> is there is none).
884 Can be used to efficiently iterate over records in the resultset:
886 my $rs = $schema->resultset('CD')->search;
887 while (my $cd = $rs->next) {
891 Note that you need to store the resultset object, and call C<next> on it.
892 Calling C<< resultset('Table')->next >> repeatedly will always return the
893 first record from the resultset.
899 if (my $cache = $self->get_cache) {
900 $self->{all_cache_position} ||= 0;
901 return $cache->[$self->{all_cache_position}++];
903 if ($self->{attrs}{cache}) {
904 $self->{all_cache_position} = 1;
905 return ($self->all)[0];
907 if ($self->{stashed_objects}) {
908 my $obj = shift(@{$self->{stashed_objects}});
909 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
913 exists $self->{stashed_row}
914 ? @{delete $self->{stashed_row}}
915 : $self->cursor->next
917 return undef unless (@row);
918 my ($row, @more) = $self->_construct_object(@row);
919 $self->{stashed_objects} = \@more if @more;
923 sub _construct_object {
924 my ($self, @row) = @_;
925 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
926 my @new = $self->result_class->inflate_result($self->result_source, @$info);
927 @new = $self->{_attrs}{record_filter}->(@new)
928 if exists $self->{_attrs}{record_filter};
932 sub _collapse_result {
933 my ($self, $as_proto, $row) = @_;
937 # 'foo' => [ undef, 'foo' ]
938 # 'foo.bar' => [ 'foo', 'bar' ]
939 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
941 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
943 my %collapse = %{$self->{_attrs}{collapse}||{}};
947 # if we're doing collapsing (has_many prefetch) we need to grab records
948 # until the PK changes, so fill @pri_index. if not, we leave it empty so
949 # we know we don't have to bother.
951 # the reason for not using the collapse stuff directly is because if you
952 # had for e.g. two artists in a row with no cds, the collapse info for
953 # both would be NULL (undef) so you'd lose the second artist
955 # store just the index so we can check the array positions from the row
956 # without having to contruct the full hash
958 if (keys %collapse) {
959 my %pri = map { ($_ => 1) } $self->result_source->primary_columns;
960 foreach my $i (0 .. $#construct_as) {
961 next if defined($construct_as[$i][0]); # only self table
962 if (delete $pri{$construct_as[$i][1]}) {
963 push(@pri_index, $i);
965 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
969 # no need to do an if, it'll be empty if @pri_index is empty anyway
971 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
975 do { # no need to check anything at the front, we always want the first row
979 foreach my $this_as (@construct_as) {
980 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
983 push(@const_rows, \%const);
985 } until ( # no pri_index => no collapse => drop straight out
988 do { # get another row, stash it, drop out if different PK
990 @copy = $self->cursor->next;
991 $self->{stashed_row} = \@copy;
993 # last thing in do block, counts as true if anything doesn't match
995 # check xor defined first for NULL vs. NOT NULL then if one is
996 # defined the other must be so check string equality
999 (defined $pri_vals{$_} ^ defined $copy[$_])
1000 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1005 my $alias = $self->{attrs}{alias};
1012 foreach my $const (@const_rows) {
1013 scalar @const_keys or do {
1014 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1016 foreach my $key (@const_keys) {
1019 my @parts = split(/\./, $key);
1021 my $data = $const->{$key};
1022 foreach my $p (@parts) {
1023 $target = $target->[1]->{$p} ||= [];
1025 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1026 # collapsing at this point and on final part
1027 my $pos = $collapse_pos{$cur};
1028 CK: foreach my $ck (@ckey) {
1029 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1030 $collapse_pos{$cur} = $data;
1031 delete @collapse_pos{ # clear all positioning for sub-entries
1032 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1039 if (exists $collapse{$cur}) {
1040 $target = $target->[-1];
1043 $target->[0] = $data;
1045 $info->[0] = $const->{$key};
1053 =head2 result_source
1057 =item Arguments: $result_source?
1059 =item Return Value: $result_source
1063 An accessor for the primary ResultSource object from which this ResultSet
1070 =item Arguments: $result_class?
1072 =item Return Value: $result_class
1076 An accessor for the class to use when creating row objects. Defaults to
1077 C<< result_source->result_class >> - which in most cases is the name of the
1078 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1083 my ($self, $result_class) = @_;
1084 if ($result_class) {
1085 $self->ensure_class_loaded($result_class);
1086 $self->_result_class($result_class);
1088 $self->_result_class;
1095 =item Arguments: $cond, \%attrs??
1097 =item Return Value: $count
1101 Performs an SQL C<COUNT> with the same query as the resultset was built
1102 with to find the number of elements. If passed arguments, does a search
1103 on the resultset and counts the results of that.
1105 Note: When using C<count> with C<group_by>, L<DBIx::Class> emulates C<GROUP BY>
1106 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
1107 not support C<DISTINCT> with multiple columns. If you are using such a
1108 database, you should only use columns from the main table in your C<group_by>
1115 return $self->search(@_)->count if @_ and defined $_[0];
1116 return scalar @{ $self->get_cache } if $self->get_cache;
1117 my $count = $self->_count;
1118 return 0 unless $count;
1120 # need to take offset from resolved attrs
1122 $count -= $self->{_attrs}{offset} if $self->{_attrs}{offset};
1123 $count = $self->{attrs}{rows} if
1124 $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
1125 $count = 0 if ($count < 0);
1129 sub _count { # Separated out so pager can get the full count
1131 my $attrs = { %{$self->_resolved_attrs} };
1133 if (my $group_by = $attrs->{group_by}) {
1134 delete $attrs->{having};
1135 delete $attrs->{order_by};
1136 my @distinct = (ref $group_by ? @$group_by : ($group_by));
1137 # todo: try CONCAT for multi-column pk
1138 my @pk = $self->result_source->primary_columns;
1140 my $alias = $attrs->{alias};
1141 foreach my $column (@distinct) {
1142 if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
1143 @distinct = ($column);
1149 $attrs->{select} = $group_by;
1150 $attrs->{from} = (ref $self)->new($self->result_source, $attrs)->cursor->as_query;
1153 $attrs->{select} = { count => '*' };
1154 $attrs->{as} = [qw/count/];
1156 # offset, order by, group by, where and page are not needed to count. record_filter is cdbi
1157 delete $attrs->{$_} for qw/rows offset order_by group_by where page pager record_filter/;
1159 $self->result_source->resultset;
1160 my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
1161 my ($count) = $tmp_rs->cursor->next;
1169 =head2 count_literal
1173 =item Arguments: $sql_fragment, @bind_values
1175 =item Return Value: $count
1179 Counts the results in a literal query. Equivalent to calling L</search_literal>
1180 with the passed arguments, then L</count>.
1184 sub count_literal { shift->search_literal(@_)->count; }
1190 =item Arguments: none
1192 =item Return Value: @objects
1196 Returns all elements in the resultset. Called implicitly if the resultset
1197 is returned in list context.
1204 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1207 return @{ $self->get_cache } if $self->get_cache;
1211 # TODO: don't call resolve here
1212 if (keys %{$self->_resolved_attrs->{collapse}}) {
1213 # if ($self->{attrs}{prefetch}) {
1214 # Using $self->cursor->all is really just an optimisation.
1215 # If we're collapsing has_many prefetches it probably makes
1216 # very little difference, and this is cleaner than hacking
1217 # _construct_object to survive the approach
1218 my @row = $self->cursor->next;
1220 push(@obj, $self->_construct_object(@row));
1221 @row = (exists $self->{stashed_row}
1222 ? @{delete $self->{stashed_row}}
1223 : $self->cursor->next);
1226 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1229 $self->set_cache(\@obj) if $self->{attrs}{cache};
1237 =item Arguments: none
1239 =item Return Value: $self
1243 Resets the resultset's cursor, so you can iterate through the elements again.
1249 delete $self->{_attrs} if exists $self->{_attrs};
1250 $self->{all_cache_position} = 0;
1251 $self->cursor->reset;
1259 =item Arguments: none
1261 =item Return Value: $object?
1265 Resets the resultset and returns an object for the first result (if the
1266 resultset returns anything).
1271 return $_[0]->reset->next;
1274 # _cond_for_update_delete
1276 # update/delete require the condition to be modified to handle
1277 # the differing SQL syntax available. This transforms the $self->{cond}
1278 # appropriately, returning the new condition.
1280 sub _cond_for_update_delete {
1281 my ($self, $full_cond) = @_;
1284 $full_cond ||= $self->{cond};
1285 # No-op. No condition, we're updating/deleting everything
1286 return $cond unless ref $full_cond;
1288 if (ref $full_cond eq 'ARRAY') {
1292 foreach my $key (keys %{$_}) {
1294 $hash{$1} = $_->{$key};
1300 elsif (ref $full_cond eq 'HASH') {
1301 if ((keys %{$full_cond})[0] eq '-and') {
1304 my @cond = @{$full_cond->{-and}};
1305 for (my $i = 0; $i < @cond; $i++) {
1306 my $entry = $cond[$i];
1309 if (ref $entry eq 'HASH') {
1310 $hash = $self->_cond_for_update_delete($entry);
1313 $entry =~ /([^.]+)$/;
1314 $hash->{$1} = $cond[++$i];
1317 push @{$cond->{-and}}, $hash;
1321 foreach my $key (keys %{$full_cond}) {
1323 $cond->{$1} = $full_cond->{$key};
1328 $self->throw_exception(
1329 "Can't update/delete on resultset with condition unless hash or array"
1341 =item Arguments: \%values
1343 =item Return Value: $storage_rv
1347 Sets the specified columns in the resultset to the supplied values in a
1348 single query. Return value will be true if the update succeeded or false
1349 if no records were updated; exact type of success value is storage-dependent.
1354 my ($self, $values) = @_;
1355 $self->throw_exception("Values for update must be a hash")
1356 unless ref $values eq 'HASH';
1358 carp( 'WARNING! Currently $rs->update() does not generate proper SQL'
1359 . ' on joined resultsets, and may affect rows well outside of the'
1360 . ' contents of $rs. Use at your own risk' )
1361 if ( $self->{attrs}{seen_join} );
1363 my $cond = $self->_cond_for_update_delete;
1365 return $self->result_source->storage->update(
1366 $self->result_source, $values, $cond
1374 =item Arguments: \%values
1376 =item Return Value: 1
1380 Fetches all objects and updates them one at a time. Note that C<update_all>
1381 will run DBIC cascade triggers, while L</update> will not.
1386 my ($self, $values) = @_;
1387 $self->throw_exception("Values for update must be a hash")
1388 unless ref $values eq 'HASH';
1389 foreach my $obj ($self->all) {
1390 $obj->set_columns($values)->update;
1399 =item Arguments: none
1401 =item Return Value: 1
1405 Deletes the contents of the resultset from its result source. Note that this
1406 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1407 to run. See also L<DBIx::Class::Row/delete>.
1409 delete may not generate correct SQL for a query with joins or a resultset
1410 chained from a related resultset. In this case it will generate a warning:-
1412 WARNING! Currently $rs->delete() does not generate proper SQL on
1413 joined resultsets, and may delete rows well outside of the contents
1414 of $rs. Use at your own risk
1416 In these cases you may find that delete_all is more appropriate, or you
1417 need to respecify your query in a way that can be expressed without a join.
1423 $self->throw_exception("Delete should not be passed any arguments")
1425 carp( 'WARNING! Currently $rs->delete() does not generate proper SQL'
1426 . ' on joined resultsets, and may delete rows well outside of the'
1427 . ' contents of $rs. Use at your own risk' )
1428 if ( $self->{attrs}{seen_join} );
1429 my $cond = $self->_cond_for_update_delete;
1431 $self->result_source->storage->delete($self->result_source, $cond);
1439 =item Arguments: none
1441 =item Return Value: 1
1445 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1446 will run DBIC cascade triggers, while L</delete> will not.
1452 $_->delete for $self->all;
1460 =item Arguments: \@data;
1464 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
1465 For the arrayref of hashrefs style each hashref should be a structure suitable
1466 forsubmitting to a $resultset->create(...) method.
1468 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
1469 to insert the data, as this is a faster method.
1471 Otherwise, each set of data is inserted into the database using
1472 L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row
1473 objects is returned.
1475 Example: Assuming an Artist Class that has many CDs Classes relating:
1477 my $Artist_rs = $schema->resultset("Artist");
1479 ## Void Context Example
1480 $Artist_rs->populate([
1481 { artistid => 4, name => 'Manufactured Crap', cds => [
1482 { title => 'My First CD', year => 2006 },
1483 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1486 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
1487 { title => 'My parents sold me to a record company' ,year => 2005 },
1488 { title => 'Why Am I So Ugly?', year => 2006 },
1489 { title => 'I Got Surgery and am now Popular', year => 2007 }
1494 ## Array Context Example
1495 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
1496 { name => "Artist One"},
1497 { name => "Artist Two"},
1498 { name => "Artist Three", cds=> [
1499 { title => "First CD", year => 2007},
1500 { title => "Second CD", year => 2008},
1504 print $ArtistOne->name; ## response is 'Artist One'
1505 print $ArtistThree->cds->count ## reponse is '2'
1507 For the arrayref of arrayrefs style, the first element should be a list of the
1508 fieldsnames to which the remaining elements are rows being inserted. For
1511 $Arstist_rs->populate([
1512 [qw/artistid name/],
1513 [100, 'A Formally Unknown Singer'],
1514 [101, 'A singer that jumped the shark two albums ago'],
1515 [102, 'An actually cool singer.'],
1518 Please note an important effect on your data when choosing between void and
1519 wantarray context. Since void context goes straight to C<insert_bulk> in
1520 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
1521 c<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
1522 create primary keys for you, you will find that your PKs are empty. In this
1523 case you will have to use the wantarray context in order to create those
1529 my $self = shift @_;
1530 my $data = ref $_[0][0] eq 'HASH'
1531 ? $_[0] : ref $_[0][0] eq 'ARRAY' ? $self->_normalize_populate_args($_[0]) :
1532 $self->throw_exception('Populate expects an arrayref of hashes or arrayref of arrayrefs');
1534 if(defined wantarray) {
1536 foreach my $item (@$data) {
1537 push(@created, $self->create($item));
1541 my ($first, @rest) = @$data;
1543 my @names = grep {!ref $first->{$_}} keys %$first;
1544 my @rels = grep { $self->result_source->has_relationship($_) } keys %$first;
1545 my @pks = $self->result_source->primary_columns;
1547 ## do the belongs_to relationships
1548 foreach my $index (0..$#$data) {
1549 if( grep { !defined $data->[$index]->{$_} } @pks ) {
1550 my @ret = $self->populate($data);
1554 foreach my $rel (@rels) {
1555 next unless $data->[$index]->{$rel} && ref $data->[$index]->{$rel} eq "HASH";
1556 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
1557 my ($reverse) = keys %{$self->result_source->reverse_relationship_info($rel)};
1558 my $related = $result->result_source->resolve_condition(
1559 $result->result_source->relationship_info($reverse)->{cond},
1564 delete $data->[$index]->{$rel};
1565 $data->[$index] = {%{$data->[$index]}, %$related};
1567 push @names, keys %$related if $index == 0;
1571 ## do bulk insert on current row
1572 my @values = map { [ @$_{@names} ] } @$data;
1574 $self->result_source->storage->insert_bulk(
1575 $self->result_source,
1580 ## do the has_many relationships
1581 foreach my $item (@$data) {
1583 foreach my $rel (@rels) {
1584 next unless $item->{$rel} && ref $item->{$rel} eq "ARRAY";
1586 my $parent = $self->find(map {{$_=>$item->{$_}} } @pks)
1587 || $self->throw_exception('Cannot find the relating object.');
1589 my $child = $parent->$rel;
1591 my $related = $child->result_source->resolve_condition(
1592 $parent->result_source->relationship_info($rel)->{cond},
1597 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
1598 my @populate = map { {%$_, %$related} } @rows_to_add;
1600 $child->populate( \@populate );
1606 =head2 _normalize_populate_args ($args)
1608 Private method used by L</populate> to normalize its incoming arguments. Factored
1609 out in case you want to subclass and accept new argument structures to the
1610 L</populate> method.
1614 sub _normalize_populate_args {
1615 my ($self, $data) = @_;
1616 my @names = @{shift(@$data)};
1617 my @results_to_create;
1618 foreach my $datum (@$data) {
1619 my %result_to_create;
1620 foreach my $index (0..$#names) {
1621 $result_to_create{$names[$index]} = $$datum[$index];
1623 push @results_to_create, \%result_to_create;
1625 return \@results_to_create;
1632 =item Arguments: none
1634 =item Return Value: $pager
1638 Return Value a L<Data::Page> object for the current resultset. Only makes
1639 sense for queries with a C<page> attribute.
1645 my $attrs = $self->{attrs};
1646 $self->throw_exception("Can't create pager for non-paged rs")
1647 unless $self->{attrs}{page};
1648 $attrs->{rows} ||= 10;
1649 return $self->{pager} ||= Data::Page->new(
1650 $self->_count, $attrs->{rows}, $self->{attrs}{page});
1657 =item Arguments: $page_number
1659 =item Return Value: $rs
1663 Returns a resultset for the $page_number page of the resultset on which page
1664 is called, where each page contains a number of rows equal to the 'rows'
1665 attribute set on the resultset (10 by default).
1670 my ($self, $page) = @_;
1671 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1678 =item Arguments: \%vals
1680 =item Return Value: $rowobject
1684 Creates a new row object in the resultset's result class and returns
1685 it. The row is not inserted into the database at this point, call
1686 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
1687 will tell you whether the row object has been inserted or not.
1689 Passes the hashref of input on to L<DBIx::Class::Row/new>.
1694 my ($self, $values) = @_;
1695 $self->throw_exception( "new_result needs a hash" )
1696 unless (ref $values eq 'HASH');
1699 my $alias = $self->{attrs}{alias};
1702 defined $self->{cond}
1703 && $self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION
1705 %new = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
1706 $new{-from_resultset} = [ keys %new ] if keys %new;
1708 $self->throw_exception(
1709 "Can't abstract implicit construct, condition not a hash"
1710 ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1712 my $collapsed_cond = (
1714 ? $self->_collapse_cond($self->{cond})
1718 # precendence must be given to passed values over values inherited from
1719 # the cond, so the order here is important.
1720 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
1721 while( my($col,$value) = each %implied ){
1722 if(ref($value) eq 'HASH' && keys(%$value) && (keys %$value)[0] eq '='){
1723 $new{$col} = $value->{'='};
1726 $new{$col} = $value if $self->_is_deterministic_value($value);
1732 %{ $self->_remove_alias($values, $alias) },
1733 -source_handle => $self->_source_handle,
1734 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
1737 return $self->result_class->new(\%new);
1740 # _is_deterministic_value
1742 # Make an effor to strip non-deterministic values from the condition,
1743 # to make sure new_result chokes less
1745 sub _is_deterministic_value {
1748 my $ref_type = ref $value;
1749 return 1 if $ref_type eq '' || $ref_type eq 'SCALAR';
1750 return 1 if Scalar::Util::blessed($value);
1756 # Recursively collapse the condition.
1758 sub _collapse_cond {
1759 my ($self, $cond, $collapsed) = @_;
1763 if (ref $cond eq 'ARRAY') {
1764 foreach my $subcond (@$cond) {
1765 next unless ref $subcond; # -or
1766 # warn "ARRAY: " . Dumper $subcond;
1767 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1770 elsif (ref $cond eq 'HASH') {
1771 if (keys %$cond and (keys %$cond)[0] eq '-and') {
1772 foreach my $subcond (@{$cond->{-and}}) {
1773 # warn "HASH: " . Dumper $subcond;
1774 $collapsed = $self->_collapse_cond($subcond, $collapsed);
1778 # warn "LEAF: " . Dumper $cond;
1779 foreach my $col (keys %$cond) {
1780 my $value = $cond->{$col};
1781 $collapsed->{$col} = $value;
1791 # Remove the specified alias from the specified query hash. A copy is made so
1792 # the original query is not modified.
1795 my ($self, $query, $alias) = @_;
1797 my %orig = %{ $query || {} };
1800 foreach my $key (keys %orig) {
1802 $unaliased{$key} = $orig{$key};
1805 $unaliased{$1} = $orig{$key}
1806 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
1812 =head2 as_query (EXPERIMENTAL)
1816 =item Arguments: none
1818 =item Return Value: \[ $sql, @bind ]
1822 Returns the SQL query and bind vars associated with the invocant.
1824 This is generally used as the RHS for a subquery.
1826 B<NOTE>: This feature is still experimental.
1830 sub as_query { return shift->cursor->as_query(@_) }
1836 =item Arguments: \%vals, \%attrs?
1838 =item Return Value: $rowobject
1842 my $artist = $schema->resultset('Artist')->find_or_new(
1843 { artist => 'fred' }, { key => 'artists' });
1845 $cd->cd_to_producer->find_or_new({ producer => $producer },
1846 { key => 'primary });
1848 Find an existing record from this resultset, based on its primary
1849 key, or a unique constraint. If none exists, instantiate a new result
1850 object and return it. The object will not be saved into your storage
1851 until you call L<DBIx::Class::Row/insert> on it.
1853 You most likely want this method when looking for existing rows using
1854 a unique constraint that is not the primary key, or looking for
1857 If you want objects to be saved immediately, use L</find_or_create> instead.
1859 B<Note>: C<find_or_new> is probably not what you want when creating a
1860 new row in a table that uses primary keys supplied by the
1861 database. Passing in a primary key column with a value of I<undef>
1862 will cause L</find> to attempt to search for a row with a value of
1869 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1870 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
1871 my $exists = $self->find($hash, $attrs);
1872 return defined $exists ? $exists : $self->new_result($hash);
1879 =item Arguments: \%vals
1881 =item Return Value: a L<DBIx::Class::Row> $object
1885 Attempt to create a single new row or a row with multiple related rows
1886 in the table represented by the resultset (and related tables). This
1887 will not check for duplicate rows before inserting, use
1888 L</find_or_create> to do that.
1890 To create one row for this resultset, pass a hashref of key/value
1891 pairs representing the columns of the table and the values you wish to
1892 store. If the appropriate relationships are set up, foreign key fields
1893 can also be passed an object representing the foreign row, and the
1894 value will be set to its primary key.
1896 To create related objects, pass a hashref for the value if the related
1897 item is a foreign key relationship (L<DBIx::Class::Relationship/belongs_to>),
1898 and use the name of the relationship as the key. (NOT the name of the field,
1899 necessarily). For C<has_many> and C<has_one> relationships, pass an arrayref
1900 of hashrefs containing the data for each of the rows to create in the foreign
1901 tables, again using the relationship name as the key.
1903 Instead of hashrefs of plain related data (key/value pairs), you may
1904 also pass new or inserted objects. New objects (not inserted yet, see
1905 L</new>), will be inserted into their appropriate tables.
1907 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1909 Example of creating a new row.
1911 $person_rs->create({
1912 name=>"Some Person",
1913 email=>"somebody@someplace.com"
1916 Example of creating a new row and also creating rows in a related C<has_many>
1917 or C<has_one> resultset. Note Arrayref.
1920 { artistid => 4, name => 'Manufactured Crap', cds => [
1921 { title => 'My First CD', year => 2006 },
1922 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
1927 Example of creating a new row and also creating a row in a related
1928 C<belongs_to>resultset. Note Hashref.
1931 title=>"Music for Silly Walks",
1934 name=>"Silly Musician",
1941 my ($self, $attrs) = @_;
1942 $self->throw_exception( "create needs a hashref" )
1943 unless ref $attrs eq 'HASH';
1944 return $self->new_result($attrs)->insert;
1947 =head2 find_or_create
1951 =item Arguments: \%vals, \%attrs?
1953 =item Return Value: $rowobject
1957 $cd->cd_to_producer->find_or_create({ producer => $producer },
1958 { key => 'primary });
1960 Tries to find a record based on its primary key or unique constraints; if none
1961 is found, creates one and returns that instead.
1963 my $cd = $schema->resultset('CD')->find_or_create({
1965 artist => 'Massive Attack',
1966 title => 'Mezzanine',
1970 Also takes an optional C<key> attribute, to search by a specific key or unique
1971 constraint. For example:
1973 my $cd = $schema->resultset('CD')->find_or_create(
1975 artist => 'Massive Attack',
1976 title => 'Mezzanine',
1978 { key => 'cd_artist_title' }
1981 B<Note>: Because find_or_create() reads from the database and then
1982 possibly inserts based on the result, this method is subject to a race
1983 condition. Another process could create a record in the table after
1984 the find has completed and before the create has started. To avoid
1985 this problem, use find_or_create() inside a transaction.
1987 B<Note>: C<find_or_create> is probably not what you want when creating
1988 a new row in a table that uses primary keys supplied by the
1989 database. Passing in a primary key column with a value of I<undef>
1990 will cause L</find> to attempt to search for a row with a value of
1993 See also L</find> and L</update_or_create>. For information on how to declare
1994 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1998 sub find_or_create {
2000 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2001 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2002 my $exists = $self->find($hash, $attrs);
2003 return defined $exists ? $exists : $self->create($hash);
2006 =head2 update_or_create
2010 =item Arguments: \%col_values, { key => $unique_constraint }?
2012 =item Return Value: $rowobject
2016 $resultset->update_or_create({ col => $val, ... });
2018 First, searches for an existing row matching one of the unique constraints
2019 (including the primary key) on the source of this resultset. If a row is
2020 found, updates it with the other given column values. Otherwise, creates a new
2023 Takes an optional C<key> attribute to search on a specific unique constraint.
2026 # In your application
2027 my $cd = $schema->resultset('CD')->update_or_create(
2029 artist => 'Massive Attack',
2030 title => 'Mezzanine',
2033 { key => 'cd_artist_title' }
2036 $cd->cd_to_producer->update_or_create({
2037 producer => $producer,
2044 If no C<key> is specified, it searches on all unique constraints defined on the
2045 source, including the primary key.
2047 If the C<key> is specified as C<primary>, it searches only on the primary key.
2049 See also L</find> and L</find_or_create>. For information on how to declare
2050 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2052 B<Note>: C<update_or_create> is probably not what you want when
2053 looking for a row in a table that uses primary keys supplied by the
2054 database, unless you actually have a key value. Passing in a primary
2055 key column with a value of I<undef> will cause L</find> to attempt to
2056 search for a row with a value of I<NULL>.
2060 sub update_or_create {
2062 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2063 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2065 my $row = $self->find($cond, $attrs);
2067 $row->update($cond);
2071 return $self->create($cond);
2078 =item Arguments: none
2080 =item Return Value: \@cache_objects?
2084 Gets the contents of the cache for the resultset, if the cache is set.
2086 The cache is populated either by using the L</prefetch> attribute to
2087 L</search> or by calling L</set_cache>.
2099 =item Arguments: \@cache_objects
2101 =item Return Value: \@cache_objects
2105 Sets the contents of the cache for the resultset. Expects an arrayref
2106 of objects of the same class as those produced by the resultset. Note that
2107 if the cache is set the resultset will return the cached objects rather
2108 than re-querying the database even if the cache attr is not set.
2110 The contents of the cache can also be populated by using the
2111 L</prefetch> attribute to L</search>.
2116 my ( $self, $data ) = @_;
2117 $self->throw_exception("set_cache requires an arrayref")
2118 if defined($data) && (ref $data ne 'ARRAY');
2119 $self->{all_cache} = $data;
2126 =item Arguments: none
2128 =item Return Value: []
2132 Clears the cache for the resultset.
2137 shift->set_cache(undef);
2140 =head2 related_resultset
2144 =item Arguments: $relationship_name
2146 =item Return Value: $resultset
2150 Returns a related resultset for the supplied relationship name.
2152 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2156 sub related_resultset {
2157 my ($self, $rel) = @_;
2159 $self->{related_resultsets} ||= {};
2160 return $self->{related_resultsets}{$rel} ||= do {
2161 my $rel_obj = $self->result_source->relationship_info($rel);
2163 $self->throw_exception(
2164 "search_related: result source '" . $self->result_source->source_name .
2165 "' has no such relationship $rel")
2168 my ($from,$seen) = $self->_resolve_from($rel);
2170 my $join_count = $seen->{$rel};
2171 my $alias = ($join_count > 1 ? join('_', $rel, $join_count) : $rel);
2173 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
2174 my %attrs = %{$self->{attrs}||{}};
2175 delete @attrs{qw(result_class alias)};
2179 if (my $cache = $self->get_cache) {
2180 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
2181 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
2186 my $rel_source = $self->result_source->related_source($rel);
2190 # The reason we do this now instead of passing the alias to the
2191 # search_rs below is that if you wrap/overload resultset on the
2192 # source you need to know what alias it's -going- to have for things
2193 # to work sanely (e.g. RestrictWithObject wants to be able to add
2194 # extra query restrictions, and these may need to be $alias.)
2196 my $attrs = $rel_source->resultset_attributes;
2197 local $attrs->{alias} = $alias;
2199 $rel_source->resultset
2207 where => $self->{cond},
2212 $new->set_cache($new_cache) if $new_cache;
2217 =head2 current_source_alias
2221 =item Arguments: none
2223 =item Return Value: $source_alias
2227 Returns the current table alias for the result source this resultset is built
2228 on, that will be used in the SQL query. Usually it is C<me>.
2230 Currently the source alias that refers to the result set returned by a
2231 L</search>/L</find> family method depends on how you got to the resultset: it's
2232 C<me> by default, but eg. L</search_related> aliases it to the related result
2233 source name (and keeps C<me> referring to the original result set). The long
2234 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
2235 (and make this method unnecessary).
2237 Thus it's currently necessary to use this method in predefined queries (see
2238 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
2239 source alias of the current result set:
2241 # in a result set class
2243 my ($self, $user) = @_;
2245 my $me = $self->current_source_alias;
2247 return $self->search(
2248 "$me.modified" => $user->id,
2254 sub current_source_alias {
2257 return ($self->{attrs} || {})->{alias} || 'me';
2261 my ($self, $extra_join) = @_;
2262 my $source = $self->result_source;
2263 my $attrs = $self->{attrs};
2265 my $from = $attrs->{from}
2266 || [ { $attrs->{alias} => $source->from } ];
2268 my $seen = { %{$attrs->{seen_join}||{}} };
2270 my $join = ($attrs->{join}
2271 ? [ $attrs->{join}, $extra_join ]
2274 # we need to take the prefetch the attrs into account before we
2275 # ->resolve_join as otherwise they get lost - captainL
2276 my $merged = $self->_merge_attr( $join, $attrs->{prefetch} );
2280 ($join ? $source->resolve_join($merged, $attrs->{alias}, $seen) : ()),
2283 return ($from,$seen);
2286 sub _resolved_attrs {
2288 return $self->{_attrs} if $self->{_attrs};
2290 my $attrs = { %{ $self->{attrs} || {} } };
2291 my $source = $self->result_source;
2292 my $alias = $attrs->{alias};
2294 $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
2297 # build columns (as long as select isn't set) into a set of as/select hashes
2298 unless ( $attrs->{select} ) {
2300 ( ref($_) eq 'HASH' ) ? $_
2303 /^\Q${alias}.\E(.+)$/ ? $1
2305 ) => ( /\./ ? $_ : "${alias}.$_" )
2307 } ( ref($attrs->{columns}) eq 'ARRAY' ) ? @{ delete $attrs->{columns}} : (delete $attrs->{columns} || $source->columns );
2309 # add the additional columns on
2310 foreach ( 'include_columns', '+columns' ) {
2311 push @colbits, map {
2312 ( ref($_) eq 'HASH' )
2314 : { ( split( /\./, $_ ) )[-1] => ( /\./ ? $_ : "${alias}.$_" ) }
2315 } ( ref($attrs->{$_}) eq 'ARRAY' ) ? @{ delete $attrs->{$_} } : delete $attrs->{$_} if ( $attrs->{$_} );
2318 # start with initial select items
2319 if ( $attrs->{select} ) {
2321 ( ref $attrs->{select} eq 'ARRAY' )
2322 ? [ @{ $attrs->{select} } ]
2323 : [ $attrs->{select} ];
2327 ref $attrs->{as} eq 'ARRAY'
2328 ? [ @{ $attrs->{as} } ]
2331 : [ map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{ $attrs->{select} } ]
2336 # otherwise we intialise select & as to empty
2337 $attrs->{select} = [];
2341 # now add colbits to select/as
2342 push( @{ $attrs->{select} }, map { values( %{$_} ) } @colbits );
2343 push( @{ $attrs->{as} }, map { keys( %{$_} ) } @colbits );
2346 if ( $adds = delete $attrs->{'+select'} ) {
2347 $adds = [$adds] unless ref $adds eq 'ARRAY';
2349 @{ $attrs->{select} },
2350 map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds
2353 if ( $adds = delete $attrs->{'+as'} ) {
2354 $adds = [$adds] unless ref $adds eq 'ARRAY';
2355 push( @{ $attrs->{as} }, @$adds );
2358 $attrs->{from} ||= [ { $self->{attrs}{alias} => $source->from } ];
2360 if ( exists $attrs->{join} || exists $attrs->{prefetch} ) {
2361 my $join = delete $attrs->{join} || {};
2363 if ( defined $attrs->{prefetch} ) {
2364 $join = $self->_merge_attr( $join, $attrs->{prefetch} );
2368 $attrs->{from} = # have to copy here to avoid corrupting the original
2370 @{ $attrs->{from} },
2371 $source->resolve_join(
2372 $join, $alias, { %{ $attrs->{seen_join} || {} } }
2378 $attrs->{group_by} ||= $attrs->{select}
2379 if delete $attrs->{distinct};
2380 if ( $attrs->{order_by} ) {
2381 $attrs->{order_by} = (
2382 ref( $attrs->{order_by} ) eq 'ARRAY'
2383 ? [ @{ $attrs->{order_by} } ]
2384 : [ $attrs->{order_by} ]
2388 $attrs->{order_by} = [];
2391 my $collapse = $attrs->{collapse} || {};
2392 if ( my $prefetch = delete $attrs->{prefetch} ) {
2393 $prefetch = $self->_merge_attr( {}, $prefetch );
2395 my $seen = { %{ $attrs->{seen_join} || {} } };
2396 foreach my $p ( ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch) ) {
2398 # bring joins back to level of current class
2400 $source->resolve_prefetch( $p, $alias, $seen, \@pre_order, $collapse );
2401 push( @{ $attrs->{select} }, map { $_->[0] } @prefetch );
2402 push( @{ $attrs->{as} }, map { $_->[1] } @prefetch );
2404 push( @{ $attrs->{order_by} }, @pre_order );
2406 $attrs->{collapse} = $collapse;
2408 if ( $attrs->{page} ) {
2409 $attrs->{offset} ||= 0;
2410 $attrs->{offset} += ( $attrs->{rows} * ( $attrs->{page} - 1 ) );
2413 return $self->{_attrs} = $attrs;
2417 my ($self, $attr) = @_;
2419 if (ref $attr eq 'HASH') {
2420 return $self->_rollout_hash($attr);
2421 } elsif (ref $attr eq 'ARRAY') {
2422 return $self->_rollout_array($attr);
2428 sub _rollout_array {
2429 my ($self, $attr) = @_;
2432 foreach my $element (@{$attr}) {
2433 if (ref $element eq 'HASH') {
2434 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
2435 } elsif (ref $element eq 'ARRAY') {
2436 # XXX - should probably recurse here
2437 push( @rolled_array, @{$self->_rollout_array($element)} );
2439 push( @rolled_array, $element );
2442 return \@rolled_array;
2446 my ($self, $attr) = @_;
2449 foreach my $key (keys %{$attr}) {
2450 push( @rolled_array, { $key => $attr->{$key} } );
2452 return \@rolled_array;
2455 sub _calculate_score {
2456 my ($self, $a, $b) = @_;
2458 if (ref $b eq 'HASH') {
2459 my ($b_key) = keys %{$b};
2460 if (ref $a eq 'HASH') {
2461 my ($a_key) = keys %{$a};
2462 if ($a_key eq $b_key) {
2463 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
2468 return ($a eq $b_key) ? 1 : 0;
2471 if (ref $a eq 'HASH') {
2472 my ($a_key) = keys %{$a};
2473 return ($b eq $a_key) ? 1 : 0;
2475 return ($b eq $a) ? 1 : 0;
2481 my ($self, $orig, $import) = @_;
2483 return $import unless defined($orig);
2484 return $orig unless defined($import);
2486 $orig = $self->_rollout_attr($orig);
2487 $import = $self->_rollout_attr($import);
2490 foreach my $import_element ( @{$import} ) {
2491 # find best candidate from $orig to merge $b_element into
2492 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
2493 foreach my $orig_element ( @{$orig} ) {
2494 my $score = $self->_calculate_score( $orig_element, $import_element );
2495 if ($score > $best_candidate->{score}) {
2496 $best_candidate->{position} = $position;
2497 $best_candidate->{score} = $score;
2501 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
2503 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
2504 push( @{$orig}, $import_element );
2506 my $orig_best = $orig->[$best_candidate->{position}];
2507 # merge orig_best and b_element together and replace original with merged
2508 if (ref $orig_best ne 'HASH') {
2509 $orig->[$best_candidate->{position}] = $import_element;
2510 } elsif (ref $import_element eq 'HASH') {
2511 my ($key) = keys %{$orig_best};
2512 $orig->[$best_candidate->{position}] = { $key => $self->_merge_attr($orig_best->{$key}, $import_element->{$key}) };
2515 $seen_keys->{$import_key} = 1; # don't merge the same key twice
2525 $self->_source_handle($_[0]->handle);
2527 $self->_source_handle->resolve;
2531 =head2 throw_exception
2533 See L<DBIx::Class::Schema/throw_exception> for details.
2537 sub throw_exception {
2539 if (ref $self && $self->_source_handle->schema) {
2540 $self->_source_handle->schema->throw_exception(@_)
2547 # XXX: FIXME: Attributes docs need clearing up
2551 Attributes are used to refine a ResultSet in various ways when
2552 searching for data. They can be passed to any method which takes an
2553 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
2556 These are in no particular order:
2562 =item Value: ( $order_by | \@order_by | \%order_by )
2566 Which column(s) to order the results by. If a single column name, or
2567 an arrayref of names is supplied, the argument is passed through
2568 directly to SQL. The hashref syntax allows for connection-agnostic
2569 specification of ordering direction:
2571 For descending order:
2573 order_by => { -desc => [qw/col1 col2 col3/] }
2575 For explicit ascending order:
2577 order_by => { -asc => 'col' }
2579 The old scalarref syntax (i.e. order_by => \'year DESC') is still
2580 supported, although you are strongly encouraged to use the hashref
2581 syntax as outlined above.
2587 =item Value: \@columns
2591 Shortcut to request a particular set of columns to be retrieved. Each
2592 column spec may be a string (a table column name), or a hash (in which
2593 case the key is the C<as> value, and the value is used as the C<select>
2594 expression). Adds C<me.> onto the start of any column without a C<.> in
2595 it and sets C<select> from that, then auto-populates C<as> from
2596 C<select> as normal. (You may also use the C<cols> attribute, as in
2597 earlier versions of DBIC.)
2603 =item Value: \@columns
2607 Indicates additional columns to be selected from storage. Works the same
2608 as L</columns> but adds columns to the selection. (You may also use the
2609 C<include_columns> attribute, as in earlier versions of DBIC). For
2612 $schema->resultset('CD')->search(undef, {
2613 '+columns' => ['artist.name'],
2617 would return all CDs and include a 'name' column to the information
2618 passed to object inflation. Note that the 'artist' is the name of the
2619 column (or relationship) accessor, and 'name' is the name of the column
2620 accessor in the related table.
2622 =head2 include_columns
2626 =item Value: \@columns
2630 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
2636 =item Value: \@select_columns
2640 Indicates which columns should be selected from the storage. You can use
2641 column names, or in the case of RDBMS back ends, function or stored procedure
2644 $rs = $schema->resultset('Employee')->search(undef, {
2647 { count => 'employeeid' },
2652 When you use function/stored procedure names and do not supply an C<as>
2653 attribute, the column names returned are storage-dependent. E.g. MySQL would
2654 return a column named C<count(employeeid)> in the above example.
2660 Indicates additional columns to be selected from storage. Works the same as
2661 L</select> but adds columns to the selection.
2669 Indicates additional column names for those added via L</+select>. See L</as>.
2677 =item Value: \@inflation_names
2681 Indicates column names for object inflation. That is, C<as>
2682 indicates the name that the column can be accessed as via the
2683 C<get_column> method (or via the object accessor, B<if one already
2684 exists>). It has nothing to do with the SQL code C<SELECT foo AS bar>.
2686 The C<as> attribute is used in conjunction with C<select>,
2687 usually when C<select> contains one or more function or stored
2690 $rs = $schema->resultset('Employee')->search(undef, {
2693 { count => 'employeeid' }
2695 as => ['name', 'employee_count'],
2698 my $employee = $rs->first(); # get the first Employee
2700 If the object against which the search is performed already has an accessor
2701 matching a column name specified in C<as>, the value can be retrieved using
2702 the accessor as normal:
2704 my $name = $employee->name();
2706 If on the other hand an accessor does not exist in the object, you need to
2707 use C<get_column> instead:
2709 my $employee_count = $employee->get_column('employee_count');
2711 You can create your own accessors if required - see
2712 L<DBIx::Class::Manual::Cookbook> for details.
2714 Please note: This will NOT insert an C<AS employee_count> into the SQL
2715 statement produced, it is used for internal access only. Thus
2716 attempting to use the accessor in an C<order_by> clause or similar
2717 will fail miserably.
2719 To get around this limitation, you can supply literal SQL to your
2720 C<select> attibute that contains the C<AS alias> text, eg:
2722 select => [\'myfield AS alias']
2728 =item Value: ($rel_name | \@rel_names | \%rel_names)
2732 Contains a list of relationships that should be joined for this query. For
2735 # Get CDs by Nine Inch Nails
2736 my $rs = $schema->resultset('CD')->search(
2737 { 'artist.name' => 'Nine Inch Nails' },
2738 { join => 'artist' }
2741 Can also contain a hash reference to refer to the other relation's relations.
2744 package MyApp::Schema::Track;
2745 use base qw/DBIx::Class/;
2746 __PACKAGE__->table('track');
2747 __PACKAGE__->add_columns(qw/trackid cd position title/);
2748 __PACKAGE__->set_primary_key('trackid');
2749 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
2752 # In your application
2753 my $rs = $schema->resultset('Artist')->search(
2754 { 'track.title' => 'Teardrop' },
2756 join => { cd => 'track' },
2757 order_by => 'artist.name',
2761 You need to use the relationship (not the table) name in conditions,
2762 because they are aliased as such. The current table is aliased as "me", so
2763 you need to use me.column_name in order to avoid ambiguity. For example:
2765 # Get CDs from 1984 with a 'Foo' track
2766 my $rs = $schema->resultset('CD')->search(
2769 'tracks.name' => 'Foo'
2771 { join => 'tracks' }
2774 If the same join is supplied twice, it will be aliased to <rel>_2 (and
2775 similarly for a third time). For e.g.
2777 my $rs = $schema->resultset('Artist')->search({
2778 'cds.title' => 'Down to Earth',
2779 'cds_2.title' => 'Popular',
2781 join => [ qw/cds cds/ ],
2784 will return a set of all artists that have both a cd with title 'Down
2785 to Earth' and a cd with title 'Popular'.
2787 If you want to fetch related objects from other tables as well, see C<prefetch>
2790 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
2796 =item Value: ($rel_name | \@rel_names | \%rel_names)
2800 Contains one or more relationships that should be fetched along with
2801 the main query (when they are accessed afterwards the data will
2802 already be available, without extra queries to the database). This is
2803 useful for when you know you will need the related objects, because it
2804 saves at least one query:
2806 my $rs = $schema->resultset('Tag')->search(
2815 The initial search results in SQL like the following:
2817 SELECT tag.*, cd.*, artist.* FROM tag
2818 JOIN cd ON tag.cd = cd.cdid
2819 JOIN artist ON cd.artist = artist.artistid
2821 L<DBIx::Class> has no need to go back to the database when we access the
2822 C<cd> or C<artist> relationships, which saves us two SQL statements in this
2825 Simple prefetches will be joined automatically, so there is no need
2826 for a C<join> attribute in the above search.
2828 C<prefetch> can be used with the following relationship types: C<belongs_to>,
2829 C<has_one> (or if you're using C<add_relationship>, any relationship declared
2830 with an accessor type of 'single' or 'filter'). A more complex example that
2831 prefetches an artists cds, the tracks on those cds, and the tags associted
2832 with that artist is given below (assuming many-to-many from artists to tags):
2834 my $rs = $schema->resultset('Artist')->search(
2838 { cds => 'tracks' },
2839 { artist_tags => 'tags' }
2845 B<NOTE:> If you specify a C<prefetch> attribute, the C<join> and C<select>
2846 attributes will be ignored.
2856 Makes the resultset paged and specifies the page to retrieve. Effectively
2857 identical to creating a non-pages resultset and then calling ->page($page)
2860 If L<rows> attribute is not specified it defualts to 10 rows per page.
2870 Specifes the maximum number of rows for direct retrieval or the number of
2871 rows per page if the page attribute or method is used.
2877 =item Value: $offset
2881 Specifies the (zero-based) row number for the first row to be returned, or the
2882 of the first row of the first page if paging is used.
2888 =item Value: \@columns
2892 A arrayref of columns to group by. Can include columns of joined tables.
2894 group_by => [qw/ column1 column2 ... /]
2900 =item Value: $condition
2904 HAVING is a select statement attribute that is applied between GROUP BY and
2905 ORDER BY. It is applied to the after the grouping calculations have been
2908 having => { 'count(employee)' => { '>=', 100 } }
2914 =item Value: (0 | 1)
2918 Set to 1 to group by all columns.
2924 Adds to the WHERE clause.
2926 # only return rows WHERE deleted IS NULL for all searches
2927 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
2929 Can be overridden by passing C<{ where => undef }> as an attribute
2936 Set to 1 to cache search results. This prevents extra SQL queries if you
2937 revisit rows in your ResultSet:
2939 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
2941 while( my $artist = $resultset->next ) {
2945 $rs->first; # without cache, this would issue a query
2947 By default, searches are not cached.
2949 For more examples of using these attributes, see
2950 L<DBIx::Class::Manual::Cookbook>.
2956 =item Value: \@from_clause
2960 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
2961 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
2964 NOTE: Use this on your own risk. This allows you to shoot off your foot!
2966 C<join> will usually do what you need and it is strongly recommended that you
2967 avoid using C<from> unless you cannot achieve the desired result using C<join>.
2968 And we really do mean "cannot", not just tried and failed. Attempting to use
2969 this because you're having problems with C<join> is like trying to use x86
2970 ASM because you've got a syntax error in your C. Trust us on this.
2972 Now, if you're still really, really sure you need to use this (and if you're
2973 not 100% sure, ask the mailing list first), here's an explanation of how this
2976 The syntax is as follows -
2979 { <alias1> => <table1> },
2981 { <alias2> => <table2>, -join_type => 'inner|left|right' },
2982 [], # nested JOIN (optional)
2983 { <table1.column1> => <table2.column2>, ... (more conditions) },
2985 # More of the above [ ] may follow for additional joins
2992 ON <table1.column1> = <table2.column2>
2993 <more joins may follow>
2995 An easy way to follow the examples below is to remember the following:
2997 Anything inside "[]" is a JOIN
2998 Anything inside "{}" is a condition for the enclosing JOIN
3000 The following examples utilize a "person" table in a family tree application.
3001 In order to express parent->child relationships, this table is self-joined:
3003 # Person->belongs_to('father' => 'Person');
3004 # Person->belongs_to('mother' => 'Person');
3006 C<from> can be used to nest joins. Here we return all children with a father,
3007 then search against all mothers of those children:
3009 $rs = $schema->resultset('Person')->search(
3012 alias => 'mother', # alias columns in accordance with "from"
3014 { mother => 'person' },
3017 { child => 'person' },
3019 { father => 'person' },
3020 { 'father.person_id' => 'child.father_id' }
3023 { 'mother.person_id' => 'child.mother_id' }
3030 # SELECT mother.* FROM person mother
3033 # JOIN person father
3034 # ON ( father.person_id = child.father_id )
3036 # ON ( mother.person_id = child.mother_id )
3038 The type of any join can be controlled manually. To search against only people
3039 with a father in the person table, we could explicitly use C<INNER JOIN>:
3041 $rs = $schema->resultset('Person')->search(
3044 alias => 'child', # alias columns in accordance with "from"
3046 { child => 'person' },
3048 { father => 'person', -join_type => 'inner' },
3049 { 'father.id' => 'child.father_id' }
3056 # SELECT child.* FROM person child
3057 # INNER JOIN person father ON child.father_id = father.id
3059 If you need to express really complex joins or you need a subselect, you
3060 can supply literal SQL to C<from> via a scalar reference. In this case
3061 the contents of the scalar will replace the table name asscoiated with the
3064 WARNING: This technique might very well not work as expected on chained
3065 searches - you have been warned.
3067 # Assuming the Event resultsource is defined as:
3069 MySchema::Event->add_columns (
3072 is_auto_increment => 1,
3081 MySchema::Event->set_primary_key ('sequence');
3083 # This will get back the latest event for every location. The column
3084 # selector is still provided by DBIC, all we do is add a JOIN/WHERE
3085 # combo to limit the resultset
3087 $rs = $schema->resultset('Event');
3088 $table = $rs->result_source->name;
3089 $latest = $rs->search (
3092 (SELECT e1.* FROM $table e1
3094 ON e1.location = e2.location
3095 AND e1.sequence < e2.sequence
3096 WHERE e2.sequence is NULL
3101 # Equivalent SQL (with the DBIC chunks added):
3103 SELECT me.sequence, me.location, me.type FROM
3104 (SELECT e1.* FROM events e1
3106 ON e1.location = e2.location
3107 AND e1.sequence < e2.sequence
3108 WHERE e2.sequence is NULL
3115 =item Value: ( 'update' | 'shared' )
3119 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT