1 package DBIx::Class::ResultSet;
5 use base qw/DBIx::Class/;
7 use DBIx::Class::Exception;
8 use DBIx::Class::ResultSetColumn;
9 use Scalar::Util qw/blessed weaken/;
11 use Data::Compare (); # no imports!!! guard against insane architecture
13 # not importing first() as it will clash with our own method
17 # De-duplication in _merge_attr() is disabled, but left in for reference
18 # (the merger is used for other things that ought not to be de-duped)
19 *__HM_DEDUP = sub () { 0 };
29 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class result_source/);
33 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
37 my $users_rs = $schema->resultset('User');
38 while( $user = $users_rs->next) {
39 print $user->username;
42 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
43 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
47 A ResultSet is an object which stores a set of conditions representing
48 a query. It is the backbone of DBIx::Class (i.e. the really
49 important/useful bit).
51 No SQL is executed on the database when a ResultSet is created, it
52 just stores all the conditions needed to create the query.
54 A basic ResultSet representing the data of an entire table is returned
55 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
56 L<Source|DBIx::Class::Manual::Glossary/Source> name.
58 my $users_rs = $schema->resultset('User');
60 A new ResultSet is returned from calling L</search> on an existing
61 ResultSet. The new one will contain all the conditions of the
62 original, plus any new conditions added in the C<search> call.
64 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
65 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
68 The query that the ResultSet represents is B<only> executed against
69 the database when these methods are called:
70 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
72 If a resultset is used in a numeric context it returns the L</count>.
73 However, if it is used in a boolean context it is B<always> true. So if
74 you want to check if a resultset has any results, you must use C<if $rs
77 =head1 CUSTOM ResultSet CLASSES THAT USE Moose
79 If you want to make your custom ResultSet classes with L<Moose>, use a template
82 package MyApp::Schema::ResultSet::User;
85 use namespace::autoclean;
87 extends 'DBIx::Class::ResultSet';
89 sub BUILDARGS { $_[2] }
93 __PACKAGE__->meta->make_immutable;
97 The L<MooseX::NonMoose> is necessary so that the L<Moose> constructor does not
98 clash with the regular ResultSet constructor. Alternatively, you can use:
100 __PACKAGE__->meta->make_immutable(inline_constructor => 0);
102 The L<BUILDARGS|Moose::Manual::Construction/BUILDARGS> is necessary because the
103 signature of the ResultSet C<new> is C<< ->new($source, \%args) >>.
107 =head2 Chaining resultsets
109 Let's say you've got a query that needs to be run to return some data
110 to the user. But, you have an authorization system in place that
111 prevents certain users from seeing certain information. So, you want
112 to construct the basic query in one method, but add constraints to it in
117 my $request = $self->get_request; # Get a request object somehow.
118 my $schema = $self->result_source->schema;
120 my $cd_rs = $schema->resultset('CD')->search({
121 title => $request->param('title'),
122 year => $request->param('year'),
125 $cd_rs = $self->apply_security_policy( $cd_rs );
127 return $cd_rs->all();
130 sub apply_security_policy {
139 =head3 Resolving conditions and attributes
141 When a resultset is chained from another resultset, conditions and
142 attributes with the same keys need resolving.
144 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
145 into the existing ones from the original resultset.
147 The L</where> and L</having> attributes, and any search conditions, are
148 merged with an SQL C<AND> to the existing condition from the original
151 All other attributes are overridden by any new ones supplied in the
154 =head2 Multiple queries
156 Since a resultset just defines a query, you can do all sorts of
157 things with it with the same object.
159 # Don't hit the DB yet.
160 my $cd_rs = $schema->resultset('CD')->search({
161 title => 'something',
165 # Each of these hits the DB individually.
166 my $count = $cd_rs->count;
167 my $most_recent = $cd_rs->get_column('date_released')->max();
168 my @records = $cd_rs->all;
170 And it's not just limited to SELECT statements.
176 $cd_rs->create({ artist => 'Fred' });
178 Which is the same as:
180 $schema->resultset('CD')->create({
181 title => 'something',
186 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
194 =item Arguments: $source, \%$attrs
196 =item Return Value: $rs
200 The resultset constructor. Takes a source object (usually a
201 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
202 L</ATTRIBUTES> below). Does not perform any queries -- these are
203 executed as needed by the other methods.
205 Generally you won't need to construct a resultset manually. You'll
206 automatically get one from e.g. a L</search> called in scalar context:
208 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
210 IMPORTANT: If called on an object, proxies to new_result instead so
212 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
214 will return a CD object, not a ResultSet.
220 return $class->new_result(@_) if ref $class;
222 my ($source, $attrs) = @_;
223 $source = $source->resolve
224 if $source->isa('DBIx::Class::ResultSourceHandle');
225 $attrs = { %{$attrs||{}} };
227 if ($attrs->{page}) {
228 $attrs->{rows} ||= 10;
231 $attrs->{alias} ||= 'me';
234 result_source => $source,
235 cond => $attrs->{where},
240 # if there is a dark selector, this means we are already in a
241 # chain and the cleanup/sanification was taken care of by
243 $self->_normalize_selection($attrs)
244 unless $attrs->{_dark_selector};
247 $attrs->{result_class} || $source->result_class
257 =item Arguments: $cond, \%attrs?
259 =item Return Value: $resultset (scalar context) || @row_objs (list context)
263 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
264 my $new_rs = $cd_rs->search({ year => 2005 });
266 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
267 # year = 2005 OR year = 2004
269 In list context, C<< ->all() >> is called implicitly on the resultset, thus
270 returning a list of row objects instead. To avoid that, use L</search_rs>.
272 If you need to pass in additional attributes but no additional condition,
273 call it as C<search(undef, \%attrs)>.
275 # "SELECT name, artistid FROM $artist_table"
276 my @all_artists = $schema->resultset('Artist')->search(undef, {
277 columns => [qw/name artistid/],
280 For a list of attributes that can be passed to C<search>, see
281 L</ATTRIBUTES>. For more examples of using this function, see
282 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
283 documentation for the first argument, see L<SQL::Abstract>
284 and its extension L<DBIx::Class::SQLMaker>.
286 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
290 Note that L</search> does not process/deflate any of the values passed in the
291 L<SQL::Abstract>-compatible search condition structure. This is unlike other
292 condition-bound methods L</new>, L</create> and L</find>. The user must ensure
293 manually that any value passed to this method will stringify to something the
294 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
295 objects, for more info see:
296 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
302 my $rs = $self->search_rs( @_ );
307 elsif (defined wantarray) {
311 # we can be called by a relationship helper, which in
312 # turn may be called in void context due to some braindead
313 # overload or whatever else the user decided to be clever
314 # at this particular day. Thus limit the exception to
315 # external code calls only
316 $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
317 if (caller)[0] !~ /^\QDBIx::Class::/;
327 =item Arguments: $cond, \%attrs?
329 =item Return Value: $resultset
333 This method does the same exact thing as search() except it will
334 always return a resultset, even in list context.
341 # Special-case handling for (undef, undef).
342 if ( @_ == 2 && !defined $_[1] && !defined $_[0] ) {
348 if (ref $_[-1] eq 'HASH') {
349 # copy for _normalize_selection
350 $call_attrs = { %{ pop @_ } };
352 elsif (! defined $_[-1] ) {
353 pop @_; # search({}, undef)
357 # see if we can keep the cache (no $rs changes)
359 my %safe = (alias => 1, cache => 1);
360 if ( ! List::Util::first { !$safe{$_} } keys %$call_attrs and (
363 ref $_[0] eq 'HASH' && ! keys %{$_[0]}
365 ref $_[0] eq 'ARRAY' && ! @{$_[0]}
367 $cache = $self->get_cache;
370 my $rsrc = $self->result_source;
372 my $old_attrs = { %{$self->{attrs}} };
373 my $old_having = delete $old_attrs->{having};
374 my $old_where = delete $old_attrs->{where};
376 my $new_attrs = { %$old_attrs };
378 # take care of call attrs (only if anything is changing)
379 if (keys %$call_attrs) {
381 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
383 # reset the current selector list if new selectors are supplied
384 if (List::Util::first { exists $call_attrs->{$_} } qw/columns cols select as/) {
385 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')};
388 # Normalize the new selector list (operates on the passed-in attr structure)
389 # Need to do it on every chain instead of only once on _resolved_attrs, in
390 # order to allow detection of empty vs partial 'as'
391 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
392 if $old_attrs->{_dark_selector};
393 $self->_normalize_selection ($call_attrs);
395 # start with blind overwriting merge, exclude selector attrs
396 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
397 delete @{$new_attrs}{@selector_attrs};
399 for (@selector_attrs) {
400 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
401 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
404 # older deprecated name, use only if {columns} is not there
405 if (my $c = delete $new_attrs->{cols}) {
406 if ($new_attrs->{columns}) {
407 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
410 $new_attrs->{columns} = $c;
415 # join/prefetch use their own crazy merging heuristics
416 foreach my $key (qw/join prefetch/) {
417 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
418 if exists $call_attrs->{$key};
421 # stack binds together
422 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
426 # rip apart the rest of @_, parse a condition
429 if (ref $_[0] eq 'HASH') {
430 (keys %{$_[0]}) ? $_[0] : undef
436 $self->throw_exception('Odd number of arguments to search')
444 if( @_ > 1 and ! $rsrc->result_class->isa('DBIx::Class::CDBICompat') ) {
445 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead';
448 for ($old_where, $call_cond) {
450 $new_attrs->{where} = $self->_stack_cond (
451 $_, $new_attrs->{where}
456 if (defined $old_having) {
457 $new_attrs->{having} = $self->_stack_cond (
458 $old_having, $new_attrs->{having}
462 my $rs = (ref $self)->new($rsrc, $new_attrs);
464 $rs->set_cache($cache) if ($cache);
470 sub _normalize_selection {
471 my ($self, $attrs) = @_;
474 $attrs->{'+columns'} = $self->_merge_attr($attrs->{'+columns'}, delete $attrs->{include_columns})
475 if exists $attrs->{include_columns};
477 # columns are always placed first, however
479 # Keep the X vs +X separation until _resolved_attrs time - this allows to
480 # delay the decision on whether to use a default select list ($rsrc->columns)
481 # allowing stuff like the remove_columns helper to work
483 # select/as +select/+as pairs need special handling - the amount of select/as
484 # elements in each pair does *not* have to be equal (think multicolumn
485 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
486 # supplied at all) - try to infer the alias, either from the -as parameter
487 # of the selector spec, or use the parameter whole if it looks like a column
488 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
489 # is ok as well), but make sure no more additions to the 'as' chain take place
490 for my $pref ('', '+') {
492 my ($sel, $as) = map {
493 my $key = "${pref}${_}";
495 my $val = [ ref $attrs->{$key} eq 'ARRAY'
497 : $attrs->{$key} || ()
499 delete $attrs->{$key};
503 if (! @$as and ! @$sel ) {
506 elsif (@$as and ! @$sel) {
507 $self->throw_exception(
508 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
512 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
513 # if any @$as has been supplied we assume the user knows what (s)he is doing
514 # and blindly keep stacking up pieces
515 unless ($attrs->{_dark_selector}) {
518 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
519 push @$as, $_->{-as};
521 # assume any plain no-space, no-parenthesis string to be a column spec
522 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
523 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
526 # if all else fails - raise a flag that no more aliasing will be allowed
528 $attrs->{_dark_selector} = {
530 string => ($dark_sel_dumper ||= do {
531 require Data::Dumper::Concise;
532 Data::Dumper::Concise::DumperObject()->Indent(0);
533 })->Values([$_])->Dump
541 elsif (@$as < @$sel) {
542 $self->throw_exception(
543 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
546 elsif ($pref and $attrs->{_dark_selector}) {
547 $self->throw_exception(
548 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
554 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
555 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
560 my ($self, $left, $right) = @_;
562 # collapse single element top-level conditions
563 # (single pass only, unlikely to need recursion)
564 for ($left, $right) {
565 if (ref $_ eq 'ARRAY') {
573 elsif (ref $_ eq 'HASH') {
574 my ($first, $more) = keys %$_;
577 if (! defined $first) {
581 elsif (! defined $more) {
582 if ($first eq '-and' and ref $_->{'-and'} eq 'HASH') {
585 elsif ($first eq '-or' and ref $_->{'-or'} eq 'ARRAY') {
592 # merge hashes with weeding out of duplicates (simple cases only)
593 if (ref $left eq 'HASH' and ref $right eq 'HASH') {
595 # shallow copy to destroy
596 $right = { %$right };
597 for (grep { exists $right->{$_} } keys %$left) {
598 # the use of eq_deeply here is justified - the rhs of an
599 # expression can contain a lot of twisted weird stuff
600 delete $right->{$_} if Data::Compare::Compare( $left->{$_}, $right->{$_} );
603 $right = undef unless keys %$right;
607 if (defined $left xor defined $right) {
608 return defined $left ? $left : $right;
610 elsif (! defined $left) {
614 return { -and => [ $left, $right ] };
618 =head2 search_literal
622 =item Arguments: $sql_fragment, @bind_values
624 =item Return Value: $resultset (scalar context) || @row_objs (list context)
628 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
629 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
631 Pass a literal chunk of SQL to be added to the conditional part of the
634 CAVEAT: C<search_literal> is provided for Class::DBI compatibility and should
635 only be used in that context. C<search_literal> is a convenience method.
636 It is equivalent to calling $schema->search(\[]), but if you want to ensure
637 columns are bound correctly, use C<search>.
639 Example of how to use C<search> instead of C<search_literal>
641 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
642 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
645 See L<DBIx::Class::Manual::Cookbook/Searching> and
646 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
647 require C<search_literal>.
652 my ($self, $sql, @bind) = @_;
654 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
657 return $self->search(\[ $sql, map [ __DUMMY__ => $_ ], @bind ], ($attr || () ));
664 =item Arguments: \%columns_values | @pk_values, \%attrs?
666 =item Return Value: $row_object | undef
670 Finds and returns a single row based on supplied criteria. Takes either a
671 hashref with the same format as L</create> (including inference of foreign
672 keys from related objects), or a list of primary key values in the same
673 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
674 declaration on the L</result_source>.
676 In either case an attempt is made to combine conditions already existing on
677 the resultset with the condition passed to this method.
679 To aid with preparing the correct query for the storage you may supply the
680 C<key> attribute, which is the name of a
681 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
682 unique constraint corresponding to the
683 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
684 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
685 to construct a query that satisfies the named unique constraint fully (
686 non-NULL values for each column member of the constraint) an exception is
689 If no C<key> is specified, the search is carried over all unique constraints
690 which are fully defined by the available condition.
692 If no such constraint is found, C<find> currently defaults to a simple
693 C<< search->(\%column_values) >> which may or may not do what you expect.
694 Note that this fallback behavior may be deprecated in further versions. If
695 you need to search with arbitrary conditions - use L</search>. If the query
696 resulting from this fallback produces more than one row, a warning to the
697 effect is issued, though only the first row is constructed and returned as
700 In addition to C<key>, L</find> recognizes and applies standard
701 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
703 Note that if you have extra concerns about the correctness of the resulting
704 query you need to specify the C<key> attribute and supply the entire condition
705 as an argument to find (since it is not always possible to perform the
706 combination of the resultset condition with the supplied one, especially if
707 the resultset condition contains literal sql).
709 For example, to find a row by its primary key:
711 my $cd = $schema->resultset('CD')->find(5);
713 You can also find a row by a specific unique constraint:
715 my $cd = $schema->resultset('CD')->find(
717 artist => 'Massive Attack',
718 title => 'Mezzanine',
720 { key => 'cd_artist_title' }
723 See also L</find_or_create> and L</update_or_create>.
729 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
731 my $rsrc = $self->result_source;
734 if (exists $attrs->{key}) {
735 $constraint_name = defined $attrs->{key}
737 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
741 # Parse out the condition from input
744 if (ref $_[0] eq 'HASH') {
745 $call_cond = { %{$_[0]} };
748 # if only values are supplied we need to default to 'primary'
749 $constraint_name = 'primary' unless defined $constraint_name;
751 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
753 $self->throw_exception(
754 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
757 $self->throw_exception (
758 'find() expects either a column/value hashref, or a list of values '
759 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
760 ) unless @c_cols == @_;
763 @{$call_cond}{@c_cols} = @_;
767 for my $key (keys %$call_cond) {
769 my $keyref = ref($call_cond->{$key})
771 my $relinfo = $rsrc->relationship_info($key)
773 my $val = delete $call_cond->{$key};
775 next if $keyref eq 'ARRAY'; # has_many for multi_create
777 my $rel_q = $rsrc->_resolve_condition(
778 $relinfo->{cond}, $val, $key, $key
780 die "Can't handle complex relationship conditions in find" if ref($rel_q) ne 'HASH';
781 @related{keys %$rel_q} = values %$rel_q;
785 # relationship conditions take precedence (?)
786 @{$call_cond}{keys %related} = values %related;
788 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
790 if (defined $constraint_name) {
791 $final_cond = $self->_qualify_cond_columns (
793 $self->_build_unique_cond (
801 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
802 # This means that we got here after a merger of relationship conditions
803 # in ::Relationship::Base::search_related (the row method), and furthermore
804 # the relationship is of the 'single' type. This means that the condition
805 # provided by the relationship (already attached to $self) is sufficient,
806 # as there can be only one row in the database that would satisfy the
810 # no key was specified - fall down to heuristics mode:
811 # run through all unique queries registered on the resultset, and
812 # 'OR' all qualifying queries together
813 my (@unique_queries, %seen_column_combinations);
814 for my $c_name ($rsrc->unique_constraint_names) {
815 next if $seen_column_combinations{
816 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
819 push @unique_queries, try {
820 $self->_build_unique_cond ($c_name, $call_cond, 'croak_on_nulls')
824 $final_cond = @unique_queries
825 ? [ map { $self->_qualify_cond_columns($_, $alias) } @unique_queries ]
826 : $self->_non_unique_find_fallback ($call_cond, $attrs)
830 # Run the query, passing the result_class since it should propagate for find
831 my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
832 if ($rs->_resolved_attrs->{collapse}) {
834 carp "Query returned more than one row" if $rs->next;
842 # This is a stop-gap method as agreed during the discussion on find() cleanup:
843 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
845 # It is invoked when find() is called in legacy-mode with insufficiently-unique
846 # condition. It is provided for overrides until a saner way forward is devised
848 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
849 # the road. Please adjust your tests accordingly to catch this situation early
850 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
852 # The method will not be removed without an adequately complete replacement
853 # for strict-mode enforcement
854 sub _non_unique_find_fallback {
855 my ($self, $cond, $attrs) = @_;
857 return $self->_qualify_cond_columns(
859 exists $attrs->{alias}
861 : $self->{attrs}{alias}
866 sub _qualify_cond_columns {
867 my ($self, $cond, $alias) = @_;
869 my %aliased = %$cond;
870 for (keys %aliased) {
871 $aliased{"$alias.$_"} = delete $aliased{$_}
878 sub _build_unique_cond {
879 my ($self, $constraint_name, $extra_cond, $croak_on_null) = @_;
881 my @c_cols = $self->result_source->unique_constraint_columns($constraint_name);
883 # combination may fail if $self->{cond} is non-trivial
884 my ($final_cond) = try {
885 $self->_merge_with_rscond ($extra_cond)
890 # trim out everything not in $columns
891 $final_cond = { map {
892 exists $final_cond->{$_}
893 ? ( $_ => $final_cond->{$_} )
897 if (my @missing = grep
898 { ! ($croak_on_null ? defined $final_cond->{$_} : exists $final_cond->{$_}) }
901 $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', no values for column(s): %s",
903 join (', ', map { "'$_'" } @missing),
910 !$ENV{DBIC_NULLABLE_KEY_NOWARN}
912 my @undefs = grep { ! defined $final_cond->{$_} } (keys %$final_cond)
914 carp_unique ( sprintf (
915 "NULL/undef values supplied for requested unique constraint '%s' (NULL "
916 . 'values in column(s): %s). This is almost certainly not what you wanted, '
917 . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
919 join (', ', map { "'$_'" } @undefs),
926 =head2 search_related
930 =item Arguments: $rel, $cond?, \%attrs?
932 =item Return Value: $new_resultset (scalar context) || @row_objs (list context)
936 $new_rs = $cd_rs->search_related('artist', {
940 Searches the specified relationship, optionally specifying a condition and
941 attributes for matching records. See L</ATTRIBUTES> for more information.
943 In list context, C<< ->all() >> is called implicitly on the resultset, thus
944 returning a list of row objects instead. To avoid that, use L</search_related_rs>.
946 See also L</search_related_rs>.
951 return shift->related_resultset(shift)->search(@_);
954 =head2 search_related_rs
956 This method works exactly the same as search_related, except that
957 it guarantees a resultset, even in list context.
961 sub search_related_rs {
962 return shift->related_resultset(shift)->search_rs(@_);
969 =item Arguments: none
971 =item Return Value: $cursor
975 Returns a storage-driven cursor to the given resultset. See
976 L<DBIx::Class::Cursor> for more information.
983 my $attrs = $self->_resolved_attrs_copy;
985 return $self->{cursor}
986 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
987 $attrs->{where},$attrs);
994 =item Arguments: $cond?
996 =item Return Value: $row_object | undef
1000 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1002 Inflates the first result without creating a cursor if the resultset has
1003 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1006 While this method can take an optional search condition (just like L</search>)
1007 being a fast-code-path it does not recognize search attributes. If you need to
1008 add extra joins or similar, call L</search> and then chain-call L</single> on the
1009 L<DBIx::Class::ResultSet> returned.
1015 As of 0.08100, this method enforces the assumption that the preceding
1016 query returns only one row. If more than one row is returned, you will receive
1019 Query returned more than one row
1021 In this case, you should be using L</next> or L</find> instead, or if you really
1022 know what you are doing, use the L</rows> attribute to explicitly limit the size
1025 This method will also throw an exception if it is called on a resultset prefetching
1026 has_many, as such a prefetch implies fetching multiple rows from the database in
1027 order to assemble the resulting object.
1034 my ($self, $where) = @_;
1036 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1039 my $attrs = $self->_resolved_attrs_copy;
1041 $self->throw_exception(
1042 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
1043 ) if $attrs->{collapse};
1046 if (defined $attrs->{where}) {
1049 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1050 $where, delete $attrs->{where} ]
1053 $attrs->{where} = $where;
1057 my $data = [ $self->result_source->storage->select_single(
1058 $attrs->{from}, $attrs->{select},
1059 $attrs->{where}, $attrs
1061 return undef unless @$data;
1062 $self->{stashed_rows} = [ $data ];
1063 $self->_construct_objects->[0];
1069 # Recursively collapse the query, accumulating values for each column.
1071 sub _collapse_query {
1072 my ($self, $query, $collapsed) = @_;
1076 if (ref $query eq 'ARRAY') {
1077 foreach my $subquery (@$query) {
1078 next unless ref $subquery; # -or
1079 $collapsed = $self->_collapse_query($subquery, $collapsed);
1082 elsif (ref $query eq 'HASH') {
1083 if (keys %$query and (keys %$query)[0] eq '-and') {
1084 foreach my $subquery (@{$query->{-and}}) {
1085 $collapsed = $self->_collapse_query($subquery, $collapsed);
1089 foreach my $col (keys %$query) {
1090 my $value = $query->{$col};
1091 $collapsed->{$col}{$value}++;
1103 =item Arguments: $cond?
1105 =item Return Value: $resultsetcolumn
1109 my $max_length = $rs->get_column('length')->max;
1111 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1116 my ($self, $column) = @_;
1117 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1125 =item Arguments: $cond, \%attrs?
1127 =item Return Value: $resultset (scalar context) || @row_objs (list context)
1131 # WHERE title LIKE '%blue%'
1132 $cd_rs = $rs->search_like({ title => '%blue%'});
1134 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1135 that this is simply a convenience method retained for ex Class::DBI users.
1136 You most likely want to use L</search> with specific operators.
1138 For more information, see L<DBIx::Class::Manual::Cookbook>.
1140 This method is deprecated and will be removed in 0.09. Use L</search()>
1141 instead. An example conversion is:
1143 ->search_like({ foo => 'bar' });
1147 ->search({ foo => { like => 'bar' } });
1154 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1155 .' Instead use ->search({ x => { -like => "y%" } })'
1156 .' (note the outer pair of {}s - they are important!)'
1158 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1159 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1160 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1161 return $class->search($query, { %$attrs });
1168 =item Arguments: $first, $last
1170 =item Return Value: $resultset (scalar context) || @row_objs (list context)
1174 Returns a resultset or object list representing a subset of elements from the
1175 resultset slice is called on. Indexes are from 0, i.e., to get the first
1176 three records, call:
1178 my ($one, $two, $three) = $rs->slice(0, 2);
1183 my ($self, $min, $max) = @_;
1184 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1185 $attrs->{offset} = $self->{attrs}{offset} || 0;
1186 $attrs->{offset} += $min;
1187 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1188 return $self->search(undef, $attrs);
1189 #my $slice = (ref $self)->new($self->result_source, $attrs);
1190 #return (wantarray ? $slice->all : $slice);
1197 =item Arguments: none
1199 =item Return Value: $result | undef
1203 Returns the next element in the resultset (C<undef> is there is none).
1205 Can be used to efficiently iterate over records in the resultset:
1207 my $rs = $schema->resultset('CD')->search;
1208 while (my $cd = $rs->next) {
1212 Note that you need to store the resultset object, and call C<next> on it.
1213 Calling C<< resultset('Table')->next >> repeatedly will always return the
1214 first record from the resultset.
1221 if (my $cache = $self->get_cache) {
1222 $self->{all_cache_position} ||= 0;
1223 return $cache->[$self->{all_cache_position}++];
1226 if ($self->{attrs}{cache}) {
1227 delete $self->{pager};
1228 $self->{all_cache_position} = 1;
1229 return ($self->all)[0];
1232 return shift(@{$self->{stashed_objects}}) if @{ $self->{stashed_objects}||[] };
1234 $self->{stashed_objects} = $self->_construct_objects
1237 return shift @{$self->{stashed_objects}};
1240 # Constructs as many objects as it can in one pass while respecting
1241 # cursor laziness. Several modes of operation:
1243 # * Always builds everything present in @{$self->{stashed_rows}}
1244 # * If called with $fetch_all true - pulls everything off the cursor and
1245 # builds all objects in one pass
1246 # * If $self->_resolved_attrs->{collapse} is true, checks the order_by
1247 # and if the resultset is ordered properly by the left side:
1248 # * Fetches stuff off the cursor until the "master object" changes,
1249 # and saves the last extra row (if any) in @{$self->{stashed_rows}}
1251 # * Just fetches, and collapses/constructs everything as if $fetch_all
1252 # was requested (there is no other way to collapse except for an
1254 # * If no collapse is requested - just get the next row, construct and
1256 sub _construct_objects {
1257 my ($self, $fetch_all) = @_;
1259 my $rsrc = $self->result_source;
1260 my $attrs = $self->_resolved_attrs;
1261 my $cursor = $self->cursor;
1263 # this will be used as both initial raw-row collector AND as a RV of
1264 # _construct_objects. Not regrowing the array twice matters a lot...
1265 # a suprising amount actually
1266 my $rows = (delete $self->{stashed_rows}) || [];
1268 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1269 $rows = [ @$rows, $cursor->all ];
1271 elsif (!$attrs->{collapse}) {
1272 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1273 push @$rows, do { my @r = $cursor->next; @r ? \@r : () }
1277 $attrs->{_ordered_for_collapse} ||= (!$attrs->{order_by}) ? undef : do {
1278 my $st = $rsrc->schema->storage;
1281 ( $st->_extract_order_criteria($attrs->{order_by}) )
1284 my $colinfos = $st->_resolve_column_info($attrs->{from}, \@ord_cols);
1286 for (0 .. $#ord_cols) {
1288 ! $colinfos->{$ord_cols[$_]}
1290 $colinfos->{$ord_cols[$_]}{-result_source} != $rsrc
1292 splice @ord_cols, $_;
1297 # since all we check here are the start of the order_by belonging to the
1298 # top level $rsrc, a present identifying set will mean that the resultset
1299 # is ordered by its leftmost table in a tsable manner
1300 (@ord_cols and $rsrc->_identifying_column_set({ map
1301 { $colinfos->{$_}{-colname} => $colinfos->{$_} }
1306 if ($attrs->{_ordered_for_collapse}) {
1307 push @$rows, do { my @r = $cursor->next; @r ? \@r : () };
1309 # instead of looping over ->next, use ->all in stealth mode
1310 # FIXME - encapsulation breach, got to be a better way
1311 elsif (! $cursor->{done}) {
1312 push @$rows, $cursor->all;
1313 $cursor->{done} = 1;
1318 return undef unless @$rows;
1320 my $res_class = $self->result_class;
1321 my $inflator = $res_class->can ('inflate_result')
1322 or $self->throw_exception("Inflator $res_class does not provide an inflate_result() method");
1324 my $infmap = $attrs->{as};
1326 if (!$attrs->{collapse} and $attrs->{_single_object_inflation}) {
1327 # construct a much simpler array->hash folder for the one-table cases right here
1329 # FIXME SUBOPTIMAL this is a very very very hot spot
1330 # while rather optimal we can *still* do much better, by
1331 # building a smarter [Row|HRI]::inflate_result(), and
1332 # switch to feeding it data via a much leaner interface
1334 # crude unscientific benchmarking indicated the shortcut eval is not worth it for
1335 # this particular resultset size
1337 my @as_idx = 0..$#$infmap;
1338 for my $r (@$rows) {
1339 $r = $inflator->($res_class, $rsrc, { map { $infmap->[$_] => $r->[$_] } @as_idx } );
1344 '$_ = $inflator->($res_class, $rsrc, { %s }) for @$rows',
1345 join (', ', map { "\$infmap->[$_] => \$_->[$_]" } 0..$#$infmap )
1350 ($self->{_row_parser} ||= eval sprintf 'sub { %s }', $rsrc->_mk_row_parser({
1351 inflate_map => $infmap,
1352 selection => $attrs->{select},
1353 collapse => $attrs->{collapse},
1354 }) or die $@)->($rows, $fetch_all ? () : (
1355 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1356 sub { my @r = $cursor->next or return; \@r }, # how the collapser gets more rows
1357 ($self->{stashed_rows} = []), # where does it stuff excess
1358 )); # modify $rows in-place, shrinking/extending as necessary
1360 $_ = $inflator->($res_class, $rsrc, @$_) for @$rows;
1365 if ($attrs->{record_filter}) {
1366 $_ = $attrs->{record_filter}->($_) for @$rows;
1372 =head2 result_source
1376 =item Arguments: $result_source?
1378 =item Return Value: $result_source
1382 An accessor for the primary ResultSource object from which this ResultSet
1389 =item Arguments: $result_class?
1391 =item Return Value: $result_class
1395 An accessor for the class to use when creating row objects. Defaults to
1396 C<< result_source->result_class >> - which in most cases is the name of the
1397 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1399 Note that changing the result_class will also remove any components
1400 that were originally loaded in the source class via
1401 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1402 in the original source class will not run.
1407 my ($self, $result_class) = @_;
1408 if ($result_class) {
1409 unless (ref $result_class) { # don't fire this for an object
1410 $self->ensure_class_loaded($result_class);
1412 $self->_result_class($result_class);
1413 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1414 # permit the user to set result class on one result set only; it only
1415 # chains if provided to search()
1416 #$self->{attrs}{result_class} = $result_class if ref $self;
1418 $self->_result_class;
1425 =item Arguments: $cond, \%attrs??
1427 =item Return Value: $count
1431 Performs an SQL C<COUNT> with the same query as the resultset was built
1432 with to find the number of elements. Passing arguments is equivalent to
1433 C<< $rs->search ($cond, \%attrs)->count >>
1439 return $self->search(@_)->count if @_ and defined $_[0];
1440 return scalar @{ $self->get_cache } if $self->get_cache;
1442 my $attrs = $self->_resolved_attrs_copy;
1444 # this is a little optimization - it is faster to do the limit
1445 # adjustments in software, instead of a subquery
1446 my ($rows, $offset) = delete @{$attrs}{qw/rows offset/};
1449 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1450 $crs = $self->_count_subq_rs ($attrs);
1453 $crs = $self->_count_rs ($attrs);
1455 my $count = $crs->next;
1457 $count -= $offset if $offset;
1458 $count = $rows if $rows and $rows < $count;
1459 $count = 0 if ($count < 0);
1468 =item Arguments: $cond, \%attrs??
1470 =item Return Value: $count_rs
1474 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1475 This can be very handy for subqueries:
1477 ->search( { amount => $some_rs->count_rs->as_query } )
1479 As with regular resultsets the SQL query will be executed only after
1480 the resultset is accessed via L</next> or L</all>. That would return
1481 the same single value obtainable via L</count>.
1487 return $self->search(@_)->count_rs if @_;
1489 # this may look like a lack of abstraction (count() does about the same)
1490 # but in fact an _rs *must* use a subquery for the limits, as the
1491 # software based limiting can not be ported if this $rs is to be used
1492 # in a subquery itself (i.e. ->as_query)
1493 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1494 return $self->_count_subq_rs;
1497 return $self->_count_rs;
1502 # returns a ResultSetColumn object tied to the count query
1505 my ($self, $attrs) = @_;
1507 my $rsrc = $self->result_source;
1508 $attrs ||= $self->_resolved_attrs;
1510 my $tmp_attrs = { %$attrs };
1511 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1512 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1514 # overwrite the selector (supplied by the storage)
1515 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $attrs);
1516 $tmp_attrs->{as} = 'count';
1518 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1524 # same as above but uses a subquery
1526 sub _count_subq_rs {
1527 my ($self, $attrs) = @_;
1529 my $rsrc = $self->result_source;
1530 $attrs ||= $self->_resolved_attrs;
1532 my $sub_attrs = { %$attrs };
1533 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1534 delete @{$sub_attrs}{qw/collapse columns as select _prefetch_selector_range order_by for/};
1536 # if we multi-prefetch we group_by something unique, as this is what we would
1537 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1538 if ( $attrs->{collapse} ) {
1539 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1540 $rsrc->_identifying_column_set || $self->throw_exception(
1541 'Unable to construct a unique group_by criteria properly collapsing the '
1542 . 'has_many prefetch before count()'
1547 # Calculate subquery selector
1548 if (my $g = $sub_attrs->{group_by}) {
1550 my $sql_maker = $rsrc->storage->sql_maker;
1552 # necessary as the group_by may refer to aliased functions
1554 for my $sel (@{$attrs->{select}}) {
1555 $sel_index->{$sel->{-as}} = $sel
1556 if (ref $sel eq 'HASH' and $sel->{-as});
1559 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1560 # also look for named aggregates referred in the having clause
1561 # having often contains scalarrefs - thus parse it out entirely
1563 if ($attrs->{having}) {
1564 local $sql_maker->{having_bind};
1565 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1566 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1567 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1568 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1569 # if we don't unset it we screw up retarded but unfortunately working
1570 # 'MAX(foo.bar)' => { '>', 3 }
1571 $sql_maker->{name_sep} = '';
1574 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1576 my $sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1578 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1579 # and if all fails for an utterly naive quoted scalar-with-function
1581 $rquote $sep $lquote (.+?) $rquote
1583 [\s,] \w+ \. (\w+) [\s,]
1585 [\s,] $lquote (.+?) $rquote [\s,]
1587 push @parts, ($1 || $2 || $3); # one of them matched if we got here
1592 my $colpiece = $sel_index->{$_} || $_;
1594 # unqualify join-based group_by's. Arcane but possible query
1595 # also horrible horrible hack to alias a column (not a func.)
1596 # (probably need to introduce SQLA syntax)
1597 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1600 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1602 push @{$sub_attrs->{select}}, $colpiece;
1606 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1607 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1610 return $rsrc->resultset_class
1611 ->new ($rsrc, $sub_attrs)
1613 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1614 ->get_column ('count');
1621 =head2 count_literal
1625 =item Arguments: $sql_fragment, @bind_values
1627 =item Return Value: $count
1631 Counts the results in a literal query. Equivalent to calling L</search_literal>
1632 with the passed arguments, then L</count>.
1636 sub count_literal { shift->search_literal(@_)->count; }
1642 =item Arguments: none
1644 =item Return Value: @objects
1648 Returns all elements in the resultset.
1655 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1658 delete @{$self}{qw/stashed_rows stashed_objects/};
1660 if (my $c = $self->get_cache) {
1664 $self->cursor->reset;
1666 my $objs = $self->_construct_objects('fetch_all') || [];
1668 $self->set_cache($objs) if $self->{attrs}{cache};
1677 =item Arguments: none
1679 =item Return Value: $self
1683 Resets the resultset's cursor, so you can iterate through the elements again.
1684 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1692 delete @{$self}{qw/_attrs stashed_rows stashed_objects/};
1694 $self->{all_cache_position} = 0;
1695 $self->cursor->reset;
1703 =item Arguments: none
1705 =item Return Value: $object | undef
1709 Resets the resultset and returns an object for the first result (or C<undef>
1710 if the resultset is empty).
1715 return $_[0]->reset->next;
1721 # Determines whether and what type of subquery is required for the $rs operation.
1722 # If grouping is necessary either supplies its own, or verifies the current one
1723 # After all is done delegates to the proper storage method.
1725 sub _rs_update_delete {
1726 my ($self, $op, $values) = @_;
1728 my $cond = $self->{cond};
1729 my $rsrc = $self->result_source;
1730 my $storage = $rsrc->schema->storage;
1732 my $attrs = { %{$self->_resolved_attrs} };
1734 # "needs" is a strong word here - if the subquery is part of an IN clause - no point of
1735 # even adding the group_by. It will really be used only when composing a poor-man's
1736 # multicolumn-IN equivalent OR set
1737 my $needs_group_by_subq = defined $attrs->{group_by};
1739 # simplify the joinmap and maybe decide if a grouping (and thus subquery) is necessary
1740 my $relation_classifications;
1741 if (ref($attrs->{from}) eq 'ARRAY') {
1742 if (@{$attrs->{from}} == 1) {
1743 # not a fucking JOIN at all, quit with the dickery
1744 $relation_classifications = {};
1746 $attrs->{from} = $storage->_prune_unused_joins ($attrs->{from}, $attrs->{select}, $cond, $attrs);
1748 $relation_classifications = $storage->_resolve_aliastypes_from_select_args (
1749 [ @{$attrs->{from}}[1 .. $#{$attrs->{from}}] ],
1753 ) unless $needs_group_by_subq; # we already know we need a group, no point of resolving them
1757 $needs_group_by_subq ||= 1; # if {from} is unparseable assume the worst
1760 $needs_group_by_subq ||= exists $relation_classifications->{multiplying};
1762 # if no subquery - life is easy-ish
1764 $needs_group_by_subq
1766 keys %$relation_classifications # if any joins at all - need to wrap a subq
1768 $self->_has_resolved_attr(qw/rows offset/) # limits call for a subq
1770 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1771 # a condition containing 'me' or other table prefixes will not work
1772 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1773 my $sqla = $rsrc->storage->sql_maker;
1774 local $sqla->{_dequalify_idents} = 1;
1775 return $rsrc->storage->$op(
1777 $op eq 'update' ? $values : (),
1782 # we got this far - means it is time to wrap a subquery
1783 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1785 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1790 my $existing_group_by = delete $attrs->{group_by};
1792 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1793 delete @{$attrs}{qw/collapse select _prefetch_selector_range as/};
1794 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1795 $attrs->{group_by} = \ ''; # FIXME - this is an evil hack, it causes the optimiser to kick in and throw away the LEFT joins
1796 my $subrs = (ref $self)->new($rsrc, $attrs);
1798 if (@$idcols == 1) {
1799 return $storage->$op (
1801 $op eq 'update' ? $values : (),
1802 { $idcols->[0] => { -in => $subrs->as_query } },
1805 elsif ($storage->_use_multicolumn_in) {
1806 # This is hideously ugly, but SQLA does not understand multicol IN expressions
1807 my $sql_maker = $storage->sql_maker;
1808 my ($sql, @bind) = @${$subrs->as_query};
1809 $sql = sprintf ('(%s) IN %s', # the as_query already comes with a set of parenthesis
1810 join (', ', map { $sql_maker->_quote ($_) } @$idcols),
1814 return $storage->$op (
1816 $op eq 'update' ? $values : (),
1821 # if all else fails - get all primary keys and operate over a ORed set
1822 # wrap in a transaction for consistency
1823 # this is where the group_by starts to matter
1825 if ($needs_group_by_subq) {
1826 $subq_group_by = $attrs->{columns};
1828 # make sure if there is a supplied group_by it matches the columns compiled above
1829 # perfectly. Anything else can not be sanely executed on most databases so croak
1830 # right then and there
1831 if ($existing_group_by) {
1832 my @current_group_by = map
1833 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1838 join ("\x00", sort @current_group_by)
1840 join ("\x00", sort @$subq_group_by )
1842 $self->throw_exception (
1843 "You have just attempted a $op operation on a resultset which does group_by"
1844 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1845 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1846 . ' kind of queries. Please retry the operation with a modified group_by or'
1847 . ' without using one at all.'
1853 my $guard = $storage->txn_scope_guard;
1856 for my $row ($subrs->search({}, { group_by => $subq_group_by })->cursor->all) {
1857 push @op_condition, { map
1858 { $idcols->[$_] => $row->[$_] }
1863 my $res = $storage->$op (
1865 $op eq 'update' ? $values : (),
1879 =item Arguments: \%values
1881 =item Return Value: $storage_rv
1885 Sets the specified columns in the resultset to the supplied values in a
1886 single query. Note that this will not run any accessor/set_column/update
1887 triggers, nor will it update any row object instances derived from this
1888 resultset (this includes the contents of the L<resultset cache|/set_cache>
1889 if any). See L</update_all> if you need to execute any on-update
1890 triggers or cascades defined either by you or a
1891 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1893 The return value is a pass through of what the underlying
1894 storage backend returned, and may vary. See L<DBI/execute> for the most
1899 Note that L</update> does not process/deflate any of the values passed in.
1900 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
1901 ensure manually that any value passed to this method will stringify to
1902 something the RDBMS knows how to deal with. A notable example is the
1903 handling of L<DateTime> objects, for more info see:
1904 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
1909 my ($self, $values) = @_;
1910 $self->throw_exception('Values for update must be a hash')
1911 unless ref $values eq 'HASH';
1913 return $self->_rs_update_delete ('update', $values);
1920 =item Arguments: \%values
1922 =item Return Value: 1
1926 Fetches all objects and updates them one at a time via
1927 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
1928 triggers, while L</update> will not.
1933 my ($self, $values) = @_;
1934 $self->throw_exception('Values for update_all must be a hash')
1935 unless ref $values eq 'HASH';
1937 my $guard = $self->result_source->schema->txn_scope_guard;
1938 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
1947 =item Arguments: none
1949 =item Return Value: $storage_rv
1953 Deletes the rows matching this resultset in a single query. Note that this
1954 will not run any delete triggers, nor will it alter the
1955 L<in_storage|DBIx::Class::Row/in_storage> status of any row object instances
1956 derived from this resultset (this includes the contents of the
1957 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
1958 execute any on-delete triggers or cascades defined either by you or a
1959 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1961 The return value is a pass through of what the underlying storage backend
1962 returned, and may vary. See L<DBI/execute> for the most common case.
1968 $self->throw_exception('delete does not accept any arguments')
1971 return $self->_rs_update_delete ('delete');
1978 =item Arguments: none
1980 =item Return Value: 1
1984 Fetches all objects and deletes them one at a time via
1985 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
1986 triggers, while L</delete> will not.
1992 $self->throw_exception('delete_all does not accept any arguments')
1995 my $guard = $self->result_source->schema->txn_scope_guard;
1996 $_->delete for $self->all;
2005 =item Arguments: \@data;
2009 Accepts either an arrayref of hashrefs or alternatively an arrayref of arrayrefs.
2010 For the arrayref of hashrefs style each hashref should be a structure suitable
2011 for submitting to a $resultset->create(...) method.
2013 In void context, C<insert_bulk> in L<DBIx::Class::Storage::DBI> is used
2014 to insert the data, as this is a faster method.
2016 Otherwise, each set of data is inserted into the database using
2017 L<DBIx::Class::ResultSet/create>, and the resulting objects are
2018 accumulated into an array. The array itself, or an array reference
2019 is returned depending on scalar or list context.
2021 Example: Assuming an Artist Class that has many CDs Classes relating:
2023 my $Artist_rs = $schema->resultset("Artist");
2025 ## Void Context Example
2026 $Artist_rs->populate([
2027 { artistid => 4, name => 'Manufactured Crap', cds => [
2028 { title => 'My First CD', year => 2006 },
2029 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2032 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2033 { title => 'My parents sold me to a record company', year => 2005 },
2034 { title => 'Why Am I So Ugly?', year => 2006 },
2035 { title => 'I Got Surgery and am now Popular', year => 2007 }
2040 ## Array Context Example
2041 my ($ArtistOne, $ArtistTwo, $ArtistThree) = $Artist_rs->populate([
2042 { name => "Artist One"},
2043 { name => "Artist Two"},
2044 { name => "Artist Three", cds=> [
2045 { title => "First CD", year => 2007},
2046 { title => "Second CD", year => 2008},
2050 print $ArtistOne->name; ## response is 'Artist One'
2051 print $ArtistThree->cds->count ## reponse is '2'
2053 For the arrayref of arrayrefs style, the first element should be a list of the
2054 fieldsnames to which the remaining elements are rows being inserted. For
2057 $Arstist_rs->populate([
2058 [qw/artistid name/],
2059 [100, 'A Formally Unknown Singer'],
2060 [101, 'A singer that jumped the shark two albums ago'],
2061 [102, 'An actually cool singer'],
2064 Please note an important effect on your data when choosing between void and
2065 wantarray context. Since void context goes straight to C<insert_bulk> in
2066 L<DBIx::Class::Storage::DBI> this will skip any component that is overriding
2067 C<insert>. So if you are using something like L<DBIx-Class-UUIDColumns> to
2068 create primary keys for you, you will find that your PKs are empty. In this
2069 case you will have to use the wantarray context in order to create those
2077 # cruft placed in standalone method
2078 my $data = $self->_normalize_populate_args(@_);
2080 return unless @$data;
2082 if(defined wantarray) {
2084 foreach my $item (@$data) {
2085 push(@created, $self->create($item));
2087 return wantarray ? @created : \@created;
2090 my $first = $data->[0];
2092 # if a column is a registered relationship, and is a non-blessed hash/array, consider
2093 # it relationship data
2094 my (@rels, @columns);
2095 my $rsrc = $self->result_source;
2096 my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2097 for (keys %$first) {
2098 my $ref = ref $first->{$_};
2099 $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2105 my @pks = $rsrc->primary_columns;
2107 ## do the belongs_to relationships
2108 foreach my $index (0..$#$data) {
2110 # delegate to create() for any dataset without primary keys with specified relationships
2111 if (grep { !defined $data->[$index]->{$_} } @pks ) {
2113 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
2114 my @ret = $self->populate($data);
2120 foreach my $rel (@rels) {
2121 next unless ref $data->[$index]->{$rel} eq "HASH";
2122 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2123 my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2124 my $related = $result->result_source->_resolve_condition(
2125 $reverse_relinfo->{cond},
2131 delete $data->[$index]->{$rel};
2132 $data->[$index] = {%{$data->[$index]}, %$related};
2134 push @columns, keys %$related if $index == 0;
2138 ## inherit the data locked in the conditions of the resultset
2139 my ($rs_data) = $self->_merge_with_rscond({});
2140 delete @{$rs_data}{@columns};
2141 my @inherit_cols = keys %$rs_data;
2142 my @inherit_data = values %$rs_data;
2144 ## do bulk insert on current row
2145 $rsrc->storage->insert_bulk(
2147 [@columns, @inherit_cols],
2148 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
2151 ## do the has_many relationships
2152 foreach my $item (@$data) {
2156 foreach my $rel (@rels) {
2157 next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2159 $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2161 my $child = $main_row->$rel;
2163 my $related = $child->result_source->_resolve_condition(
2164 $rels->{$rel}{cond},
2170 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2171 my @populate = map { {%$_, %$related} } @rows_to_add;
2173 $child->populate( \@populate );
2180 # populate() argumnets went over several incarnations
2181 # What we ultimately support is AoH
2182 sub _normalize_populate_args {
2183 my ($self, $arg) = @_;
2185 if (ref $arg eq 'ARRAY') {
2189 elsif (ref $arg->[0] eq 'HASH') {
2192 elsif (ref $arg->[0] eq 'ARRAY') {
2194 my @colnames = @{$arg->[0]};
2195 foreach my $values (@{$arg}[1 .. $#$arg]) {
2196 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2202 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2209 =item Arguments: none
2211 =item Return Value: $pager
2215 Return Value a L<Data::Page> object for the current resultset. Only makes
2216 sense for queries with a C<page> attribute.
2218 To get the full count of entries for a paged resultset, call
2219 C<total_entries> on the L<Data::Page> object.
2226 return $self->{pager} if $self->{pager};
2228 my $attrs = $self->{attrs};
2229 if (!defined $attrs->{page}) {
2230 $self->throw_exception("Can't create pager for non-paged rs");
2232 elsif ($attrs->{page} <= 0) {
2233 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2235 $attrs->{rows} ||= 10;
2237 # throw away the paging flags and re-run the count (possibly
2238 # with a subselect) to get the real total count
2239 my $count_attrs = { %$attrs };
2240 delete @{$count_attrs}{qw/rows offset page pager/};
2242 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2244 require DBIx::Class::ResultSet::Pager;
2245 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2246 sub { $total_rs->count }, #lazy-get the total
2248 $self->{attrs}{page},
2256 =item Arguments: $page_number
2258 =item Return Value: $rs
2262 Returns a resultset for the $page_number page of the resultset on which page
2263 is called, where each page contains a number of rows equal to the 'rows'
2264 attribute set on the resultset (10 by default).
2269 my ($self, $page) = @_;
2270 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2277 =item Arguments: \%vals
2279 =item Return Value: $rowobject
2283 Creates a new row object in the resultset's result class and returns
2284 it. The row is not inserted into the database at this point, call
2285 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2286 will tell you whether the row object has been inserted or not.
2288 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2293 my ($self, $values) = @_;
2294 $self->throw_exception( "new_result needs a hash" )
2295 unless (ref $values eq 'HASH');
2297 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2301 @$cols_from_relations
2302 ? (-cols_from_relations => $cols_from_relations)
2304 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2307 return $self->result_class->new(\%new);
2310 # _merge_with_rscond
2312 # Takes a simple hash of K/V data and returns its copy merged with the
2313 # condition already present on the resultset. Additionally returns an
2314 # arrayref of value/condition names, which were inferred from related
2315 # objects (this is needed for in-memory related objects)
2316 sub _merge_with_rscond {
2317 my ($self, $data) = @_;
2319 my (%new_data, @cols_from_relations);
2321 my $alias = $self->{attrs}{alias};
2323 if (! defined $self->{cond}) {
2324 # just massage $data below
2326 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
2327 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2328 @cols_from_relations = keys %new_data;
2330 elsif (ref $self->{cond} ne 'HASH') {
2331 $self->throw_exception(
2332 "Can't abstract implicit construct, resultset condition not a hash"
2336 # precendence must be given to passed values over values inherited from
2337 # the cond, so the order here is important.
2338 my $collapsed_cond = $self->_collapse_cond($self->{cond});
2339 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2341 while ( my($col, $value) = each %implied ) {
2342 my $vref = ref $value;
2348 (keys %$value)[0] eq '='
2350 $new_data{$col} = $value->{'='};
2352 elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2353 $new_data{$col} = $value;
2360 %{ $self->_remove_alias($data, $alias) },
2363 return (\%new_data, \@cols_from_relations);
2366 # _has_resolved_attr
2368 # determines if the resultset defines at least one
2369 # of the attributes supplied
2371 # used to determine if a subquery is neccessary
2373 # supports some virtual attributes:
2375 # This will scan for any joins being present on the resultset.
2376 # It is not a mere key-search but a deep inspection of {from}
2379 sub _has_resolved_attr {
2380 my ($self, @attr_names) = @_;
2382 my $attrs = $self->_resolved_attrs;
2386 for my $n (@attr_names) {
2387 if (grep { $n eq $_ } (qw/-join/) ) {
2388 $extra_checks{$n}++;
2392 my $attr = $attrs->{$n};
2394 next if not defined $attr;
2396 if (ref $attr eq 'HASH') {
2397 return 1 if keys %$attr;
2399 elsif (ref $attr eq 'ARRAY') {
2407 # a resolved join is expressed as a multi-level from
2409 $extra_checks{-join}
2411 ref $attrs->{from} eq 'ARRAY'
2413 @{$attrs->{from}} > 1
2421 # Recursively collapse the condition.
2423 sub _collapse_cond {
2424 my ($self, $cond, $collapsed) = @_;
2428 if (ref $cond eq 'ARRAY') {
2429 foreach my $subcond (@$cond) {
2430 next unless ref $subcond; # -or
2431 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2434 elsif (ref $cond eq 'HASH') {
2435 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2436 foreach my $subcond (@{$cond->{-and}}) {
2437 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2441 foreach my $col (keys %$cond) {
2442 my $value = $cond->{$col};
2443 $collapsed->{$col} = $value;
2453 # Remove the specified alias from the specified query hash. A copy is made so
2454 # the original query is not modified.
2457 my ($self, $query, $alias) = @_;
2459 my %orig = %{ $query || {} };
2462 foreach my $key (keys %orig) {
2464 $unaliased{$key} = $orig{$key};
2467 $unaliased{$1} = $orig{$key}
2468 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2478 =item Arguments: none
2480 =item Return Value: \[ $sql, @bind ]
2484 Returns the SQL query and bind vars associated with the invocant.
2486 This is generally used as the RHS for a subquery.
2493 my $attrs = $self->_resolved_attrs_copy;
2498 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2499 # $sql also has no wrapping parenthesis in list ctx
2501 my $sqlbind = $self->result_source->storage
2502 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2511 =item Arguments: \%vals, \%attrs?
2513 =item Return Value: $rowobject
2517 my $artist = $schema->resultset('Artist')->find_or_new(
2518 { artist => 'fred' }, { key => 'artists' });
2520 $cd->cd_to_producer->find_or_new({ producer => $producer },
2521 { key => 'primary });
2523 Find an existing record from this resultset using L</find>. if none exists,
2524 instantiate a new result object and return it. The object will not be saved
2525 into your storage until you call L<DBIx::Class::Row/insert> on it.
2527 You most likely want this method when looking for existing rows using a unique
2528 constraint that is not the primary key, or looking for related rows.
2530 If you want objects to be saved immediately, use L</find_or_create> instead.
2532 B<Note>: Make sure to read the documentation of L</find> and understand the
2533 significance of the C<key> attribute, as its lack may skew your search, and
2534 subsequently result in spurious new objects.
2536 B<Note>: Take care when using C<find_or_new> with a table having
2537 columns with default values that you intend to be automatically
2538 supplied by the database (e.g. an auto_increment primary key column).
2539 In normal usage, the value of such columns should NOT be included at
2540 all in the call to C<find_or_new>, even when set to C<undef>.
2546 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2547 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2548 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2551 return $self->new_result($hash);
2558 =item Arguments: \%vals
2560 =item Return Value: a L<DBIx::Class::Row> $object
2564 Attempt to create a single new row or a row with multiple related rows
2565 in the table represented by the resultset (and related tables). This
2566 will not check for duplicate rows before inserting, use
2567 L</find_or_create> to do that.
2569 To create one row for this resultset, pass a hashref of key/value
2570 pairs representing the columns of the table and the values you wish to
2571 store. If the appropriate relationships are set up, foreign key fields
2572 can also be passed an object representing the foreign row, and the
2573 value will be set to its primary key.
2575 To create related objects, pass a hashref of related-object column values
2576 B<keyed on the relationship name>. If the relationship is of type C<multi>
2577 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2578 The process will correctly identify columns holding foreign keys, and will
2579 transparently populate them from the keys of the corresponding relation.
2580 This can be applied recursively, and will work correctly for a structure
2581 with an arbitrary depth and width, as long as the relationships actually
2582 exists and the correct column data has been supplied.
2585 Instead of hashrefs of plain related data (key/value pairs), you may
2586 also pass new or inserted objects. New objects (not inserted yet, see
2587 L</new>), will be inserted into their appropriate tables.
2589 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
2591 Example of creating a new row.
2593 $person_rs->create({
2594 name=>"Some Person",
2595 email=>"somebody@someplace.com"
2598 Example of creating a new row and also creating rows in a related C<has_many>
2599 or C<has_one> resultset. Note Arrayref.
2602 { artistid => 4, name => 'Manufactured Crap', cds => [
2603 { title => 'My First CD', year => 2006 },
2604 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2609 Example of creating a new row and also creating a row in a related
2610 C<belongs_to> resultset. Note Hashref.
2613 title=>"Music for Silly Walks",
2616 name=>"Silly Musician",
2624 When subclassing ResultSet never attempt to override this method. Since
2625 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2626 lot of the internals simply never call it, so your override will be
2627 bypassed more often than not. Override either L<new|DBIx::Class::Row/new>
2628 or L<insert|DBIx::Class::Row/insert> depending on how early in the
2629 L</create> process you need to intervene.
2636 my ($self, $attrs) = @_;
2637 $self->throw_exception( "create needs a hashref" )
2638 unless ref $attrs eq 'HASH';
2639 return $self->new_result($attrs)->insert;
2642 =head2 find_or_create
2646 =item Arguments: \%vals, \%attrs?
2648 =item Return Value: $rowobject
2652 $cd->cd_to_producer->find_or_create({ producer => $producer },
2653 { key => 'primary' });
2655 Tries to find a record based on its primary key or unique constraints; if none
2656 is found, creates one and returns that instead.
2658 my $cd = $schema->resultset('CD')->find_or_create({
2660 artist => 'Massive Attack',
2661 title => 'Mezzanine',
2665 Also takes an optional C<key> attribute, to search by a specific key or unique
2666 constraint. For example:
2668 my $cd = $schema->resultset('CD')->find_or_create(
2670 artist => 'Massive Attack',
2671 title => 'Mezzanine',
2673 { key => 'cd_artist_title' }
2676 B<Note>: Make sure to read the documentation of L</find> and understand the
2677 significance of the C<key> attribute, as its lack may skew your search, and
2678 subsequently result in spurious row creation.
2680 B<Note>: Because find_or_create() reads from the database and then
2681 possibly inserts based on the result, this method is subject to a race
2682 condition. Another process could create a record in the table after
2683 the find has completed and before the create has started. To avoid
2684 this problem, use find_or_create() inside a transaction.
2686 B<Note>: Take care when using C<find_or_create> with a table having
2687 columns with default values that you intend to be automatically
2688 supplied by the database (e.g. an auto_increment primary key column).
2689 In normal usage, the value of such columns should NOT be included at
2690 all in the call to C<find_or_create>, even when set to C<undef>.
2692 See also L</find> and L</update_or_create>. For information on how to declare
2693 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2695 If you need to know if an existing row was found or a new one created use
2696 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2697 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2700 my $cd = $schema->resultset('CD')->find_or_new({
2702 artist => 'Massive Attack',
2703 title => 'Mezzanine',
2707 if( $cd->in_storage ) {
2714 sub find_or_create {
2716 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2717 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2718 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2721 return $self->create($hash);
2724 =head2 update_or_create
2728 =item Arguments: \%col_values, { key => $unique_constraint }?
2730 =item Return Value: $row_object
2734 $resultset->update_or_create({ col => $val, ... });
2736 Like L</find_or_create>, but if a row is found it is immediately updated via
2737 C<< $found_row->update (\%col_values) >>.
2740 Takes an optional C<key> attribute to search on a specific unique constraint.
2743 # In your application
2744 my $cd = $schema->resultset('CD')->update_or_create(
2746 artist => 'Massive Attack',
2747 title => 'Mezzanine',
2750 { key => 'cd_artist_title' }
2753 $cd->cd_to_producer->update_or_create({
2754 producer => $producer,
2760 B<Note>: Make sure to read the documentation of L</find> and understand the
2761 significance of the C<key> attribute, as its lack may skew your search, and
2762 subsequently result in spurious row creation.
2764 B<Note>: Take care when using C<update_or_create> with a table having
2765 columns with default values that you intend to be automatically
2766 supplied by the database (e.g. an auto_increment primary key column).
2767 In normal usage, the value of such columns should NOT be included at
2768 all in the call to C<update_or_create>, even when set to C<undef>.
2770 See also L</find> and L</find_or_create>. For information on how to declare
2771 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2773 If you need to know if an existing row was updated or a new one created use
2774 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2775 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2778 my $cd = $schema->resultset('CD')->update_or_new(
2780 artist => 'Massive Attack',
2781 title => 'Mezzanine',
2784 { key => 'cd_artist_title' }
2787 if( $cd->in_storage ) {
2794 sub update_or_create {
2796 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2797 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2799 my $row = $self->find($cond, $attrs);
2801 $row->update($cond);
2805 return $self->create($cond);
2808 =head2 update_or_new
2812 =item Arguments: \%col_values, { key => $unique_constraint }?
2814 =item Return Value: $rowobject
2818 $resultset->update_or_new({ col => $val, ... });
2820 Like L</find_or_new> but if a row is found it is immediately updated via
2821 C<< $found_row->update (\%col_values) >>.
2825 # In your application
2826 my $cd = $schema->resultset('CD')->update_or_new(
2828 artist => 'Massive Attack',
2829 title => 'Mezzanine',
2832 { key => 'cd_artist_title' }
2835 if ($cd->in_storage) {
2836 # the cd was updated
2839 # the cd is not yet in the database, let's insert it
2843 B<Note>: Make sure to read the documentation of L</find> and understand the
2844 significance of the C<key> attribute, as its lack may skew your search, and
2845 subsequently result in spurious new objects.
2847 B<Note>: Take care when using C<update_or_new> with a table having
2848 columns with default values that you intend to be automatically
2849 supplied by the database (e.g. an auto_increment primary key column).
2850 In normal usage, the value of such columns should NOT be included at
2851 all in the call to C<update_or_new>, even when set to C<undef>.
2853 See also L</find>, L</find_or_create> and L</find_or_new>.
2859 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2860 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2862 my $row = $self->find( $cond, $attrs );
2863 if ( defined $row ) {
2864 $row->update($cond);
2868 return $self->new_result($cond);
2875 =item Arguments: none
2877 =item Return Value: \@cache_objects | undef
2881 Gets the contents of the cache for the resultset, if the cache is set.
2883 The cache is populated either by using the L</prefetch> attribute to
2884 L</search> or by calling L</set_cache>.
2896 =item Arguments: \@cache_objects
2898 =item Return Value: \@cache_objects
2902 Sets the contents of the cache for the resultset. Expects an arrayref
2903 of objects of the same class as those produced by the resultset. Note that
2904 if the cache is set the resultset will return the cached objects rather
2905 than re-querying the database even if the cache attr is not set.
2907 The contents of the cache can also be populated by using the
2908 L</prefetch> attribute to L</search>.
2913 my ( $self, $data ) = @_;
2914 $self->throw_exception("set_cache requires an arrayref")
2915 if defined($data) && (ref $data ne 'ARRAY');
2916 $self->{all_cache} = $data;
2923 =item Arguments: none
2925 =item Return Value: undef
2929 Clears the cache for the resultset.
2934 shift->set_cache(undef);
2941 =item Arguments: none
2943 =item Return Value: true, if the resultset has been paginated
2951 return !!$self->{attrs}{page};
2958 =item Arguments: none
2960 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2968 return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
2971 =head2 related_resultset
2975 =item Arguments: $relationship_name
2977 =item Return Value: $resultset
2981 Returns a related resultset for the supplied relationship name.
2983 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2987 sub related_resultset {
2988 my ($self, $rel) = @_;
2990 $self->{related_resultsets} ||= {};
2991 return $self->{related_resultsets}{$rel} ||= do {
2992 my $rsrc = $self->result_source;
2993 my $rel_info = $rsrc->relationship_info($rel);
2995 $self->throw_exception(
2996 "search_related: result source '" . $rsrc->source_name .
2997 "' has no such relationship $rel")
3000 my $attrs = $self->_chain_relationship($rel);
3002 my $join_count = $attrs->{seen_join}{$rel};
3004 my $alias = $self->result_source->storage
3005 ->relname_to_table_alias($rel, $join_count);
3007 # since this is search_related, and we already slid the select window inwards
3008 # (the select/as attrs were deleted in the beginning), we need to flip all
3009 # left joins to inner, so we get the expected results
3010 # read the comment on top of the actual function to see what this does
3011 $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3014 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3015 delete @{$attrs}{qw(result_class alias)};
3019 if (my $cache = $self->get_cache) {
3020 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
3021 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache||[]} }
3026 my $rel_source = $rsrc->related_source($rel);
3030 # The reason we do this now instead of passing the alias to the
3031 # search_rs below is that if you wrap/overload resultset on the
3032 # source you need to know what alias it's -going- to have for things
3033 # to work sanely (e.g. RestrictWithObject wants to be able to add
3034 # extra query restrictions, and these may need to be $alias.)
3036 my $rel_attrs = $rel_source->resultset_attributes;
3037 local $rel_attrs->{alias} = $alias;
3039 $rel_source->resultset
3043 where => $attrs->{where},
3046 $new->set_cache($new_cache) if $new_cache;
3051 =head2 current_source_alias
3055 =item Arguments: none
3057 =item Return Value: $source_alias
3061 Returns the current table alias for the result source this resultset is built
3062 on, that will be used in the SQL query. Usually it is C<me>.
3064 Currently the source alias that refers to the result set returned by a
3065 L</search>/L</find> family method depends on how you got to the resultset: it's
3066 C<me> by default, but eg. L</search_related> aliases it to the related result
3067 source name (and keeps C<me> referring to the original result set). The long
3068 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3069 (and make this method unnecessary).
3071 Thus it's currently necessary to use this method in predefined queries (see
3072 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3073 source alias of the current result set:
3075 # in a result set class
3077 my ($self, $user) = @_;
3079 my $me = $self->current_source_alias;
3081 return $self->search({
3082 "$me.modified" => $user->id,
3088 sub current_source_alias {
3091 return ($self->{attrs} || {})->{alias} || 'me';
3094 =head2 as_subselect_rs
3098 =item Arguments: none
3100 =item Return Value: $resultset
3104 Act as a barrier to SQL symbols. The resultset provided will be made into a
3105 "virtual view" by including it as a subquery within the from clause. From this
3106 point on, any joined tables are inaccessible to ->search on the resultset (as if
3107 it were simply where-filtered without joins). For example:
3109 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3111 # 'x' now pollutes the query namespace
3113 # So the following works as expected
3114 my $ok_rs = $rs->search({'x.other' => 1});
3116 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3117 # def) we look for one row with contradictory terms and join in another table
3118 # (aliased 'x_2') which we never use
3119 my $broken_rs = $rs->search({'x.name' => 'def'});
3121 my $rs2 = $rs->as_subselect_rs;
3123 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3124 my $not_joined_rs = $rs2->search({'x.other' => 1});
3126 # works as expected: finds a 'table' row related to two x rows (abc and def)
3127 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3129 Another example of when one might use this would be to select a subset of
3130 columns in a group by clause:
3132 my $rs = $schema->resultset('Bar')->search(undef, {
3133 group_by => [qw{ id foo_id baz_id }],
3134 })->as_subselect_rs->search(undef, {
3135 columns => [qw{ id foo_id }]
3138 In the above example normally columns would have to be equal to the group by,
3139 but because we isolated the group by into a subselect the above works.
3143 sub as_subselect_rs {
3146 my $attrs = $self->_resolved_attrs;
3148 my $fresh_rs = (ref $self)->new (
3149 $self->result_source
3152 # these pieces will be locked in the subquery
3153 delete $fresh_rs->{cond};
3154 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3156 return $fresh_rs->search( {}, {
3158 $attrs->{alias} => $self->as_query,
3159 -alias => $attrs->{alias},
3160 -rsrc => $self->result_source,
3162 alias => $attrs->{alias},
3166 # This code is called by search_related, and makes sure there
3167 # is clear separation between the joins before, during, and
3168 # after the relationship. This information is needed later
3169 # in order to properly resolve prefetch aliases (any alias
3170 # with a relation_chain_depth less than the depth of the
3171 # current prefetch is not considered)
3173 # The increments happen twice per join. An even number means a
3174 # relationship specified via a search_related, whereas an odd
3175 # number indicates a join/prefetch added via attributes
3177 # Also this code will wrap the current resultset (the one we
3178 # chain to) in a subselect IFF it contains limiting attributes
3179 sub _chain_relationship {
3180 my ($self, $rel) = @_;
3181 my $source = $self->result_source;
3182 my $attrs = { %{$self->{attrs}||{}} };
3184 # we need to take the prefetch the attrs into account before we
3185 # ->_resolve_join as otherwise they get lost - captainL
3186 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3188 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
3190 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3193 my @force_subq_attrs = qw/offset rows group_by having/;
3196 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3198 $self->_has_resolved_attr (@force_subq_attrs)
3200 # Nuke the prefetch (if any) before the new $rs attrs
3201 # are resolved (prefetch is useless - we are wrapping
3202 # a subquery anyway).
3203 my $rs_copy = $self->search;
3204 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3205 $rs_copy->{attrs}{join},
3206 delete $rs_copy->{attrs}{prefetch},
3211 -alias => $attrs->{alias},
3212 $attrs->{alias} => $rs_copy->as_query,
3214 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3215 $seen->{-relation_chain_depth} = 0;
3217 elsif ($attrs->{from}) { #shallow copy suffices
3218 $from = [ @{$attrs->{from}} ];
3223 -alias => $attrs->{alias},
3224 $attrs->{alias} => $source->from,
3228 my $jpath = ($seen->{-relation_chain_depth})
3229 ? $from->[-1][0]{-join_path}
3232 my @requested_joins = $source->_resolve_join(
3239 push @$from, @requested_joins;
3241 $seen->{-relation_chain_depth}++;
3243 # if $self already had a join/prefetch specified on it, the requested
3244 # $rel might very well be already included. What we do in this case
3245 # is effectively a no-op (except that we bump up the chain_depth on
3246 # the join in question so we could tell it *is* the search_related)
3249 # we consider the last one thus reverse
3250 for my $j (reverse @requested_joins) {
3251 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3252 if ($rel eq $last_j) {
3253 $j->[0]{-relation_chain_depth}++;
3259 unless ($already_joined) {
3260 push @$from, $source->_resolve_join(
3268 $seen->{-relation_chain_depth}++;
3270 return {%$attrs, from => $from, seen_join => $seen};
3273 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
3274 sub _resolved_attrs_copy {
3276 return { %{$self->_resolved_attrs (@_)} };
3279 sub _resolved_attrs {
3281 return $self->{_attrs} if $self->{_attrs};
3283 my $attrs = { %{ $self->{attrs} || {} } };
3284 my $source = $self->result_source;
3285 my $alias = $attrs->{alias};
3287 # default selection list
3288 $attrs->{columns} = [ $source->columns ]
3289 unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3291 # merge selectors together
3292 for (qw/columns select as/) {
3293 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3294 if $attrs->{$_} or $attrs->{"+$_"};
3297 # disassemble columns
3299 if (my $cols = delete $attrs->{columns}) {
3300 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3301 if (ref $c eq 'HASH') {
3302 for my $as (keys %$c) {
3303 push @sel, $c->{$as};
3314 # when trying to weed off duplicates later do not go past this point -
3315 # everything added from here on is unbalanced "anyone's guess" stuff
3316 my $dedup_stop_idx = $#as;
3318 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3320 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3321 if $attrs->{select};
3323 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3324 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_" for @sel;
3326 # disqualify all $alias.col as-bits (inflate-map mandated)
3327 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_ for @as;
3329 # de-duplicate the result (remove *identical* select/as pairs)
3330 # and also die on duplicate {as} pointing to different {select}s
3331 # not using a c-style for as the condition is prone to shrinkage
3334 while ($i <= $dedup_stop_idx) {
3335 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3340 elsif ($seen->{$as[$i]}++) {
3341 $self->throw_exception(
3342 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3350 $attrs->{select} = \@sel;
3351 $attrs->{as} = \@as;
3353 $attrs->{from} ||= [{
3355 -alias => $self->{attrs}{alias},
3356 $self->{attrs}{alias} => $source->from,
3359 if ( $attrs->{join} || $attrs->{prefetch} ) {
3361 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3362 if ref $attrs->{from} ne 'ARRAY';
3364 my $join = (delete $attrs->{join}) || {};
3366 if ( defined $attrs->{prefetch} ) {
3367 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3370 $attrs->{from} = # have to copy here to avoid corrupting the original
3372 @{ $attrs->{from} },
3373 $source->_resolve_join(
3376 { %{ $attrs->{seen_join} || {} } },
3377 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3378 ? $attrs->{from}[-1][0]{-join_path}
3385 if ( defined $attrs->{order_by} ) {
3386 $attrs->{order_by} = (
3387 ref( $attrs->{order_by} ) eq 'ARRAY'
3388 ? [ @{ $attrs->{order_by} } ]
3389 : [ $attrs->{order_by} || () ]
3393 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3394 $attrs->{group_by} = [ $attrs->{group_by} ];
3397 # generate the distinct induced group_by early, as prefetch will be carried via a
3398 # subquery (since a group_by is present)
3399 if (delete $attrs->{distinct}) {
3400 if ($attrs->{group_by}) {
3401 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3404 # distinct affects only the main selection part, not what prefetch may
3406 $attrs->{group_by} = $source->storage->_group_over_selection (
3414 # generate selections based on the prefetch helper
3416 $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} )
3417 if defined $attrs->{prefetch};
3421 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3422 if $attrs->{_dark_selector};
3424 $attrs->{collapse} = 1;
3426 # this is a separate structure (we don't look in {from} directly)
3427 # as the resolver needs to shift things off the lists to work
3428 # properly (identical-prefetches on different branches)
3430 if (ref $attrs->{from} eq 'ARRAY') {
3432 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3434 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3435 next unless $j->[0]{-alias};
3436 next unless $j->[0]{-join_path};
3437 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3439 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3442 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3443 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3447 my @prefetch = $source->_resolve_prefetch( $prefetch, $alias, $join_map );
3449 # we need to somehow mark which columns came from prefetch
3451 my $sel_end = $#{$attrs->{select}};
3452 $attrs->{_prefetch_selector_range} = [ $sel_end + 1, $sel_end + @prefetch ];
3455 push @{ $attrs->{select} }, (map { $_->[0] } @prefetch);
3456 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3459 $attrs->{_single_object_inflation} = ! List::Util::first { $_ =~ /\./ } @{$attrs->{as}};
3461 # run through the resulting joinstructure (starting from our current slot)
3462 # and unset collapse if proven unnesessary
3463 if ($attrs->{collapse} && ref $attrs->{from} eq 'ARRAY') {
3465 if (@{$attrs->{from}} > 1) {
3467 # find where our table-spec starts and consider only things after us
3468 my @fromlist = @{$attrs->{from}};
3470 my $t = shift @fromlist;
3471 $t = $t->[0] if ref $t eq 'ARRAY'; #me vs join from-spec mismatch
3472 last if ($t->{-alias} && $t->{-alias} eq $alias);
3476 $attrs->{collapse} = ! $_->[0]{-is_single}
3481 # no joins - no collapse
3482 $attrs->{collapse} = 0;
3486 if (! $attrs->{order_by} and $attrs->{collapse}) {
3487 # default order for collapsing unless the user asked for something
3488 $attrs->{order_by} = [ map { "$alias.$_" } $source->primary_columns ];
3489 $attrs->{_ordered_for_collapse} = 1;
3490 $attrs->{_order_is_artificial} = 1;
3493 # if both page and offset are specified, produce a combined offset
3494 # even though it doesn't make much sense, this is what pre 081xx has
3496 if (my $page = delete $attrs->{page}) {
3498 ($attrs->{rows} * ($page - 1))
3500 ($attrs->{offset} || 0)
3504 return $self->{_attrs} = $attrs;
3508 my ($self, $attr) = @_;
3510 if (ref $attr eq 'HASH') {
3511 return $self->_rollout_hash($attr);
3512 } elsif (ref $attr eq 'ARRAY') {
3513 return $self->_rollout_array($attr);
3519 sub _rollout_array {
3520 my ($self, $attr) = @_;
3523 foreach my $element (@{$attr}) {
3524 if (ref $element eq 'HASH') {
3525 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3526 } elsif (ref $element eq 'ARRAY') {
3527 # XXX - should probably recurse here
3528 push( @rolled_array, @{$self->_rollout_array($element)} );
3530 push( @rolled_array, $element );
3533 return \@rolled_array;
3537 my ($self, $attr) = @_;
3540 foreach my $key (keys %{$attr}) {
3541 push( @rolled_array, { $key => $attr->{$key} } );
3543 return \@rolled_array;
3546 sub _calculate_score {
3547 my ($self, $a, $b) = @_;
3549 if (defined $a xor defined $b) {
3552 elsif (not defined $a) {
3556 if (ref $b eq 'HASH') {
3557 my ($b_key) = keys %{$b};
3558 if (ref $a eq 'HASH') {
3559 my ($a_key) = keys %{$a};
3560 if ($a_key eq $b_key) {
3561 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3566 return ($a eq $b_key) ? 1 : 0;
3569 if (ref $a eq 'HASH') {
3570 my ($a_key) = keys %{$a};
3571 return ($b eq $a_key) ? 1 : 0;
3573 return ($b eq $a) ? 1 : 0;
3578 sub _merge_joinpref_attr {
3579 my ($self, $orig, $import) = @_;
3581 return $import unless defined($orig);
3582 return $orig unless defined($import);
3584 $orig = $self->_rollout_attr($orig);
3585 $import = $self->_rollout_attr($import);
3588 foreach my $import_element ( @{$import} ) {
3589 # find best candidate from $orig to merge $b_element into
3590 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3591 foreach my $orig_element ( @{$orig} ) {
3592 my $score = $self->_calculate_score( $orig_element, $import_element );
3593 if ($score > $best_candidate->{score}) {
3594 $best_candidate->{position} = $position;
3595 $best_candidate->{score} = $score;
3599 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3600 $import_key = '' if not defined $import_key;
3602 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3603 push( @{$orig}, $import_element );
3605 my $orig_best = $orig->[$best_candidate->{position}];
3606 # merge orig_best and b_element together and replace original with merged
3607 if (ref $orig_best ne 'HASH') {
3608 $orig->[$best_candidate->{position}] = $import_element;
3609 } elsif (ref $import_element eq 'HASH') {
3610 my ($key) = keys %{$orig_best};
3611 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3614 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3625 require Hash::Merge;
3626 my $hm = Hash::Merge->new;
3628 $hm->specify_behavior({
3631 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3633 if ($defl xor $defr) {
3634 return [ $defl ? $_[0] : $_[1] ];
3639 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3643 return [$_[0], $_[1]];
3647 return $_[1] if !defined $_[0];
3648 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3649 return [$_[0], @{$_[1]}]
3652 return [] if !defined $_[0] and !keys %{$_[1]};
3653 return [ $_[1] ] if !defined $_[0];
3654 return [ $_[0] ] if !keys %{$_[1]};
3655 return [$_[0], $_[1]]
3660 return $_[0] if !defined $_[1];
3661 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3662 return [@{$_[0]}, $_[1]]
3665 my @ret = @{$_[0]} or return $_[1];
3666 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3667 my %idx = map { $_ => 1 } @ret;
3668 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3672 return [ $_[1] ] if ! @{$_[0]};
3673 return $_[0] if !keys %{$_[1]};
3674 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3675 return [ @{$_[0]}, $_[1] ];
3680 return [] if !keys %{$_[0]} and !defined $_[1];
3681 return [ $_[0] ] if !defined $_[1];
3682 return [ $_[1] ] if !keys %{$_[0]};
3683 return [$_[0], $_[1]]
3686 return [] if !keys %{$_[0]} and !@{$_[1]};
3687 return [ $_[0] ] if !@{$_[1]};
3688 return $_[1] if !keys %{$_[0]};
3689 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3690 return [ $_[0], @{$_[1]} ];
3693 return [] if !keys %{$_[0]} and !keys %{$_[1]};
3694 return [ $_[0] ] if !keys %{$_[1]};
3695 return [ $_[1] ] if !keys %{$_[0]};
3696 return [ $_[0] ] if $_[0] eq $_[1];
3697 return [ $_[0], $_[1] ];
3700 } => 'DBIC_RS_ATTR_MERGER');
3704 return $hm->merge ($_[1], $_[2]);
3708 sub STORABLE_freeze {
3709 my ($self, $cloning) = @_;
3710 my $to_serialize = { %$self };
3712 # A cursor in progress can't be serialized (and would make little sense anyway)
3713 # the parser can be regenerated (and can't be serialized)
3714 delete @{$to_serialize}{qw/cursor _row_parser/};
3716 # nor is it sensical to store a not-yet-fired-count pager
3717 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3718 delete $to_serialize->{pager};
3721 Storable::nfreeze($to_serialize);
3724 # need this hook for symmetry
3726 my ($self, $cloning, $serialized) = @_;
3728 %$self = %{ Storable::thaw($serialized) };
3734 =head2 throw_exception
3736 See L<DBIx::Class::Schema/throw_exception> for details.
3740 sub throw_exception {
3743 if (ref $self and my $rsrc = $self->result_source) {
3744 $rsrc->throw_exception(@_)
3747 DBIx::Class::Exception->throw(@_);
3751 # XXX: FIXME: Attributes docs need clearing up
3755 Attributes are used to refine a ResultSet in various ways when
3756 searching for data. They can be passed to any method which takes an
3757 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3760 These are in no particular order:
3766 =item Value: ( $order_by | \@order_by | \%order_by )
3770 Which column(s) to order the results by.
3772 [The full list of suitable values is documented in
3773 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3776 If a single column name, or an arrayref of names is supplied, the
3777 argument is passed through directly to SQL. The hashref syntax allows
3778 for connection-agnostic specification of ordering direction:
3780 For descending order:
3782 order_by => { -desc => [qw/col1 col2 col3/] }
3784 For explicit ascending order:
3786 order_by => { -asc => 'col' }
3788 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3789 supported, although you are strongly encouraged to use the hashref
3790 syntax as outlined above.
3796 =item Value: \@columns
3800 Shortcut to request a particular set of columns to be retrieved. Each
3801 column spec may be a string (a table column name), or a hash (in which
3802 case the key is the C<as> value, and the value is used as the C<select>
3803 expression). Adds C<me.> onto the start of any column without a C<.> in
3804 it and sets C<select> from that, then auto-populates C<as> from
3805 C<select> as normal. (You may also use the C<cols> attribute, as in
3806 earlier versions of DBIC.)
3808 Essentially C<columns> does the same as L</select> and L</as>.
3810 columns => [ 'foo', { bar => 'baz' } ]
3814 select => [qw/foo baz/],
3821 =item Value: \@columns
3825 Indicates additional columns to be selected from storage. Works the same
3826 as L</columns> but adds columns to the selection. (You may also use the
3827 C<include_columns> attribute, as in earlier versions of DBIC). For
3830 $schema->resultset('CD')->search(undef, {
3831 '+columns' => ['artist.name'],
3835 would return all CDs and include a 'name' column to the information
3836 passed to object inflation. Note that the 'artist' is the name of the
3837 column (or relationship) accessor, and 'name' is the name of the column
3838 accessor in the related table.
3840 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
3841 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
3842 unary plus operator before it.
3844 =head2 include_columns
3848 =item Value: \@columns
3852 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3858 =item Value: \@select_columns
3862 Indicates which columns should be selected from the storage. You can use
3863 column names, or in the case of RDBMS back ends, function or stored procedure
3866 $rs = $schema->resultset('Employee')->search(undef, {
3869 { count => 'employeeid' },
3870 { max => { length => 'name' }, -as => 'longest_name' }
3875 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3877 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3878 use L</select>, to instruct DBIx::Class how to store the result of the column.
3879 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3880 identifier aliasing. You can however alias a function, so you can use it in
3881 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3882 attribute> supplied as shown in the example above.
3884 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
3885 Not doing so causes Perl to incorrectly interpret them as a bareword with a
3886 unary plus operator before it.
3892 Indicates additional columns to be selected from storage. Works the same as
3893 L</select> but adds columns to the default selection, instead of specifying
3902 Indicates additional column names for those added via L</+select>. See L</as>.
3910 =item Value: \@inflation_names
3914 Indicates column names for object inflation. That is L</as> indicates the
3915 slot name in which the column value will be stored within the
3916 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3917 identifier by the C<get_column> method (or via the object accessor B<if one
3918 with the same name already exists>) as shown below. The L</as> attribute has
3919 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3921 $rs = $schema->resultset('Employee')->search(undef, {
3924 { count => 'employeeid' },
3925 { max => { length => 'name' }, -as => 'longest_name' }
3934 If the object against which the search is performed already has an accessor
3935 matching a column name specified in C<as>, the value can be retrieved using
3936 the accessor as normal:
3938 my $name = $employee->name();
3940 If on the other hand an accessor does not exist in the object, you need to
3941 use C<get_column> instead:
3943 my $employee_count = $employee->get_column('employee_count');
3945 You can create your own accessors if required - see
3946 L<DBIx::Class::Manual::Cookbook> for details.
3952 =item Value: ($rel_name | \@rel_names | \%rel_names)
3956 Contains a list of relationships that should be joined for this query. For
3959 # Get CDs by Nine Inch Nails
3960 my $rs = $schema->resultset('CD')->search(
3961 { 'artist.name' => 'Nine Inch Nails' },
3962 { join => 'artist' }
3965 Can also contain a hash reference to refer to the other relation's relations.
3968 package MyApp::Schema::Track;
3969 use base qw/DBIx::Class/;
3970 __PACKAGE__->table('track');
3971 __PACKAGE__->add_columns(qw/trackid cd position title/);
3972 __PACKAGE__->set_primary_key('trackid');
3973 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3976 # In your application
3977 my $rs = $schema->resultset('Artist')->search(
3978 { 'track.title' => 'Teardrop' },
3980 join => { cd => 'track' },
3981 order_by => 'artist.name',
3985 You need to use the relationship (not the table) name in conditions,
3986 because they are aliased as such. The current table is aliased as "me", so
3987 you need to use me.column_name in order to avoid ambiguity. For example:
3989 # Get CDs from 1984 with a 'Foo' track
3990 my $rs = $schema->resultset('CD')->search(
3993 'tracks.name' => 'Foo'
3995 { join => 'tracks' }
3998 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3999 similarly for a third time). For e.g.
4001 my $rs = $schema->resultset('Artist')->search({
4002 'cds.title' => 'Down to Earth',
4003 'cds_2.title' => 'Popular',
4005 join => [ qw/cds cds/ ],
4008 will return a set of all artists that have both a cd with title 'Down
4009 to Earth' and a cd with title 'Popular'.
4011 If you want to fetch related objects from other tables as well, see C<prefetch>
4014 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4020 =item Value: ($rel_name | \@rel_names | \%rel_names)
4024 Contains one or more relationships that should be fetched along with
4025 the main query (when they are accessed afterwards the data will
4026 already be available, without extra queries to the database). This is
4027 useful for when you know you will need the related objects, because it
4028 saves at least one query:
4030 my $rs = $schema->resultset('Tag')->search(
4039 The initial search results in SQL like the following:
4041 SELECT tag.*, cd.*, artist.* FROM tag
4042 JOIN cd ON tag.cd = cd.cdid
4043 JOIN artist ON cd.artist = artist.artistid
4045 L<DBIx::Class> has no need to go back to the database when we access the
4046 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4049 Simple prefetches will be joined automatically, so there is no need
4050 for a C<join> attribute in the above search.
4052 L</prefetch> can be used with the any of the relationship types and
4053 multiple prefetches can be specified together. Below is a more complex
4054 example that prefetches a CD's artist, its liner notes (if present),
4055 the cover image, the tracks on that cd, and the guests on those
4059 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4060 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4061 My::Schema::CD->has_one( cover_image => 'My::Schema::Artwork' );
4062 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4064 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4066 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4069 my $rs = $schema->resultset('CD')->search(
4073 { artist => 'record_label'}, # belongs_to => belongs_to
4074 'liner_note', # might_have
4075 'cover_image', # has_one
4076 { tracks => 'guests' }, # has_many => has_many
4081 This will produce SQL like the following:
4083 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4087 ON artist.artistid = me.artistid
4088 JOIN record_label record_label
4089 ON record_label.labelid = artist.labelid
4090 LEFT JOIN track tracks
4091 ON tracks.cdid = me.cdid
4092 LEFT JOIN guest guests
4093 ON guests.trackid = track.trackid
4094 LEFT JOIN liner_notes liner_note
4095 ON liner_note.cdid = me.cdid
4096 JOIN cd_artwork cover_image
4097 ON cover_image.cdid = me.cdid
4100 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4101 C<tracks>, and C<guests> of the CD will all be available through the
4102 relationship accessors without the need for additional queries to the
4105 However, there is one caveat to be observed: it can be dangerous to
4106 prefetch more than one L<has_many|DBIx::Class::Relationship/has_many>
4107 relationship on a given level. e.g.:
4109 my $rs = $schema->resultset('CD')->search(
4113 'tracks', # has_many
4114 { cd_to_producer => 'producer' }, # has_many => belongs_to (i.e. m2m)
4119 In fact, C<DBIx::Class> will emit the following warning:
4121 Prefetching multiple has_many rels tracks and cd_to_producer at top
4122 level will explode the number of row objects retrievable via ->next
4123 or ->all. Use at your own risk.
4125 The collapser currently can't identify duplicate tuples for multiple
4126 L<has_many|DBIx::Class::Relationship/has_many> relationships and as a
4127 result the second L<has_many|DBIx::Class::Relationship/has_many>
4128 relation could contain redundant objects.
4130 =head3 Using L</prefetch> with L</join>
4132 L</prefetch> implies a L</join> with the equivalent argument, and is
4133 properly merged with any existing L</join> specification. So the
4136 my $rs = $schema->resultset('CD')->search(
4137 {'record_label.name' => 'Music Product Ltd.'},
4139 join => {artist => 'record_label'},
4140 prefetch => 'artist',
4144 ... will work, searching on the record label's name, but only
4145 prefetching the C<artist>.
4147 =head3 Using L</prefetch> with L</select> / L</+select> / L</as> / L</+as>
4149 L</prefetch> implies a L</+select>/L</+as> with the fields of the
4150 prefetched relations. So given:
4152 my $rs = $schema->resultset('CD')->search(
4155 select => ['cd.title'],
4157 prefetch => 'artist',
4161 The L</select> becomes: C<'cd.title', 'artist.*'> and the L</as>
4162 becomes: C<'cd_title', 'artist.*'>.
4166 Prefetch does a lot of deep magic. As such, it may not behave exactly
4167 as you might expect.
4173 Prefetch uses the L</cache> to populate the prefetched relationships. This
4174 may or may not be what you want.
4178 If you specify a condition on a prefetched relationship, ONLY those
4179 rows that match the prefetched condition will be fetched into that relationship.
4180 This means that adding prefetch to a search() B<may alter> what is returned by
4181 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4183 my $artist_rs = $schema->resultset('Artist')->search({
4189 my $count = $artist_rs->first->cds->count;
4191 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4193 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4195 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4197 that cmp_ok() may or may not pass depending on the datasets involved. This
4198 behavior may or may not survive the 0.09 transition.
4210 Makes the resultset paged and specifies the page to retrieve. Effectively
4211 identical to creating a non-pages resultset and then calling ->page($page)
4214 If L</rows> attribute is not specified it defaults to 10 rows per page.
4216 When you have a paged resultset, L</count> will only return the number
4217 of rows in the page. To get the total, use the L</pager> and call
4218 C<total_entries> on it.
4228 Specifies the maximum number of rows for direct retrieval or the number of
4229 rows per page if the page attribute or method is used.
4235 =item Value: $offset
4239 Specifies the (zero-based) row number for the first row to be returned, or the
4240 of the first row of the first page if paging is used.
4242 =head2 software_limit
4246 =item Value: (0 | 1)
4250 When combined with L</rows> and/or L</offset> the generated SQL will not
4251 include any limit dialect stanzas. Instead the entire result will be selected
4252 as if no limits were specified, and DBIC will perform the limit locally, by
4253 artificially advancing and finishing the resulting L</cursor>.
4255 This is the recommended way of performing resultset limiting when no sane RDBMS
4256 implementation is available (e.g.
4257 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4258 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4264 =item Value: \@columns
4268 A arrayref of columns to group by. Can include columns of joined tables.
4270 group_by => [qw/ column1 column2 ... /]
4276 =item Value: $condition
4280 HAVING is a select statement attribute that is applied between GROUP BY and
4281 ORDER BY. It is applied to the after the grouping calculations have been
4284 having => { 'count_employee' => { '>=', 100 } }
4286 or with an in-place function in which case literal SQL is required:
4288 having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4294 =item Value: (0 | 1)
4298 Set to 1 to group by all columns. If the resultset already has a group_by
4299 attribute, this setting is ignored and an appropriate warning is issued.
4305 Adds to the WHERE clause.
4307 # only return rows WHERE deleted IS NULL for all searches
4308 __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
4310 Can be overridden by passing C<< { where => undef } >> as an attribute
4313 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4319 Set to 1 to cache search results. This prevents extra SQL queries if you
4320 revisit rows in your ResultSet:
4322 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4324 while( my $artist = $resultset->next ) {
4328 $rs->first; # without cache, this would issue a query
4330 By default, searches are not cached.
4332 For more examples of using these attributes, see
4333 L<DBIx::Class::Manual::Cookbook>.
4339 =item Value: ( 'update' | 'shared' )
4343 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT