1 package DBIx::Class::ResultSet;
5 use base qw/DBIx::Class/;
7 use DBIx::Class::ResultSetColumn;
8 use Scalar::Util qw/blessed weaken/;
10 use Data::Compare (); # no imports!!! guard against insane architecture
12 # not importing first() as it will clash with our own method
16 # De-duplication in _merge_attr() is disabled, but left in for reference
17 # (the merger is used for other things that ought not to be de-duped)
18 *__HM_DEDUP = sub () { 0 };
28 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class result_source/);
32 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
36 my $users_rs = $schema->resultset('User');
37 while( $user = $users_rs->next) {
38 print $user->username;
41 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
42 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
46 A ResultSet is an object which stores a set of conditions representing
47 a query. It is the backbone of DBIx::Class (i.e. the really
48 important/useful bit).
50 No SQL is executed on the database when a ResultSet is created, it
51 just stores all the conditions needed to create the query.
53 A basic ResultSet representing the data of an entire table is returned
54 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
55 L<Source|DBIx::Class::Manual::Glossary/Source> name.
57 my $users_rs = $schema->resultset('User');
59 A new ResultSet is returned from calling L</search> on an existing
60 ResultSet. The new one will contain all the conditions of the
61 original, plus any new conditions added in the C<search> call.
63 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
64 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
67 The query that the ResultSet represents is B<only> executed against
68 the database when these methods are called:
69 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
71 If a resultset is used in a numeric context it returns the L</count>.
72 However, if it is used in a boolean context it is B<always> true. So if
73 you want to check if a resultset has any results, you must use C<if $rs
76 =head1 CUSTOM ResultSet CLASSES THAT USE Moose
78 If you want to make your custom ResultSet classes with L<Moose>, use a template
81 package MyApp::Schema::ResultSet::User;
84 use namespace::autoclean;
86 extends 'DBIx::Class::ResultSet';
88 sub BUILDARGS { $_[2] }
92 __PACKAGE__->meta->make_immutable;
96 The L<MooseX::NonMoose> is necessary so that the L<Moose> constructor does not
97 clash with the regular ResultSet constructor. Alternatively, you can use:
99 __PACKAGE__->meta->make_immutable(inline_constructor => 0);
101 The L<BUILDARGS|Moose::Manual::Construction/BUILDARGS> is necessary because the
102 signature of the ResultSet C<new> is C<< ->new($source, \%args) >>.
106 =head2 Chaining resultsets
108 Let's say you've got a query that needs to be run to return some data
109 to the user. But, you have an authorization system in place that
110 prevents certain users from seeing certain information. So, you want
111 to construct the basic query in one method, but add constraints to it in
116 my $request = $self->get_request; # Get a request object somehow.
117 my $schema = $self->result_source->schema;
119 my $cd_rs = $schema->resultset('CD')->search({
120 title => $request->param('title'),
121 year => $request->param('year'),
124 $cd_rs = $self->apply_security_policy( $cd_rs );
126 return $cd_rs->all();
129 sub apply_security_policy {
138 =head3 Resolving conditions and attributes
140 When a resultset is chained from another resultset, conditions and
141 attributes with the same keys need resolving.
143 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
144 into the existing ones from the original resultset.
146 The L</where> and L</having> attributes, and any search conditions, are
147 merged with an SQL C<AND> to the existing condition from the original
150 All other attributes are overridden by any new ones supplied in the
153 =head2 Multiple queries
155 Since a resultset just defines a query, you can do all sorts of
156 things with it with the same object.
158 # Don't hit the DB yet.
159 my $cd_rs = $schema->resultset('CD')->search({
160 title => 'something',
164 # Each of these hits the DB individually.
165 my $count = $cd_rs->count;
166 my $most_recent = $cd_rs->get_column('date_released')->max();
167 my @records = $cd_rs->all;
169 And it's not just limited to SELECT statements.
175 $cd_rs->create({ artist => 'Fred' });
177 Which is the same as:
179 $schema->resultset('CD')->create({
180 title => 'something',
185 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
193 =item Arguments: L<$source|DBIx::Class::ResultSource>, L<\%attrs?|/ATTRIBUTES>
195 =item Return Value: L<$resultset|/search>
199 The resultset constructor. Takes a source object (usually a
200 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
201 L</ATTRIBUTES> below). Does not perform any queries -- these are
202 executed as needed by the other methods.
204 Generally you never construct a resultset manually. Instead you get one
206 C<< $schema->L<resultset|DBIx::Class::Schema/resultset>('$source_name') >>
207 or C<< $another_resultset->L<search|/search>(...) >> (the later called in
210 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
216 If called on an object, proxies to L</new_result> instead, so
218 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
220 will return a CD object, not a ResultSet, and is equivalent to:
222 my $cd = $schema->resultset('CD')->new_result({ title => 'Spoon' });
224 Please also keep in mind that many internals call L</new_result> directly,
225 so overloading this method with the idea of intercepting new result object
226 creation B<will not work>. See also warning pertaining to L</create>.
234 return $class->new_result(@_) if ref $class;
236 my ($source, $attrs) = @_;
237 $source = $source->resolve
238 if $source->isa('DBIx::Class::ResultSourceHandle');
239 $attrs = { %{$attrs||{}} };
241 if ($attrs->{page}) {
242 $attrs->{rows} ||= 10;
245 $attrs->{alias} ||= 'me';
248 result_source => $source,
249 cond => $attrs->{where},
254 # if there is a dark selector, this means we are already in a
255 # chain and the cleanup/sanification was taken care of by
257 $self->_normalize_selection($attrs)
258 unless $attrs->{_dark_selector};
261 $attrs->{result_class} || $source->result_class
271 =item Arguments: L<$cond|DBIx::Class::SQLMaker> | undef, L<\%attrs?|/ATTRIBUTES>
273 =item Return Value: $resultset (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
277 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
278 my $new_rs = $cd_rs->search({ year => 2005 });
280 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
281 # year = 2005 OR year = 2004
283 In list context, C<< ->all() >> is called implicitly on the resultset, thus
284 returning a list of L<result|DBIx::Class::Manual::ResultClass> objects instead.
285 To avoid that, use L</search_rs>.
287 If you need to pass in additional attributes but no additional condition,
288 call it as C<search(undef, \%attrs)>.
290 # "SELECT name, artistid FROM $artist_table"
291 my @all_artists = $schema->resultset('Artist')->search(undef, {
292 columns => [qw/name artistid/],
295 For a list of attributes that can be passed to C<search>, see
296 L</ATTRIBUTES>. For more examples of using this function, see
297 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
298 documentation for the first argument, see L<SQL::Abstract>
299 and its extension L<DBIx::Class::SQLMaker>.
301 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
305 Note that L</search> does not process/deflate any of the values passed in the
306 L<SQL::Abstract>-compatible search condition structure. This is unlike other
307 condition-bound methods L</new_result>, L</create> and L</find>. The user must ensure
308 manually that any value passed to this method will stringify to something the
309 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
310 objects, for more info see:
311 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
317 my $rs = $self->search_rs( @_ );
322 elsif (defined wantarray) {
326 # we can be called by a relationship helper, which in
327 # turn may be called in void context due to some braindead
328 # overload or whatever else the user decided to be clever
329 # at this particular day. Thus limit the exception to
330 # external code calls only
331 $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
332 if (caller)[0] !~ /^\QDBIx::Class::/;
342 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
344 =item Return Value: L<$resultset|/search>
348 This method does the same exact thing as search() except it will
349 always return a resultset, even in list context.
356 my $rsrc = $self->result_source;
357 my ($call_cond, $call_attrs);
359 # Special-case handling for (undef, undef) or (undef)
360 # Note that (foo => undef) is valid deprecated syntax
361 @_ = () if not scalar grep { defined $_ } @_;
367 # fish out attrs in the ($condref, $attr) case
368 elsif (@_ == 2 and ( ! defined $_[0] or (ref $_[0]) ne '') ) {
369 ($call_cond, $call_attrs) = @_;
372 $self->throw_exception('Odd number of arguments to search')
376 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
377 unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
379 for my $i (0 .. $#_) {
381 $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
382 if (! defined $_[$i] or ref $_[$i] ne '');
388 # see if we can keep the cache (no $rs changes)
390 my %safe = (alias => 1, cache => 1);
391 if ( ! List::Util::first { !$safe{$_} } keys %$call_attrs and (
394 ref $_[0] eq 'HASH' && ! keys %{$_[0]}
396 ref $_[0] eq 'ARRAY' && ! @{$_[0]}
398 $cache = $self->get_cache;
401 my $old_attrs = { %{$self->{attrs}} };
402 my $old_having = delete $old_attrs->{having};
403 my $old_where = delete $old_attrs->{where};
405 my $new_attrs = { %$old_attrs };
407 # take care of call attrs (only if anything is changing)
408 if ($call_attrs and keys %$call_attrs) {
410 # copy for _normalize_selection
411 $call_attrs = { %$call_attrs };
413 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
415 # reset the current selector list if new selectors are supplied
416 if (List::Util::first { exists $call_attrs->{$_} } qw/columns cols select as/) {
417 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')};
420 # Normalize the new selector list (operates on the passed-in attr structure)
421 # Need to do it on every chain instead of only once on _resolved_attrs, in
422 # order to allow detection of empty vs partial 'as'
423 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
424 if $old_attrs->{_dark_selector};
425 $self->_normalize_selection ($call_attrs);
427 # start with blind overwriting merge, exclude selector attrs
428 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
429 delete @{$new_attrs}{@selector_attrs};
431 for (@selector_attrs) {
432 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
433 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
436 # older deprecated name, use only if {columns} is not there
437 if (my $c = delete $new_attrs->{cols}) {
438 if ($new_attrs->{columns}) {
439 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
442 $new_attrs->{columns} = $c;
447 # join/prefetch use their own crazy merging heuristics
448 foreach my $key (qw/join prefetch/) {
449 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
450 if exists $call_attrs->{$key};
453 # stack binds together
454 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
458 for ($old_where, $call_cond) {
460 $new_attrs->{where} = $self->_stack_cond (
461 $_, $new_attrs->{where}
466 if (defined $old_having) {
467 $new_attrs->{having} = $self->_stack_cond (
468 $old_having, $new_attrs->{having}
472 my $rs = (ref $self)->new($rsrc, $new_attrs);
474 $rs->set_cache($cache) if ($cache);
480 sub _normalize_selection {
481 my ($self, $attrs) = @_;
484 $attrs->{'+columns'} = $self->_merge_attr($attrs->{'+columns'}, delete $attrs->{include_columns})
485 if exists $attrs->{include_columns};
487 # columns are always placed first, however
489 # Keep the X vs +X separation until _resolved_attrs time - this allows to
490 # delay the decision on whether to use a default select list ($rsrc->columns)
491 # allowing stuff like the remove_columns helper to work
493 # select/as +select/+as pairs need special handling - the amount of select/as
494 # elements in each pair does *not* have to be equal (think multicolumn
495 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
496 # supplied at all) - try to infer the alias, either from the -as parameter
497 # of the selector spec, or use the parameter whole if it looks like a column
498 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
499 # is ok as well), but make sure no more additions to the 'as' chain take place
500 for my $pref ('', '+') {
502 my ($sel, $as) = map {
503 my $key = "${pref}${_}";
505 my $val = [ ref $attrs->{$key} eq 'ARRAY'
507 : $attrs->{$key} || ()
509 delete $attrs->{$key};
513 if (! @$as and ! @$sel ) {
516 elsif (@$as and ! @$sel) {
517 $self->throw_exception(
518 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
522 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
523 # if any @$as has been supplied we assume the user knows what (s)he is doing
524 # and blindly keep stacking up pieces
525 unless ($attrs->{_dark_selector}) {
528 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
529 push @$as, $_->{-as};
531 # assume any plain no-space, no-parenthesis string to be a column spec
532 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
533 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
536 # if all else fails - raise a flag that no more aliasing will be allowed
538 $attrs->{_dark_selector} = {
540 string => ($dark_sel_dumper ||= do {
541 require Data::Dumper::Concise;
542 Data::Dumper::Concise::DumperObject()->Indent(0);
543 })->Values([$_])->Dump
551 elsif (@$as < @$sel) {
552 $self->throw_exception(
553 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
556 elsif ($pref and $attrs->{_dark_selector}) {
557 $self->throw_exception(
558 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
564 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
565 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
570 my ($self, $left, $right) = @_;
572 # collapse single element top-level conditions
573 # (single pass only, unlikely to need recursion)
574 for ($left, $right) {
575 if (ref $_ eq 'ARRAY') {
583 elsif (ref $_ eq 'HASH') {
584 my ($first, $more) = keys %$_;
587 if (! defined $first) {
591 elsif (! defined $more) {
592 if ($first eq '-and' and ref $_->{'-and'} eq 'HASH') {
595 elsif ($first eq '-or' and ref $_->{'-or'} eq 'ARRAY') {
602 # merge hashes with weeding out of duplicates (simple cases only)
603 if (ref $left eq 'HASH' and ref $right eq 'HASH') {
605 # shallow copy to destroy
606 $right = { %$right };
607 for (grep { exists $right->{$_} } keys %$left) {
608 # the use of eq_deeply here is justified - the rhs of an
609 # expression can contain a lot of twisted weird stuff
610 delete $right->{$_} if Data::Compare::Compare( $left->{$_}, $right->{$_} );
613 $right = undef unless keys %$right;
617 if (defined $left xor defined $right) {
618 return defined $left ? $left : $right;
620 elsif (! defined $left) {
624 return { -and => [ $left, $right ] };
628 =head2 search_literal
630 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
631 should only be used in that context. C<search_literal> is a convenience
632 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
633 want to ensure columns are bound correctly, use L</search>.
635 See L<DBIx::Class::Manual::Cookbook/Searching> and
636 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
637 require C<search_literal>.
641 =item Arguments: $sql_fragment, @standalone_bind_values
643 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
647 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
648 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
650 Pass a literal chunk of SQL to be added to the conditional part of the
653 Example of how to use C<search> instead of C<search_literal>
655 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
656 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
661 my ($self, $sql, @bind) = @_;
663 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
666 return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
673 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
675 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
679 Finds and returns a single row based on supplied criteria. Takes either a
680 hashref with the same format as L</create> (including inference of foreign
681 keys from related objects), or a list of primary key values in the same
682 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
683 declaration on the L</result_source>.
685 In either case an attempt is made to combine conditions already existing on
686 the resultset with the condition passed to this method.
688 To aid with preparing the correct query for the storage you may supply the
689 C<key> attribute, which is the name of a
690 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
691 unique constraint corresponding to the
692 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
693 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
694 to construct a query that satisfies the named unique constraint fully (
695 non-NULL values for each column member of the constraint) an exception is
698 If no C<key> is specified, the search is carried over all unique constraints
699 which are fully defined by the available condition.
701 If no such constraint is found, C<find> currently defaults to a simple
702 C<< search->(\%column_values) >> which may or may not do what you expect.
703 Note that this fallback behavior may be deprecated in further versions. If
704 you need to search with arbitrary conditions - use L</search>. If the query
705 resulting from this fallback produces more than one row, a warning to the
706 effect is issued, though only the first row is constructed and returned as
709 In addition to C<key>, L</find> recognizes and applies standard
710 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
712 Note that if you have extra concerns about the correctness of the resulting
713 query you need to specify the C<key> attribute and supply the entire condition
714 as an argument to find (since it is not always possible to perform the
715 combination of the resultset condition with the supplied one, especially if
716 the resultset condition contains literal sql).
718 For example, to find a row by its primary key:
720 my $cd = $schema->resultset('CD')->find(5);
722 You can also find a row by a specific unique constraint:
724 my $cd = $schema->resultset('CD')->find(
726 artist => 'Massive Attack',
727 title => 'Mezzanine',
729 { key => 'cd_artist_title' }
732 See also L</find_or_create> and L</update_or_create>.
738 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
740 my $rsrc = $self->result_source;
743 if (exists $attrs->{key}) {
744 $constraint_name = defined $attrs->{key}
746 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
750 # Parse out the condition from input
753 if (ref $_[0] eq 'HASH') {
754 $call_cond = { %{$_[0]} };
757 # if only values are supplied we need to default to 'primary'
758 $constraint_name = 'primary' unless defined $constraint_name;
760 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
762 $self->throw_exception(
763 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
766 $self->throw_exception (
767 'find() expects either a column/value hashref, or a list of values '
768 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
769 ) unless @c_cols == @_;
772 @{$call_cond}{@c_cols} = @_;
776 for my $key (keys %$call_cond) {
778 my $keyref = ref($call_cond->{$key})
780 my $relinfo = $rsrc->relationship_info($key)
782 my $val = delete $call_cond->{$key};
784 next if $keyref eq 'ARRAY'; # has_many for multi_create
786 my $rel_q = $rsrc->_resolve_condition(
787 $relinfo->{cond}, $val, $key, $key
789 die "Can't handle complex relationship conditions in find" if ref($rel_q) ne 'HASH';
790 @related{keys %$rel_q} = values %$rel_q;
794 # relationship conditions take precedence (?)
795 @{$call_cond}{keys %related} = values %related;
797 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
799 if (defined $constraint_name) {
800 $final_cond = $self->_qualify_cond_columns (
802 $self->_build_unique_cond (
810 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
811 # This means that we got here after a merger of relationship conditions
812 # in ::Relationship::Base::search_related (the row method), and furthermore
813 # the relationship is of the 'single' type. This means that the condition
814 # provided by the relationship (already attached to $self) is sufficient,
815 # as there can be only one row in the database that would satisfy the
819 # no key was specified - fall down to heuristics mode:
820 # run through all unique queries registered on the resultset, and
821 # 'OR' all qualifying queries together
822 my (@unique_queries, %seen_column_combinations);
823 for my $c_name ($rsrc->unique_constraint_names) {
824 next if $seen_column_combinations{
825 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
828 push @unique_queries, try {
829 $self->_build_unique_cond ($c_name, $call_cond, 'croak_on_nulls')
833 $final_cond = @unique_queries
834 ? [ map { $self->_qualify_cond_columns($_, $alias) } @unique_queries ]
835 : $self->_non_unique_find_fallback ($call_cond, $attrs)
839 # Run the query, passing the result_class since it should propagate for find
840 my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
841 if (keys %{$rs->_resolved_attrs->{collapse}}) {
843 carp "Query returned more than one row" if $rs->next;
851 # This is a stop-gap method as agreed during the discussion on find() cleanup:
852 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
854 # It is invoked when find() is called in legacy-mode with insufficiently-unique
855 # condition. It is provided for overrides until a saner way forward is devised
857 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
858 # the road. Please adjust your tests accordingly to catch this situation early
859 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
861 # The method will not be removed without an adequately complete replacement
862 # for strict-mode enforcement
863 sub _non_unique_find_fallback {
864 my ($self, $cond, $attrs) = @_;
866 return $self->_qualify_cond_columns(
868 exists $attrs->{alias}
870 : $self->{attrs}{alias}
875 sub _qualify_cond_columns {
876 my ($self, $cond, $alias) = @_;
878 my %aliased = %$cond;
879 for (keys %aliased) {
880 $aliased{"$alias.$_"} = delete $aliased{$_}
887 sub _build_unique_cond {
888 my ($self, $constraint_name, $extra_cond, $croak_on_null) = @_;
890 my @c_cols = $self->result_source->unique_constraint_columns($constraint_name);
892 # combination may fail if $self->{cond} is non-trivial
893 my ($final_cond) = try {
894 $self->_merge_with_rscond ($extra_cond)
899 # trim out everything not in $columns
900 $final_cond = { map {
901 exists $final_cond->{$_}
902 ? ( $_ => $final_cond->{$_} )
906 if (my @missing = grep
907 { ! ($croak_on_null ? defined $final_cond->{$_} : exists $final_cond->{$_}) }
910 $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', no values for column(s): %s",
912 join (', ', map { "'$_'" } @missing),
919 !$ENV{DBIC_NULLABLE_KEY_NOWARN}
921 my @undefs = sort grep { ! defined $final_cond->{$_} } (keys %$final_cond)
923 carp_unique ( sprintf (
924 "NULL/undef values supplied for requested unique constraint '%s' (NULL "
925 . 'values in column(s): %s). This is almost certainly not what you wanted, '
926 . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
928 join (', ', map { "'$_'" } @undefs),
935 =head2 search_related
939 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
941 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
945 $new_rs = $cd_rs->search_related('artist', {
949 Searches the specified relationship, optionally specifying a condition and
950 attributes for matching records. See L</ATTRIBUTES> for more information.
952 In list context, C<< ->all() >> is called implicitly on the resultset, thus
953 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
955 See also L</search_related_rs>.
960 return shift->related_resultset(shift)->search(@_);
963 =head2 search_related_rs
965 This method works exactly the same as search_related, except that
966 it guarantees a resultset, even in list context.
970 sub search_related_rs {
971 return shift->related_resultset(shift)->search_rs(@_);
978 =item Arguments: none
980 =item Return Value: L<$cursor|DBIx::Class::Cursor>
984 Returns a storage-driven cursor to the given resultset. See
985 L<DBIx::Class::Cursor> for more information.
992 return $self->{cursor} ||= do {
993 my $attrs = { %{$self->_resolved_attrs } };
994 $self->result_source->storage->select(
995 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
1004 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1006 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1010 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1012 Inflates the first result without creating a cursor if the resultset has
1013 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1016 While this method can take an optional search condition (just like L</search>)
1017 being a fast-code-path it does not recognize search attributes. If you need to
1018 add extra joins or similar, call L</search> and then chain-call L</single> on the
1019 L<DBIx::Class::ResultSet> returned.
1025 As of 0.08100, this method enforces the assumption that the preceding
1026 query returns only one row. If more than one row is returned, you will receive
1029 Query returned more than one row
1031 In this case, you should be using L</next> or L</find> instead, or if you really
1032 know what you are doing, use the L</rows> attribute to explicitly limit the size
1035 This method will also throw an exception if it is called on a resultset prefetching
1036 has_many, as such a prefetch implies fetching multiple rows from the database in
1037 order to assemble the resulting object.
1044 my ($self, $where) = @_;
1046 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1049 my $attrs = { %{$self->_resolved_attrs} };
1051 if (keys %{$attrs->{collapse}}) {
1052 $self->throw_exception(
1053 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
1058 if (defined $attrs->{where}) {
1061 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1062 $where, delete $attrs->{where} ]
1065 $attrs->{where} = $where;
1069 my @data = $self->result_source->storage->select_single(
1070 $attrs->{from}, $attrs->{select},
1071 $attrs->{where}, $attrs
1074 return (@data ? ($self->_construct_object(@data))[0] : undef);
1080 # Recursively collapse the query, accumulating values for each column.
1082 sub _collapse_query {
1083 my ($self, $query, $collapsed) = @_;
1087 if (ref $query eq 'ARRAY') {
1088 foreach my $subquery (@$query) {
1089 next unless ref $subquery; # -or
1090 $collapsed = $self->_collapse_query($subquery, $collapsed);
1093 elsif (ref $query eq 'HASH') {
1094 if (keys %$query and (keys %$query)[0] eq '-and') {
1095 foreach my $subquery (@{$query->{-and}}) {
1096 $collapsed = $self->_collapse_query($subquery, $collapsed);
1100 foreach my $col (keys %$query) {
1101 my $value = $query->{$col};
1102 $collapsed->{$col}{$value}++;
1114 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1116 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1120 my $max_length = $rs->get_column('length')->max;
1122 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1127 my ($self, $column) = @_;
1128 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1136 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1138 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1142 # WHERE title LIKE '%blue%'
1143 $cd_rs = $rs->search_like({ title => '%blue%'});
1145 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1146 that this is simply a convenience method retained for ex Class::DBI users.
1147 You most likely want to use L</search> with specific operators.
1149 For more information, see L<DBIx::Class::Manual::Cookbook>.
1151 This method is deprecated and will be removed in 0.09. Use L</search()>
1152 instead. An example conversion is:
1154 ->search_like({ foo => 'bar' });
1158 ->search({ foo => { like => 'bar' } });
1165 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1166 .' Instead use ->search({ x => { -like => "y%" } })'
1167 .' (note the outer pair of {}s - they are important!)'
1169 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1170 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1171 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1172 return $class->search($query, { %$attrs });
1179 =item Arguments: $first, $last
1181 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1185 Returns a resultset or object list representing a subset of elements from the
1186 resultset slice is called on. Indexes are from 0, i.e., to get the first
1187 three records, call:
1189 my ($one, $two, $three) = $rs->slice(0, 2);
1194 my ($self, $min, $max) = @_;
1195 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1196 $attrs->{offset} = $self->{attrs}{offset} || 0;
1197 $attrs->{offset} += $min;
1198 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1199 return $self->search(undef, $attrs);
1200 #my $slice = (ref $self)->new($self->result_source, $attrs);
1201 #return (wantarray ? $slice->all : $slice);
1208 =item Arguments: none
1210 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1214 Returns the next element in the resultset (C<undef> is there is none).
1216 Can be used to efficiently iterate over records in the resultset:
1218 my $rs = $schema->resultset('CD')->search;
1219 while (my $cd = $rs->next) {
1223 Note that you need to store the resultset object, and call C<next> on it.
1224 Calling C<< resultset('Table')->next >> repeatedly will always return the
1225 first record from the resultset.
1231 if (my $cache = $self->get_cache) {
1232 $self->{all_cache_position} ||= 0;
1233 return $cache->[$self->{all_cache_position}++];
1235 if ($self->{attrs}{cache}) {
1236 delete $self->{pager};
1237 $self->{all_cache_position} = 1;
1238 return ($self->all)[0];
1240 if ($self->{stashed_objects}) {
1241 my $obj = shift(@{$self->{stashed_objects}});
1242 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
1246 exists $self->{stashed_row}
1247 ? @{delete $self->{stashed_row}}
1248 : $self->cursor->next
1250 return undef unless (@row);
1251 my ($row, @more) = $self->_construct_object(@row);
1252 $self->{stashed_objects} = \@more if @more;
1256 sub _construct_object {
1257 my ($self, @row) = @_;
1259 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
1261 my @new = $self->result_class->inflate_result($self->result_source, @$info);
1262 @new = $self->{_attrs}{record_filter}->(@new)
1263 if exists $self->{_attrs}{record_filter};
1267 sub _collapse_result {
1268 my ($self, $as_proto, $row) = @_;
1272 # 'foo' => [ undef, 'foo' ]
1273 # 'foo.bar' => [ 'foo', 'bar' ]
1274 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
1276 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
1278 my %collapse = %{$self->{_attrs}{collapse}||{}};
1282 # if we're doing collapsing (has_many prefetch) we need to grab records
1283 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1284 # we know we don't have to bother.
1286 # the reason for not using the collapse stuff directly is because if you
1287 # had for e.g. two artists in a row with no cds, the collapse info for
1288 # both would be NULL (undef) so you'd lose the second artist
1290 # store just the index so we can check the array positions from the row
1291 # without having to contruct the full hash
1293 if (keys %collapse) {
1294 my %pri = map { ($_ => 1) } $self->result_source->_pri_cols;
1295 foreach my $i (0 .. $#construct_as) {
1296 next if defined($construct_as[$i][0]); # only self table
1297 if (delete $pri{$construct_as[$i][1]}) {
1298 push(@pri_index, $i);
1300 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1304 # no need to do an if, it'll be empty if @pri_index is empty anyway
1306 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1310 do { # no need to check anything at the front, we always want the first row
1314 foreach my $this_as (@construct_as) {
1315 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1318 push(@const_rows, \%const);
1320 } until ( # no pri_index => no collapse => drop straight out
1323 do { # get another row, stash it, drop out if different PK
1325 @copy = $self->cursor->next;
1326 $self->{stashed_row} = \@copy;
1328 # last thing in do block, counts as true if anything doesn't match
1330 # check xor defined first for NULL vs. NOT NULL then if one is
1331 # defined the other must be so check string equality
1334 (defined $pri_vals{$_} ^ defined $copy[$_])
1335 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1340 my $alias = $self->{attrs}{alias};
1347 foreach my $const (@const_rows) {
1348 scalar @const_keys or do {
1349 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1351 foreach my $key (@const_keys) {
1354 my @parts = split(/\./, $key);
1356 my $data = $const->{$key};
1357 foreach my $p (@parts) {
1358 $target = $target->[1]->{$p} ||= [];
1360 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1361 # collapsing at this point and on final part
1362 my $pos = $collapse_pos{$cur};
1363 CK: foreach my $ck (@ckey) {
1364 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1365 $collapse_pos{$cur} = $data;
1366 delete @collapse_pos{ # clear all positioning for sub-entries
1367 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1374 if (exists $collapse{$cur}) {
1375 $target = $target->[-1];
1378 $target->[0] = $data;
1380 $info->[0] = $const->{$key};
1388 =head2 result_source
1392 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1394 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1398 An accessor for the primary ResultSource object from which this ResultSet
1405 =item Arguments: $result_class?
1407 =item Return Value: $result_class
1411 An accessor for the class to use when creating result objects. Defaults to
1412 C<< result_source->result_class >> - which in most cases is the name of the
1413 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1415 Note that changing the result_class will also remove any components
1416 that were originally loaded in the source class via
1417 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1418 in the original source class will not run.
1423 my ($self, $result_class) = @_;
1424 if ($result_class) {
1425 unless (ref $result_class) { # don't fire this for an object
1426 $self->ensure_class_loaded($result_class);
1428 $self->_result_class($result_class);
1429 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1430 # permit the user to set result class on one result set only; it only
1431 # chains if provided to search()
1432 #$self->{attrs}{result_class} = $result_class if ref $self;
1434 $self->_result_class;
1441 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1443 =item Return Value: $count
1447 Performs an SQL C<COUNT> with the same query as the resultset was built
1448 with to find the number of elements. Passing arguments is equivalent to
1449 C<< $rs->search ($cond, \%attrs)->count >>
1455 return $self->search(@_)->count if @_ and defined $_[0];
1456 return scalar @{ $self->get_cache } if $self->get_cache;
1458 my $attrs = { %{ $self->_resolved_attrs } };
1460 # this is a little optimization - it is faster to do the limit
1461 # adjustments in software, instead of a subquery
1462 my $rows = delete $attrs->{rows};
1463 my $offset = delete $attrs->{offset};
1466 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1467 $crs = $self->_count_subq_rs ($attrs);
1470 $crs = $self->_count_rs ($attrs);
1472 my $count = $crs->next;
1474 $count -= $offset if $offset;
1475 $count = $rows if $rows and $rows < $count;
1476 $count = 0 if ($count < 0);
1485 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1487 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1491 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1492 This can be very handy for subqueries:
1494 ->search( { amount => $some_rs->count_rs->as_query } )
1496 As with regular resultsets the SQL query will be executed only after
1497 the resultset is accessed via L</next> or L</all>. That would return
1498 the same single value obtainable via L</count>.
1504 return $self->search(@_)->count_rs if @_;
1506 # this may look like a lack of abstraction (count() does about the same)
1507 # but in fact an _rs *must* use a subquery for the limits, as the
1508 # software based limiting can not be ported if this $rs is to be used
1509 # in a subquery itself (i.e. ->as_query)
1510 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1511 return $self->_count_subq_rs;
1514 return $self->_count_rs;
1519 # returns a ResultSetColumn object tied to the count query
1522 my ($self, $attrs) = @_;
1524 my $rsrc = $self->result_source;
1525 $attrs ||= $self->_resolved_attrs;
1527 my $tmp_attrs = { %$attrs };
1528 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1529 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1531 # overwrite the selector (supplied by the storage)
1532 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $attrs);
1533 $tmp_attrs->{as} = 'count';
1534 delete @{$tmp_attrs}{qw/columns/};
1536 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1542 # same as above but uses a subquery
1544 sub _count_subq_rs {
1545 my ($self, $attrs) = @_;
1547 my $rsrc = $self->result_source;
1548 $attrs ||= $self->_resolved_attrs;
1550 my $sub_attrs = { %$attrs };
1551 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1552 delete @{$sub_attrs}{qw/collapse columns as select _prefetch_selector_range order_by for/};
1554 # if we multi-prefetch we group_by something unique, as this is what we would
1555 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1556 if ( keys %{$attrs->{collapse}} ) {
1557 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1558 $rsrc->_identifying_column_set || $self->throw_exception(
1559 'Unable to construct a unique group_by criteria properly collapsing the '
1560 . 'has_many prefetch before count()'
1565 # Calculate subquery selector
1566 if (my $g = $sub_attrs->{group_by}) {
1568 my $sql_maker = $rsrc->storage->sql_maker;
1570 # necessary as the group_by may refer to aliased functions
1572 for my $sel (@{$attrs->{select}}) {
1573 $sel_index->{$sel->{-as}} = $sel
1574 if (ref $sel eq 'HASH' and $sel->{-as});
1577 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1578 # also look for named aggregates referred in the having clause
1579 # having often contains scalarrefs - thus parse it out entirely
1581 if ($attrs->{having}) {
1582 local $sql_maker->{having_bind};
1583 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1584 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1585 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1586 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1587 # if we don't unset it we screw up retarded but unfortunately working
1588 # 'MAX(foo.bar)' => { '>', 3 }
1589 $sql_maker->{name_sep} = '';
1592 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1594 my $sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1596 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1597 # and if all fails for an utterly naive quoted scalar-with-function
1599 $rquote $sep $lquote (.+?) $rquote
1601 [\s,] \w+ \. (\w+) [\s,]
1603 [\s,] $lquote (.+?) $rquote [\s,]
1605 push @parts, ($1 || $2 || $3); # one of them matched if we got here
1610 my $colpiece = $sel_index->{$_} || $_;
1612 # unqualify join-based group_by's. Arcane but possible query
1613 # also horrible horrible hack to alias a column (not a func.)
1614 # (probably need to introduce SQLA syntax)
1615 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1618 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1620 push @{$sub_attrs->{select}}, $colpiece;
1624 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1625 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1628 return $rsrc->resultset_class
1629 ->new ($rsrc, $sub_attrs)
1631 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1632 ->get_column ('count');
1639 =head2 count_literal
1641 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1642 should only be used in that context. See L</search_literal> for further info.
1646 =item Arguments: $sql_fragment, @standalone_bind_values
1648 =item Return Value: $count
1652 Counts the results in a literal query. Equivalent to calling L</search_literal>
1653 with the passed arguments, then L</count>.
1657 sub count_literal { shift->search_literal(@_)->count; }
1663 =item Arguments: none
1665 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1669 Returns all elements in the resultset.
1676 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1679 return @{ $self->get_cache } if $self->get_cache;
1683 if (keys %{$self->_resolved_attrs->{collapse}}) {
1684 # Using $self->cursor->all is really just an optimisation.
1685 # If we're collapsing has_many prefetches it probably makes
1686 # very little difference, and this is cleaner than hacking
1687 # _construct_object to survive the approach
1688 $self->cursor->reset;
1689 my @row = $self->cursor->next;
1691 push(@obj, $self->_construct_object(@row));
1692 @row = (exists $self->{stashed_row}
1693 ? @{delete $self->{stashed_row}}
1694 : $self->cursor->next);
1697 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1700 $self->set_cache(\@obj) if $self->{attrs}{cache};
1709 =item Arguments: none
1711 =item Return Value: $self
1715 Resets the resultset's cursor, so you can iterate through the elements again.
1716 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1723 $self->{all_cache_position} = 0;
1724 $self->cursor->reset;
1732 =item Arguments: none
1734 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1738 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1739 an object for the first result (or C<undef> if the resultset is empty).
1744 return $_[0]->reset->next;
1750 # Determines whether and what type of subquery is required for the $rs operation.
1751 # If grouping is necessary either supplies its own, or verifies the current one
1752 # After all is done delegates to the proper storage method.
1754 sub _rs_update_delete {
1755 my ($self, $op, $values) = @_;
1757 my $rsrc = $self->result_source;
1758 my $storage = $rsrc->schema->storage;
1760 my $attrs = { %{$self->_resolved_attrs} };
1762 my $join_classifications;
1763 my $existing_group_by = delete $attrs->{group_by};
1765 # do we need a subquery for any reason?
1767 defined $existing_group_by
1769 # if {from} is unparseable wrap a subq
1770 ref($attrs->{from}) ne 'ARRAY'
1772 # limits call for a subq
1773 $self->_has_resolved_attr(qw/rows offset/)
1776 # simplify the joinmap, so we can further decide if a subq is necessary
1777 if (!$needs_subq and @{$attrs->{from}} > 1) {
1778 $attrs->{from} = $storage->_prune_unused_joins ($attrs->{from}, $attrs->{select}, $self->{cond}, $attrs);
1780 # check if there are any joins left after the prune
1781 if ( @{$attrs->{from}} > 1 ) {
1782 $join_classifications = $storage->_resolve_aliastypes_from_select_args (
1783 [ @{$attrs->{from}}[1 .. $#{$attrs->{from}}] ],
1789 # any non-pruneable joins imply subq
1790 $needs_subq = scalar keys %{ $join_classifications->{restricting} || {} };
1794 # check if the head is composite (by now all joins are thrown out unless $needs_subq)
1796 (ref $attrs->{from}[0]) ne 'HASH'
1798 ref $attrs->{from}[0]{ $attrs->{from}[0]{-alias} }
1802 # do we need anything like a subquery?
1803 if (! $needs_subq) {
1804 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1805 # a condition containing 'me' or other table prefixes will not work
1806 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1808 my $sqla = $rsrc->storage->sql_maker;
1809 local $sqla->{_dequalify_idents} = 1;
1810 \[ $sqla->_recurse_where($self->{cond}) ];
1814 # we got this far - means it is time to wrap a subquery
1815 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1817 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1823 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1824 delete $attrs->{$_} for qw/collapse _collapse_order_by select _prefetch_selector_range as/;
1825 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1826 $attrs->{group_by} = \ ''; # FIXME - this is an evil hack, it causes the optimiser to kick in and throw away the LEFT joins
1827 my $subrs = (ref $self)->new($rsrc, $attrs);
1829 if (@$idcols == 1) {
1830 $cond = { $idcols->[0] => { -in => $subrs->as_query } };
1832 elsif ($storage->_use_multicolumn_in) {
1833 # no syntax for calling this properly yet
1834 # !!! EXPERIMENTAL API !!! WILL CHANGE !!!
1835 $cond = $storage->sql_maker->_where_op_multicolumn_in (
1836 $idcols, # how do I convey a list of idents...? can binds reside on lhs?
1841 # if all else fails - get all primary keys and operate over a ORed set
1842 # wrap in a transaction for consistency
1843 # this is where the group_by/multiplication starts to matter
1847 keys %{ $join_classifications->{multiplying} || {} }
1849 # make sure if there is a supplied group_by it matches the columns compiled above
1850 # perfectly. Anything else can not be sanely executed on most databases so croak
1851 # right then and there
1852 if ($existing_group_by) {
1853 my @current_group_by = map
1854 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1859 join ("\x00", sort @current_group_by)
1861 join ("\x00", sort @{$attrs->{columns}} )
1863 $self->throw_exception (
1864 "You have just attempted a $op operation on a resultset which does group_by"
1865 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1866 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1867 . ' kind of queries. Please retry the operation with a modified group_by or'
1868 . ' without using one at all.'
1873 $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
1876 $guard = $storage->txn_scope_guard;
1879 for my $row ($subrs->cursor->all) {
1881 { $idcols->[$_] => $row->[$_] }
1888 my $res = $storage->$op (
1890 $op eq 'update' ? $values : (),
1894 $guard->commit if $guard;
1903 =item Arguments: \%values
1905 =item Return Value: $underlying_storage_rv
1909 Sets the specified columns in the resultset to the supplied values in a
1910 single query. Note that this will not run any accessor/set_column/update
1911 triggers, nor will it update any result object instances derived from this
1912 resultset (this includes the contents of the L<resultset cache|/set_cache>
1913 if any). See L</update_all> if you need to execute any on-update
1914 triggers or cascades defined either by you or a
1915 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1917 The return value is a pass through of what the underlying
1918 storage backend returned, and may vary. See L<DBI/execute> for the most
1923 Note that L</update> does not process/deflate any of the values passed in.
1924 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
1925 ensure manually that any value passed to this method will stringify to
1926 something the RDBMS knows how to deal with. A notable example is the
1927 handling of L<DateTime> objects, for more info see:
1928 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
1933 my ($self, $values) = @_;
1934 $self->throw_exception('Values for update must be a hash')
1935 unless ref $values eq 'HASH';
1937 return $self->_rs_update_delete ('update', $values);
1944 =item Arguments: \%values
1946 =item Return Value: 1
1950 Fetches all objects and updates them one at a time via
1951 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
1952 triggers, while L</update> will not.
1957 my ($self, $values) = @_;
1958 $self->throw_exception('Values for update_all must be a hash')
1959 unless ref $values eq 'HASH';
1961 my $guard = $self->result_source->schema->txn_scope_guard;
1962 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
1971 =item Arguments: none
1973 =item Return Value: $underlying_storage_rv
1977 Deletes the rows matching this resultset in a single query. Note that this
1978 will not run any delete triggers, nor will it alter the
1979 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
1980 derived from this resultset (this includes the contents of the
1981 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
1982 execute any on-delete triggers or cascades defined either by you or a
1983 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1985 The return value is a pass through of what the underlying storage backend
1986 returned, and may vary. See L<DBI/execute> for the most common case.
1992 $self->throw_exception('delete does not accept any arguments')
1995 return $self->_rs_update_delete ('delete');
2002 =item Arguments: none
2004 =item Return Value: 1
2008 Fetches all objects and deletes them one at a time via
2009 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2010 triggers, while L</delete> will not.
2016 $self->throw_exception('delete_all does not accept any arguments')
2019 my $guard = $self->result_source->schema->txn_scope_guard;
2020 $_->delete for $self->all;
2029 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2031 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2035 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2042 The context of this method call has an important effect on what is
2043 submitted to storage. In void context data is fed directly to fastpath
2044 insertion routines provided by the underlying storage (most often
2045 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2046 L<insert|DBIx::Class::Row/insert> calls on the
2047 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2048 augmentation of these methods provided by components. For example if you
2049 are using something like L<DBIx::Class::UUIDColumns> to create primary
2050 keys for you, you will find that your PKs are empty. In this case you
2051 will have to explicitly force scalar or list context in order to create
2056 In non-void (scalar or list) context, this method is simply a wrapper
2057 for L</create>. Depending on list or scalar context either a list of
2058 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2059 containing these objects is returned.
2061 When supplying data in "arrayref of arrayrefs" invocation style, the
2062 first element should be a list of column names and each subsequent
2063 element should be a data value in the earlier specified column order.
2066 $Arstist_rs->populate([
2067 [ qw( artistid name ) ],
2068 [ 100, 'A Formally Unknown Singer' ],
2069 [ 101, 'A singer that jumped the shark two albums ago' ],
2070 [ 102, 'An actually cool singer' ],
2073 For the arrayref of hashrefs style each hashref should be a structure
2074 suitable for passing to L</create>. Multi-create is also permitted with
2077 $schema->resultset("Artist")->populate([
2078 { artistid => 4, name => 'Manufactured Crap', cds => [
2079 { title => 'My First CD', year => 2006 },
2080 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2083 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2084 { title => 'My parents sold me to a record company', year => 2005 },
2085 { title => 'Why Am I So Ugly?', year => 2006 },
2086 { title => 'I Got Surgery and am now Popular', year => 2007 }
2091 If you attempt a void-context multi-create as in the example above (each
2092 Artist also has the related list of CDs), and B<do not> supply the
2093 necessary autoinc foreign key information, this method will proxy to the
2094 less efficient L</create>, and then throw the Result objects away. In this
2095 case there are obviously no benefits to using this method over L</create>.
2102 # cruft placed in standalone method
2103 my $data = $self->_normalize_populate_args(@_);
2105 return unless @$data;
2107 if(defined wantarray) {
2108 my @created = map { $self->create($_) } @$data;
2109 return wantarray ? @created : \@created;
2112 my $first = $data->[0];
2114 # if a column is a registered relationship, and is a non-blessed hash/array, consider
2115 # it relationship data
2116 my (@rels, @columns);
2117 my $rsrc = $self->result_source;
2118 my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2119 for (keys %$first) {
2120 my $ref = ref $first->{$_};
2121 $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2127 my @pks = $rsrc->primary_columns;
2129 ## do the belongs_to relationships
2130 foreach my $index (0..$#$data) {
2132 # delegate to create() for any dataset without primary keys with specified relationships
2133 if (grep { !defined $data->[$index]->{$_} } @pks ) {
2135 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
2136 my @ret = $self->populate($data);
2142 foreach my $rel (@rels) {
2143 next unless ref $data->[$index]->{$rel} eq "HASH";
2144 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2145 my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2146 my $related = $result->result_source->_resolve_condition(
2147 $reverse_relinfo->{cond},
2153 delete $data->[$index]->{$rel};
2154 $data->[$index] = {%{$data->[$index]}, %$related};
2156 push @columns, keys %$related if $index == 0;
2160 ## inherit the data locked in the conditions of the resultset
2161 my ($rs_data) = $self->_merge_with_rscond({});
2162 delete @{$rs_data}{@columns};
2164 ## do bulk insert on current row
2165 $rsrc->storage->insert_bulk(
2167 [@columns, keys %$rs_data],
2168 [ map { [ @$_{@columns}, values %$rs_data ] } @$data ],
2171 ## do the has_many relationships
2172 foreach my $item (@$data) {
2176 foreach my $rel (@rels) {
2177 next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2179 $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2181 my $child = $main_row->$rel;
2183 my $related = $child->result_source->_resolve_condition(
2184 $rels->{$rel}{cond},
2190 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2191 my @populate = map { {%$_, %$related} } @rows_to_add;
2193 $child->populate( \@populate );
2200 # populate() argumnets went over several incarnations
2201 # What we ultimately support is AoH
2202 sub _normalize_populate_args {
2203 my ($self, $arg) = @_;
2205 if (ref $arg eq 'ARRAY') {
2209 elsif (ref $arg->[0] eq 'HASH') {
2212 elsif (ref $arg->[0] eq 'ARRAY') {
2214 my @colnames = @{$arg->[0]};
2215 foreach my $values (@{$arg}[1 .. $#$arg]) {
2216 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2222 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2229 =item Arguments: none
2231 =item Return Value: L<$pager|Data::Page>
2235 Returns a L<Data::Page> object for the current resultset. Only makes
2236 sense for queries with a C<page> attribute.
2238 To get the full count of entries for a paged resultset, call
2239 C<total_entries> on the L<Data::Page> object.
2246 return $self->{pager} if $self->{pager};
2248 my $attrs = $self->{attrs};
2249 if (!defined $attrs->{page}) {
2250 $self->throw_exception("Can't create pager for non-paged rs");
2252 elsif ($attrs->{page} <= 0) {
2253 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2255 $attrs->{rows} ||= 10;
2257 # throw away the paging flags and re-run the count (possibly
2258 # with a subselect) to get the real total count
2259 my $count_attrs = { %$attrs };
2260 delete $count_attrs->{$_} for qw/rows offset page pager/;
2262 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2264 require DBIx::Class::ResultSet::Pager;
2265 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2266 sub { $total_rs->count }, #lazy-get the total
2268 $self->{attrs}{page},
2276 =item Arguments: $page_number
2278 =item Return Value: L<$resultset|/search>
2282 Returns a resultset for the $page_number page of the resultset on which page
2283 is called, where each page contains a number of rows equal to the 'rows'
2284 attribute set on the resultset (10 by default).
2289 my ($self, $page) = @_;
2290 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2297 =item Arguments: \%col_data
2299 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2303 Creates a new result object in the resultset's result class and returns
2304 it. The row is not inserted into the database at this point, call
2305 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2306 will tell you whether the result object has been inserted or not.
2308 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2313 my ($self, $values) = @_;
2315 $self->throw_exception( "new_result takes only one argument - a hashref of values" )
2318 $self->throw_exception( "new_result expects a hashref" )
2319 unless (ref $values eq 'HASH');
2321 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2325 @$cols_from_relations
2326 ? (-cols_from_relations => $cols_from_relations)
2328 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2331 return $self->result_class->new(\%new);
2334 # _merge_with_rscond
2336 # Takes a simple hash of K/V data and returns its copy merged with the
2337 # condition already present on the resultset. Additionally returns an
2338 # arrayref of value/condition names, which were inferred from related
2339 # objects (this is needed for in-memory related objects)
2340 sub _merge_with_rscond {
2341 my ($self, $data) = @_;
2343 my (%new_data, @cols_from_relations);
2345 my $alias = $self->{attrs}{alias};
2347 if (! defined $self->{cond}) {
2348 # just massage $data below
2350 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
2351 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2352 @cols_from_relations = keys %new_data;
2354 elsif (ref $self->{cond} ne 'HASH') {
2355 $self->throw_exception(
2356 "Can't abstract implicit construct, resultset condition not a hash"
2360 # precendence must be given to passed values over values inherited from
2361 # the cond, so the order here is important.
2362 my $collapsed_cond = $self->_collapse_cond($self->{cond});
2363 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2365 while ( my($col, $value) = each %implied ) {
2366 my $vref = ref $value;
2372 (keys %$value)[0] eq '='
2374 $new_data{$col} = $value->{'='};
2376 elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2377 $new_data{$col} = $value;
2384 %{ $self->_remove_alias($data, $alias) },
2387 return (\%new_data, \@cols_from_relations);
2390 # _has_resolved_attr
2392 # determines if the resultset defines at least one
2393 # of the attributes supplied
2395 # used to determine if a subquery is neccessary
2397 # supports some virtual attributes:
2399 # This will scan for any joins being present on the resultset.
2400 # It is not a mere key-search but a deep inspection of {from}
2403 sub _has_resolved_attr {
2404 my ($self, @attr_names) = @_;
2406 my $attrs = $self->_resolved_attrs;
2410 for my $n (@attr_names) {
2411 if (grep { $n eq $_ } (qw/-join/) ) {
2412 $extra_checks{$n}++;
2416 my $attr = $attrs->{$n};
2418 next if not defined $attr;
2420 if (ref $attr eq 'HASH') {
2421 return 1 if keys %$attr;
2423 elsif (ref $attr eq 'ARRAY') {
2431 # a resolved join is expressed as a multi-level from
2433 $extra_checks{-join}
2435 ref $attrs->{from} eq 'ARRAY'
2437 @{$attrs->{from}} > 1
2445 # Recursively collapse the condition.
2447 sub _collapse_cond {
2448 my ($self, $cond, $collapsed) = @_;
2452 if (ref $cond eq 'ARRAY') {
2453 foreach my $subcond (@$cond) {
2454 next unless ref $subcond; # -or
2455 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2458 elsif (ref $cond eq 'HASH') {
2459 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2460 foreach my $subcond (@{$cond->{-and}}) {
2461 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2465 foreach my $col (keys %$cond) {
2466 my $value = $cond->{$col};
2467 $collapsed->{$col} = $value;
2477 # Remove the specified alias from the specified query hash. A copy is made so
2478 # the original query is not modified.
2481 my ($self, $query, $alias) = @_;
2483 my %orig = %{ $query || {} };
2486 foreach my $key (keys %orig) {
2488 $unaliased{$key} = $orig{$key};
2491 $unaliased{$1} = $orig{$key}
2492 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2502 =item Arguments: none
2504 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2508 Returns the SQL query and bind vars associated with the invocant.
2510 This is generally used as the RHS for a subquery.
2517 my $attrs = { %{ $self->_resolved_attrs } };
2522 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2523 # $sql also has no wrapping parenthesis in list ctx
2525 my $sqlbind = $self->result_source->storage
2526 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2535 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2537 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2541 my $artist = $schema->resultset('Artist')->find_or_new(
2542 { artist => 'fred' }, { key => 'artists' });
2544 $cd->cd_to_producer->find_or_new({ producer => $producer },
2545 { key => 'primary });
2547 Find an existing record from this resultset using L</find>. if none exists,
2548 instantiate a new result object and return it. The object will not be saved
2549 into your storage until you call L<DBIx::Class::Row/insert> on it.
2551 You most likely want this method when looking for existing rows using a unique
2552 constraint that is not the primary key, or looking for related rows.
2554 If you want objects to be saved immediately, use L</find_or_create> instead.
2556 B<Note>: Make sure to read the documentation of L</find> and understand the
2557 significance of the C<key> attribute, as its lack may skew your search, and
2558 subsequently result in spurious new objects.
2560 B<Note>: Take care when using C<find_or_new> with a table having
2561 columns with default values that you intend to be automatically
2562 supplied by the database (e.g. an auto_increment primary key column).
2563 In normal usage, the value of such columns should NOT be included at
2564 all in the call to C<find_or_new>, even when set to C<undef>.
2570 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2571 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2572 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2575 return $self->new_result($hash);
2582 =item Arguments: \%col_data
2584 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2588 Attempt to create a single new row or a row with multiple related rows
2589 in the table represented by the resultset (and related tables). This
2590 will not check for duplicate rows before inserting, use
2591 L</find_or_create> to do that.
2593 To create one row for this resultset, pass a hashref of key/value
2594 pairs representing the columns of the table and the values you wish to
2595 store. If the appropriate relationships are set up, foreign key fields
2596 can also be passed an object representing the foreign row, and the
2597 value will be set to its primary key.
2599 To create related objects, pass a hashref of related-object column values
2600 B<keyed on the relationship name>. If the relationship is of type C<multi>
2601 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2602 The process will correctly identify columns holding foreign keys, and will
2603 transparently populate them from the keys of the corresponding relation.
2604 This can be applied recursively, and will work correctly for a structure
2605 with an arbitrary depth and width, as long as the relationships actually
2606 exists and the correct column data has been supplied.
2608 Instead of hashrefs of plain related data (key/value pairs), you may
2609 also pass new or inserted objects. New objects (not inserted yet, see
2610 L</new_result>), will be inserted into their appropriate tables.
2612 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2614 Example of creating a new row.
2616 $person_rs->create({
2617 name=>"Some Person",
2618 email=>"somebody@someplace.com"
2621 Example of creating a new row and also creating rows in a related C<has_many>
2622 or C<has_one> resultset. Note Arrayref.
2625 { artistid => 4, name => 'Manufactured Crap', cds => [
2626 { title => 'My First CD', year => 2006 },
2627 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2632 Example of creating a new row and also creating a row in a related
2633 C<belongs_to> resultset. Note Hashref.
2636 title=>"Music for Silly Walks",
2639 name=>"Silly Musician",
2647 When subclassing ResultSet never attempt to override this method. Since
2648 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2649 lot of the internals simply never call it, so your override will be
2650 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2651 or L<DBIx::Class::Row/insert> depending on how early in the
2652 L</create> process you need to intervene. See also warning pertaining to
2660 my ($self, $attrs) = @_;
2661 $self->throw_exception( "create needs a hashref" )
2662 unless ref $attrs eq 'HASH';
2663 return $self->new_result($attrs)->insert;
2666 =head2 find_or_create
2670 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2672 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2676 $cd->cd_to_producer->find_or_create({ producer => $producer },
2677 { key => 'primary' });
2679 Tries to find a record based on its primary key or unique constraints; if none
2680 is found, creates one and returns that instead.
2682 my $cd = $schema->resultset('CD')->find_or_create({
2684 artist => 'Massive Attack',
2685 title => 'Mezzanine',
2689 Also takes an optional C<key> attribute, to search by a specific key or unique
2690 constraint. For example:
2692 my $cd = $schema->resultset('CD')->find_or_create(
2694 artist => 'Massive Attack',
2695 title => 'Mezzanine',
2697 { key => 'cd_artist_title' }
2700 B<Note>: Make sure to read the documentation of L</find> and understand the
2701 significance of the C<key> attribute, as its lack may skew your search, and
2702 subsequently result in spurious row creation.
2704 B<Note>: Because find_or_create() reads from the database and then
2705 possibly inserts based on the result, this method is subject to a race
2706 condition. Another process could create a record in the table after
2707 the find has completed and before the create has started. To avoid
2708 this problem, use find_or_create() inside a transaction.
2710 B<Note>: Take care when using C<find_or_create> with a table having
2711 columns with default values that you intend to be automatically
2712 supplied by the database (e.g. an auto_increment primary key column).
2713 In normal usage, the value of such columns should NOT be included at
2714 all in the call to C<find_or_create>, even when set to C<undef>.
2716 See also L</find> and L</update_or_create>. For information on how to declare
2717 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2719 If you need to know if an existing row was found or a new one created use
2720 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2721 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2724 my $cd = $schema->resultset('CD')->find_or_new({
2726 artist => 'Massive Attack',
2727 title => 'Mezzanine',
2731 if( !$cd->in_storage ) {
2738 sub find_or_create {
2740 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2741 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2742 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2745 return $self->create($hash);
2748 =head2 update_or_create
2752 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2754 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2758 $resultset->update_or_create({ col => $val, ... });
2760 Like L</find_or_create>, but if a row is found it is immediately updated via
2761 C<< $found_row->update (\%col_data) >>.
2764 Takes an optional C<key> attribute to search on a specific unique constraint.
2767 # In your application
2768 my $cd = $schema->resultset('CD')->update_or_create(
2770 artist => 'Massive Attack',
2771 title => 'Mezzanine',
2774 { key => 'cd_artist_title' }
2777 $cd->cd_to_producer->update_or_create({
2778 producer => $producer,
2784 B<Note>: Make sure to read the documentation of L</find> and understand the
2785 significance of the C<key> attribute, as its lack may skew your search, and
2786 subsequently result in spurious row creation.
2788 B<Note>: Take care when using C<update_or_create> with a table having
2789 columns with default values that you intend to be automatically
2790 supplied by the database (e.g. an auto_increment primary key column).
2791 In normal usage, the value of such columns should NOT be included at
2792 all in the call to C<update_or_create>, even when set to C<undef>.
2794 See also L</find> and L</find_or_create>. For information on how to declare
2795 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2797 If you need to know if an existing row was updated or a new one created use
2798 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2799 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2804 sub update_or_create {
2806 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2807 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2809 my $row = $self->find($cond, $attrs);
2811 $row->update($cond);
2815 return $self->create($cond);
2818 =head2 update_or_new
2822 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2824 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2828 $resultset->update_or_new({ col => $val, ... });
2830 Like L</find_or_new> but if a row is found it is immediately updated via
2831 C<< $found_row->update (\%col_data) >>.
2835 # In your application
2836 my $cd = $schema->resultset('CD')->update_or_new(
2838 artist => 'Massive Attack',
2839 title => 'Mezzanine',
2842 { key => 'cd_artist_title' }
2845 if ($cd->in_storage) {
2846 # the cd was updated
2849 # the cd is not yet in the database, let's insert it
2853 B<Note>: Make sure to read the documentation of L</find> and understand the
2854 significance of the C<key> attribute, as its lack may skew your search, and
2855 subsequently result in spurious new objects.
2857 B<Note>: Take care when using C<update_or_new> with a table having
2858 columns with default values that you intend to be automatically
2859 supplied by the database (e.g. an auto_increment primary key column).
2860 In normal usage, the value of such columns should NOT be included at
2861 all in the call to C<update_or_new>, even when set to C<undef>.
2863 See also L</find>, L</find_or_create> and L</find_or_new>.
2869 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2870 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2872 my $row = $self->find( $cond, $attrs );
2873 if ( defined $row ) {
2874 $row->update($cond);
2878 return $self->new_result($cond);
2885 =item Arguments: none
2887 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
2891 Gets the contents of the cache for the resultset, if the cache is set.
2893 The cache is populated either by using the L</prefetch> attribute to
2894 L</search> or by calling L</set_cache>.
2906 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2908 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2912 Sets the contents of the cache for the resultset. Expects an arrayref
2913 of objects of the same class as those produced by the resultset. Note that
2914 if the cache is set, the resultset will return the cached objects rather
2915 than re-querying the database even if the cache attr is not set.
2917 The contents of the cache can also be populated by using the
2918 L</prefetch> attribute to L</search>.
2923 my ( $self, $data ) = @_;
2924 $self->throw_exception("set_cache requires an arrayref")
2925 if defined($data) && (ref $data ne 'ARRAY');
2926 $self->{all_cache} = $data;
2933 =item Arguments: none
2935 =item Return Value: undef
2939 Clears the cache for the resultset.
2944 shift->set_cache(undef);
2951 =item Arguments: none
2953 =item Return Value: true, if the resultset has been paginated
2961 return !!$self->{attrs}{page};
2968 =item Arguments: none
2970 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2978 return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
2981 =head2 related_resultset
2985 =item Arguments: $rel_name
2987 =item Return Value: L<$resultset|/search>
2991 Returns a related resultset for the supplied relationship name.
2993 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
2997 sub related_resultset {
2998 my ($self, $rel) = @_;
3000 $self->{related_resultsets} ||= {};
3001 return $self->{related_resultsets}{$rel} ||= do {
3002 my $rsrc = $self->result_source;
3003 my $rel_info = $rsrc->relationship_info($rel);
3005 $self->throw_exception(
3006 "search_related: result source '" . $rsrc->source_name .
3007 "' has no such relationship $rel")
3010 my $attrs = $self->_chain_relationship($rel);
3012 my $join_count = $attrs->{seen_join}{$rel};
3014 my $alias = $self->result_source->storage
3015 ->relname_to_table_alias($rel, $join_count);
3017 # since this is search_related, and we already slid the select window inwards
3018 # (the select/as attrs were deleted in the beginning), we need to flip all
3019 # left joins to inner, so we get the expected results
3020 # read the comment on top of the actual function to see what this does
3021 $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3024 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3025 delete @{$attrs}{qw(result_class alias)};
3029 if (my $cache = $self->get_cache) {
3030 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
3031 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
3036 my $rel_source = $rsrc->related_source($rel);
3040 # The reason we do this now instead of passing the alias to the
3041 # search_rs below is that if you wrap/overload resultset on the
3042 # source you need to know what alias it's -going- to have for things
3043 # to work sanely (e.g. RestrictWithObject wants to be able to add
3044 # extra query restrictions, and these may need to be $alias.)
3046 my $rel_attrs = $rel_source->resultset_attributes;
3047 local $rel_attrs->{alias} = $alias;
3049 $rel_source->resultset
3053 where => $attrs->{where},
3056 $new->set_cache($new_cache) if $new_cache;
3061 =head2 current_source_alias
3065 =item Arguments: none
3067 =item Return Value: $source_alias
3071 Returns the current table alias for the result source this resultset is built
3072 on, that will be used in the SQL query. Usually it is C<me>.
3074 Currently the source alias that refers to the result set returned by a
3075 L</search>/L</find> family method depends on how you got to the resultset: it's
3076 C<me> by default, but eg. L</search_related> aliases it to the related result
3077 source name (and keeps C<me> referring to the original result set). The long
3078 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3079 (and make this method unnecessary).
3081 Thus it's currently necessary to use this method in predefined queries (see
3082 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3083 source alias of the current result set:
3085 # in a result set class
3087 my ($self, $user) = @_;
3089 my $me = $self->current_source_alias;
3091 return $self->search({
3092 "$me.modified" => $user->id,
3098 sub current_source_alias {
3099 return (shift->{attrs} || {})->{alias} || 'me';
3102 =head2 as_subselect_rs
3106 =item Arguments: none
3108 =item Return Value: L<$resultset|/search>
3112 Act as a barrier to SQL symbols. The resultset provided will be made into a
3113 "virtual view" by including it as a subquery within the from clause. From this
3114 point on, any joined tables are inaccessible to ->search on the resultset (as if
3115 it were simply where-filtered without joins). For example:
3117 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3119 # 'x' now pollutes the query namespace
3121 # So the following works as expected
3122 my $ok_rs = $rs->search({'x.other' => 1});
3124 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3125 # def) we look for one row with contradictory terms and join in another table
3126 # (aliased 'x_2') which we never use
3127 my $broken_rs = $rs->search({'x.name' => 'def'});
3129 my $rs2 = $rs->as_subselect_rs;
3131 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3132 my $not_joined_rs = $rs2->search({'x.other' => 1});
3134 # works as expected: finds a 'table' row related to two x rows (abc and def)
3135 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3137 Another example of when one might use this would be to select a subset of
3138 columns in a group by clause:
3140 my $rs = $schema->resultset('Bar')->search(undef, {
3141 group_by => [qw{ id foo_id baz_id }],
3142 })->as_subselect_rs->search(undef, {
3143 columns => [qw{ id foo_id }]
3146 In the above example normally columns would have to be equal to the group by,
3147 but because we isolated the group by into a subselect the above works.
3151 sub as_subselect_rs {
3154 my $attrs = $self->_resolved_attrs;
3156 my $fresh_rs = (ref $self)->new (
3157 $self->result_source
3160 # these pieces will be locked in the subquery
3161 delete $fresh_rs->{cond};
3162 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3164 return $fresh_rs->search( {}, {
3166 $attrs->{alias} => $self->as_query,
3167 -alias => $attrs->{alias},
3168 -rsrc => $self->result_source,
3170 alias => $attrs->{alias},
3174 # This code is called by search_related, and makes sure there
3175 # is clear separation between the joins before, during, and
3176 # after the relationship. This information is needed later
3177 # in order to properly resolve prefetch aliases (any alias
3178 # with a relation_chain_depth less than the depth of the
3179 # current prefetch is not considered)
3181 # The increments happen twice per join. An even number means a
3182 # relationship specified via a search_related, whereas an odd
3183 # number indicates a join/prefetch added via attributes
3185 # Also this code will wrap the current resultset (the one we
3186 # chain to) in a subselect IFF it contains limiting attributes
3187 sub _chain_relationship {
3188 my ($self, $rel) = @_;
3189 my $source = $self->result_source;
3190 my $attrs = { %{$self->{attrs}||{}} };
3192 # we need to take the prefetch the attrs into account before we
3193 # ->_resolve_join as otherwise they get lost - captainL
3194 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3196 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
3198 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3201 my @force_subq_attrs = qw/offset rows group_by having/;
3204 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3206 $self->_has_resolved_attr (@force_subq_attrs)
3208 # Nuke the prefetch (if any) before the new $rs attrs
3209 # are resolved (prefetch is useless - we are wrapping
3210 # a subquery anyway).
3211 my $rs_copy = $self->search;
3212 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3213 $rs_copy->{attrs}{join},
3214 delete $rs_copy->{attrs}{prefetch},
3219 -alias => $attrs->{alias},
3220 $attrs->{alias} => $rs_copy->as_query,
3222 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3223 $seen->{-relation_chain_depth} = 0;
3225 elsif ($attrs->{from}) { #shallow copy suffices
3226 $from = [ @{$attrs->{from}} ];
3231 -alias => $attrs->{alias},
3232 $attrs->{alias} => $source->from,
3236 my $jpath = ($seen->{-relation_chain_depth})
3237 ? $from->[-1][0]{-join_path}
3240 my @requested_joins = $source->_resolve_join(
3247 push @$from, @requested_joins;
3249 $seen->{-relation_chain_depth}++;
3251 # if $self already had a join/prefetch specified on it, the requested
3252 # $rel might very well be already included. What we do in this case
3253 # is effectively a no-op (except that we bump up the chain_depth on
3254 # the join in question so we could tell it *is* the search_related)
3257 # we consider the last one thus reverse
3258 for my $j (reverse @requested_joins) {
3259 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3260 if ($rel eq $last_j) {
3261 $j->[0]{-relation_chain_depth}++;
3267 unless ($already_joined) {
3268 push @$from, $source->_resolve_join(
3276 $seen->{-relation_chain_depth}++;
3278 return {%$attrs, from => $from, seen_join => $seen};
3281 sub _resolved_attrs {
3283 return $self->{_attrs} if $self->{_attrs};
3285 my $attrs = { %{ $self->{attrs} || {} } };
3286 my $source = $self->result_source;
3287 my $alias = $attrs->{alias};
3289 # default selection list
3290 $attrs->{columns} = [ $source->columns ]
3291 unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3293 # merge selectors together
3294 for (qw/columns select as/) {
3295 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3296 if $attrs->{$_} or $attrs->{"+$_"};
3299 # disassemble columns
3301 if (my $cols = delete $attrs->{columns}) {
3302 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3303 if (ref $c eq 'HASH') {
3304 for my $as (sort keys %$c) {
3305 push @sel, $c->{$as};
3316 # when trying to weed off duplicates later do not go past this point -
3317 # everything added from here on is unbalanced "anyone's guess" stuff
3318 my $dedup_stop_idx = $#as;
3320 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3322 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3323 if $attrs->{select};
3325 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3327 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_";
3330 # disqualify all $alias.col as-bits (collapser mandated)
3332 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_;
3335 # de-duplicate the result (remove *identical* select/as pairs)
3336 # and also die on duplicate {as} pointing to different {select}s
3337 # not using a c-style for as the condition is prone to shrinkage
3340 while ($i <= $dedup_stop_idx) {
3341 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3346 elsif ($seen->{$as[$i]}++) {
3347 $self->throw_exception(
3348 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3356 $attrs->{select} = \@sel;
3357 $attrs->{as} = \@as;
3359 $attrs->{from} ||= [{
3361 -alias => $self->{attrs}{alias},
3362 $self->{attrs}{alias} => $source->from,
3365 if ( $attrs->{join} || $attrs->{prefetch} ) {
3367 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3368 if ref $attrs->{from} ne 'ARRAY';
3370 my $join = (delete $attrs->{join}) || {};
3372 if ( defined $attrs->{prefetch} ) {
3373 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3376 $attrs->{from} = # have to copy here to avoid corrupting the original
3378 @{ $attrs->{from} },
3379 $source->_resolve_join(
3382 { %{ $attrs->{seen_join} || {} } },
3383 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3384 ? $attrs->{from}[-1][0]{-join_path}
3391 if ( defined $attrs->{order_by} ) {
3392 $attrs->{order_by} = (
3393 ref( $attrs->{order_by} ) eq 'ARRAY'
3394 ? [ @{ $attrs->{order_by} } ]
3395 : [ $attrs->{order_by} || () ]
3399 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3400 $attrs->{group_by} = [ $attrs->{group_by} ];
3403 # generate the distinct induced group_by early, as prefetch will be carried via a
3404 # subquery (since a group_by is present)
3405 if (delete $attrs->{distinct}) {
3406 if ($attrs->{group_by}) {
3407 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3410 # distinct affects only the main selection part, not what prefetch may
3412 $attrs->{group_by} = $source->storage->_group_over_selection (
3420 $attrs->{collapse} ||= {};
3421 if ($attrs->{prefetch}) {
3423 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3424 if $attrs->{_dark_selector};
3426 my $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} );
3428 my $prefetch_ordering = [];
3430 # this is a separate structure (we don't look in {from} directly)
3431 # as the resolver needs to shift things off the lists to work
3432 # properly (identical-prefetches on different branches)
3434 if (ref $attrs->{from} eq 'ARRAY') {
3436 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3438 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3439 next unless $j->[0]{-alias};
3440 next unless $j->[0]{-join_path};
3441 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3443 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3446 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3447 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3452 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
3454 # we need to somehow mark which columns came from prefetch
3456 my $sel_end = $#{$attrs->{select}};
3457 $attrs->{_prefetch_selector_range} = [ $sel_end + 1, $sel_end + @prefetch ];
3460 push @{ $attrs->{select} }, (map { $_->[0] } @prefetch);
3461 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3463 push( @{$attrs->{order_by}}, @$prefetch_ordering );
3464 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
3467 # if both page and offset are specified, produce a combined offset
3468 # even though it doesn't make much sense, this is what pre 081xx has
3470 if (my $page = delete $attrs->{page}) {
3472 ($attrs->{rows} * ($page - 1))
3474 ($attrs->{offset} || 0)
3478 return $self->{_attrs} = $attrs;
3482 my ($self, $attr) = @_;
3484 if (ref $attr eq 'HASH') {
3485 return $self->_rollout_hash($attr);
3486 } elsif (ref $attr eq 'ARRAY') {
3487 return $self->_rollout_array($attr);
3493 sub _rollout_array {
3494 my ($self, $attr) = @_;
3497 foreach my $element (@{$attr}) {
3498 if (ref $element eq 'HASH') {
3499 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3500 } elsif (ref $element eq 'ARRAY') {
3501 # XXX - should probably recurse here
3502 push( @rolled_array, @{$self->_rollout_array($element)} );
3504 push( @rolled_array, $element );
3507 return \@rolled_array;
3511 my ($self, $attr) = @_;
3514 foreach my $key (keys %{$attr}) {
3515 push( @rolled_array, { $key => $attr->{$key} } );
3517 return \@rolled_array;
3520 sub _calculate_score {
3521 my ($self, $a, $b) = @_;
3523 if (defined $a xor defined $b) {
3526 elsif (not defined $a) {
3530 if (ref $b eq 'HASH') {
3531 my ($b_key) = keys %{$b};
3532 if (ref $a eq 'HASH') {
3533 my ($a_key) = keys %{$a};
3534 if ($a_key eq $b_key) {
3535 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3540 return ($a eq $b_key) ? 1 : 0;
3543 if (ref $a eq 'HASH') {
3544 my ($a_key) = keys %{$a};
3545 return ($b eq $a_key) ? 1 : 0;
3547 return ($b eq $a) ? 1 : 0;
3552 sub _merge_joinpref_attr {
3553 my ($self, $orig, $import) = @_;
3555 return $import unless defined($orig);
3556 return $orig unless defined($import);
3558 $orig = $self->_rollout_attr($orig);
3559 $import = $self->_rollout_attr($import);
3562 foreach my $import_element ( @{$import} ) {
3563 # find best candidate from $orig to merge $b_element into
3564 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3565 foreach my $orig_element ( @{$orig} ) {
3566 my $score = $self->_calculate_score( $orig_element, $import_element );
3567 if ($score > $best_candidate->{score}) {
3568 $best_candidate->{position} = $position;
3569 $best_candidate->{score} = $score;
3573 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3574 $import_key = '' if not defined $import_key;
3576 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3577 push( @{$orig}, $import_element );
3579 my $orig_best = $orig->[$best_candidate->{position}];
3580 # merge orig_best and b_element together and replace original with merged
3581 if (ref $orig_best ne 'HASH') {
3582 $orig->[$best_candidate->{position}] = $import_element;
3583 } elsif (ref $import_element eq 'HASH') {
3584 my ($key) = keys %{$orig_best};
3585 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3588 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3599 require Hash::Merge;
3600 my $hm = Hash::Merge->new;
3602 $hm->specify_behavior({
3605 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3607 if ($defl xor $defr) {
3608 return [ $defl ? $_[0] : $_[1] ];
3613 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3617 return [$_[0], $_[1]];
3621 return $_[1] if !defined $_[0];
3622 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3623 return [$_[0], @{$_[1]}]
3626 return [] if !defined $_[0] and !keys %{$_[1]};
3627 return [ $_[1] ] if !defined $_[0];
3628 return [ $_[0] ] if !keys %{$_[1]};
3629 return [$_[0], $_[1]]
3634 return $_[0] if !defined $_[1];
3635 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3636 return [@{$_[0]}, $_[1]]
3639 my @ret = @{$_[0]} or return $_[1];
3640 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3641 my %idx = map { $_ => 1 } @ret;
3642 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3646 return [ $_[1] ] if ! @{$_[0]};
3647 return $_[0] if !keys %{$_[1]};
3648 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3649 return [ @{$_[0]}, $_[1] ];
3654 return [] if !keys %{$_[0]} and !defined $_[1];
3655 return [ $_[0] ] if !defined $_[1];
3656 return [ $_[1] ] if !keys %{$_[0]};
3657 return [$_[0], $_[1]]
3660 return [] if !keys %{$_[0]} and !@{$_[1]};
3661 return [ $_[0] ] if !@{$_[1]};
3662 return $_[1] if !keys %{$_[0]};
3663 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3664 return [ $_[0], @{$_[1]} ];
3667 return [] if !keys %{$_[0]} and !keys %{$_[1]};
3668 return [ $_[0] ] if !keys %{$_[1]};
3669 return [ $_[1] ] if !keys %{$_[0]};
3670 return [ $_[0] ] if $_[0] eq $_[1];
3671 return [ $_[0], $_[1] ];
3674 } => 'DBIC_RS_ATTR_MERGER');
3678 return $hm->merge ($_[1], $_[2]);
3682 sub STORABLE_freeze {
3683 my ($self, $cloning) = @_;
3684 my $to_serialize = { %$self };
3686 # A cursor in progress can't be serialized (and would make little sense anyway)
3687 delete $to_serialize->{cursor};
3689 # nor is it sensical to store a not-yet-fired-count pager
3690 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3691 delete $to_serialize->{pager};
3694 Storable::nfreeze($to_serialize);
3697 # need this hook for symmetry
3699 my ($self, $cloning, $serialized) = @_;
3701 %$self = %{ Storable::thaw($serialized) };
3707 =head2 throw_exception
3709 See L<DBIx::Class::Schema/throw_exception> for details.
3713 sub throw_exception {
3716 if (ref $self and my $rsrc = $self->result_source) {
3717 $rsrc->throw_exception(@_)
3720 DBIx::Class::Exception->throw(@_);
3724 # XXX: FIXME: Attributes docs need clearing up
3728 Attributes are used to refine a ResultSet in various ways when
3729 searching for data. They can be passed to any method which takes an
3730 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3733 Default attributes can be set on the result class using
3734 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
3735 the CAVEATS on that feature before using it!)
3737 These are in no particular order:
3743 =item Value: ( $order_by | \@order_by | \%order_by )
3747 Which column(s) to order the results by.
3749 [The full list of suitable values is documented in
3750 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3753 If a single column name, or an arrayref of names is supplied, the
3754 argument is passed through directly to SQL. The hashref syntax allows
3755 for connection-agnostic specification of ordering direction:
3757 For descending order:
3759 order_by => { -desc => [qw/col1 col2 col3/] }
3761 For explicit ascending order:
3763 order_by => { -asc => 'col' }
3765 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3766 supported, although you are strongly encouraged to use the hashref
3767 syntax as outlined above.
3773 =item Value: \@columns
3777 Shortcut to request a particular set of columns to be retrieved. Each
3778 column spec may be a string (a table column name), or a hash (in which
3779 case the key is the C<as> value, and the value is used as the C<select>
3780 expression). Adds C<me.> onto the start of any column without a C<.> in
3781 it and sets C<select> from that, then auto-populates C<as> from
3782 C<select> as normal. (You may also use the C<cols> attribute, as in
3783 earlier versions of DBIC.)
3785 Essentially C<columns> does the same as L</select> and L</as>.
3787 columns => [ 'foo', { bar => 'baz' } ]
3791 select => [qw/foo baz/],
3798 =item Value: \@columns
3802 Indicates additional columns to be selected from storage. Works the same
3803 as L</columns> but adds columns to the selection. (You may also use the
3804 C<include_columns> attribute, as in earlier versions of DBIC). For
3807 $schema->resultset('CD')->search(undef, {
3808 '+columns' => ['artist.name'],
3812 would return all CDs and include a 'name' column to the information
3813 passed to object inflation. Note that the 'artist' is the name of the
3814 column (or relationship) accessor, and 'name' is the name of the column
3815 accessor in the related table.
3817 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
3818 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
3819 unary plus operator before it.
3821 =head2 include_columns
3825 =item Value: \@columns
3829 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3835 =item Value: \@select_columns
3839 Indicates which columns should be selected from the storage. You can use
3840 column names, or in the case of RDBMS back ends, function or stored procedure
3843 $rs = $schema->resultset('Employee')->search(undef, {
3846 { count => 'employeeid' },
3847 { max => { length => 'name' }, -as => 'longest_name' }
3852 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3854 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3855 use L</select>, to instruct DBIx::Class how to store the result of the column.
3856 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3857 identifier aliasing. You can however alias a function, so you can use it in
3858 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3859 attribute> supplied as shown in the example above.
3861 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
3862 Not doing so causes Perl to incorrectly interpret them as a bareword with a
3863 unary plus operator before it.
3869 Indicates additional columns to be selected from storage. Works the same as
3870 L</select> but adds columns to the default selection, instead of specifying
3879 Indicates additional column names for those added via L</+select>. See L</as>.
3887 =item Value: \@inflation_names
3891 Indicates column names for object inflation. That is L</as> indicates the
3892 slot name in which the column value will be stored within the
3893 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3894 identifier by the C<get_column> method (or via the object accessor B<if one
3895 with the same name already exists>) as shown below. The L</as> attribute has
3896 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3898 $rs = $schema->resultset('Employee')->search(undef, {
3901 { count => 'employeeid' },
3902 { max => { length => 'name' }, -as => 'longest_name' }
3911 If the object against which the search is performed already has an accessor
3912 matching a column name specified in C<as>, the value can be retrieved using
3913 the accessor as normal:
3915 my $name = $employee->name();
3917 If on the other hand an accessor does not exist in the object, you need to
3918 use C<get_column> instead:
3920 my $employee_count = $employee->get_column('employee_count');
3922 You can create your own accessors if required - see
3923 L<DBIx::Class::Manual::Cookbook> for details.
3929 =item Value: ($rel_name | \@rel_names | \%rel_names)
3933 Contains a list of relationships that should be joined for this query. For
3936 # Get CDs by Nine Inch Nails
3937 my $rs = $schema->resultset('CD')->search(
3938 { 'artist.name' => 'Nine Inch Nails' },
3939 { join => 'artist' }
3942 Can also contain a hash reference to refer to the other relation's relations.
3945 package MyApp::Schema::Track;
3946 use base qw/DBIx::Class/;
3947 __PACKAGE__->table('track');
3948 __PACKAGE__->add_columns(qw/trackid cd position title/);
3949 __PACKAGE__->set_primary_key('trackid');
3950 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3953 # In your application
3954 my $rs = $schema->resultset('Artist')->search(
3955 { 'track.title' => 'Teardrop' },
3957 join => { cd => 'track' },
3958 order_by => 'artist.name',
3962 You need to use the relationship (not the table) name in conditions,
3963 because they are aliased as such. The current table is aliased as "me", so
3964 you need to use me.column_name in order to avoid ambiguity. For example:
3966 # Get CDs from 1984 with a 'Foo' track
3967 my $rs = $schema->resultset('CD')->search(
3970 'tracks.name' => 'Foo'
3972 { join => 'tracks' }
3975 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3976 similarly for a third time). For e.g.
3978 my $rs = $schema->resultset('Artist')->search({
3979 'cds.title' => 'Down to Earth',
3980 'cds_2.title' => 'Popular',
3982 join => [ qw/cds cds/ ],
3985 will return a set of all artists that have both a cd with title 'Down
3986 to Earth' and a cd with title 'Popular'.
3988 If you want to fetch related objects from other tables as well, see C<prefetch>
3991 NOTE: An internal join-chain pruner will discard certain joins while
3992 constructing the actual SQL query, as long as the joins in question do not
3993 affect the retrieved result. This for example includes 1:1 left joins
3994 that are not part of the restriction specification (WHERE/HAVING) nor are
3995 a part of the query selection.
3997 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4003 =item Value: ($rel_name | \@rel_names | \%rel_names)
4007 Contains one or more relationships that should be fetched along with
4008 the main query (when they are accessed afterwards the data will
4009 already be available, without extra queries to the database). This is
4010 useful for when you know you will need the related objects, because it
4011 saves at least one query:
4013 my $rs = $schema->resultset('Tag')->search(
4022 The initial search results in SQL like the following:
4024 SELECT tag.*, cd.*, artist.* FROM tag
4025 JOIN cd ON tag.cd = cd.cdid
4026 JOIN artist ON cd.artist = artist.artistid
4028 L<DBIx::Class> has no need to go back to the database when we access the
4029 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4032 Simple prefetches will be joined automatically, so there is no need
4033 for a C<join> attribute in the above search.
4035 L</prefetch> can be used with the any of the relationship types and
4036 multiple prefetches can be specified together. Below is a more complex
4037 example that prefetches a CD's artist, its liner notes (if present),
4038 the cover image, the tracks on that cd, and the guests on those
4042 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4043 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4044 My::Schema::CD->has_one( cover_image => 'My::Schema::Artwork' );
4045 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4047 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4049 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4052 my $rs = $schema->resultset('CD')->search(
4056 { artist => 'record_label'}, # belongs_to => belongs_to
4057 'liner_note', # might_have
4058 'cover_image', # has_one
4059 { tracks => 'guests' }, # has_many => has_many
4064 This will produce SQL like the following:
4066 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4070 ON artist.artistid = me.artistid
4071 JOIN record_label record_label
4072 ON record_label.labelid = artist.labelid
4073 LEFT JOIN track tracks
4074 ON tracks.cdid = me.cdid
4075 LEFT JOIN guest guests
4076 ON guests.trackid = track.trackid
4077 LEFT JOIN liner_notes liner_note
4078 ON liner_note.cdid = me.cdid
4079 JOIN cd_artwork cover_image
4080 ON cover_image.cdid = me.cdid
4083 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4084 C<tracks>, and C<guests> of the CD will all be available through the
4085 relationship accessors without the need for additional queries to the
4088 However, there is one caveat to be observed: it can be dangerous to
4089 prefetch more than one L<has_many|DBIx::Class::Relationship/has_many>
4090 relationship on a given level. e.g.:
4092 my $rs = $schema->resultset('CD')->search(
4096 'tracks', # has_many
4097 { cd_to_producer => 'producer' }, # has_many => belongs_to (i.e. m2m)
4102 The collapser currently can't identify duplicate tuples for multiple
4103 L<has_many|DBIx::Class::Relationship/has_many> relationships and as a
4104 result the second L<has_many|DBIx::Class::Relationship/has_many>
4105 relation could contain redundant objects.
4107 =head3 Using L</prefetch> with L</join>
4109 L</prefetch> implies a L</join> with the equivalent argument, and is
4110 properly merged with any existing L</join> specification. So the
4113 my $rs = $schema->resultset('CD')->search(
4114 {'record_label.name' => 'Music Product Ltd.'},
4116 join => {artist => 'record_label'},
4117 prefetch => 'artist',
4121 ... will work, searching on the record label's name, but only
4122 prefetching the C<artist>.
4124 =head3 Using L</prefetch> with L</select> / L</+select> / L</as> / L</+as>
4126 L</prefetch> implies a L</+select>/L</+as> with the fields of the
4127 prefetched relations. So given:
4129 my $rs = $schema->resultset('CD')->search(
4132 select => ['cd.title'],
4134 prefetch => 'artist',
4138 The L</select> becomes: C<'cd.title', 'artist.*'> and the L</as>
4139 becomes: C<'cd_title', 'artist.*'>.
4143 Prefetch does a lot of deep magic. As such, it may not behave exactly
4144 as you might expect.
4150 Prefetch uses the L</cache> to populate the prefetched relationships. This
4151 may or may not be what you want.
4155 If you specify a condition on a prefetched relationship, ONLY those
4156 rows that match the prefetched condition will be fetched into that relationship.
4157 This means that adding prefetch to a search() B<may alter> what is returned by
4158 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4160 my $artist_rs = $schema->resultset('Artist')->search({
4166 my $count = $artist_rs->first->cds->count;
4168 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4170 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4172 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4174 that cmp_ok() may or may not pass depending on the datasets involved. This
4175 behavior may or may not survive the 0.09 transition.
4183 =item Value: $source_alias
4187 Sets the source alias for the query. Normally, this defaults to C<me>, but
4188 nested search queries (sub-SELECTs) might need specific aliases set to
4189 reference inner queries. For example:
4192 ->related_resultset('CDs')
4193 ->related_resultset('Tracks')
4195 'track.id' => { -ident => 'none_search.id' },
4199 my $ids = $self->search({
4202 alias => 'none_search',
4203 group_by => 'none_search.id',
4204 })->get_column('id')->as_query;
4206 $self->search({ id => { -in => $ids } })
4208 This attribute is directly tied to L</current_source_alias>.
4218 Makes the resultset paged and specifies the page to retrieve. Effectively
4219 identical to creating a non-pages resultset and then calling ->page($page)
4222 If L</rows> attribute is not specified it defaults to 10 rows per page.
4224 When you have a paged resultset, L</count> will only return the number
4225 of rows in the page. To get the total, use the L</pager> and call
4226 C<total_entries> on it.
4236 Specifies the maximum number of rows for direct retrieval or the number of
4237 rows per page if the page attribute or method is used.
4243 =item Value: $offset
4247 Specifies the (zero-based) row number for the first row to be returned, or the
4248 of the first row of the first page if paging is used.
4250 =head2 software_limit
4254 =item Value: (0 | 1)
4258 When combined with L</rows> and/or L</offset> the generated SQL will not
4259 include any limit dialect stanzas. Instead the entire result will be selected
4260 as if no limits were specified, and DBIC will perform the limit locally, by
4261 artificially advancing and finishing the resulting L</cursor>.
4263 This is the recommended way of performing resultset limiting when no sane RDBMS
4264 implementation is available (e.g.
4265 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4266 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4272 =item Value: \@columns
4276 A arrayref of columns to group by. Can include columns of joined tables.
4278 group_by => [qw/ column1 column2 ... /]
4284 =item Value: $condition
4288 HAVING is a select statement attribute that is applied between GROUP BY and
4289 ORDER BY. It is applied to the after the grouping calculations have been
4292 having => { 'count_employee' => { '>=', 100 } }
4294 or with an in-place function in which case literal SQL is required:
4296 having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4302 =item Value: (0 | 1)
4306 Set to 1 to group by all columns. If the resultset already has a group_by
4307 attribute, this setting is ignored and an appropriate warning is issued.
4313 Adds to the WHERE clause.
4315 # only return rows WHERE deleted IS NULL for all searches
4316 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4318 Can be overridden by passing C<< { where => undef } >> as an attribute
4321 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4327 Set to 1 to cache search results. This prevents extra SQL queries if you
4328 revisit rows in your ResultSet:
4330 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4332 while( my $artist = $resultset->next ) {
4336 $rs->first; # without cache, this would issue a query
4338 By default, searches are not cached.
4340 For more examples of using these attributes, see
4341 L<DBIx::Class::Manual::Cookbook>.
4347 =item Value: ( 'update' | 'shared' | \$scalar )
4351 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4352 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4355 =head1 DBIC BIND VALUES
4357 Because DBIC may need more information to bind values than just the column name
4358 and value itself, it uses a special format for both passing and receiving bind
4359 values. Each bind value should be composed of an arrayref of
4360 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4366 If present (in any form), this is what is being passed directly to bind_param.
4367 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4368 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4370 If this is specified, all other bind options described below are ignored.
4374 If present, this is used to infer the actual bind attribute by passing to
4375 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4376 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4378 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4379 currently drivers are expected to "Do the Right Thing" when given a common
4380 datatype name. (Not ideal, but that's what we got at this point.)
4384 Currently used to correctly allocate buffers for bind_param_inout().
4385 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4386 or to a sensible value based on the "data_type".
4390 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4391 explicitly specified they are never overriden). Also used by some weird DBDs,
4392 where the column name should be available at bind_param time (e.g. Oracle).
4396 For backwards compatibility and convenience, the following shortcuts are
4399 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4400 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4401 [ undef, $val ] === [ {}, $val ]
4403 =head1 AUTHOR AND CONTRIBUTORS
4405 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
4409 You may distribute this code under the same terms as Perl itself.