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: L<$source|DBIx::Class::ResultSource>, L<\%attrs?|/ATTRIBUTES>
196 =item Return Value: L<$resultset|/search>
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 never construct a resultset manually. Instead you get one
207 C<< $schema->L<resultset|DBIx::Class::Schema/resultset>('$source_name') >>
208 or C<< $another_resultset->L<search|/search>(...) >> (the later called in
211 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
217 If called on an object, proxies to L</new_result> instead, so
219 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
221 will return a CD object, not a ResultSet, and is equivalent to:
223 my $cd = $schema->resultset('CD')->new_result({ title => 'Spoon' });
225 Please also keep in mind that many internals call L</new_result> directly,
226 so overloading this method with the idea of intercepting new result object
227 creation B<will not work>. See also warning pertaining to L</create>.
235 return $class->new_result(@_) if ref $class;
237 my ($source, $attrs) = @_;
238 $source = $source->resolve
239 if $source->isa('DBIx::Class::ResultSourceHandle');
240 $attrs = { %{$attrs||{}} };
242 if ($attrs->{page}) {
243 $attrs->{rows} ||= 10;
246 $attrs->{alias} ||= 'me';
249 result_source => $source,
250 cond => $attrs->{where},
255 # if there is a dark selector, this means we are already in a
256 # chain and the cleanup/sanification was taken care of by
258 $self->_normalize_selection($attrs)
259 unless $attrs->{_dark_selector};
262 $attrs->{result_class} || $source->result_class
272 =item Arguments: L<$cond|DBIx::Class::SQLMaker> | undef, L<\%attrs?|/ATTRIBUTES>
274 =item Return Value: $resultset (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
278 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
279 my $new_rs = $cd_rs->search({ year => 2005 });
281 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
282 # year = 2005 OR year = 2004
284 In list context, C<< ->all() >> is called implicitly on the resultset, thus
285 returning a list of L<result|DBIx::Class::Manual::ResultClass> objects instead.
286 To avoid that, use L</search_rs>.
288 If you need to pass in additional attributes but no additional condition,
289 call it as C<search(undef, \%attrs)>.
291 # "SELECT name, artistid FROM $artist_table"
292 my @all_artists = $schema->resultset('Artist')->search(undef, {
293 columns => [qw/name artistid/],
296 For a list of attributes that can be passed to C<search>, see
297 L</ATTRIBUTES>. For more examples of using this function, see
298 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
299 documentation for the first argument, see L<SQL::Abstract>
300 and its extension L<DBIx::Class::SQLMaker>.
302 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
306 Note that L</search> does not process/deflate any of the values passed in the
307 L<SQL::Abstract>-compatible search condition structure. This is unlike other
308 condition-bound methods L</new_result>, L</create> and L</find>. The user must ensure
309 manually that any value passed to this method will stringify to something the
310 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
311 objects, for more info see:
312 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
318 my $rs = $self->search_rs( @_ );
323 elsif (defined wantarray) {
327 # we can be called by a relationship helper, which in
328 # turn may be called in void context due to some braindead
329 # overload or whatever else the user decided to be clever
330 # at this particular day. Thus limit the exception to
331 # external code calls only
332 $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
333 if (caller)[0] !~ /^\QDBIx::Class::/;
343 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
345 =item Return Value: L<$resultset|/search>
349 This method does the same exact thing as search() except it will
350 always return a resultset, even in list context.
357 my $rsrc = $self->result_source;
358 my ($call_cond, $call_attrs);
360 # Special-case handling for (undef, undef) or (undef)
361 # Note that (foo => undef) is valid deprecated syntax
362 @_ = () if not scalar grep { defined $_ } @_;
368 # fish out attrs in the ($condref, $attr) case
369 elsif (@_ == 2 and ( ! defined $_[0] or (ref $_[0]) ne '') ) {
370 ($call_cond, $call_attrs) = @_;
373 $self->throw_exception('Odd number of arguments to search')
377 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
378 unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
380 for my $i (0 .. $#_) {
382 $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
383 if (! defined $_[$i] or ref $_[$i] ne '');
389 # see if we can keep the cache (no $rs changes)
391 my %safe = (alias => 1, cache => 1);
392 if ( ! List::Util::first { !$safe{$_} } keys %$call_attrs and (
395 ref $_[0] eq 'HASH' && ! keys %{$_[0]}
397 ref $_[0] eq 'ARRAY' && ! @{$_[0]}
399 $cache = $self->get_cache;
402 my $old_attrs = { %{$self->{attrs}} };
403 my $old_having = delete $old_attrs->{having};
404 my $old_where = delete $old_attrs->{where};
406 my $new_attrs = { %$old_attrs };
408 # take care of call attrs (only if anything is changing)
409 if ($call_attrs and keys %$call_attrs) {
411 # copy for _normalize_selection
412 $call_attrs = { %$call_attrs };
414 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
416 # reset the current selector list if new selectors are supplied
417 if (List::Util::first { exists $call_attrs->{$_} } qw/columns cols select as/) {
418 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')};
421 # Normalize the new selector list (operates on the passed-in attr structure)
422 # Need to do it on every chain instead of only once on _resolved_attrs, in
423 # order to allow detection of empty vs partial 'as'
424 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
425 if $old_attrs->{_dark_selector};
426 $self->_normalize_selection ($call_attrs);
428 # start with blind overwriting merge, exclude selector attrs
429 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
430 delete @{$new_attrs}{@selector_attrs};
432 for (@selector_attrs) {
433 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
434 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
437 # older deprecated name, use only if {columns} is not there
438 if (my $c = delete $new_attrs->{cols}) {
439 if ($new_attrs->{columns}) {
440 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
443 $new_attrs->{columns} = $c;
448 # join/prefetch use their own crazy merging heuristics
449 foreach my $key (qw/join prefetch/) {
450 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
451 if exists $call_attrs->{$key};
454 # stack binds together
455 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
459 for ($old_where, $call_cond) {
461 $new_attrs->{where} = $self->_stack_cond (
462 $_, $new_attrs->{where}
467 if (defined $old_having) {
468 $new_attrs->{having} = $self->_stack_cond (
469 $old_having, $new_attrs->{having}
473 my $rs = (ref $self)->new($rsrc, $new_attrs);
475 $rs->set_cache($cache) if ($cache);
481 sub _normalize_selection {
482 my ($self, $attrs) = @_;
485 $attrs->{'+columns'} = $self->_merge_attr($attrs->{'+columns'}, delete $attrs->{include_columns})
486 if exists $attrs->{include_columns};
488 # columns are always placed first, however
490 # Keep the X vs +X separation until _resolved_attrs time - this allows to
491 # delay the decision on whether to use a default select list ($rsrc->columns)
492 # allowing stuff like the remove_columns helper to work
494 # select/as +select/+as pairs need special handling - the amount of select/as
495 # elements in each pair does *not* have to be equal (think multicolumn
496 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
497 # supplied at all) - try to infer the alias, either from the -as parameter
498 # of the selector spec, or use the parameter whole if it looks like a column
499 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
500 # is ok as well), but make sure no more additions to the 'as' chain take place
501 for my $pref ('', '+') {
503 my ($sel, $as) = map {
504 my $key = "${pref}${_}";
506 my $val = [ ref $attrs->{$key} eq 'ARRAY'
508 : $attrs->{$key} || ()
510 delete $attrs->{$key};
514 if (! @$as and ! @$sel ) {
517 elsif (@$as and ! @$sel) {
518 $self->throw_exception(
519 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
523 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
524 # if any @$as has been supplied we assume the user knows what (s)he is doing
525 # and blindly keep stacking up pieces
526 unless ($attrs->{_dark_selector}) {
529 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
530 push @$as, $_->{-as};
532 # assume any plain no-space, no-parenthesis string to be a column spec
533 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
534 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
537 # if all else fails - raise a flag that no more aliasing will be allowed
539 $attrs->{_dark_selector} = {
541 string => ($dark_sel_dumper ||= do {
542 require Data::Dumper::Concise;
543 Data::Dumper::Concise::DumperObject()->Indent(0);
544 })->Values([$_])->Dump
552 elsif (@$as < @$sel) {
553 $self->throw_exception(
554 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
557 elsif ($pref and $attrs->{_dark_selector}) {
558 $self->throw_exception(
559 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
565 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
566 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
571 my ($self, $left, $right) = @_;
573 # collapse single element top-level conditions
574 # (single pass only, unlikely to need recursion)
575 for ($left, $right) {
576 if (ref $_ eq 'ARRAY') {
584 elsif (ref $_ eq 'HASH') {
585 my ($first, $more) = keys %$_;
588 if (! defined $first) {
592 elsif (! defined $more) {
593 if ($first eq '-and' and ref $_->{'-and'} eq 'HASH') {
596 elsif ($first eq '-or' and ref $_->{'-or'} eq 'ARRAY') {
603 # merge hashes with weeding out of duplicates (simple cases only)
604 if (ref $left eq 'HASH' and ref $right eq 'HASH') {
606 # shallow copy to destroy
607 $right = { %$right };
608 for (grep { exists $right->{$_} } keys %$left) {
609 # the use of eq_deeply here is justified - the rhs of an
610 # expression can contain a lot of twisted weird stuff
611 delete $right->{$_} if Data::Compare::Compare( $left->{$_}, $right->{$_} );
614 $right = undef unless keys %$right;
618 if (defined $left xor defined $right) {
619 return defined $left ? $left : $right;
621 elsif (! defined $left) {
625 return { -and => [ $left, $right ] };
629 =head2 search_literal
631 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
632 should only be used in that context. C<search_literal> is a convenience
633 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
634 want to ensure columns are bound correctly, use L</search>.
636 See L<DBIx::Class::Manual::Cookbook/Searching> and
637 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
638 require C<search_literal>.
642 =item Arguments: $sql_fragment, @standalone_bind_values
644 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
648 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
649 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
651 Pass a literal chunk of SQL to be added to the conditional part of the
654 Example of how to use C<search> instead of C<search_literal>
656 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
657 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
662 my ($self, $sql, @bind) = @_;
664 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
667 return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
674 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
676 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
680 Finds and returns a single row based on supplied criteria. Takes either a
681 hashref with the same format as L</create> (including inference of foreign
682 keys from related objects), or a list of primary key values in the same
683 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
684 declaration on the L</result_source>.
686 In either case an attempt is made to combine conditions already existing on
687 the resultset with the condition passed to this method.
689 To aid with preparing the correct query for the storage you may supply the
690 C<key> attribute, which is the name of a
691 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
692 unique constraint corresponding to the
693 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
694 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
695 to construct a query that satisfies the named unique constraint fully (
696 non-NULL values for each column member of the constraint) an exception is
699 If no C<key> is specified, the search is carried over all unique constraints
700 which are fully defined by the available condition.
702 If no such constraint is found, C<find> currently defaults to a simple
703 C<< search->(\%column_values) >> which may or may not do what you expect.
704 Note that this fallback behavior may be deprecated in further versions. If
705 you need to search with arbitrary conditions - use L</search>. If the query
706 resulting from this fallback produces more than one row, a warning to the
707 effect is issued, though only the first row is constructed and returned as
710 In addition to C<key>, L</find> recognizes and applies standard
711 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
713 Note that if you have extra concerns about the correctness of the resulting
714 query you need to specify the C<key> attribute and supply the entire condition
715 as an argument to find (since it is not always possible to perform the
716 combination of the resultset condition with the supplied one, especially if
717 the resultset condition contains literal sql).
719 For example, to find a row by its primary key:
721 my $cd = $schema->resultset('CD')->find(5);
723 You can also find a row by a specific unique constraint:
725 my $cd = $schema->resultset('CD')->find(
727 artist => 'Massive Attack',
728 title => 'Mezzanine',
730 { key => 'cd_artist_title' }
733 See also L</find_or_create> and L</update_or_create>.
739 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
741 my $rsrc = $self->result_source;
744 if (exists $attrs->{key}) {
745 $constraint_name = defined $attrs->{key}
747 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
751 # Parse out the condition from input
754 if (ref $_[0] eq 'HASH') {
755 $call_cond = { %{$_[0]} };
758 # if only values are supplied we need to default to 'primary'
759 $constraint_name = 'primary' unless defined $constraint_name;
761 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
763 $self->throw_exception(
764 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
767 $self->throw_exception (
768 'find() expects either a column/value hashref, or a list of values '
769 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
770 ) unless @c_cols == @_;
773 @{$call_cond}{@c_cols} = @_;
777 for my $key (keys %$call_cond) {
779 my $keyref = ref($call_cond->{$key})
781 my $relinfo = $rsrc->relationship_info($key)
783 my $val = delete $call_cond->{$key};
785 next if $keyref eq 'ARRAY'; # has_many for multi_create
787 my $rel_q = $rsrc->_resolve_condition(
788 $relinfo->{cond}, $val, $key, $key
790 die "Can't handle complex relationship conditions in find" if ref($rel_q) ne 'HASH';
791 @related{keys %$rel_q} = values %$rel_q;
795 # relationship conditions take precedence (?)
796 @{$call_cond}{keys %related} = values %related;
798 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
800 if (defined $constraint_name) {
801 $final_cond = $self->_qualify_cond_columns (
803 $self->_build_unique_cond (
811 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
812 # This means that we got here after a merger of relationship conditions
813 # in ::Relationship::Base::search_related (the row method), and furthermore
814 # the relationship is of the 'single' type. This means that the condition
815 # provided by the relationship (already attached to $self) is sufficient,
816 # as there can be only one row in the database that would satisfy the
820 # no key was specified - fall down to heuristics mode:
821 # run through all unique queries registered on the resultset, and
822 # 'OR' all qualifying queries together
823 my (@unique_queries, %seen_column_combinations);
824 for my $c_name ($rsrc->unique_constraint_names) {
825 next if $seen_column_combinations{
826 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
829 push @unique_queries, try {
830 $self->_build_unique_cond ($c_name, $call_cond, 'croak_on_nulls')
834 $final_cond = @unique_queries
835 ? [ map { $self->_qualify_cond_columns($_, $alias) } @unique_queries ]
836 : $self->_non_unique_find_fallback ($call_cond, $attrs)
840 # Run the query, passing the result_class since it should propagate for find
841 my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
842 if (keys %{$rs->_resolved_attrs->{collapse}}) {
844 carp "Query returned more than one row" if $rs->next;
852 # This is a stop-gap method as agreed during the discussion on find() cleanup:
853 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
855 # It is invoked when find() is called in legacy-mode with insufficiently-unique
856 # condition. It is provided for overrides until a saner way forward is devised
858 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
859 # the road. Please adjust your tests accordingly to catch this situation early
860 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
862 # The method will not be removed without an adequately complete replacement
863 # for strict-mode enforcement
864 sub _non_unique_find_fallback {
865 my ($self, $cond, $attrs) = @_;
867 return $self->_qualify_cond_columns(
869 exists $attrs->{alias}
871 : $self->{attrs}{alias}
876 sub _qualify_cond_columns {
877 my ($self, $cond, $alias) = @_;
879 my %aliased = %$cond;
880 for (keys %aliased) {
881 $aliased{"$alias.$_"} = delete $aliased{$_}
888 sub _build_unique_cond {
889 my ($self, $constraint_name, $extra_cond, $croak_on_null) = @_;
891 my @c_cols = $self->result_source->unique_constraint_columns($constraint_name);
893 # combination may fail if $self->{cond} is non-trivial
894 my ($final_cond) = try {
895 $self->_merge_with_rscond ($extra_cond)
900 # trim out everything not in $columns
901 $final_cond = { map {
902 exists $final_cond->{$_}
903 ? ( $_ => $final_cond->{$_} )
907 if (my @missing = grep
908 { ! ($croak_on_null ? defined $final_cond->{$_} : exists $final_cond->{$_}) }
911 $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', no values for column(s): %s",
913 join (', ', map { "'$_'" } @missing),
920 !$ENV{DBIC_NULLABLE_KEY_NOWARN}
922 my @undefs = sort grep { ! defined $final_cond->{$_} } (keys %$final_cond)
924 carp_unique ( sprintf (
925 "NULL/undef values supplied for requested unique constraint '%s' (NULL "
926 . 'values in column(s): %s). This is almost certainly not what you wanted, '
927 . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
929 join (', ', map { "'$_'" } @undefs),
936 =head2 search_related
940 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
942 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
946 $new_rs = $cd_rs->search_related('artist', {
950 Searches the specified relationship, optionally specifying a condition and
951 attributes for matching records. See L</ATTRIBUTES> for more information.
953 In list context, C<< ->all() >> is called implicitly on the resultset, thus
954 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
956 See also L</search_related_rs>.
961 return shift->related_resultset(shift)->search(@_);
964 =head2 search_related_rs
966 This method works exactly the same as search_related, except that
967 it guarantees a resultset, even in list context.
971 sub search_related_rs {
972 return shift->related_resultset(shift)->search_rs(@_);
979 =item Arguments: none
981 =item Return Value: L<$cursor|DBIx::Class::Cursor>
985 Returns a storage-driven cursor to the given resultset. See
986 L<DBIx::Class::Cursor> for more information.
993 return $self->{cursor} ||= do {
994 my $attrs = { %{$self->_resolved_attrs } };
995 $self->result_source->storage->select(
996 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
1005 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1007 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1011 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1013 Inflates the first result without creating a cursor if the resultset has
1014 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1017 While this method can take an optional search condition (just like L</search>)
1018 being a fast-code-path it does not recognize search attributes. If you need to
1019 add extra joins or similar, call L</search> and then chain-call L</single> on the
1020 L<DBIx::Class::ResultSet> returned.
1026 As of 0.08100, this method enforces the assumption that the preceding
1027 query returns only one row. If more than one row is returned, you will receive
1030 Query returned more than one row
1032 In this case, you should be using L</next> or L</find> instead, or if you really
1033 know what you are doing, use the L</rows> attribute to explicitly limit the size
1036 This method will also throw an exception if it is called on a resultset prefetching
1037 has_many, as such a prefetch implies fetching multiple rows from the database in
1038 order to assemble the resulting object.
1045 my ($self, $where) = @_;
1047 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1050 my $attrs = { %{$self->_resolved_attrs} };
1052 if (keys %{$attrs->{collapse}}) {
1053 $self->throw_exception(
1054 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
1059 if (defined $attrs->{where}) {
1062 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1063 $where, delete $attrs->{where} ]
1066 $attrs->{where} = $where;
1070 my @data = $self->result_source->storage->select_single(
1071 $attrs->{from}, $attrs->{select},
1072 $attrs->{where}, $attrs
1075 return (@data ? ($self->_construct_object(@data))[0] : undef);
1081 # Recursively collapse the query, accumulating values for each column.
1083 sub _collapse_query {
1084 my ($self, $query, $collapsed) = @_;
1088 if (ref $query eq 'ARRAY') {
1089 foreach my $subquery (@$query) {
1090 next unless ref $subquery; # -or
1091 $collapsed = $self->_collapse_query($subquery, $collapsed);
1094 elsif (ref $query eq 'HASH') {
1095 if (keys %$query and (keys %$query)[0] eq '-and') {
1096 foreach my $subquery (@{$query->{-and}}) {
1097 $collapsed = $self->_collapse_query($subquery, $collapsed);
1101 foreach my $col (keys %$query) {
1102 my $value = $query->{$col};
1103 $collapsed->{$col}{$value}++;
1115 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1117 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1121 my $max_length = $rs->get_column('length')->max;
1123 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1128 my ($self, $column) = @_;
1129 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1137 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1139 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1143 # WHERE title LIKE '%blue%'
1144 $cd_rs = $rs->search_like({ title => '%blue%'});
1146 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1147 that this is simply a convenience method retained for ex Class::DBI users.
1148 You most likely want to use L</search> with specific operators.
1150 For more information, see L<DBIx::Class::Manual::Cookbook>.
1152 This method is deprecated and will be removed in 0.09. Use L</search()>
1153 instead. An example conversion is:
1155 ->search_like({ foo => 'bar' });
1159 ->search({ foo => { like => 'bar' } });
1166 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1167 .' Instead use ->search({ x => { -like => "y%" } })'
1168 .' (note the outer pair of {}s - they are important!)'
1170 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1171 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1172 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1173 return $class->search($query, { %$attrs });
1180 =item Arguments: $first, $last
1182 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1186 Returns a resultset or object list representing a subset of elements from the
1187 resultset slice is called on. Indexes are from 0, i.e., to get the first
1188 three records, call:
1190 my ($one, $two, $three) = $rs->slice(0, 2);
1195 my ($self, $min, $max) = @_;
1196 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1197 $attrs->{offset} = $self->{attrs}{offset} || 0;
1198 $attrs->{offset} += $min;
1199 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1200 return $self->search(undef, $attrs);
1201 #my $slice = (ref $self)->new($self->result_source, $attrs);
1202 #return (wantarray ? $slice->all : $slice);
1209 =item Arguments: none
1211 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1215 Returns the next element in the resultset (C<undef> is there is none).
1217 Can be used to efficiently iterate over records in the resultset:
1219 my $rs = $schema->resultset('CD')->search;
1220 while (my $cd = $rs->next) {
1224 Note that you need to store the resultset object, and call C<next> on it.
1225 Calling C<< resultset('Table')->next >> repeatedly will always return the
1226 first record from the resultset.
1232 if (my $cache = $self->get_cache) {
1233 $self->{all_cache_position} ||= 0;
1234 return $cache->[$self->{all_cache_position}++];
1236 if ($self->{attrs}{cache}) {
1237 delete $self->{pager};
1238 $self->{all_cache_position} = 1;
1239 return ($self->all)[0];
1241 if ($self->{stashed_objects}) {
1242 my $obj = shift(@{$self->{stashed_objects}});
1243 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
1247 exists $self->{stashed_row}
1248 ? @{delete $self->{stashed_row}}
1249 : $self->cursor->next
1251 return undef unless (@row);
1252 my ($row, @more) = $self->_construct_object(@row);
1253 $self->{stashed_objects} = \@more if @more;
1257 sub _construct_object {
1258 my ($self, @row) = @_;
1260 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
1262 my @new = $self->result_class->inflate_result($self->result_source, @$info);
1263 @new = $self->{_attrs}{record_filter}->(@new)
1264 if exists $self->{_attrs}{record_filter};
1268 sub _collapse_result {
1269 my ($self, $as_proto, $row) = @_;
1273 # 'foo' => [ undef, 'foo' ]
1274 # 'foo.bar' => [ 'foo', 'bar' ]
1275 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
1277 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
1279 my %collapse = %{$self->{_attrs}{collapse}||{}};
1283 # if we're doing collapsing (has_many prefetch) we need to grab records
1284 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1285 # we know we don't have to bother.
1287 # the reason for not using the collapse stuff directly is because if you
1288 # had for e.g. two artists in a row with no cds, the collapse info for
1289 # both would be NULL (undef) so you'd lose the second artist
1291 # store just the index so we can check the array positions from the row
1292 # without having to contruct the full hash
1294 if (keys %collapse) {
1295 my %pri = map { ($_ => 1) } $self->result_source->_pri_cols;
1296 foreach my $i (0 .. $#construct_as) {
1297 next if defined($construct_as[$i][0]); # only self table
1298 if (delete $pri{$construct_as[$i][1]}) {
1299 push(@pri_index, $i);
1301 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1305 # no need to do an if, it'll be empty if @pri_index is empty anyway
1307 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1311 do { # no need to check anything at the front, we always want the first row
1315 foreach my $this_as (@construct_as) {
1316 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1319 push(@const_rows, \%const);
1321 } until ( # no pri_index => no collapse => drop straight out
1324 do { # get another row, stash it, drop out if different PK
1326 @copy = $self->cursor->next;
1327 $self->{stashed_row} = \@copy;
1329 # last thing in do block, counts as true if anything doesn't match
1331 # check xor defined first for NULL vs. NOT NULL then if one is
1332 # defined the other must be so check string equality
1335 (defined $pri_vals{$_} ^ defined $copy[$_])
1336 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1341 my $alias = $self->{attrs}{alias};
1348 foreach my $const (@const_rows) {
1349 scalar @const_keys or do {
1350 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1352 foreach my $key (@const_keys) {
1355 my @parts = split(/\./, $key);
1357 my $data = $const->{$key};
1358 foreach my $p (@parts) {
1359 $target = $target->[1]->{$p} ||= [];
1361 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1362 # collapsing at this point and on final part
1363 my $pos = $collapse_pos{$cur};
1364 CK: foreach my $ck (@ckey) {
1365 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1366 $collapse_pos{$cur} = $data;
1367 delete @collapse_pos{ # clear all positioning for sub-entries
1368 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1375 if (exists $collapse{$cur}) {
1376 $target = $target->[-1];
1379 $target->[0] = $data;
1381 $info->[0] = $const->{$key};
1389 =head2 result_source
1393 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1395 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1399 An accessor for the primary ResultSource object from which this ResultSet
1406 =item Arguments: $result_class?
1408 =item Return Value: $result_class
1412 An accessor for the class to use when creating result objects. Defaults to
1413 C<< result_source->result_class >> - which in most cases is the name of the
1414 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1416 Note that changing the result_class will also remove any components
1417 that were originally loaded in the source class via
1418 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1419 in the original source class will not run.
1424 my ($self, $result_class) = @_;
1425 if ($result_class) {
1426 unless (ref $result_class) { # don't fire this for an object
1427 $self->ensure_class_loaded($result_class);
1429 $self->_result_class($result_class);
1430 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1431 # permit the user to set result class on one result set only; it only
1432 # chains if provided to search()
1433 #$self->{attrs}{result_class} = $result_class if ref $self;
1435 $self->_result_class;
1442 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1444 =item Return Value: $count
1448 Performs an SQL C<COUNT> with the same query as the resultset was built
1449 with to find the number of elements. Passing arguments is equivalent to
1450 C<< $rs->search ($cond, \%attrs)->count >>
1456 return $self->search(@_)->count if @_ and defined $_[0];
1457 return scalar @{ $self->get_cache } if $self->get_cache;
1459 my $attrs = { %{ $self->_resolved_attrs } };
1461 # this is a little optimization - it is faster to do the limit
1462 # adjustments in software, instead of a subquery
1463 my $rows = delete $attrs->{rows};
1464 my $offset = delete $attrs->{offset};
1467 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1468 $crs = $self->_count_subq_rs ($attrs);
1471 $crs = $self->_count_rs ($attrs);
1473 my $count = $crs->next;
1475 $count -= $offset if $offset;
1476 $count = $rows if $rows and $rows < $count;
1477 $count = 0 if ($count < 0);
1486 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1488 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1492 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1493 This can be very handy for subqueries:
1495 ->search( { amount => $some_rs->count_rs->as_query } )
1497 As with regular resultsets the SQL query will be executed only after
1498 the resultset is accessed via L</next> or L</all>. That would return
1499 the same single value obtainable via L</count>.
1505 return $self->search(@_)->count_rs if @_;
1507 # this may look like a lack of abstraction (count() does about the same)
1508 # but in fact an _rs *must* use a subquery for the limits, as the
1509 # software based limiting can not be ported if this $rs is to be used
1510 # in a subquery itself (i.e. ->as_query)
1511 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1512 return $self->_count_subq_rs;
1515 return $self->_count_rs;
1520 # returns a ResultSetColumn object tied to the count query
1523 my ($self, $attrs) = @_;
1525 my $rsrc = $self->result_source;
1526 $attrs ||= $self->_resolved_attrs;
1528 my $tmp_attrs = { %$attrs };
1529 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1530 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1532 # overwrite the selector (supplied by the storage)
1533 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $attrs);
1534 $tmp_attrs->{as} = 'count';
1535 delete @{$tmp_attrs}{qw/columns/};
1537 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1543 # same as above but uses a subquery
1545 sub _count_subq_rs {
1546 my ($self, $attrs) = @_;
1548 my $rsrc = $self->result_source;
1549 $attrs ||= $self->_resolved_attrs;
1551 my $sub_attrs = { %$attrs };
1552 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1553 delete @{$sub_attrs}{qw/collapse columns as select _prefetch_selector_range order_by for/};
1555 # if we multi-prefetch we group_by something unique, as this is what we would
1556 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1557 if ( keys %{$attrs->{collapse}} ) {
1558 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1559 $rsrc->_identifying_column_set || $self->throw_exception(
1560 'Unable to construct a unique group_by criteria properly collapsing the '
1561 . 'has_many prefetch before count()'
1566 # Calculate subquery selector
1567 if (my $g = $sub_attrs->{group_by}) {
1569 my $sql_maker = $rsrc->storage->sql_maker;
1571 # necessary as the group_by may refer to aliased functions
1573 for my $sel (@{$attrs->{select}}) {
1574 $sel_index->{$sel->{-as}} = $sel
1575 if (ref $sel eq 'HASH' and $sel->{-as});
1578 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1579 # also look for named aggregates referred in the having clause
1580 # having often contains scalarrefs - thus parse it out entirely
1582 if ($attrs->{having}) {
1583 local $sql_maker->{having_bind};
1584 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1585 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1586 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1587 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1588 # if we don't unset it we screw up retarded but unfortunately working
1589 # 'MAX(foo.bar)' => { '>', 3 }
1590 $sql_maker->{name_sep} = '';
1593 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1595 my $sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1597 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1598 # and if all fails for an utterly naive quoted scalar-with-function
1600 $rquote $sep $lquote (.+?) $rquote
1602 [\s,] \w+ \. (\w+) [\s,]
1604 [\s,] $lquote (.+?) $rquote [\s,]
1606 push @parts, ($1 || $2 || $3); # one of them matched if we got here
1611 my $colpiece = $sel_index->{$_} || $_;
1613 # unqualify join-based group_by's. Arcane but possible query
1614 # also horrible horrible hack to alias a column (not a func.)
1615 # (probably need to introduce SQLA syntax)
1616 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1619 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1621 push @{$sub_attrs->{select}}, $colpiece;
1625 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1626 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1629 return $rsrc->resultset_class
1630 ->new ($rsrc, $sub_attrs)
1632 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1633 ->get_column ('count');
1640 =head2 count_literal
1642 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1643 should only be used in that context. See L</search_literal> for further info.
1647 =item Arguments: $sql_fragment, @standalone_bind_values
1649 =item Return Value: $count
1653 Counts the results in a literal query. Equivalent to calling L</search_literal>
1654 with the passed arguments, then L</count>.
1658 sub count_literal { shift->search_literal(@_)->count; }
1664 =item Arguments: none
1666 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1670 Returns all elements in the resultset.
1677 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1680 return @{ $self->get_cache } if $self->get_cache;
1684 if (keys %{$self->_resolved_attrs->{collapse}}) {
1685 # Using $self->cursor->all is really just an optimisation.
1686 # If we're collapsing has_many prefetches it probably makes
1687 # very little difference, and this is cleaner than hacking
1688 # _construct_object to survive the approach
1689 $self->cursor->reset;
1690 my @row = $self->cursor->next;
1692 push(@obj, $self->_construct_object(@row));
1693 @row = (exists $self->{stashed_row}
1694 ? @{delete $self->{stashed_row}}
1695 : $self->cursor->next);
1698 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1701 $self->set_cache(\@obj) if $self->{attrs}{cache};
1710 =item Arguments: none
1712 =item Return Value: $self
1716 Resets the resultset's cursor, so you can iterate through the elements again.
1717 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1724 $self->{all_cache_position} = 0;
1725 $self->cursor->reset;
1733 =item Arguments: none
1735 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1739 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1740 an object for the first result (or C<undef> if the resultset is empty).
1745 return $_[0]->reset->next;
1751 # Determines whether and what type of subquery is required for the $rs operation.
1752 # If grouping is necessary either supplies its own, or verifies the current one
1753 # After all is done delegates to the proper storage method.
1755 sub _rs_update_delete {
1756 my ($self, $op, $values) = @_;
1758 my $cond = $self->{cond};
1759 my $rsrc = $self->result_source;
1760 my $storage = $rsrc->schema->storage;
1762 my $attrs = { %{$self->_resolved_attrs} };
1764 my $existing_group_by = delete $attrs->{group_by};
1765 my $needs_subq = defined $existing_group_by;
1767 # simplify the joinmap and maybe decide if a subquery is necessary
1768 my $relation_classifications = {};
1770 if (ref($attrs->{from}) eq 'ARRAY') {
1771 # if we already know we need a subq, no point of classifying relations
1772 if (!$needs_subq and @{$attrs->{from}} > 1) {
1773 $attrs->{from} = $storage->_prune_unused_joins ($attrs->{from}, $attrs->{select}, $cond, $attrs);
1775 $relation_classifications = $storage->_resolve_aliastypes_from_select_args (
1776 [ @{$attrs->{from}}[1 .. $#{$attrs->{from}}] ],
1784 $needs_subq ||= 1; # if {from} is unparseable assume the worst
1787 # do we need anything like a subquery?
1791 ! keys %{ $relation_classifications->{restricting} || {} }
1793 ! $self->_has_resolved_attr(qw/rows offset/) # limits call for a subq
1795 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1796 # a condition containing 'me' or other table prefixes will not work
1797 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1799 my $sqla = $rsrc->storage->sql_maker;
1800 local $sqla->{_dequalify_idents} = 1;
1801 \[ $sqla->_recurse_where($self->{cond}) ];
1803 return $rsrc->storage->$op(
1805 $op eq 'update' ? $values : (),
1810 # we got this far - means it is time to wrap a subquery
1811 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1813 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1819 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1820 delete $attrs->{$_} for qw/collapse _collapse_order_by select _prefetch_selector_range as/;
1821 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1822 $attrs->{group_by} = \ ''; # FIXME - this is an evil hack, it causes the optimiser to kick in and throw away the LEFT joins
1823 my $subrs = (ref $self)->new($rsrc, $attrs);
1825 if (@$idcols == 1) {
1826 return $storage->$op (
1828 $op eq 'update' ? $values : (),
1829 { $idcols->[0] => { -in => $subrs->as_query } },
1832 elsif ($storage->_use_multicolumn_in) {
1833 # This is hideously ugly, but SQLA does not understand multicol IN expressions
1834 my $sql_maker = $storage->sql_maker;
1835 my ($sql, @bind) = @${$subrs->as_query};
1836 $sql = sprintf ('(%s) IN %s', # the as_query already comes with a set of parenthesis
1837 join (', ', map { $sql_maker->_quote ($_) } @$idcols),
1841 return $storage->$op (
1843 $op eq 'update' ? $values : (),
1849 # if all else fails - get all primary keys and operate over a ORed set
1850 # wrap in a transaction for consistency
1851 # this is where the group_by starts to matter
1855 keys %{ $relation_classifications->{multiplying} || {} }
1857 # make sure if there is a supplied group_by it matches the columns compiled above
1858 # perfectly. Anything else can not be sanely executed on most databases so croak
1859 # right then and there
1860 if ($existing_group_by) {
1861 my @current_group_by = map
1862 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1867 join ("\x00", sort @current_group_by)
1869 join ("\x00", sort @{$attrs->{columns}} )
1871 $self->throw_exception (
1872 "You have just attempted a $op operation on a resultset which does group_by"
1873 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1874 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1875 . ' kind of queries. Please retry the operation with a modified group_by or'
1876 . ' without using one at all.'
1881 $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
1884 my $guard = $storage->txn_scope_guard;
1887 for my $row ($subrs->cursor->all) {
1888 push @op_condition, { map
1889 { $idcols->[$_] => $row->[$_] }
1894 my $res = $storage->$op (
1896 $op eq 'update' ? $values : (),
1910 =item Arguments: \%values
1912 =item Return Value: $underlying_storage_rv
1916 Sets the specified columns in the resultset to the supplied values in a
1917 single query. Note that this will not run any accessor/set_column/update
1918 triggers, nor will it update any result object instances derived from this
1919 resultset (this includes the contents of the L<resultset cache|/set_cache>
1920 if any). See L</update_all> if you need to execute any on-update
1921 triggers or cascades defined either by you or a
1922 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1924 The return value is a pass through of what the underlying
1925 storage backend returned, and may vary. See L<DBI/execute> for the most
1930 Note that L</update> does not process/deflate any of the values passed in.
1931 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
1932 ensure manually that any value passed to this method will stringify to
1933 something the RDBMS knows how to deal with. A notable example is the
1934 handling of L<DateTime> objects, for more info see:
1935 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
1940 my ($self, $values) = @_;
1941 $self->throw_exception('Values for update must be a hash')
1942 unless ref $values eq 'HASH';
1944 return $self->_rs_update_delete ('update', $values);
1951 =item Arguments: \%values
1953 =item Return Value: 1
1957 Fetches all objects and updates them one at a time via
1958 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
1959 triggers, while L</update> will not.
1964 my ($self, $values) = @_;
1965 $self->throw_exception('Values for update_all must be a hash')
1966 unless ref $values eq 'HASH';
1968 my $guard = $self->result_source->schema->txn_scope_guard;
1969 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
1978 =item Arguments: none
1980 =item Return Value: $underlying_storage_rv
1984 Deletes the rows matching this resultset in a single query. Note that this
1985 will not run any delete triggers, nor will it alter the
1986 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
1987 derived from this resultset (this includes the contents of the
1988 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
1989 execute any on-delete triggers or cascades defined either by you or a
1990 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1992 The return value is a pass through of what the underlying storage backend
1993 returned, and may vary. See L<DBI/execute> for the most common case.
1999 $self->throw_exception('delete does not accept any arguments')
2002 return $self->_rs_update_delete ('delete');
2009 =item Arguments: none
2011 =item Return Value: 1
2015 Fetches all objects and deletes them one at a time via
2016 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2017 triggers, while L</delete> will not.
2023 $self->throw_exception('delete_all does not accept any arguments')
2026 my $guard = $self->result_source->schema->txn_scope_guard;
2027 $_->delete for $self->all;
2036 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2038 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2042 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2049 The context of this method call has an important effect on what is
2050 submitted to storage. In void context data is fed directly to fastpath
2051 insertion routines provided by the underlying storage (most often
2052 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2053 L<insert|DBIx::Class::Row/insert> calls on the
2054 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2055 augmentation of these methods provided by components. For example if you
2056 are using something like L<DBIx::Class::UUIDColumns> to create primary
2057 keys for you, you will find that your PKs are empty. In this case you
2058 will have to explicitly force scalar or list context in order to create
2063 In non-void (scalar or list) context, this method is simply a wrapper
2064 for L</create>. Depending on list or scalar context either a list of
2065 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2066 containing these objects is returned.
2068 When supplying data in "arrayref of arrayrefs" invocation style, the
2069 first element should be a list of column names and each subsequent
2070 element should be a data value in the earlier specified column order.
2073 $Arstist_rs->populate([
2074 [ qw( artistid name ) ],
2075 [ 100, 'A Formally Unknown Singer' ],
2076 [ 101, 'A singer that jumped the shark two albums ago' ],
2077 [ 102, 'An actually cool singer' ],
2080 For the arrayref of hashrefs style each hashref should be a structure
2081 suitable for passing to L</create>. Multi-create is also permitted with
2084 $schema->resultset("Artist")->populate([
2085 { artistid => 4, name => 'Manufactured Crap', cds => [
2086 { title => 'My First CD', year => 2006 },
2087 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2090 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2091 { title => 'My parents sold me to a record company', year => 2005 },
2092 { title => 'Why Am I So Ugly?', year => 2006 },
2093 { title => 'I Got Surgery and am now Popular', year => 2007 }
2098 If you attempt a void-context multi-create as in the example above (each
2099 Artist also has the related list of CDs), and B<do not> supply the
2100 necessary autoinc foreign key information, this method will proxy to the
2101 less efficient L</create>, and then throw the Result objects away. In this
2102 case there are obviously no benefits to using this method over L</create>.
2109 # cruft placed in standalone method
2110 my $data = $self->_normalize_populate_args(@_);
2112 return unless @$data;
2114 if(defined wantarray) {
2115 my @created = map { $self->create($_) } @$data;
2116 return wantarray ? @created : \@created;
2119 my $first = $data->[0];
2121 # if a column is a registered relationship, and is a non-blessed hash/array, consider
2122 # it relationship data
2123 my (@rels, @columns);
2124 my $rsrc = $self->result_source;
2125 my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2126 for (keys %$first) {
2127 my $ref = ref $first->{$_};
2128 $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2134 my @pks = $rsrc->primary_columns;
2136 ## do the belongs_to relationships
2137 foreach my $index (0..$#$data) {
2139 # delegate to create() for any dataset without primary keys with specified relationships
2140 if (grep { !defined $data->[$index]->{$_} } @pks ) {
2142 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
2143 my @ret = $self->populate($data);
2149 foreach my $rel (@rels) {
2150 next unless ref $data->[$index]->{$rel} eq "HASH";
2151 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2152 my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2153 my $related = $result->result_source->_resolve_condition(
2154 $reverse_relinfo->{cond},
2160 delete $data->[$index]->{$rel};
2161 $data->[$index] = {%{$data->[$index]}, %$related};
2163 push @columns, keys %$related if $index == 0;
2167 ## inherit the data locked in the conditions of the resultset
2168 my ($rs_data) = $self->_merge_with_rscond({});
2169 delete @{$rs_data}{@columns};
2171 ## do bulk insert on current row
2172 $rsrc->storage->insert_bulk(
2174 [@columns, keys %$rs_data],
2175 [ map { [ @$_{@columns}, values %$rs_data ] } @$data ],
2178 ## do the has_many relationships
2179 foreach my $item (@$data) {
2183 foreach my $rel (@rels) {
2184 next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2186 $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2188 my $child = $main_row->$rel;
2190 my $related = $child->result_source->_resolve_condition(
2191 $rels->{$rel}{cond},
2197 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2198 my @populate = map { {%$_, %$related} } @rows_to_add;
2200 $child->populate( \@populate );
2207 # populate() argumnets went over several incarnations
2208 # What we ultimately support is AoH
2209 sub _normalize_populate_args {
2210 my ($self, $arg) = @_;
2212 if (ref $arg eq 'ARRAY') {
2216 elsif (ref $arg->[0] eq 'HASH') {
2219 elsif (ref $arg->[0] eq 'ARRAY') {
2221 my @colnames = @{$arg->[0]};
2222 foreach my $values (@{$arg}[1 .. $#$arg]) {
2223 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2229 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2236 =item Arguments: none
2238 =item Return Value: L<$pager|Data::Page>
2242 Returns a L<Data::Page> object for the current resultset. Only makes
2243 sense for queries with a C<page> attribute.
2245 To get the full count of entries for a paged resultset, call
2246 C<total_entries> on the L<Data::Page> object.
2253 return $self->{pager} if $self->{pager};
2255 my $attrs = $self->{attrs};
2256 if (!defined $attrs->{page}) {
2257 $self->throw_exception("Can't create pager for non-paged rs");
2259 elsif ($attrs->{page} <= 0) {
2260 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2262 $attrs->{rows} ||= 10;
2264 # throw away the paging flags and re-run the count (possibly
2265 # with a subselect) to get the real total count
2266 my $count_attrs = { %$attrs };
2267 delete $count_attrs->{$_} for qw/rows offset page pager/;
2269 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2271 require DBIx::Class::ResultSet::Pager;
2272 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2273 sub { $total_rs->count }, #lazy-get the total
2275 $self->{attrs}{page},
2283 =item Arguments: $page_number
2285 =item Return Value: L<$resultset|/search>
2289 Returns a resultset for the $page_number page of the resultset on which page
2290 is called, where each page contains a number of rows equal to the 'rows'
2291 attribute set on the resultset (10 by default).
2296 my ($self, $page) = @_;
2297 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2304 =item Arguments: \%col_data
2306 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2310 Creates a new result object in the resultset's result class and returns
2311 it. The row is not inserted into the database at this point, call
2312 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2313 will tell you whether the result object has been inserted or not.
2315 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2320 my ($self, $values) = @_;
2322 $self->throw_exception( "new_result takes only one argument - a hashref of values" )
2325 $self->throw_exception( "new_result expects a hashref" )
2326 unless (ref $values eq 'HASH');
2328 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2332 @$cols_from_relations
2333 ? (-cols_from_relations => $cols_from_relations)
2335 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2338 return $self->result_class->new(\%new);
2341 # _merge_with_rscond
2343 # Takes a simple hash of K/V data and returns its copy merged with the
2344 # condition already present on the resultset. Additionally returns an
2345 # arrayref of value/condition names, which were inferred from related
2346 # objects (this is needed for in-memory related objects)
2347 sub _merge_with_rscond {
2348 my ($self, $data) = @_;
2350 my (%new_data, @cols_from_relations);
2352 my $alias = $self->{attrs}{alias};
2354 if (! defined $self->{cond}) {
2355 # just massage $data below
2357 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
2358 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2359 @cols_from_relations = keys %new_data;
2361 elsif (ref $self->{cond} ne 'HASH') {
2362 $self->throw_exception(
2363 "Can't abstract implicit construct, resultset condition not a hash"
2367 # precendence must be given to passed values over values inherited from
2368 # the cond, so the order here is important.
2369 my $collapsed_cond = $self->_collapse_cond($self->{cond});
2370 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2372 while ( my($col, $value) = each %implied ) {
2373 my $vref = ref $value;
2379 (keys %$value)[0] eq '='
2381 $new_data{$col} = $value->{'='};
2383 elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2384 $new_data{$col} = $value;
2391 %{ $self->_remove_alias($data, $alias) },
2394 return (\%new_data, \@cols_from_relations);
2397 # _has_resolved_attr
2399 # determines if the resultset defines at least one
2400 # of the attributes supplied
2402 # used to determine if a subquery is neccessary
2404 # supports some virtual attributes:
2406 # This will scan for any joins being present on the resultset.
2407 # It is not a mere key-search but a deep inspection of {from}
2410 sub _has_resolved_attr {
2411 my ($self, @attr_names) = @_;
2413 my $attrs = $self->_resolved_attrs;
2417 for my $n (@attr_names) {
2418 if (grep { $n eq $_ } (qw/-join/) ) {
2419 $extra_checks{$n}++;
2423 my $attr = $attrs->{$n};
2425 next if not defined $attr;
2427 if (ref $attr eq 'HASH') {
2428 return 1 if keys %$attr;
2430 elsif (ref $attr eq 'ARRAY') {
2438 # a resolved join is expressed as a multi-level from
2440 $extra_checks{-join}
2442 ref $attrs->{from} eq 'ARRAY'
2444 @{$attrs->{from}} > 1
2452 # Recursively collapse the condition.
2454 sub _collapse_cond {
2455 my ($self, $cond, $collapsed) = @_;
2459 if (ref $cond eq 'ARRAY') {
2460 foreach my $subcond (@$cond) {
2461 next unless ref $subcond; # -or
2462 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2465 elsif (ref $cond eq 'HASH') {
2466 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2467 foreach my $subcond (@{$cond->{-and}}) {
2468 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2472 foreach my $col (keys %$cond) {
2473 my $value = $cond->{$col};
2474 $collapsed->{$col} = $value;
2484 # Remove the specified alias from the specified query hash. A copy is made so
2485 # the original query is not modified.
2488 my ($self, $query, $alias) = @_;
2490 my %orig = %{ $query || {} };
2493 foreach my $key (keys %orig) {
2495 $unaliased{$key} = $orig{$key};
2498 $unaliased{$1} = $orig{$key}
2499 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2509 =item Arguments: none
2511 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2515 Returns the SQL query and bind vars associated with the invocant.
2517 This is generally used as the RHS for a subquery.
2524 my $attrs = { %{ $self->_resolved_attrs } };
2529 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2530 # $sql also has no wrapping parenthesis in list ctx
2532 my $sqlbind = $self->result_source->storage
2533 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2542 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2544 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2548 my $artist = $schema->resultset('Artist')->find_or_new(
2549 { artist => 'fred' }, { key => 'artists' });
2551 $cd->cd_to_producer->find_or_new({ producer => $producer },
2552 { key => 'primary });
2554 Find an existing record from this resultset using L</find>. if none exists,
2555 instantiate a new result object and return it. The object will not be saved
2556 into your storage until you call L<DBIx::Class::Row/insert> on it.
2558 You most likely want this method when looking for existing rows using a unique
2559 constraint that is not the primary key, or looking for related rows.
2561 If you want objects to be saved immediately, use L</find_or_create> instead.
2563 B<Note>: Make sure to read the documentation of L</find> and understand the
2564 significance of the C<key> attribute, as its lack may skew your search, and
2565 subsequently result in spurious new objects.
2567 B<Note>: Take care when using C<find_or_new> with a table having
2568 columns with default values that you intend to be automatically
2569 supplied by the database (e.g. an auto_increment primary key column).
2570 In normal usage, the value of such columns should NOT be included at
2571 all in the call to C<find_or_new>, even when set to C<undef>.
2577 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2578 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2579 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2582 return $self->new_result($hash);
2589 =item Arguments: \%col_data
2591 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2595 Attempt to create a single new row or a row with multiple related rows
2596 in the table represented by the resultset (and related tables). This
2597 will not check for duplicate rows before inserting, use
2598 L</find_or_create> to do that.
2600 To create one row for this resultset, pass a hashref of key/value
2601 pairs representing the columns of the table and the values you wish to
2602 store. If the appropriate relationships are set up, foreign key fields
2603 can also be passed an object representing the foreign row, and the
2604 value will be set to its primary key.
2606 To create related objects, pass a hashref of related-object column values
2607 B<keyed on the relationship name>. If the relationship is of type C<multi>
2608 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2609 The process will correctly identify columns holding foreign keys, and will
2610 transparently populate them from the keys of the corresponding relation.
2611 This can be applied recursively, and will work correctly for a structure
2612 with an arbitrary depth and width, as long as the relationships actually
2613 exists and the correct column data has been supplied.
2615 Instead of hashrefs of plain related data (key/value pairs), you may
2616 also pass new or inserted objects. New objects (not inserted yet, see
2617 L</new_result>), will be inserted into their appropriate tables.
2619 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2621 Example of creating a new row.
2623 $person_rs->create({
2624 name=>"Some Person",
2625 email=>"somebody@someplace.com"
2628 Example of creating a new row and also creating rows in a related C<has_many>
2629 or C<has_one> resultset. Note Arrayref.
2632 { artistid => 4, name => 'Manufactured Crap', cds => [
2633 { title => 'My First CD', year => 2006 },
2634 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2639 Example of creating a new row and also creating a row in a related
2640 C<belongs_to> resultset. Note Hashref.
2643 title=>"Music for Silly Walks",
2646 name=>"Silly Musician",
2654 When subclassing ResultSet never attempt to override this method. Since
2655 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2656 lot of the internals simply never call it, so your override will be
2657 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2658 or L<DBIx::Class::Row/insert> depending on how early in the
2659 L</create> process you need to intervene. See also warning pertaining to
2667 my ($self, $attrs) = @_;
2668 $self->throw_exception( "create needs a hashref" )
2669 unless ref $attrs eq 'HASH';
2670 return $self->new_result($attrs)->insert;
2673 =head2 find_or_create
2677 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2679 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2683 $cd->cd_to_producer->find_or_create({ producer => $producer },
2684 { key => 'primary' });
2686 Tries to find a record based on its primary key or unique constraints; if none
2687 is found, creates one and returns that instead.
2689 my $cd = $schema->resultset('CD')->find_or_create({
2691 artist => 'Massive Attack',
2692 title => 'Mezzanine',
2696 Also takes an optional C<key> attribute, to search by a specific key or unique
2697 constraint. For example:
2699 my $cd = $schema->resultset('CD')->find_or_create(
2701 artist => 'Massive Attack',
2702 title => 'Mezzanine',
2704 { key => 'cd_artist_title' }
2707 B<Note>: Make sure to read the documentation of L</find> and understand the
2708 significance of the C<key> attribute, as its lack may skew your search, and
2709 subsequently result in spurious row creation.
2711 B<Note>: Because find_or_create() reads from the database and then
2712 possibly inserts based on the result, this method is subject to a race
2713 condition. Another process could create a record in the table after
2714 the find has completed and before the create has started. To avoid
2715 this problem, use find_or_create() inside a transaction.
2717 B<Note>: Take care when using C<find_or_create> with a table having
2718 columns with default values that you intend to be automatically
2719 supplied by the database (e.g. an auto_increment primary key column).
2720 In normal usage, the value of such columns should NOT be included at
2721 all in the call to C<find_or_create>, even when set to C<undef>.
2723 See also L</find> and L</update_or_create>. For information on how to declare
2724 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2726 If you need to know if an existing row was found or a new one created use
2727 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2728 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2731 my $cd = $schema->resultset('CD')->find_or_new({
2733 artist => 'Massive Attack',
2734 title => 'Mezzanine',
2738 if( !$cd->in_storage ) {
2745 sub find_or_create {
2747 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2748 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2749 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2752 return $self->create($hash);
2755 =head2 update_or_create
2759 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2761 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2765 $resultset->update_or_create({ col => $val, ... });
2767 Like L</find_or_create>, but if a row is found it is immediately updated via
2768 C<< $found_row->update (\%col_data) >>.
2771 Takes an optional C<key> attribute to search on a specific unique constraint.
2774 # In your application
2775 my $cd = $schema->resultset('CD')->update_or_create(
2777 artist => 'Massive Attack',
2778 title => 'Mezzanine',
2781 { key => 'cd_artist_title' }
2784 $cd->cd_to_producer->update_or_create({
2785 producer => $producer,
2791 B<Note>: Make sure to read the documentation of L</find> and understand the
2792 significance of the C<key> attribute, as its lack may skew your search, and
2793 subsequently result in spurious row creation.
2795 B<Note>: Take care when using C<update_or_create> with a table having
2796 columns with default values that you intend to be automatically
2797 supplied by the database (e.g. an auto_increment primary key column).
2798 In normal usage, the value of such columns should NOT be included at
2799 all in the call to C<update_or_create>, even when set to C<undef>.
2801 See also L</find> and L</find_or_create>. For information on how to declare
2802 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2804 If you need to know if an existing row was updated or a new one created use
2805 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2806 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2811 sub update_or_create {
2813 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2814 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2816 my $row = $self->find($cond, $attrs);
2818 $row->update($cond);
2822 return $self->create($cond);
2825 =head2 update_or_new
2829 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2831 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2835 $resultset->update_or_new({ col => $val, ... });
2837 Like L</find_or_new> but if a row is found it is immediately updated via
2838 C<< $found_row->update (\%col_data) >>.
2842 # In your application
2843 my $cd = $schema->resultset('CD')->update_or_new(
2845 artist => 'Massive Attack',
2846 title => 'Mezzanine',
2849 { key => 'cd_artist_title' }
2852 if ($cd->in_storage) {
2853 # the cd was updated
2856 # the cd is not yet in the database, let's insert it
2860 B<Note>: Make sure to read the documentation of L</find> and understand the
2861 significance of the C<key> attribute, as its lack may skew your search, and
2862 subsequently result in spurious new objects.
2864 B<Note>: Take care when using C<update_or_new> with a table having
2865 columns with default values that you intend to be automatically
2866 supplied by the database (e.g. an auto_increment primary key column).
2867 In normal usage, the value of such columns should NOT be included at
2868 all in the call to C<update_or_new>, even when set to C<undef>.
2870 See also L</find>, L</find_or_create> and L</find_or_new>.
2876 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2877 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2879 my $row = $self->find( $cond, $attrs );
2880 if ( defined $row ) {
2881 $row->update($cond);
2885 return $self->new_result($cond);
2892 =item Arguments: none
2894 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
2898 Gets the contents of the cache for the resultset, if the cache is set.
2900 The cache is populated either by using the L</prefetch> attribute to
2901 L</search> or by calling L</set_cache>.
2913 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2915 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2919 Sets the contents of the cache for the resultset. Expects an arrayref
2920 of objects of the same class as those produced by the resultset. Note that
2921 if the cache is set, the resultset will return the cached objects rather
2922 than re-querying the database even if the cache attr is not set.
2924 The contents of the cache can also be populated by using the
2925 L</prefetch> attribute to L</search>.
2930 my ( $self, $data ) = @_;
2931 $self->throw_exception("set_cache requires an arrayref")
2932 if defined($data) && (ref $data ne 'ARRAY');
2933 $self->{all_cache} = $data;
2940 =item Arguments: none
2942 =item Return Value: undef
2946 Clears the cache for the resultset.
2951 shift->set_cache(undef);
2958 =item Arguments: none
2960 =item Return Value: true, if the resultset has been paginated
2968 return !!$self->{attrs}{page};
2975 =item Arguments: none
2977 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2985 return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
2988 =head2 related_resultset
2992 =item Arguments: $rel_name
2994 =item Return Value: L<$resultset|/search>
2998 Returns a related resultset for the supplied relationship name.
3000 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3004 sub related_resultset {
3005 my ($self, $rel) = @_;
3007 $self->{related_resultsets} ||= {};
3008 return $self->{related_resultsets}{$rel} ||= do {
3009 my $rsrc = $self->result_source;
3010 my $rel_info = $rsrc->relationship_info($rel);
3012 $self->throw_exception(
3013 "search_related: result source '" . $rsrc->source_name .
3014 "' has no such relationship $rel")
3017 my $attrs = $self->_chain_relationship($rel);
3019 my $join_count = $attrs->{seen_join}{$rel};
3021 my $alias = $self->result_source->storage
3022 ->relname_to_table_alias($rel, $join_count);
3024 # since this is search_related, and we already slid the select window inwards
3025 # (the select/as attrs were deleted in the beginning), we need to flip all
3026 # left joins to inner, so we get the expected results
3027 # read the comment on top of the actual function to see what this does
3028 $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3031 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3032 delete @{$attrs}{qw(result_class alias)};
3036 if (my $cache = $self->get_cache) {
3037 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
3038 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
3043 my $rel_source = $rsrc->related_source($rel);
3047 # The reason we do this now instead of passing the alias to the
3048 # search_rs below is that if you wrap/overload resultset on the
3049 # source you need to know what alias it's -going- to have for things
3050 # to work sanely (e.g. RestrictWithObject wants to be able to add
3051 # extra query restrictions, and these may need to be $alias.)
3053 my $rel_attrs = $rel_source->resultset_attributes;
3054 local $rel_attrs->{alias} = $alias;
3056 $rel_source->resultset
3060 where => $attrs->{where},
3063 $new->set_cache($new_cache) if $new_cache;
3068 =head2 current_source_alias
3072 =item Arguments: none
3074 =item Return Value: $source_alias
3078 Returns the current table alias for the result source this resultset is built
3079 on, that will be used in the SQL query. Usually it is C<me>.
3081 Currently the source alias that refers to the result set returned by a
3082 L</search>/L</find> family method depends on how you got to the resultset: it's
3083 C<me> by default, but eg. L</search_related> aliases it to the related result
3084 source name (and keeps C<me> referring to the original result set). The long
3085 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3086 (and make this method unnecessary).
3088 Thus it's currently necessary to use this method in predefined queries (see
3089 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3090 source alias of the current result set:
3092 # in a result set class
3094 my ($self, $user) = @_;
3096 my $me = $self->current_source_alias;
3098 return $self->search({
3099 "$me.modified" => $user->id,
3105 sub current_source_alias {
3106 return (shift->{attrs} || {})->{alias} || 'me';
3109 =head2 as_subselect_rs
3113 =item Arguments: none
3115 =item Return Value: L<$resultset|/search>
3119 Act as a barrier to SQL symbols. The resultset provided will be made into a
3120 "virtual view" by including it as a subquery within the from clause. From this
3121 point on, any joined tables are inaccessible to ->search on the resultset (as if
3122 it were simply where-filtered without joins). For example:
3124 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3126 # 'x' now pollutes the query namespace
3128 # So the following works as expected
3129 my $ok_rs = $rs->search({'x.other' => 1});
3131 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3132 # def) we look for one row with contradictory terms and join in another table
3133 # (aliased 'x_2') which we never use
3134 my $broken_rs = $rs->search({'x.name' => 'def'});
3136 my $rs2 = $rs->as_subselect_rs;
3138 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3139 my $not_joined_rs = $rs2->search({'x.other' => 1});
3141 # works as expected: finds a 'table' row related to two x rows (abc and def)
3142 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3144 Another example of when one might use this would be to select a subset of
3145 columns in a group by clause:
3147 my $rs = $schema->resultset('Bar')->search(undef, {
3148 group_by => [qw{ id foo_id baz_id }],
3149 })->as_subselect_rs->search(undef, {
3150 columns => [qw{ id foo_id }]
3153 In the above example normally columns would have to be equal to the group by,
3154 but because we isolated the group by into a subselect the above works.
3158 sub as_subselect_rs {
3161 my $attrs = $self->_resolved_attrs;
3163 my $fresh_rs = (ref $self)->new (
3164 $self->result_source
3167 # these pieces will be locked in the subquery
3168 delete $fresh_rs->{cond};
3169 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3171 return $fresh_rs->search( {}, {
3173 $attrs->{alias} => $self->as_query,
3174 -alias => $attrs->{alias},
3175 -rsrc => $self->result_source,
3177 alias => $attrs->{alias},
3181 # This code is called by search_related, and makes sure there
3182 # is clear separation between the joins before, during, and
3183 # after the relationship. This information is needed later
3184 # in order to properly resolve prefetch aliases (any alias
3185 # with a relation_chain_depth less than the depth of the
3186 # current prefetch is not considered)
3188 # The increments happen twice per join. An even number means a
3189 # relationship specified via a search_related, whereas an odd
3190 # number indicates a join/prefetch added via attributes
3192 # Also this code will wrap the current resultset (the one we
3193 # chain to) in a subselect IFF it contains limiting attributes
3194 sub _chain_relationship {
3195 my ($self, $rel) = @_;
3196 my $source = $self->result_source;
3197 my $attrs = { %{$self->{attrs}||{}} };
3199 # we need to take the prefetch the attrs into account before we
3200 # ->_resolve_join as otherwise they get lost - captainL
3201 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3203 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
3205 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3208 my @force_subq_attrs = qw/offset rows group_by having/;
3211 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3213 $self->_has_resolved_attr (@force_subq_attrs)
3215 # Nuke the prefetch (if any) before the new $rs attrs
3216 # are resolved (prefetch is useless - we are wrapping
3217 # a subquery anyway).
3218 my $rs_copy = $self->search;
3219 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3220 $rs_copy->{attrs}{join},
3221 delete $rs_copy->{attrs}{prefetch},
3226 -alias => $attrs->{alias},
3227 $attrs->{alias} => $rs_copy->as_query,
3229 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3230 $seen->{-relation_chain_depth} = 0;
3232 elsif ($attrs->{from}) { #shallow copy suffices
3233 $from = [ @{$attrs->{from}} ];
3238 -alias => $attrs->{alias},
3239 $attrs->{alias} => $source->from,
3243 my $jpath = ($seen->{-relation_chain_depth})
3244 ? $from->[-1][0]{-join_path}
3247 my @requested_joins = $source->_resolve_join(
3254 push @$from, @requested_joins;
3256 $seen->{-relation_chain_depth}++;
3258 # if $self already had a join/prefetch specified on it, the requested
3259 # $rel might very well be already included. What we do in this case
3260 # is effectively a no-op (except that we bump up the chain_depth on
3261 # the join in question so we could tell it *is* the search_related)
3264 # we consider the last one thus reverse
3265 for my $j (reverse @requested_joins) {
3266 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3267 if ($rel eq $last_j) {
3268 $j->[0]{-relation_chain_depth}++;
3274 unless ($already_joined) {
3275 push @$from, $source->_resolve_join(
3283 $seen->{-relation_chain_depth}++;
3285 return {%$attrs, from => $from, seen_join => $seen};
3288 sub _resolved_attrs {
3290 return $self->{_attrs} if $self->{_attrs};
3292 my $attrs = { %{ $self->{attrs} || {} } };
3293 my $source = $self->result_source;
3294 my $alias = $attrs->{alias};
3296 # default selection list
3297 $attrs->{columns} = [ $source->columns ]
3298 unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3300 # merge selectors together
3301 for (qw/columns select as/) {
3302 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3303 if $attrs->{$_} or $attrs->{"+$_"};
3306 # disassemble columns
3308 if (my $cols = delete $attrs->{columns}) {
3309 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3310 if (ref $c eq 'HASH') {
3311 for my $as (sort keys %$c) {
3312 push @sel, $c->{$as};
3323 # when trying to weed off duplicates later do not go past this point -
3324 # everything added from here on is unbalanced "anyone's guess" stuff
3325 my $dedup_stop_idx = $#as;
3327 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3329 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3330 if $attrs->{select};
3332 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3334 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_";
3337 # disqualify all $alias.col as-bits (collapser mandated)
3339 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_;
3342 # de-duplicate the result (remove *identical* select/as pairs)
3343 # and also die on duplicate {as} pointing to different {select}s
3344 # not using a c-style for as the condition is prone to shrinkage
3347 while ($i <= $dedup_stop_idx) {
3348 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3353 elsif ($seen->{$as[$i]}++) {
3354 $self->throw_exception(
3355 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3363 $attrs->{select} = \@sel;
3364 $attrs->{as} = \@as;
3366 $attrs->{from} ||= [{
3368 -alias => $self->{attrs}{alias},
3369 $self->{attrs}{alias} => $source->from,
3372 if ( $attrs->{join} || $attrs->{prefetch} ) {
3374 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3375 if ref $attrs->{from} ne 'ARRAY';
3377 my $join = (delete $attrs->{join}) || {};
3379 if ( defined $attrs->{prefetch} ) {
3380 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3383 $attrs->{from} = # have to copy here to avoid corrupting the original
3385 @{ $attrs->{from} },
3386 $source->_resolve_join(
3389 { %{ $attrs->{seen_join} || {} } },
3390 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3391 ? $attrs->{from}[-1][0]{-join_path}
3398 if ( defined $attrs->{order_by} ) {
3399 $attrs->{order_by} = (
3400 ref( $attrs->{order_by} ) eq 'ARRAY'
3401 ? [ @{ $attrs->{order_by} } ]
3402 : [ $attrs->{order_by} || () ]
3406 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3407 $attrs->{group_by} = [ $attrs->{group_by} ];
3410 # generate the distinct induced group_by early, as prefetch will be carried via a
3411 # subquery (since a group_by is present)
3412 if (delete $attrs->{distinct}) {
3413 if ($attrs->{group_by}) {
3414 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3417 # distinct affects only the main selection part, not what prefetch may
3419 $attrs->{group_by} = $source->storage->_group_over_selection (
3427 $attrs->{collapse} ||= {};
3428 if ($attrs->{prefetch}) {
3430 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3431 if $attrs->{_dark_selector};
3433 my $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} );
3435 my $prefetch_ordering = [];
3437 # this is a separate structure (we don't look in {from} directly)
3438 # as the resolver needs to shift things off the lists to work
3439 # properly (identical-prefetches on different branches)
3441 if (ref $attrs->{from} eq 'ARRAY') {
3443 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3445 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3446 next unless $j->[0]{-alias};
3447 next unless $j->[0]{-join_path};
3448 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3450 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3453 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3454 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3459 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
3461 # we need to somehow mark which columns came from prefetch
3463 my $sel_end = $#{$attrs->{select}};
3464 $attrs->{_prefetch_selector_range} = [ $sel_end + 1, $sel_end + @prefetch ];
3467 push @{ $attrs->{select} }, (map { $_->[0] } @prefetch);
3468 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3470 push( @{$attrs->{order_by}}, @$prefetch_ordering );
3471 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
3474 # if both page and offset are specified, produce a combined offset
3475 # even though it doesn't make much sense, this is what pre 081xx has
3477 if (my $page = delete $attrs->{page}) {
3479 ($attrs->{rows} * ($page - 1))
3481 ($attrs->{offset} || 0)
3485 return $self->{_attrs} = $attrs;
3489 my ($self, $attr) = @_;
3491 if (ref $attr eq 'HASH') {
3492 return $self->_rollout_hash($attr);
3493 } elsif (ref $attr eq 'ARRAY') {
3494 return $self->_rollout_array($attr);
3500 sub _rollout_array {
3501 my ($self, $attr) = @_;
3504 foreach my $element (@{$attr}) {
3505 if (ref $element eq 'HASH') {
3506 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3507 } elsif (ref $element eq 'ARRAY') {
3508 # XXX - should probably recurse here
3509 push( @rolled_array, @{$self->_rollout_array($element)} );
3511 push( @rolled_array, $element );
3514 return \@rolled_array;
3518 my ($self, $attr) = @_;
3521 foreach my $key (keys %{$attr}) {
3522 push( @rolled_array, { $key => $attr->{$key} } );
3524 return \@rolled_array;
3527 sub _calculate_score {
3528 my ($self, $a, $b) = @_;
3530 if (defined $a xor defined $b) {
3533 elsif (not defined $a) {
3537 if (ref $b eq 'HASH') {
3538 my ($b_key) = keys %{$b};
3539 if (ref $a eq 'HASH') {
3540 my ($a_key) = keys %{$a};
3541 if ($a_key eq $b_key) {
3542 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3547 return ($a eq $b_key) ? 1 : 0;
3550 if (ref $a eq 'HASH') {
3551 my ($a_key) = keys %{$a};
3552 return ($b eq $a_key) ? 1 : 0;
3554 return ($b eq $a) ? 1 : 0;
3559 sub _merge_joinpref_attr {
3560 my ($self, $orig, $import) = @_;
3562 return $import unless defined($orig);
3563 return $orig unless defined($import);
3565 $orig = $self->_rollout_attr($orig);
3566 $import = $self->_rollout_attr($import);
3569 foreach my $import_element ( @{$import} ) {
3570 # find best candidate from $orig to merge $b_element into
3571 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3572 foreach my $orig_element ( @{$orig} ) {
3573 my $score = $self->_calculate_score( $orig_element, $import_element );
3574 if ($score > $best_candidate->{score}) {
3575 $best_candidate->{position} = $position;
3576 $best_candidate->{score} = $score;
3580 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3581 $import_key = '' if not defined $import_key;
3583 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3584 push( @{$orig}, $import_element );
3586 my $orig_best = $orig->[$best_candidate->{position}];
3587 # merge orig_best and b_element together and replace original with merged
3588 if (ref $orig_best ne 'HASH') {
3589 $orig->[$best_candidate->{position}] = $import_element;
3590 } elsif (ref $import_element eq 'HASH') {
3591 my ($key) = keys %{$orig_best};
3592 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3595 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3606 require Hash::Merge;
3607 my $hm = Hash::Merge->new;
3609 $hm->specify_behavior({
3612 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3614 if ($defl xor $defr) {
3615 return [ $defl ? $_[0] : $_[1] ];
3620 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3624 return [$_[0], $_[1]];
3628 return $_[1] if !defined $_[0];
3629 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3630 return [$_[0], @{$_[1]}]
3633 return [] if !defined $_[0] and !keys %{$_[1]};
3634 return [ $_[1] ] if !defined $_[0];
3635 return [ $_[0] ] if !keys %{$_[1]};
3636 return [$_[0], $_[1]]
3641 return $_[0] if !defined $_[1];
3642 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3643 return [@{$_[0]}, $_[1]]
3646 my @ret = @{$_[0]} or return $_[1];
3647 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3648 my %idx = map { $_ => 1 } @ret;
3649 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3653 return [ $_[1] ] if ! @{$_[0]};
3654 return $_[0] if !keys %{$_[1]};
3655 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3656 return [ @{$_[0]}, $_[1] ];
3661 return [] if !keys %{$_[0]} and !defined $_[1];
3662 return [ $_[0] ] if !defined $_[1];
3663 return [ $_[1] ] if !keys %{$_[0]};
3664 return [$_[0], $_[1]]
3667 return [] if !keys %{$_[0]} and !@{$_[1]};
3668 return [ $_[0] ] if !@{$_[1]};
3669 return $_[1] if !keys %{$_[0]};
3670 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3671 return [ $_[0], @{$_[1]} ];
3674 return [] if !keys %{$_[0]} and !keys %{$_[1]};
3675 return [ $_[0] ] if !keys %{$_[1]};
3676 return [ $_[1] ] if !keys %{$_[0]};
3677 return [ $_[0] ] if $_[0] eq $_[1];
3678 return [ $_[0], $_[1] ];
3681 } => 'DBIC_RS_ATTR_MERGER');
3685 return $hm->merge ($_[1], $_[2]);
3689 sub STORABLE_freeze {
3690 my ($self, $cloning) = @_;
3691 my $to_serialize = { %$self };
3693 # A cursor in progress can't be serialized (and would make little sense anyway)
3694 delete $to_serialize->{cursor};
3696 # nor is it sensical to store a not-yet-fired-count pager
3697 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3698 delete $to_serialize->{pager};
3701 Storable::nfreeze($to_serialize);
3704 # need this hook for symmetry
3706 my ($self, $cloning, $serialized) = @_;
3708 %$self = %{ Storable::thaw($serialized) };
3714 =head2 throw_exception
3716 See L<DBIx::Class::Schema/throw_exception> for details.
3720 sub throw_exception {
3723 if (ref $self and my $rsrc = $self->result_source) {
3724 $rsrc->throw_exception(@_)
3727 DBIx::Class::Exception->throw(@_);
3731 # XXX: FIXME: Attributes docs need clearing up
3735 Attributes are used to refine a ResultSet in various ways when
3736 searching for data. They can be passed to any method which takes an
3737 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3740 Default attributes can be set on the result class using
3741 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
3742 the CAVEATS on that feature before using it!)
3744 These are in no particular order:
3750 =item Value: ( $order_by | \@order_by | \%order_by )
3754 Which column(s) to order the results by.
3756 [The full list of suitable values is documented in
3757 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3760 If a single column name, or an arrayref of names is supplied, the
3761 argument is passed through directly to SQL. The hashref syntax allows
3762 for connection-agnostic specification of ordering direction:
3764 For descending order:
3766 order_by => { -desc => [qw/col1 col2 col3/] }
3768 For explicit ascending order:
3770 order_by => { -asc => 'col' }
3772 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3773 supported, although you are strongly encouraged to use the hashref
3774 syntax as outlined above.
3780 =item Value: \@columns
3784 Shortcut to request a particular set of columns to be retrieved. Each
3785 column spec may be a string (a table column name), or a hash (in which
3786 case the key is the C<as> value, and the value is used as the C<select>
3787 expression). Adds C<me.> onto the start of any column without a C<.> in
3788 it and sets C<select> from that, then auto-populates C<as> from
3789 C<select> as normal. (You may also use the C<cols> attribute, as in
3790 earlier versions of DBIC.)
3792 Essentially C<columns> does the same as L</select> and L</as>.
3794 columns => [ 'foo', { bar => 'baz' } ]
3798 select => [qw/foo baz/],
3805 =item Value: \@columns
3809 Indicates additional columns to be selected from storage. Works the same
3810 as L</columns> but adds columns to the selection. (You may also use the
3811 C<include_columns> attribute, as in earlier versions of DBIC). For
3814 $schema->resultset('CD')->search(undef, {
3815 '+columns' => ['artist.name'],
3819 would return all CDs and include a 'name' column to the information
3820 passed to object inflation. Note that the 'artist' is the name of the
3821 column (or relationship) accessor, and 'name' is the name of the column
3822 accessor in the related table.
3824 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
3825 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
3826 unary plus operator before it.
3828 =head2 include_columns
3832 =item Value: \@columns
3836 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3842 =item Value: \@select_columns
3846 Indicates which columns should be selected from the storage. You can use
3847 column names, or in the case of RDBMS back ends, function or stored procedure
3850 $rs = $schema->resultset('Employee')->search(undef, {
3853 { count => 'employeeid' },
3854 { max => { length => 'name' }, -as => 'longest_name' }
3859 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3861 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3862 use L</select>, to instruct DBIx::Class how to store the result of the column.
3863 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3864 identifier aliasing. You can however alias a function, so you can use it in
3865 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3866 attribute> supplied as shown in the example above.
3868 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
3869 Not doing so causes Perl to incorrectly interpret them as a bareword with a
3870 unary plus operator before it.
3876 Indicates additional columns to be selected from storage. Works the same as
3877 L</select> but adds columns to the default selection, instead of specifying
3886 Indicates additional column names for those added via L</+select>. See L</as>.
3894 =item Value: \@inflation_names
3898 Indicates column names for object inflation. That is L</as> indicates the
3899 slot name in which the column value will be stored within the
3900 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3901 identifier by the C<get_column> method (or via the object accessor B<if one
3902 with the same name already exists>) as shown below. The L</as> attribute has
3903 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3905 $rs = $schema->resultset('Employee')->search(undef, {
3908 { count => 'employeeid' },
3909 { max => { length => 'name' }, -as => 'longest_name' }
3918 If the object against which the search is performed already has an accessor
3919 matching a column name specified in C<as>, the value can be retrieved using
3920 the accessor as normal:
3922 my $name = $employee->name();
3924 If on the other hand an accessor does not exist in the object, you need to
3925 use C<get_column> instead:
3927 my $employee_count = $employee->get_column('employee_count');
3929 You can create your own accessors if required - see
3930 L<DBIx::Class::Manual::Cookbook> for details.
3936 =item Value: ($rel_name | \@rel_names | \%rel_names)
3940 Contains a list of relationships that should be joined for this query. For
3943 # Get CDs by Nine Inch Nails
3944 my $rs = $schema->resultset('CD')->search(
3945 { 'artist.name' => 'Nine Inch Nails' },
3946 { join => 'artist' }
3949 Can also contain a hash reference to refer to the other relation's relations.
3952 package MyApp::Schema::Track;
3953 use base qw/DBIx::Class/;
3954 __PACKAGE__->table('track');
3955 __PACKAGE__->add_columns(qw/trackid cd position title/);
3956 __PACKAGE__->set_primary_key('trackid');
3957 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3960 # In your application
3961 my $rs = $schema->resultset('Artist')->search(
3962 { 'track.title' => 'Teardrop' },
3964 join => { cd => 'track' },
3965 order_by => 'artist.name',
3969 You need to use the relationship (not the table) name in conditions,
3970 because they are aliased as such. The current table is aliased as "me", so
3971 you need to use me.column_name in order to avoid ambiguity. For example:
3973 # Get CDs from 1984 with a 'Foo' track
3974 my $rs = $schema->resultset('CD')->search(
3977 'tracks.name' => 'Foo'
3979 { join => 'tracks' }
3982 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3983 similarly for a third time). For e.g.
3985 my $rs = $schema->resultset('Artist')->search({
3986 'cds.title' => 'Down to Earth',
3987 'cds_2.title' => 'Popular',
3989 join => [ qw/cds cds/ ],
3992 will return a set of all artists that have both a cd with title 'Down
3993 to Earth' and a cd with title 'Popular'.
3995 If you want to fetch related objects from other tables as well, see C<prefetch>
3998 NOTE: An internal join-chain pruner will discard certain joins while
3999 constructing the actual SQL query, as long as the joins in question do not
4000 affect the retrieved result. This for example includes 1:1 left joins
4001 that are not part of the restriction specification (WHERE/HAVING) nor are
4002 a part of the query selection.
4004 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4010 =item Value: ($rel_name | \@rel_names | \%rel_names)
4014 Contains one or more relationships that should be fetched along with
4015 the main query (when they are accessed afterwards the data will
4016 already be available, without extra queries to the database). This is
4017 useful for when you know you will need the related objects, because it
4018 saves at least one query:
4020 my $rs = $schema->resultset('Tag')->search(
4029 The initial search results in SQL like the following:
4031 SELECT tag.*, cd.*, artist.* FROM tag
4032 JOIN cd ON tag.cd = cd.cdid
4033 JOIN artist ON cd.artist = artist.artistid
4035 L<DBIx::Class> has no need to go back to the database when we access the
4036 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4039 Simple prefetches will be joined automatically, so there is no need
4040 for a C<join> attribute in the above search.
4042 L</prefetch> can be used with the any of the relationship types and
4043 multiple prefetches can be specified together. Below is a more complex
4044 example that prefetches a CD's artist, its liner notes (if present),
4045 the cover image, the tracks on that cd, and the guests on those
4049 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4050 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4051 My::Schema::CD->has_one( cover_image => 'My::Schema::Artwork' );
4052 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4054 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4056 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4059 my $rs = $schema->resultset('CD')->search(
4063 { artist => 'record_label'}, # belongs_to => belongs_to
4064 'liner_note', # might_have
4065 'cover_image', # has_one
4066 { tracks => 'guests' }, # has_many => has_many
4071 This will produce SQL like the following:
4073 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4077 ON artist.artistid = me.artistid
4078 JOIN record_label record_label
4079 ON record_label.labelid = artist.labelid
4080 LEFT JOIN track tracks
4081 ON tracks.cdid = me.cdid
4082 LEFT JOIN guest guests
4083 ON guests.trackid = track.trackid
4084 LEFT JOIN liner_notes liner_note
4085 ON liner_note.cdid = me.cdid
4086 JOIN cd_artwork cover_image
4087 ON cover_image.cdid = me.cdid
4090 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4091 C<tracks>, and C<guests> of the CD will all be available through the
4092 relationship accessors without the need for additional queries to the
4095 However, there is one caveat to be observed: it can be dangerous to
4096 prefetch more than one L<has_many|DBIx::Class::Relationship/has_many>
4097 relationship on a given level. e.g.:
4099 my $rs = $schema->resultset('CD')->search(
4103 'tracks', # has_many
4104 { cd_to_producer => 'producer' }, # has_many => belongs_to (i.e. m2m)
4109 The collapser currently can't identify duplicate tuples for multiple
4110 L<has_many|DBIx::Class::Relationship/has_many> relationships and as a
4111 result the second L<has_many|DBIx::Class::Relationship/has_many>
4112 relation could contain redundant objects.
4114 =head3 Using L</prefetch> with L</join>
4116 L</prefetch> implies a L</join> with the equivalent argument, and is
4117 properly merged with any existing L</join> specification. So the
4120 my $rs = $schema->resultset('CD')->search(
4121 {'record_label.name' => 'Music Product Ltd.'},
4123 join => {artist => 'record_label'},
4124 prefetch => 'artist',
4128 ... will work, searching on the record label's name, but only
4129 prefetching the C<artist>.
4131 =head3 Using L</prefetch> with L</select> / L</+select> / L</as> / L</+as>
4133 L</prefetch> implies a L</+select>/L</+as> with the fields of the
4134 prefetched relations. So given:
4136 my $rs = $schema->resultset('CD')->search(
4139 select => ['cd.title'],
4141 prefetch => 'artist',
4145 The L</select> becomes: C<'cd.title', 'artist.*'> and the L</as>
4146 becomes: C<'cd_title', 'artist.*'>.
4150 Prefetch does a lot of deep magic. As such, it may not behave exactly
4151 as you might expect.
4157 Prefetch uses the L</cache> to populate the prefetched relationships. This
4158 may or may not be what you want.
4162 If you specify a condition on a prefetched relationship, ONLY those
4163 rows that match the prefetched condition will be fetched into that relationship.
4164 This means that adding prefetch to a search() B<may alter> what is returned by
4165 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4167 my $artist_rs = $schema->resultset('Artist')->search({
4173 my $count = $artist_rs->first->cds->count;
4175 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4177 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4179 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4181 that cmp_ok() may or may not pass depending on the datasets involved. This
4182 behavior may or may not survive the 0.09 transition.
4190 =item Value: $source_alias
4194 Sets the source alias for the query. Normally, this defaults to C<me>, but
4195 nested search queries (sub-SELECTs) might need specific aliases set to
4196 reference inner queries. For example:
4199 ->related_resultset('CDs')
4200 ->related_resultset('Tracks')
4202 'track.id' => { -ident => 'none_search.id' },
4206 my $ids = $self->search({
4209 alias => 'none_search',
4210 group_by => 'none_search.id',
4211 })->get_column('id')->as_query;
4213 $self->search({ id => { -in => $ids } })
4215 This attribute is directly tied to L</current_source_alias>.
4225 Makes the resultset paged and specifies the page to retrieve. Effectively
4226 identical to creating a non-pages resultset and then calling ->page($page)
4229 If L</rows> attribute is not specified it defaults to 10 rows per page.
4231 When you have a paged resultset, L</count> will only return the number
4232 of rows in the page. To get the total, use the L</pager> and call
4233 C<total_entries> on it.
4243 Specifies the maximum number of rows for direct retrieval or the number of
4244 rows per page if the page attribute or method is used.
4250 =item Value: $offset
4254 Specifies the (zero-based) row number for the first row to be returned, or the
4255 of the first row of the first page if paging is used.
4257 =head2 software_limit
4261 =item Value: (0 | 1)
4265 When combined with L</rows> and/or L</offset> the generated SQL will not
4266 include any limit dialect stanzas. Instead the entire result will be selected
4267 as if no limits were specified, and DBIC will perform the limit locally, by
4268 artificially advancing and finishing the resulting L</cursor>.
4270 This is the recommended way of performing resultset limiting when no sane RDBMS
4271 implementation is available (e.g.
4272 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4273 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4279 =item Value: \@columns
4283 A arrayref of columns to group by. Can include columns of joined tables.
4285 group_by => [qw/ column1 column2 ... /]
4291 =item Value: $condition
4295 HAVING is a select statement attribute that is applied between GROUP BY and
4296 ORDER BY. It is applied to the after the grouping calculations have been
4299 having => { 'count_employee' => { '>=', 100 } }
4301 or with an in-place function in which case literal SQL is required:
4303 having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4309 =item Value: (0 | 1)
4313 Set to 1 to group by all columns. If the resultset already has a group_by
4314 attribute, this setting is ignored and an appropriate warning is issued.
4320 Adds to the WHERE clause.
4322 # only return rows WHERE deleted IS NULL for all searches
4323 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4325 Can be overridden by passing C<< { where => undef } >> as an attribute
4328 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4334 Set to 1 to cache search results. This prevents extra SQL queries if you
4335 revisit rows in your ResultSet:
4337 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4339 while( my $artist = $resultset->next ) {
4343 $rs->first; # without cache, this would issue a query
4345 By default, searches are not cached.
4347 For more examples of using these attributes, see
4348 L<DBIx::Class::Manual::Cookbook>.
4354 =item Value: ( 'update' | 'shared' | \$scalar )
4358 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4359 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4362 =head1 DBIC BIND VALUES
4364 Because DBIC may need more information to bind values than just the column name
4365 and value itself, it uses a special format for both passing and receiving bind
4366 values. Each bind value should be composed of an arrayref of
4367 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4373 If present (in any form), this is what is being passed directly to bind_param.
4374 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4375 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4377 If this is specified, all other bind options described below are ignored.
4381 If present, this is used to infer the actual bind attribute by passing to
4382 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4383 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4385 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4386 currently drivers are expected to "Do the Right Thing" when given a common
4387 datatype name. (Not ideal, but that's what we got at this point.)
4391 Currently used to correctly allocate buffers for bind_param_inout().
4392 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4393 or to a sensible value based on the "data_type".
4397 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4398 explicitly specified they are never overriden). Also used by some weird DBDs,
4399 where the column name should be available at bind_param time (e.g. Oracle).
4403 For backwards compatibility and convenience, the following shortcuts are
4406 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4407 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4408 [ undef, $val ] === [ {}, $val ]
4410 =head1 AUTHOR AND CONTRIBUTORS
4412 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
4416 You may distribute this code under the same terms as Perl itself.