1 package DBIx::Class::ResultSet;
5 use base qw/DBIx::Class/;
7 use DBIx::Class::Exception;
8 use DBIx::Class::ResultSetColumn;
9 use Scalar::Util qw/blessed weaken/;
11 use Data::Compare (); # no imports!!! guard against insane architecture
13 # not importing first() as it will clash with our own method
17 # De-duplication in _merge_attr() is disabled, but left in for reference
18 # (the merger is used for other things that ought not to be de-duped)
19 *__HM_DEDUP = sub () { 0 };
29 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class result_source/);
33 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
37 my $users_rs = $schema->resultset('User');
38 while( $user = $users_rs->next) {
39 print $user->username;
42 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
43 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
47 A ResultSet is an object which stores a set of conditions representing
48 a query. It is the backbone of DBIx::Class (i.e. the really
49 important/useful bit).
51 No SQL is executed on the database when a ResultSet is created, it
52 just stores all the conditions needed to create the query.
54 A basic ResultSet representing the data of an entire table is returned
55 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
56 L<Source|DBIx::Class::Manual::Glossary/Source> name.
58 my $users_rs = $schema->resultset('User');
60 A new ResultSet is returned from calling L</search> on an existing
61 ResultSet. The new one will contain all the conditions of the
62 original, plus any new conditions added in the C<search> call.
64 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
65 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
68 The query that the ResultSet represents is B<only> executed against
69 the database when these methods are called:
70 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
72 If a resultset is used in a numeric context it returns the L</count>.
73 However, if it is used in a boolean context it is B<always> true. So if
74 you want to check if a resultset has any results, you must use C<if $rs
77 =head1 CUSTOM ResultSet CLASSES THAT USE Moose
79 If you want to make your custom ResultSet classes with L<Moose>, use a template
82 package MyApp::Schema::ResultSet::User;
85 use namespace::autoclean;
87 extends 'DBIx::Class::ResultSet';
89 sub BUILDARGS { $_[2] }
93 __PACKAGE__->meta->make_immutable;
97 The L<MooseX::NonMoose> is necessary so that the L<Moose> constructor does not
98 clash with the regular ResultSet constructor. Alternatively, you can use:
100 __PACKAGE__->meta->make_immutable(inline_constructor => 0);
102 The L<BUILDARGS|Moose::Manual::Construction/BUILDARGS> is necessary because the
103 signature of the ResultSet C<new> is C<< ->new($source, \%args) >>.
107 =head2 Chaining resultsets
109 Let's say you've got a query that needs to be run to return some data
110 to the user. But, you have an authorization system in place that
111 prevents certain users from seeing certain information. So, you want
112 to construct the basic query in one method, but add constraints to it in
117 my $request = $self->get_request; # Get a request object somehow.
118 my $schema = $self->result_source->schema;
120 my $cd_rs = $schema->resultset('CD')->search({
121 title => $request->param('title'),
122 year => $request->param('year'),
125 $cd_rs = $self->apply_security_policy( $cd_rs );
127 return $cd_rs->all();
130 sub apply_security_policy {
139 =head3 Resolving conditions and attributes
141 When a resultset is chained from another resultset, conditions and
142 attributes with the same keys need resolving.
144 L</join>, L</prefetch>, L</+select>, L</+as> attributes are merged
145 into the existing ones from the original resultset.
147 The L</where> and L</having> attributes, and any search conditions, are
148 merged with an SQL C<AND> to the existing condition from the original
151 All other attributes are overridden by any new ones supplied in the
154 =head2 Multiple queries
156 Since a resultset just defines a query, you can do all sorts of
157 things with it with the same object.
159 # Don't hit the DB yet.
160 my $cd_rs = $schema->resultset('CD')->search({
161 title => 'something',
165 # Each of these hits the DB individually.
166 my $count = $cd_rs->count;
167 my $most_recent = $cd_rs->get_column('date_released')->max();
168 my @records = $cd_rs->all;
170 And it's not just limited to SELECT statements.
176 $cd_rs->create({ artist => 'Fred' });
178 Which is the same as:
180 $schema->resultset('CD')->create({
181 title => 'something',
186 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
194 =item Arguments: L<$source|DBIx::Class::ResultSource>, L<\%attrs?|/ATTRIBUTES>
196 =item Return Value: L<$resultset|/search>
200 The resultset constructor. Takes a source object (usually a
201 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
202 L</ATTRIBUTES> below). Does not perform any queries -- these are
203 executed as needed by the other methods.
205 Generally you never construct a resultset manually. Instead you get one
207 C<< $schema->L<resultset|DBIx::Class::Schema/resultset>('$source_name') >>
208 or C<< $another_resultset->L<search|/search>(...) >> (the later called in
211 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
217 If called on an object, proxies to L</new_result> instead, so
219 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
221 will return a CD object, not a ResultSet, and is equivalent to:
223 my $cd = $schema->resultset('CD')->new_result({ title => 'Spoon' });
225 Please also keep in mind that many internals call L</new_result> directly,
226 so overloading this method with the idea of intercepting new result object
227 creation B<will not work>. See also warning pertaining to L</create>.
235 return $class->new_result(@_) if ref $class;
237 my ($source, $attrs) = @_;
238 $source = $source->resolve
239 if $source->isa('DBIx::Class::ResultSourceHandle');
240 $attrs = { %{$attrs||{}} };
242 if ($attrs->{page}) {
243 $attrs->{rows} ||= 10;
246 $attrs->{alias} ||= 'me';
249 result_source => $source,
250 cond => $attrs->{where},
255 # if there is a dark selector, this means we are already in a
256 # chain and the cleanup/sanification was taken care of by
258 $self->_normalize_selection($attrs)
259 unless $attrs->{_dark_selector};
262 $attrs->{result_class} || $source->result_class
272 =item Arguments: L<$cond|DBIx::Class::SQLMaker> | undef, L<\%attrs?|/ATTRIBUTES>
274 =item Return Value: $resultset (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
278 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
279 my $new_rs = $cd_rs->search({ year => 2005 });
281 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
282 # year = 2005 OR year = 2004
284 In list context, C<< ->all() >> is called implicitly on the resultset, thus
285 returning a list of L<result|DBIx::Class::Manual::ResultClass> objects instead.
286 To avoid that, use L</search_rs>.
288 If you need to pass in additional attributes but no additional condition,
289 call it as C<search(undef, \%attrs)>.
291 # "SELECT name, artistid FROM $artist_table"
292 my @all_artists = $schema->resultset('Artist')->search(undef, {
293 columns => [qw/name artistid/],
296 For a list of attributes that can be passed to C<search>, see
297 L</ATTRIBUTES>. For more examples of using this function, see
298 L<Searching|DBIx::Class::Manual::Cookbook/Searching>. For a complete
299 documentation for the first argument, see L<SQL::Abstract>
300 and its extension L<DBIx::Class::SQLMaker>.
302 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
306 Note that L</search> does not process/deflate any of the values passed in the
307 L<SQL::Abstract>-compatible search condition structure. This is unlike other
308 condition-bound methods L</new_result>, L</create> and L</find>. The user must ensure
309 manually that any value passed to this method will stringify to something the
310 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
311 objects, for more info see:
312 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
318 my $rs = $self->search_rs( @_ );
323 elsif (defined wantarray) {
327 # we can be called by a relationship helper, which in
328 # turn may be called in void context due to some braindead
329 # overload or whatever else the user decided to be clever
330 # at this particular day. Thus limit the exception to
331 # external code calls only
332 $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
333 if (caller)[0] !~ /^\QDBIx::Class::/;
343 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
345 =item Return Value: L<$resultset|/search>
349 This method does the same exact thing as search() except it will
350 always return a resultset, even in list context.
357 my $rsrc = $self->result_source;
358 my ($call_cond, $call_attrs);
360 # Special-case handling for (undef, undef) or (undef)
361 # Note that (foo => undef) is valid deprecated syntax
362 @_ = () if not scalar grep { defined $_ } @_;
368 # fish out attrs in the ($condref, $attr) case
369 elsif (@_ == 2 and ( ! defined $_[0] or (ref $_[0]) ne '') ) {
370 ($call_cond, $call_attrs) = @_;
373 $self->throw_exception('Odd number of arguments to search')
377 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
378 unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
380 for my $i (0 .. $#_) {
382 $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
383 if (! defined $_[$i] or ref $_[$i] ne '');
389 # see if we can keep the cache (no $rs changes)
391 my %safe = (alias => 1, cache => 1);
392 if ( ! List::Util::first { !$safe{$_} } keys %$call_attrs and (
395 ref $_[0] eq 'HASH' && ! keys %{$_[0]}
397 ref $_[0] eq 'ARRAY' && ! @{$_[0]}
399 $cache = $self->get_cache;
402 my $old_attrs = { %{$self->{attrs}} };
403 my $old_having = delete $old_attrs->{having};
404 my $old_where = delete $old_attrs->{where};
406 my $new_attrs = { %$old_attrs };
408 # take care of call attrs (only if anything is changing)
409 if ($call_attrs and keys %$call_attrs) {
411 # copy for _normalize_selection
412 $call_attrs = { %$call_attrs };
414 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
416 # reset the current selector list if new selectors are supplied
417 if (List::Util::first { exists $call_attrs->{$_} } qw/columns cols select as/) {
418 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')};
421 # Normalize the new selector list (operates on the passed-in attr structure)
422 # Need to do it on every chain instead of only once on _resolved_attrs, in
423 # order to allow detection of empty vs partial 'as'
424 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
425 if $old_attrs->{_dark_selector};
426 $self->_normalize_selection ($call_attrs);
428 # start with blind overwriting merge, exclude selector attrs
429 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
430 delete @{$new_attrs}{@selector_attrs};
432 for (@selector_attrs) {
433 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
434 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
437 # older deprecated name, use only if {columns} is not there
438 if (my $c = delete $new_attrs->{cols}) {
439 if ($new_attrs->{columns}) {
440 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
443 $new_attrs->{columns} = $c;
448 # join/prefetch use their own crazy merging heuristics
449 foreach my $key (qw/join prefetch/) {
450 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
451 if exists $call_attrs->{$key};
454 # stack binds together
455 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
459 for ($old_where, $call_cond) {
461 $new_attrs->{where} = $self->_stack_cond (
462 $_, $new_attrs->{where}
467 if (defined $old_having) {
468 $new_attrs->{having} = $self->_stack_cond (
469 $old_having, $new_attrs->{having}
473 my $rs = (ref $self)->new($rsrc, $new_attrs);
475 $rs->set_cache($cache) if ($cache);
481 sub _normalize_selection {
482 my ($self, $attrs) = @_;
485 $attrs->{'+columns'} = $self->_merge_attr($attrs->{'+columns'}, delete $attrs->{include_columns})
486 if exists $attrs->{include_columns};
488 # columns are always placed first, however
490 # Keep the X vs +X separation until _resolved_attrs time - this allows to
491 # delay the decision on whether to use a default select list ($rsrc->columns)
492 # allowing stuff like the remove_columns helper to work
494 # select/as +select/+as pairs need special handling - the amount of select/as
495 # elements in each pair does *not* have to be equal (think multicolumn
496 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
497 # supplied at all) - try to infer the alias, either from the -as parameter
498 # of the selector spec, or use the parameter whole if it looks like a column
499 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
500 # is ok as well), but make sure no more additions to the 'as' chain take place
501 for my $pref ('', '+') {
503 my ($sel, $as) = map {
504 my $key = "${pref}${_}";
506 my $val = [ ref $attrs->{$key} eq 'ARRAY'
508 : $attrs->{$key} || ()
510 delete $attrs->{$key};
514 if (! @$as and ! @$sel ) {
517 elsif (@$as and ! @$sel) {
518 $self->throw_exception(
519 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
523 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
524 # if any @$as has been supplied we assume the user knows what (s)he is doing
525 # and blindly keep stacking up pieces
526 unless ($attrs->{_dark_selector}) {
529 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
530 push @$as, $_->{-as};
532 # assume any plain no-space, no-parenthesis string to be a column spec
533 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
534 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
537 # if all else fails - raise a flag that no more aliasing will be allowed
539 $attrs->{_dark_selector} = {
541 string => ($dark_sel_dumper ||= do {
542 require Data::Dumper::Concise;
543 Data::Dumper::Concise::DumperObject()->Indent(0);
544 })->Values([$_])->Dump
552 elsif (@$as < @$sel) {
553 $self->throw_exception(
554 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
557 elsif ($pref and $attrs->{_dark_selector}) {
558 $self->throw_exception(
559 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
565 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
566 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
571 my ($self, $left, $right) = @_;
573 # collapse single element top-level conditions
574 # (single pass only, unlikely to need recursion)
575 for ($left, $right) {
576 if (ref $_ eq 'ARRAY') {
584 elsif (ref $_ eq 'HASH') {
585 my ($first, $more) = keys %$_;
588 if (! defined $first) {
592 elsif (! defined $more) {
593 if ($first eq '-and' and ref $_->{'-and'} eq 'HASH') {
596 elsif ($first eq '-or' and ref $_->{'-or'} eq 'ARRAY') {
603 # merge hashes with weeding out of duplicates (simple cases only)
604 if (ref $left eq 'HASH' and ref $right eq 'HASH') {
606 # shallow copy to destroy
607 $right = { %$right };
608 for (grep { exists $right->{$_} } keys %$left) {
609 # the use of eq_deeply here is justified - the rhs of an
610 # expression can contain a lot of twisted weird stuff
611 delete $right->{$_} if Data::Compare::Compare( $left->{$_}, $right->{$_} );
614 $right = undef unless keys %$right;
618 if (defined $left xor defined $right) {
619 return defined $left ? $left : $right;
621 elsif (! defined $left) {
625 return { -and => [ $left, $right ] };
629 =head2 search_literal
631 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
632 should only be used in that context. C<search_literal> is a convenience
633 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
634 want to ensure columns are bound correctly, use L</search>.
636 See L<DBIx::Class::Manual::Cookbook/Searching> and
637 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
638 require C<search_literal>.
642 =item Arguments: $sql_fragment, @standalone_bind_values
644 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
648 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
649 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
651 Pass a literal chunk of SQL to be added to the conditional part of the
654 Example of how to use C<search> instead of C<search_literal>
656 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
657 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
662 my ($self, $sql, @bind) = @_;
664 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
667 return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
674 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
676 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
680 Finds and returns a single row based on supplied criteria. Takes either a
681 hashref with the same format as L</create> (including inference of foreign
682 keys from related objects), or a list of primary key values in the same
683 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
684 declaration on the L</result_source>.
686 In either case an attempt is made to combine conditions already existing on
687 the resultset with the condition passed to this method.
689 To aid with preparing the correct query for the storage you may supply the
690 C<key> attribute, which is the name of a
691 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
692 unique constraint corresponding to the
693 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
694 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
695 to construct a query that satisfies the named unique constraint fully (
696 non-NULL values for each column member of the constraint) an exception is
699 If no C<key> is specified, the search is carried over all unique constraints
700 which are fully defined by the available condition.
702 If no such constraint is found, C<find> currently defaults to a simple
703 C<< search->(\%column_values) >> which may or may not do what you expect.
704 Note that this fallback behavior may be deprecated in further versions. If
705 you need to search with arbitrary conditions - use L</search>. If the query
706 resulting from this fallback produces more than one row, a warning to the
707 effect is issued, though only the first row is constructed and returned as
710 In addition to C<key>, L</find> recognizes and applies standard
711 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
713 Note that if you have extra concerns about the correctness of the resulting
714 query you need to specify the C<key> attribute and supply the entire condition
715 as an argument to find (since it is not always possible to perform the
716 combination of the resultset condition with the supplied one, especially if
717 the resultset condition contains literal sql).
719 For example, to find a row by its primary key:
721 my $cd = $schema->resultset('CD')->find(5);
723 You can also find a row by a specific unique constraint:
725 my $cd = $schema->resultset('CD')->find(
727 artist => 'Massive Attack',
728 title => 'Mezzanine',
730 { key => 'cd_artist_title' }
733 See also L</find_or_create> and L</update_or_create>.
739 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
741 my $rsrc = $self->result_source;
744 if (exists $attrs->{key}) {
745 $constraint_name = defined $attrs->{key}
747 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
751 # Parse out the condition from input
754 if (ref $_[0] eq 'HASH') {
755 $call_cond = { %{$_[0]} };
758 # if only values are supplied we need to default to 'primary'
759 $constraint_name = 'primary' unless defined $constraint_name;
761 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
763 $self->throw_exception(
764 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
767 $self->throw_exception (
768 'find() expects either a column/value hashref, or a list of values '
769 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
770 ) unless @c_cols == @_;
773 @{$call_cond}{@c_cols} = @_;
777 for my $key (keys %$call_cond) {
779 my $keyref = ref($call_cond->{$key})
781 my $relinfo = $rsrc->relationship_info($key)
783 my $val = delete $call_cond->{$key};
785 next if $keyref eq 'ARRAY'; # has_many for multi_create
787 my $rel_q = $rsrc->_resolve_condition(
788 $relinfo->{cond}, $val, $key, $key
790 die "Can't handle complex relationship conditions in find" if ref($rel_q) ne 'HASH';
791 @related{keys %$rel_q} = values %$rel_q;
795 # relationship conditions take precedence (?)
796 @{$call_cond}{keys %related} = values %related;
798 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
800 if (defined $constraint_name) {
801 $final_cond = $self->_qualify_cond_columns (
803 $self->_build_unique_cond (
811 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
812 # This means that we got here after a merger of relationship conditions
813 # in ::Relationship::Base::search_related (the row method), and furthermore
814 # the relationship is of the 'single' type. This means that the condition
815 # provided by the relationship (already attached to $self) is sufficient,
816 # as there can be only one row in the database that would satisfy the
820 # no key was specified - fall down to heuristics mode:
821 # run through all unique queries registered on the resultset, and
822 # 'OR' all qualifying queries together
823 my (@unique_queries, %seen_column_combinations);
824 for my $c_name ($rsrc->unique_constraint_names) {
825 next if $seen_column_combinations{
826 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
829 push @unique_queries, try {
830 $self->_build_unique_cond ($c_name, $call_cond, 'croak_on_nulls')
834 $final_cond = @unique_queries
835 ? [ map { $self->_qualify_cond_columns($_, $alias) } @unique_queries ]
836 : $self->_non_unique_find_fallback ($call_cond, $attrs)
840 # Run the query, passing the result_class since it should propagate for find
841 my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
842 if (keys %{$rs->_resolved_attrs->{collapse}}) {
844 carp "Query returned more than one row" if $rs->next;
852 # This is a stop-gap method as agreed during the discussion on find() cleanup:
853 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
855 # It is invoked when find() is called in legacy-mode with insufficiently-unique
856 # condition. It is provided for overrides until a saner way forward is devised
858 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
859 # the road. Please adjust your tests accordingly to catch this situation early
860 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
862 # The method will not be removed without an adequately complete replacement
863 # for strict-mode enforcement
864 sub _non_unique_find_fallback {
865 my ($self, $cond, $attrs) = @_;
867 return $self->_qualify_cond_columns(
869 exists $attrs->{alias}
871 : $self->{attrs}{alias}
876 sub _qualify_cond_columns {
877 my ($self, $cond, $alias) = @_;
879 my %aliased = %$cond;
880 for (keys %aliased) {
881 $aliased{"$alias.$_"} = delete $aliased{$_}
888 sub _build_unique_cond {
889 my ($self, $constraint_name, $extra_cond, $croak_on_null) = @_;
891 my @c_cols = $self->result_source->unique_constraint_columns($constraint_name);
893 # combination may fail if $self->{cond} is non-trivial
894 my ($final_cond) = try {
895 $self->_merge_with_rscond ($extra_cond)
900 # trim out everything not in $columns
901 $final_cond = { map {
902 exists $final_cond->{$_}
903 ? ( $_ => $final_cond->{$_} )
907 if (my @missing = grep
908 { ! ($croak_on_null ? defined $final_cond->{$_} : exists $final_cond->{$_}) }
911 $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', no values for column(s): %s",
913 join (', ', map { "'$_'" } @missing),
920 !$ENV{DBIC_NULLABLE_KEY_NOWARN}
922 my @undefs = sort grep { ! defined $final_cond->{$_} } (keys %$final_cond)
924 carp_unique ( sprintf (
925 "NULL/undef values supplied for requested unique constraint '%s' (NULL "
926 . 'values in column(s): %s). This is almost certainly not what you wanted, '
927 . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
929 join (', ', map { "'$_'" } @undefs),
936 =head2 search_related
940 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
942 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
946 $new_rs = $cd_rs->search_related('artist', {
950 Searches the specified relationship, optionally specifying a condition and
951 attributes for matching records. See L</ATTRIBUTES> for more information.
953 In list context, C<< ->all() >> is called implicitly on the resultset, thus
954 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
956 See also L</search_related_rs>.
961 return shift->related_resultset(shift)->search(@_);
964 =head2 search_related_rs
966 This method works exactly the same as search_related, except that
967 it guarantees a resultset, even in list context.
971 sub search_related_rs {
972 return shift->related_resultset(shift)->search_rs(@_);
979 =item Arguments: none
981 =item Return Value: L<$cursor|DBIx::Class::Cursor>
985 Returns a storage-driven cursor to the given resultset. See
986 L<DBIx::Class::Cursor> for more information.
993 return $self->{cursor} ||= do {
994 my $attrs = { %{$self->_resolved_attrs } };
995 $self->result_source->storage->select(
996 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
1005 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1007 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1011 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1013 Inflates the first result without creating a cursor if the resultset has
1014 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1017 While this method can take an optional search condition (just like L</search>)
1018 being a fast-code-path it does not recognize search attributes. If you need to
1019 add extra joins or similar, call L</search> and then chain-call L</single> on the
1020 L<DBIx::Class::ResultSet> returned.
1026 As of 0.08100, this method enforces the assumption that the preceding
1027 query returns only one row. If more than one row is returned, you will receive
1030 Query returned more than one row
1032 In this case, you should be using L</next> or L</find> instead, or if you really
1033 know what you are doing, use the L</rows> attribute to explicitly limit the size
1036 This method will also throw an exception if it is called on a resultset prefetching
1037 has_many, as such a prefetch implies fetching multiple rows from the database in
1038 order to assemble the resulting object.
1045 my ($self, $where) = @_;
1047 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1050 my $attrs = { %{$self->_resolved_attrs} };
1052 if (keys %{$attrs->{collapse}}) {
1053 $self->throw_exception(
1054 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
1059 if (defined $attrs->{where}) {
1062 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1063 $where, delete $attrs->{where} ]
1066 $attrs->{where} = $where;
1070 my @data = $self->result_source->storage->select_single(
1071 $attrs->{from}, $attrs->{select},
1072 $attrs->{where}, $attrs
1075 return (@data ? ($self->_construct_object(@data))[0] : undef);
1081 # Recursively collapse the query, accumulating values for each column.
1083 sub _collapse_query {
1084 my ($self, $query, $collapsed) = @_;
1088 if (ref $query eq 'ARRAY') {
1089 foreach my $subquery (@$query) {
1090 next unless ref $subquery; # -or
1091 $collapsed = $self->_collapse_query($subquery, $collapsed);
1094 elsif (ref $query eq 'HASH') {
1095 if (keys %$query and (keys %$query)[0] eq '-and') {
1096 foreach my $subquery (@{$query->{-and}}) {
1097 $collapsed = $self->_collapse_query($subquery, $collapsed);
1101 foreach my $col (keys %$query) {
1102 my $value = $query->{$col};
1103 $collapsed->{$col}{$value}++;
1115 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1117 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1121 my $max_length = $rs->get_column('length')->max;
1123 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1128 my ($self, $column) = @_;
1129 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1137 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1139 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1143 # WHERE title LIKE '%blue%'
1144 $cd_rs = $rs->search_like({ title => '%blue%'});
1146 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1147 that this is simply a convenience method retained for ex Class::DBI users.
1148 You most likely want to use L</search> with specific operators.
1150 For more information, see L<DBIx::Class::Manual::Cookbook>.
1152 This method is deprecated and will be removed in 0.09. Use L</search()>
1153 instead. An example conversion is:
1155 ->search_like({ foo => 'bar' });
1159 ->search({ foo => { like => 'bar' } });
1166 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1167 .' Instead use ->search({ x => { -like => "y%" } })'
1168 .' (note the outer pair of {}s - they are important!)'
1170 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1171 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1172 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1173 return $class->search($query, { %$attrs });
1180 =item Arguments: $first, $last
1182 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1186 Returns a resultset or object list representing a subset of elements from the
1187 resultset slice is called on. Indexes are from 0, i.e., to get the first
1188 three records, call:
1190 my ($one, $two, $three) = $rs->slice(0, 2);
1195 my ($self, $min, $max) = @_;
1196 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1197 $attrs->{offset} = $self->{attrs}{offset} || 0;
1198 $attrs->{offset} += $min;
1199 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1200 return $self->search(undef, $attrs);
1201 #my $slice = (ref $self)->new($self->result_source, $attrs);
1202 #return (wantarray ? $slice->all : $slice);
1209 =item Arguments: none
1211 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1215 Returns the next element in the resultset (C<undef> is there is none).
1217 Can be used to efficiently iterate over records in the resultset:
1219 my $rs = $schema->resultset('CD')->search;
1220 while (my $cd = $rs->next) {
1224 Note that you need to store the resultset object, and call C<next> on it.
1225 Calling C<< resultset('Table')->next >> repeatedly will always return the
1226 first record from the resultset.
1232 if (my $cache = $self->get_cache) {
1233 $self->{all_cache_position} ||= 0;
1234 return $cache->[$self->{all_cache_position}++];
1236 if ($self->{attrs}{cache}) {
1237 delete $self->{pager};
1238 $self->{all_cache_position} = 1;
1239 return ($self->all)[0];
1241 if ($self->{stashed_objects}) {
1242 my $obj = shift(@{$self->{stashed_objects}});
1243 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
1247 exists $self->{stashed_row}
1248 ? @{delete $self->{stashed_row}}
1249 : $self->cursor->next
1251 return undef unless (@row);
1252 my ($row, @more) = $self->_construct_object(@row);
1253 $self->{stashed_objects} = \@more if @more;
1257 sub _construct_object {
1258 my ($self, @row) = @_;
1260 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
1262 my @new = $self->result_class->inflate_result($self->result_source, @$info);
1263 @new = $self->{_attrs}{record_filter}->(@new)
1264 if exists $self->{_attrs}{record_filter};
1268 sub _collapse_result {
1269 my ($self, $as_proto, $row) = @_;
1273 # 'foo' => [ undef, 'foo' ]
1274 # 'foo.bar' => [ 'foo', 'bar' ]
1275 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
1277 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
1279 my %collapse = %{$self->{_attrs}{collapse}||{}};
1283 # if we're doing collapsing (has_many prefetch) we need to grab records
1284 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1285 # we know we don't have to bother.
1287 # the reason for not using the collapse stuff directly is because if you
1288 # had for e.g. two artists in a row with no cds, the collapse info for
1289 # both would be NULL (undef) so you'd lose the second artist
1291 # store just the index so we can check the array positions from the row
1292 # without having to contruct the full hash
1294 if (keys %collapse) {
1295 my %pri = map { ($_ => 1) } $self->result_source->_pri_cols;
1296 foreach my $i (0 .. $#construct_as) {
1297 next if defined($construct_as[$i][0]); # only self table
1298 if (delete $pri{$construct_as[$i][1]}) {
1299 push(@pri_index, $i);
1301 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1305 # no need to do an if, it'll be empty if @pri_index is empty anyway
1307 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1311 do { # no need to check anything at the front, we always want the first row
1315 foreach my $this_as (@construct_as) {
1316 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1319 push(@const_rows, \%const);
1321 } until ( # no pri_index => no collapse => drop straight out
1324 do { # get another row, stash it, drop out if different PK
1326 @copy = $self->cursor->next;
1327 $self->{stashed_row} = \@copy;
1329 # last thing in do block, counts as true if anything doesn't match
1331 # check xor defined first for NULL vs. NOT NULL then if one is
1332 # defined the other must be so check string equality
1335 (defined $pri_vals{$_} ^ defined $copy[$_])
1336 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1341 my $alias = $self->{attrs}{alias};
1348 foreach my $const (@const_rows) {
1349 scalar @const_keys or do {
1350 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1352 foreach my $key (@const_keys) {
1355 my @parts = split(/\./, $key);
1357 my $data = $const->{$key};
1358 foreach my $p (@parts) {
1359 $target = $target->[1]->{$p} ||= [];
1361 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1362 # collapsing at this point and on final part
1363 my $pos = $collapse_pos{$cur};
1364 CK: foreach my $ck (@ckey) {
1365 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1366 $collapse_pos{$cur} = $data;
1367 delete @collapse_pos{ # clear all positioning for sub-entries
1368 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1375 if (exists $collapse{$cur}) {
1376 $target = $target->[-1];
1379 $target->[0] = $data;
1381 $info->[0] = $const->{$key};
1389 =head2 result_source
1393 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1395 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1399 An accessor for the primary ResultSource object from which this ResultSet
1406 =item Arguments: $result_class?
1408 =item Return Value: $result_class
1412 An accessor for the class to use when creating result objects. Defaults to
1413 C<< result_source->result_class >> - which in most cases is the name of the
1414 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1416 Note that changing the result_class will also remove any components
1417 that were originally loaded in the source class via
1418 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1419 in the original source class will not run.
1424 my ($self, $result_class) = @_;
1425 if ($result_class) {
1426 unless (ref $result_class) { # don't fire this for an object
1427 $self->ensure_class_loaded($result_class);
1429 $self->_result_class($result_class);
1430 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1431 # permit the user to set result class on one result set only; it only
1432 # chains if provided to search()
1433 #$self->{attrs}{result_class} = $result_class if ref $self;
1435 $self->_result_class;
1442 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1444 =item Return Value: $count
1448 Performs an SQL C<COUNT> with the same query as the resultset was built
1449 with to find the number of elements. Passing arguments is equivalent to
1450 C<< $rs->search ($cond, \%attrs)->count >>
1456 return $self->search(@_)->count if @_ and defined $_[0];
1457 return scalar @{ $self->get_cache } if $self->get_cache;
1459 my $attrs = { %{ $self->_resolved_attrs } };
1461 # this is a little optimization - it is faster to do the limit
1462 # adjustments in software, instead of a subquery
1463 my $rows = delete $attrs->{rows};
1464 my $offset = delete $attrs->{offset};
1467 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1468 $crs = $self->_count_subq_rs ($attrs);
1471 $crs = $self->_count_rs ($attrs);
1473 my $count = $crs->next;
1475 $count -= $offset if $offset;
1476 $count = $rows if $rows and $rows < $count;
1477 $count = 0 if ($count < 0);
1486 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1488 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1492 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1493 This can be very handy for subqueries:
1495 ->search( { amount => $some_rs->count_rs->as_query } )
1497 As with regular resultsets the SQL query will be executed only after
1498 the resultset is accessed via L</next> or L</all>. That would return
1499 the same single value obtainable via L</count>.
1505 return $self->search(@_)->count_rs if @_;
1507 # this may look like a lack of abstraction (count() does about the same)
1508 # but in fact an _rs *must* use a subquery for the limits, as the
1509 # software based limiting can not be ported if this $rs is to be used
1510 # in a subquery itself (i.e. ->as_query)
1511 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1512 return $self->_count_subq_rs;
1515 return $self->_count_rs;
1520 # returns a ResultSetColumn object tied to the count query
1523 my ($self, $attrs) = @_;
1525 my $rsrc = $self->result_source;
1526 $attrs ||= $self->_resolved_attrs;
1528 my $tmp_attrs = { %$attrs };
1529 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1530 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1532 # overwrite the selector (supplied by the storage)
1533 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $attrs);
1534 $tmp_attrs->{as} = 'count';
1535 delete @{$tmp_attrs}{qw/columns/};
1537 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1543 # same as above but uses a subquery
1545 sub _count_subq_rs {
1546 my ($self, $attrs) = @_;
1548 my $rsrc = $self->result_source;
1549 $attrs ||= $self->_resolved_attrs;
1551 my $sub_attrs = { %$attrs };
1552 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1553 delete @{$sub_attrs}{qw/collapse columns as select _prefetch_selector_range order_by for/};
1555 # if we multi-prefetch we group_by something unique, as this is what we would
1556 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1557 if ( keys %{$attrs->{collapse}} ) {
1558 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1559 $rsrc->_identifying_column_set || $self->throw_exception(
1560 'Unable to construct a unique group_by criteria properly collapsing the '
1561 . 'has_many prefetch before count()'
1566 # Calculate subquery selector
1567 if (my $g = $sub_attrs->{group_by}) {
1569 my $sql_maker = $rsrc->storage->sql_maker;
1571 # necessary as the group_by may refer to aliased functions
1573 for my $sel (@{$attrs->{select}}) {
1574 $sel_index->{$sel->{-as}} = $sel
1575 if (ref $sel eq 'HASH' and $sel->{-as});
1578 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1579 # also look for named aggregates referred in the having clause
1580 # having often contains scalarrefs - thus parse it out entirely
1582 if ($attrs->{having}) {
1583 local $sql_maker->{having_bind};
1584 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1585 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1586 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1587 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1588 # if we don't unset it we screw up retarded but unfortunately working
1589 # 'MAX(foo.bar)' => { '>', 3 }
1590 $sql_maker->{name_sep} = '';
1593 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1595 my $sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1597 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1598 # and if all fails for an utterly naive quoted scalar-with-function
1600 $rquote $sep $lquote (.+?) $rquote
1602 [\s,] \w+ \. (\w+) [\s,]
1604 [\s,] $lquote (.+?) $rquote [\s,]
1606 push @parts, ($1 || $2 || $3); # one of them matched if we got here
1611 my $colpiece = $sel_index->{$_} || $_;
1613 # unqualify join-based group_by's. Arcane but possible query
1614 # also horrible horrible hack to alias a column (not a func.)
1615 # (probably need to introduce SQLA syntax)
1616 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1619 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1621 push @{$sub_attrs->{select}}, $colpiece;
1625 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1626 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1629 return $rsrc->resultset_class
1630 ->new ($rsrc, $sub_attrs)
1632 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1633 ->get_column ('count');
1640 =head2 count_literal
1642 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1643 should only be used in that context. See L</search_literal> for further info.
1647 =item Arguments: $sql_fragment, @standalone_bind_values
1649 =item Return Value: $count
1653 Counts the results in a literal query. Equivalent to calling L</search_literal>
1654 with the passed arguments, then L</count>.
1658 sub count_literal { shift->search_literal(@_)->count; }
1664 =item Arguments: none
1666 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1670 Returns all elements in the resultset.
1677 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1680 return @{ $self->get_cache } if $self->get_cache;
1684 if (keys %{$self->_resolved_attrs->{collapse}}) {
1685 # Using $self->cursor->all is really just an optimisation.
1686 # If we're collapsing has_many prefetches it probably makes
1687 # very little difference, and this is cleaner than hacking
1688 # _construct_object to survive the approach
1689 $self->cursor->reset;
1690 my @row = $self->cursor->next;
1692 push(@obj, $self->_construct_object(@row));
1693 @row = (exists $self->{stashed_row}
1694 ? @{delete $self->{stashed_row}}
1695 : $self->cursor->next);
1698 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1701 $self->set_cache(\@obj) if $self->{attrs}{cache};
1710 =item Arguments: none
1712 =item Return Value: $self
1716 Resets the resultset's cursor, so you can iterate through the elements again.
1717 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1724 $self->{all_cache_position} = 0;
1725 $self->cursor->reset;
1733 =item Arguments: none
1735 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1739 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1740 an object for the first result (or C<undef> if the resultset is empty).
1745 return $_[0]->reset->next;
1751 # Determines whether and what type of subquery is required for the $rs operation.
1752 # If grouping is necessary either supplies its own, or verifies the current one
1753 # After all is done delegates to the proper storage method.
1755 sub _rs_update_delete {
1756 my ($self, $op, $values) = @_;
1758 my $cond = $self->{cond};
1759 my $rsrc = $self->result_source;
1760 my $storage = $rsrc->schema->storage;
1762 my $attrs = { %{$self->_resolved_attrs} };
1764 my $join_classifications;
1765 my $existing_group_by = delete $attrs->{group_by};
1767 # do we need a subquery for any reason?
1769 defined $existing_group_by
1771 # if {from} is unparseable wrap a subq
1772 ref($attrs->{from}) ne 'ARRAY'
1774 # limits call for a subq
1775 $self->_has_resolved_attr(qw/rows offset/)
1778 # simplify the joinmap, so we can further decide if a subq is necessary
1779 if (!$needs_subq and @{$attrs->{from}} > 1) {
1780 $attrs->{from} = $storage->_prune_unused_joins ($attrs->{from}, $attrs->{select}, $cond, $attrs);
1782 # check if there are any joins left after the prune
1783 if ( @{$attrs->{from}} > 1 ) {
1784 $join_classifications = $storage->_resolve_aliastypes_from_select_args (
1785 [ @{$attrs->{from}}[1 .. $#{$attrs->{from}}] ],
1791 # any non-pruneable joins imply subq
1792 $needs_subq = scalar keys %{ $join_classifications->{restricting} || {} };
1796 # check if the head is composite (by now all joins are thrown out unless $needs_subq)
1798 (ref $attrs->{from}[0]) ne 'HASH'
1800 ref $attrs->{from}[0]{ $attrs->{from}[0]{-alias} }
1803 # do we need anything like a subquery?
1804 unless ($needs_subq) {
1805 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1806 # a condition containing 'me' or other table prefixes will not work
1807 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1809 my $sqla = $rsrc->storage->sql_maker;
1810 local $sqla->{_dequalify_idents} = 1;
1811 \[ $sqla->_recurse_where($self->{cond}) ];
1814 return $rsrc->storage->$op(
1816 $op eq 'update' ? $values : (),
1821 # we got this far - means it is time to wrap a subquery
1822 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1824 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1830 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1831 delete $attrs->{$_} for qw/collapse _collapse_order_by select _prefetch_selector_range as/;
1832 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1833 $attrs->{group_by} = \ ''; # FIXME - this is an evil hack, it causes the optimiser to kick in and throw away the LEFT joins
1834 my $subrs = (ref $self)->new($rsrc, $attrs);
1836 if (@$idcols == 1) {
1837 return $storage->$op (
1839 $op eq 'update' ? $values : (),
1840 { $idcols->[0] => { -in => $subrs->as_query } },
1843 elsif ($storage->_use_multicolumn_in) {
1844 return $storage->$op (
1846 $op eq 'update' ? $values : (),
1847 # no syntax for calling this properly yet
1848 # !!! EXPERIMENTAL API !!! WILL CHANGE !!!
1849 $storage->sql_maker->_where_op_multicolumn_in (
1850 $idcols, # how do I convey a list of idents...? can binds reside on lhs?
1857 # if all else fails - get all primary keys and operate over a ORed set
1858 # wrap in a transaction for consistency
1859 # this is where the group_by/multiplication starts to matter
1863 keys %{ $join_classifications->{multiplying} || {} }
1865 # make sure if there is a supplied group_by it matches the columns compiled above
1866 # perfectly. Anything else can not be sanely executed on most databases so croak
1867 # right then and there
1868 if ($existing_group_by) {
1869 my @current_group_by = map
1870 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1875 join ("\x00", sort @current_group_by)
1877 join ("\x00", sort @{$attrs->{columns}} )
1879 $self->throw_exception (
1880 "You have just attempted a $op operation on a resultset which does group_by"
1881 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1882 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1883 . ' kind of queries. Please retry the operation with a modified group_by or'
1884 . ' without using one at all.'
1889 $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
1892 my $guard = $storage->txn_scope_guard;
1895 for my $row ($subrs->cursor->all) {
1896 push @op_condition, { map
1897 { $idcols->[$_] => $row->[$_] }
1902 my $res = $storage->$op (
1904 $op eq 'update' ? $values : (),
1918 =item Arguments: \%values
1920 =item Return Value: $underlying_storage_rv
1924 Sets the specified columns in the resultset to the supplied values in a
1925 single query. Note that this will not run any accessor/set_column/update
1926 triggers, nor will it update any result object instances derived from this
1927 resultset (this includes the contents of the L<resultset cache|/set_cache>
1928 if any). See L</update_all> if you need to execute any on-update
1929 triggers or cascades defined either by you or a
1930 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1932 The return value is a pass through of what the underlying
1933 storage backend returned, and may vary. See L<DBI/execute> for the most
1938 Note that L</update> does not process/deflate any of the values passed in.
1939 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
1940 ensure manually that any value passed to this method will stringify to
1941 something the RDBMS knows how to deal with. A notable example is the
1942 handling of L<DateTime> objects, for more info see:
1943 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
1948 my ($self, $values) = @_;
1949 $self->throw_exception('Values for update must be a hash')
1950 unless ref $values eq 'HASH';
1952 return $self->_rs_update_delete ('update', $values);
1959 =item Arguments: \%values
1961 =item Return Value: 1
1965 Fetches all objects and updates them one at a time via
1966 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
1967 triggers, while L</update> will not.
1972 my ($self, $values) = @_;
1973 $self->throw_exception('Values for update_all must be a hash')
1974 unless ref $values eq 'HASH';
1976 my $guard = $self->result_source->schema->txn_scope_guard;
1977 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
1986 =item Arguments: none
1988 =item Return Value: $underlying_storage_rv
1992 Deletes the rows matching this resultset in a single query. Note that this
1993 will not run any delete triggers, nor will it alter the
1994 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
1995 derived from this resultset (this includes the contents of the
1996 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
1997 execute any on-delete triggers or cascades defined either by you or a
1998 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2000 The return value is a pass through of what the underlying storage backend
2001 returned, and may vary. See L<DBI/execute> for the most common case.
2007 $self->throw_exception('delete does not accept any arguments')
2010 return $self->_rs_update_delete ('delete');
2017 =item Arguments: none
2019 =item Return Value: 1
2023 Fetches all objects and deletes them one at a time via
2024 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2025 triggers, while L</delete> will not.
2031 $self->throw_exception('delete_all does not accept any arguments')
2034 my $guard = $self->result_source->schema->txn_scope_guard;
2035 $_->delete for $self->all;
2044 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2046 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2050 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2057 The context of this method call has an important effect on what is
2058 submitted to storage. In void context data is fed directly to fastpath
2059 insertion routines provided by the underlying storage (most often
2060 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2061 L<insert|DBIx::Class::Row/insert> calls on the
2062 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2063 augmentation of these methods provided by components. For example if you
2064 are using something like L<DBIx::Class::UUIDColumns> to create primary
2065 keys for you, you will find that your PKs are empty. In this case you
2066 will have to explicitly force scalar or list context in order to create
2071 In non-void (scalar or list) context, this method is simply a wrapper
2072 for L</create>. Depending on list or scalar context either a list of
2073 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2074 containing these objects is returned.
2076 When supplying data in "arrayref of arrayrefs" invocation style, the
2077 first element should be a list of column names and each subsequent
2078 element should be a data value in the earlier specified column order.
2081 $Arstist_rs->populate([
2082 [ qw( artistid name ) ],
2083 [ 100, 'A Formally Unknown Singer' ],
2084 [ 101, 'A singer that jumped the shark two albums ago' ],
2085 [ 102, 'An actually cool singer' ],
2088 For the arrayref of hashrefs style each hashref should be a structure
2089 suitable for passing to L</create>. Multi-create is also permitted with
2092 $schema->resultset("Artist")->populate([
2093 { artistid => 4, name => 'Manufactured Crap', cds => [
2094 { title => 'My First CD', year => 2006 },
2095 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2098 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2099 { title => 'My parents sold me to a record company', year => 2005 },
2100 { title => 'Why Am I So Ugly?', year => 2006 },
2101 { title => 'I Got Surgery and am now Popular', year => 2007 }
2106 If you attempt a void-context multi-create as in the example above (each
2107 Artist also has the related list of CDs), and B<do not> supply the
2108 necessary autoinc foreign key information, this method will proxy to the
2109 less efficient L</create>, and then throw the Result objects away. In this
2110 case there are obviously no benefits to using this method over L</create>.
2117 # cruft placed in standalone method
2118 my $data = $self->_normalize_populate_args(@_);
2120 return unless @$data;
2122 if(defined wantarray) {
2123 my @created = map { $self->create($_) } @$data;
2124 return wantarray ? @created : \@created;
2127 my $first = $data->[0];
2129 # if a column is a registered relationship, and is a non-blessed hash/array, consider
2130 # it relationship data
2131 my (@rels, @columns);
2132 my $rsrc = $self->result_source;
2133 my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2134 for (keys %$first) {
2135 my $ref = ref $first->{$_};
2136 $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2142 my @pks = $rsrc->primary_columns;
2144 ## do the belongs_to relationships
2145 foreach my $index (0..$#$data) {
2147 # delegate to create() for any dataset without primary keys with specified relationships
2148 if (grep { !defined $data->[$index]->{$_} } @pks ) {
2150 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
2151 my @ret = $self->populate($data);
2157 foreach my $rel (@rels) {
2158 next unless ref $data->[$index]->{$rel} eq "HASH";
2159 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2160 my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2161 my $related = $result->result_source->_resolve_condition(
2162 $reverse_relinfo->{cond},
2168 delete $data->[$index]->{$rel};
2169 $data->[$index] = {%{$data->[$index]}, %$related};
2171 push @columns, keys %$related if $index == 0;
2175 ## inherit the data locked in the conditions of the resultset
2176 my ($rs_data) = $self->_merge_with_rscond({});
2177 delete @{$rs_data}{@columns};
2179 ## do bulk insert on current row
2180 $rsrc->storage->insert_bulk(
2182 [@columns, keys %$rs_data],
2183 [ map { [ @$_{@columns}, values %$rs_data ] } @$data ],
2186 ## do the has_many relationships
2187 foreach my $item (@$data) {
2191 foreach my $rel (@rels) {
2192 next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2194 $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2196 my $child = $main_row->$rel;
2198 my $related = $child->result_source->_resolve_condition(
2199 $rels->{$rel}{cond},
2205 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2206 my @populate = map { {%$_, %$related} } @rows_to_add;
2208 $child->populate( \@populate );
2215 # populate() argumnets went over several incarnations
2216 # What we ultimately support is AoH
2217 sub _normalize_populate_args {
2218 my ($self, $arg) = @_;
2220 if (ref $arg eq 'ARRAY') {
2224 elsif (ref $arg->[0] eq 'HASH') {
2227 elsif (ref $arg->[0] eq 'ARRAY') {
2229 my @colnames = @{$arg->[0]};
2230 foreach my $values (@{$arg}[1 .. $#$arg]) {
2231 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2237 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2244 =item Arguments: none
2246 =item Return Value: L<$pager|Data::Page>
2250 Returns a L<Data::Page> object for the current resultset. Only makes
2251 sense for queries with a C<page> attribute.
2253 To get the full count of entries for a paged resultset, call
2254 C<total_entries> on the L<Data::Page> object.
2261 return $self->{pager} if $self->{pager};
2263 my $attrs = $self->{attrs};
2264 if (!defined $attrs->{page}) {
2265 $self->throw_exception("Can't create pager for non-paged rs");
2267 elsif ($attrs->{page} <= 0) {
2268 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2270 $attrs->{rows} ||= 10;
2272 # throw away the paging flags and re-run the count (possibly
2273 # with a subselect) to get the real total count
2274 my $count_attrs = { %$attrs };
2275 delete $count_attrs->{$_} for qw/rows offset page pager/;
2277 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2279 require DBIx::Class::ResultSet::Pager;
2280 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2281 sub { $total_rs->count }, #lazy-get the total
2283 $self->{attrs}{page},
2291 =item Arguments: $page_number
2293 =item Return Value: L<$resultset|/search>
2297 Returns a resultset for the $page_number page of the resultset on which page
2298 is called, where each page contains a number of rows equal to the 'rows'
2299 attribute set on the resultset (10 by default).
2304 my ($self, $page) = @_;
2305 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2312 =item Arguments: \%col_data
2314 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2318 Creates a new result object in the resultset's result class and returns
2319 it. The row is not inserted into the database at this point, call
2320 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2321 will tell you whether the result object has been inserted or not.
2323 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2328 my ($self, $values) = @_;
2330 $self->throw_exception( "new_result takes only one argument - a hashref of values" )
2333 $self->throw_exception( "new_result expects a hashref" )
2334 unless (ref $values eq 'HASH');
2336 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2340 @$cols_from_relations
2341 ? (-cols_from_relations => $cols_from_relations)
2343 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2346 return $self->result_class->new(\%new);
2349 # _merge_with_rscond
2351 # Takes a simple hash of K/V data and returns its copy merged with the
2352 # condition already present on the resultset. Additionally returns an
2353 # arrayref of value/condition names, which were inferred from related
2354 # objects (this is needed for in-memory related objects)
2355 sub _merge_with_rscond {
2356 my ($self, $data) = @_;
2358 my (%new_data, @cols_from_relations);
2360 my $alias = $self->{attrs}{alias};
2362 if (! defined $self->{cond}) {
2363 # just massage $data below
2365 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
2366 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2367 @cols_from_relations = keys %new_data;
2369 elsif (ref $self->{cond} ne 'HASH') {
2370 $self->throw_exception(
2371 "Can't abstract implicit construct, resultset condition not a hash"
2375 # precendence must be given to passed values over values inherited from
2376 # the cond, so the order here is important.
2377 my $collapsed_cond = $self->_collapse_cond($self->{cond});
2378 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2380 while ( my($col, $value) = each %implied ) {
2381 my $vref = ref $value;
2387 (keys %$value)[0] eq '='
2389 $new_data{$col} = $value->{'='};
2391 elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2392 $new_data{$col} = $value;
2399 %{ $self->_remove_alias($data, $alias) },
2402 return (\%new_data, \@cols_from_relations);
2405 # _has_resolved_attr
2407 # determines if the resultset defines at least one
2408 # of the attributes supplied
2410 # used to determine if a subquery is neccessary
2412 # supports some virtual attributes:
2414 # This will scan for any joins being present on the resultset.
2415 # It is not a mere key-search but a deep inspection of {from}
2418 sub _has_resolved_attr {
2419 my ($self, @attr_names) = @_;
2421 my $attrs = $self->_resolved_attrs;
2425 for my $n (@attr_names) {
2426 if (grep { $n eq $_ } (qw/-join/) ) {
2427 $extra_checks{$n}++;
2431 my $attr = $attrs->{$n};
2433 next if not defined $attr;
2435 if (ref $attr eq 'HASH') {
2436 return 1 if keys %$attr;
2438 elsif (ref $attr eq 'ARRAY') {
2446 # a resolved join is expressed as a multi-level from
2448 $extra_checks{-join}
2450 ref $attrs->{from} eq 'ARRAY'
2452 @{$attrs->{from}} > 1
2460 # Recursively collapse the condition.
2462 sub _collapse_cond {
2463 my ($self, $cond, $collapsed) = @_;
2467 if (ref $cond eq 'ARRAY') {
2468 foreach my $subcond (@$cond) {
2469 next unless ref $subcond; # -or
2470 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2473 elsif (ref $cond eq 'HASH') {
2474 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2475 foreach my $subcond (@{$cond->{-and}}) {
2476 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2480 foreach my $col (keys %$cond) {
2481 my $value = $cond->{$col};
2482 $collapsed->{$col} = $value;
2492 # Remove the specified alias from the specified query hash. A copy is made so
2493 # the original query is not modified.
2496 my ($self, $query, $alias) = @_;
2498 my %orig = %{ $query || {} };
2501 foreach my $key (keys %orig) {
2503 $unaliased{$key} = $orig{$key};
2506 $unaliased{$1} = $orig{$key}
2507 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2517 =item Arguments: none
2519 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2523 Returns the SQL query and bind vars associated with the invocant.
2525 This is generally used as the RHS for a subquery.
2532 my $attrs = { %{ $self->_resolved_attrs } };
2537 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2538 # $sql also has no wrapping parenthesis in list ctx
2540 my $sqlbind = $self->result_source->storage
2541 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2550 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2552 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2556 my $artist = $schema->resultset('Artist')->find_or_new(
2557 { artist => 'fred' }, { key => 'artists' });
2559 $cd->cd_to_producer->find_or_new({ producer => $producer },
2560 { key => 'primary });
2562 Find an existing record from this resultset using L</find>. if none exists,
2563 instantiate a new result object and return it. The object will not be saved
2564 into your storage until you call L<DBIx::Class::Row/insert> on it.
2566 You most likely want this method when looking for existing rows using a unique
2567 constraint that is not the primary key, or looking for related rows.
2569 If you want objects to be saved immediately, use L</find_or_create> instead.
2571 B<Note>: Make sure to read the documentation of L</find> and understand the
2572 significance of the C<key> attribute, as its lack may skew your search, and
2573 subsequently result in spurious new objects.
2575 B<Note>: Take care when using C<find_or_new> with a table having
2576 columns with default values that you intend to be automatically
2577 supplied by the database (e.g. an auto_increment primary key column).
2578 In normal usage, the value of such columns should NOT be included at
2579 all in the call to C<find_or_new>, even when set to C<undef>.
2585 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2586 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2587 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2590 return $self->new_result($hash);
2597 =item Arguments: \%col_data
2599 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2603 Attempt to create a single new row or a row with multiple related rows
2604 in the table represented by the resultset (and related tables). This
2605 will not check for duplicate rows before inserting, use
2606 L</find_or_create> to do that.
2608 To create one row for this resultset, pass a hashref of key/value
2609 pairs representing the columns of the table and the values you wish to
2610 store. If the appropriate relationships are set up, foreign key fields
2611 can also be passed an object representing the foreign row, and the
2612 value will be set to its primary key.
2614 To create related objects, pass a hashref of related-object column values
2615 B<keyed on the relationship name>. If the relationship is of type C<multi>
2616 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2617 The process will correctly identify columns holding foreign keys, and will
2618 transparently populate them from the keys of the corresponding relation.
2619 This can be applied recursively, and will work correctly for a structure
2620 with an arbitrary depth and width, as long as the relationships actually
2621 exists and the correct column data has been supplied.
2623 Instead of hashrefs of plain related data (key/value pairs), you may
2624 also pass new or inserted objects. New objects (not inserted yet, see
2625 L</new_result>), will be inserted into their appropriate tables.
2627 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2629 Example of creating a new row.
2631 $person_rs->create({
2632 name=>"Some Person",
2633 email=>"somebody@someplace.com"
2636 Example of creating a new row and also creating rows in a related C<has_many>
2637 or C<has_one> resultset. Note Arrayref.
2640 { artistid => 4, name => 'Manufactured Crap', cds => [
2641 { title => 'My First CD', year => 2006 },
2642 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2647 Example of creating a new row and also creating a row in a related
2648 C<belongs_to> resultset. Note Hashref.
2651 title=>"Music for Silly Walks",
2654 name=>"Silly Musician",
2662 When subclassing ResultSet never attempt to override this method. Since
2663 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2664 lot of the internals simply never call it, so your override will be
2665 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2666 or L<DBIx::Class::Row/insert> depending on how early in the
2667 L</create> process you need to intervene. See also warning pertaining to
2675 my ($self, $attrs) = @_;
2676 $self->throw_exception( "create needs a hashref" )
2677 unless ref $attrs eq 'HASH';
2678 return $self->new_result($attrs)->insert;
2681 =head2 find_or_create
2685 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2687 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2691 $cd->cd_to_producer->find_or_create({ producer => $producer },
2692 { key => 'primary' });
2694 Tries to find a record based on its primary key or unique constraints; if none
2695 is found, creates one and returns that instead.
2697 my $cd = $schema->resultset('CD')->find_or_create({
2699 artist => 'Massive Attack',
2700 title => 'Mezzanine',
2704 Also takes an optional C<key> attribute, to search by a specific key or unique
2705 constraint. For example:
2707 my $cd = $schema->resultset('CD')->find_or_create(
2709 artist => 'Massive Attack',
2710 title => 'Mezzanine',
2712 { key => 'cd_artist_title' }
2715 B<Note>: Make sure to read the documentation of L</find> and understand the
2716 significance of the C<key> attribute, as its lack may skew your search, and
2717 subsequently result in spurious row creation.
2719 B<Note>: Because find_or_create() reads from the database and then
2720 possibly inserts based on the result, this method is subject to a race
2721 condition. Another process could create a record in the table after
2722 the find has completed and before the create has started. To avoid
2723 this problem, use find_or_create() inside a transaction.
2725 B<Note>: Take care when using C<find_or_create> with a table having
2726 columns with default values that you intend to be automatically
2727 supplied by the database (e.g. an auto_increment primary key column).
2728 In normal usage, the value of such columns should NOT be included at
2729 all in the call to C<find_or_create>, even when set to C<undef>.
2731 See also L</find> and L</update_or_create>. For information on how to declare
2732 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2734 If you need to know if an existing row was found or a new one created use
2735 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2736 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2739 my $cd = $schema->resultset('CD')->find_or_new({
2741 artist => 'Massive Attack',
2742 title => 'Mezzanine',
2746 if( !$cd->in_storage ) {
2753 sub find_or_create {
2755 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2756 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2757 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2760 return $self->create($hash);
2763 =head2 update_or_create
2767 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2769 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2773 $resultset->update_or_create({ col => $val, ... });
2775 Like L</find_or_create>, but if a row is found it is immediately updated via
2776 C<< $found_row->update (\%col_data) >>.
2779 Takes an optional C<key> attribute to search on a specific unique constraint.
2782 # In your application
2783 my $cd = $schema->resultset('CD')->update_or_create(
2785 artist => 'Massive Attack',
2786 title => 'Mezzanine',
2789 { key => 'cd_artist_title' }
2792 $cd->cd_to_producer->update_or_create({
2793 producer => $producer,
2799 B<Note>: Make sure to read the documentation of L</find> and understand the
2800 significance of the C<key> attribute, as its lack may skew your search, and
2801 subsequently result in spurious row creation.
2803 B<Note>: Take care when using C<update_or_create> with a table having
2804 columns with default values that you intend to be automatically
2805 supplied by the database (e.g. an auto_increment primary key column).
2806 In normal usage, the value of such columns should NOT be included at
2807 all in the call to C<update_or_create>, even when set to C<undef>.
2809 See also L</find> and L</find_or_create>. For information on how to declare
2810 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2812 If you need to know if an existing row was updated or a new one created use
2813 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2814 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2819 sub update_or_create {
2821 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2822 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2824 my $row = $self->find($cond, $attrs);
2826 $row->update($cond);
2830 return $self->create($cond);
2833 =head2 update_or_new
2837 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2839 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2843 $resultset->update_or_new({ col => $val, ... });
2845 Like L</find_or_new> but if a row is found it is immediately updated via
2846 C<< $found_row->update (\%col_data) >>.
2850 # In your application
2851 my $cd = $schema->resultset('CD')->update_or_new(
2853 artist => 'Massive Attack',
2854 title => 'Mezzanine',
2857 { key => 'cd_artist_title' }
2860 if ($cd->in_storage) {
2861 # the cd was updated
2864 # the cd is not yet in the database, let's insert it
2868 B<Note>: Make sure to read the documentation of L</find> and understand the
2869 significance of the C<key> attribute, as its lack may skew your search, and
2870 subsequently result in spurious new objects.
2872 B<Note>: Take care when using C<update_or_new> with a table having
2873 columns with default values that you intend to be automatically
2874 supplied by the database (e.g. an auto_increment primary key column).
2875 In normal usage, the value of such columns should NOT be included at
2876 all in the call to C<update_or_new>, even when set to C<undef>.
2878 See also L</find>, L</find_or_create> and L</find_or_new>.
2884 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2885 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2887 my $row = $self->find( $cond, $attrs );
2888 if ( defined $row ) {
2889 $row->update($cond);
2893 return $self->new_result($cond);
2900 =item Arguments: none
2902 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
2906 Gets the contents of the cache for the resultset, if the cache is set.
2908 The cache is populated either by using the L</prefetch> attribute to
2909 L</search> or by calling L</set_cache>.
2921 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2923 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2927 Sets the contents of the cache for the resultset. Expects an arrayref
2928 of objects of the same class as those produced by the resultset. Note that
2929 if the cache is set, the resultset will return the cached objects rather
2930 than re-querying the database even if the cache attr is not set.
2932 The contents of the cache can also be populated by using the
2933 L</prefetch> attribute to L</search>.
2938 my ( $self, $data ) = @_;
2939 $self->throw_exception("set_cache requires an arrayref")
2940 if defined($data) && (ref $data ne 'ARRAY');
2941 $self->{all_cache} = $data;
2948 =item Arguments: none
2950 =item Return Value: undef
2954 Clears the cache for the resultset.
2959 shift->set_cache(undef);
2966 =item Arguments: none
2968 =item Return Value: true, if the resultset has been paginated
2976 return !!$self->{attrs}{page};
2983 =item Arguments: none
2985 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2993 return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
2996 =head2 related_resultset
3000 =item Arguments: $rel_name
3002 =item Return Value: L<$resultset|/search>
3006 Returns a related resultset for the supplied relationship name.
3008 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3012 sub related_resultset {
3013 my ($self, $rel) = @_;
3015 $self->{related_resultsets} ||= {};
3016 return $self->{related_resultsets}{$rel} ||= do {
3017 my $rsrc = $self->result_source;
3018 my $rel_info = $rsrc->relationship_info($rel);
3020 $self->throw_exception(
3021 "search_related: result source '" . $rsrc->source_name .
3022 "' has no such relationship $rel")
3025 my $attrs = $self->_chain_relationship($rel);
3027 my $join_count = $attrs->{seen_join}{$rel};
3029 my $alias = $self->result_source->storage
3030 ->relname_to_table_alias($rel, $join_count);
3032 # since this is search_related, and we already slid the select window inwards
3033 # (the select/as attrs were deleted in the beginning), we need to flip all
3034 # left joins to inner, so we get the expected results
3035 # read the comment on top of the actual function to see what this does
3036 $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3039 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3040 delete @{$attrs}{qw(result_class alias)};
3044 if (my $cache = $self->get_cache) {
3045 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
3046 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
3051 my $rel_source = $rsrc->related_source($rel);
3055 # The reason we do this now instead of passing the alias to the
3056 # search_rs below is that if you wrap/overload resultset on the
3057 # source you need to know what alias it's -going- to have for things
3058 # to work sanely (e.g. RestrictWithObject wants to be able to add
3059 # extra query restrictions, and these may need to be $alias.)
3061 my $rel_attrs = $rel_source->resultset_attributes;
3062 local $rel_attrs->{alias} = $alias;
3064 $rel_source->resultset
3068 where => $attrs->{where},
3071 $new->set_cache($new_cache) if $new_cache;
3076 =head2 current_source_alias
3080 =item Arguments: none
3082 =item Return Value: $source_alias
3086 Returns the current table alias for the result source this resultset is built
3087 on, that will be used in the SQL query. Usually it is C<me>.
3089 Currently the source alias that refers to the result set returned by a
3090 L</search>/L</find> family method depends on how you got to the resultset: it's
3091 C<me> by default, but eg. L</search_related> aliases it to the related result
3092 source name (and keeps C<me> referring to the original result set). The long
3093 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3094 (and make this method unnecessary).
3096 Thus it's currently necessary to use this method in predefined queries (see
3097 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3098 source alias of the current result set:
3100 # in a result set class
3102 my ($self, $user) = @_;
3104 my $me = $self->current_source_alias;
3106 return $self->search({
3107 "$me.modified" => $user->id,
3113 sub current_source_alias {
3114 return (shift->{attrs} || {})->{alias} || 'me';
3117 =head2 as_subselect_rs
3121 =item Arguments: none
3123 =item Return Value: L<$resultset|/search>
3127 Act as a barrier to SQL symbols. The resultset provided will be made into a
3128 "virtual view" by including it as a subquery within the from clause. From this
3129 point on, any joined tables are inaccessible to ->search on the resultset (as if
3130 it were simply where-filtered without joins). For example:
3132 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3134 # 'x' now pollutes the query namespace
3136 # So the following works as expected
3137 my $ok_rs = $rs->search({'x.other' => 1});
3139 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3140 # def) we look for one row with contradictory terms and join in another table
3141 # (aliased 'x_2') which we never use
3142 my $broken_rs = $rs->search({'x.name' => 'def'});
3144 my $rs2 = $rs->as_subselect_rs;
3146 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3147 my $not_joined_rs = $rs2->search({'x.other' => 1});
3149 # works as expected: finds a 'table' row related to two x rows (abc and def)
3150 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3152 Another example of when one might use this would be to select a subset of
3153 columns in a group by clause:
3155 my $rs = $schema->resultset('Bar')->search(undef, {
3156 group_by => [qw{ id foo_id baz_id }],
3157 })->as_subselect_rs->search(undef, {
3158 columns => [qw{ id foo_id }]
3161 In the above example normally columns would have to be equal to the group by,
3162 but because we isolated the group by into a subselect the above works.
3166 sub as_subselect_rs {
3169 my $attrs = $self->_resolved_attrs;
3171 my $fresh_rs = (ref $self)->new (
3172 $self->result_source
3175 # these pieces will be locked in the subquery
3176 delete $fresh_rs->{cond};
3177 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3179 return $fresh_rs->search( {}, {
3181 $attrs->{alias} => $self->as_query,
3182 -alias => $attrs->{alias},
3183 -rsrc => $self->result_source,
3185 alias => $attrs->{alias},
3189 # This code is called by search_related, and makes sure there
3190 # is clear separation between the joins before, during, and
3191 # after the relationship. This information is needed later
3192 # in order to properly resolve prefetch aliases (any alias
3193 # with a relation_chain_depth less than the depth of the
3194 # current prefetch is not considered)
3196 # The increments happen twice per join. An even number means a
3197 # relationship specified via a search_related, whereas an odd
3198 # number indicates a join/prefetch added via attributes
3200 # Also this code will wrap the current resultset (the one we
3201 # chain to) in a subselect IFF it contains limiting attributes
3202 sub _chain_relationship {
3203 my ($self, $rel) = @_;
3204 my $source = $self->result_source;
3205 my $attrs = { %{$self->{attrs}||{}} };
3207 # we need to take the prefetch the attrs into account before we
3208 # ->_resolve_join as otherwise they get lost - captainL
3209 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3211 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
3213 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3216 my @force_subq_attrs = qw/offset rows group_by having/;
3219 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3221 $self->_has_resolved_attr (@force_subq_attrs)
3223 # Nuke the prefetch (if any) before the new $rs attrs
3224 # are resolved (prefetch is useless - we are wrapping
3225 # a subquery anyway).
3226 my $rs_copy = $self->search;
3227 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3228 $rs_copy->{attrs}{join},
3229 delete $rs_copy->{attrs}{prefetch},
3234 -alias => $attrs->{alias},
3235 $attrs->{alias} => $rs_copy->as_query,
3237 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3238 $seen->{-relation_chain_depth} = 0;
3240 elsif ($attrs->{from}) { #shallow copy suffices
3241 $from = [ @{$attrs->{from}} ];
3246 -alias => $attrs->{alias},
3247 $attrs->{alias} => $source->from,
3251 my $jpath = ($seen->{-relation_chain_depth})
3252 ? $from->[-1][0]{-join_path}
3255 my @requested_joins = $source->_resolve_join(
3262 push @$from, @requested_joins;
3264 $seen->{-relation_chain_depth}++;
3266 # if $self already had a join/prefetch specified on it, the requested
3267 # $rel might very well be already included. What we do in this case
3268 # is effectively a no-op (except that we bump up the chain_depth on
3269 # the join in question so we could tell it *is* the search_related)
3272 # we consider the last one thus reverse
3273 for my $j (reverse @requested_joins) {
3274 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3275 if ($rel eq $last_j) {
3276 $j->[0]{-relation_chain_depth}++;
3282 unless ($already_joined) {
3283 push @$from, $source->_resolve_join(
3291 $seen->{-relation_chain_depth}++;
3293 return {%$attrs, from => $from, seen_join => $seen};
3296 sub _resolved_attrs {
3298 return $self->{_attrs} if $self->{_attrs};
3300 my $attrs = { %{ $self->{attrs} || {} } };
3301 my $source = $self->result_source;
3302 my $alias = $attrs->{alias};
3304 # default selection list
3305 $attrs->{columns} = [ $source->columns ]
3306 unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3308 # merge selectors together
3309 for (qw/columns select as/) {
3310 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3311 if $attrs->{$_} or $attrs->{"+$_"};
3314 # disassemble columns
3316 if (my $cols = delete $attrs->{columns}) {
3317 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3318 if (ref $c eq 'HASH') {
3319 for my $as (sort keys %$c) {
3320 push @sel, $c->{$as};
3331 # when trying to weed off duplicates later do not go past this point -
3332 # everything added from here on is unbalanced "anyone's guess" stuff
3333 my $dedup_stop_idx = $#as;
3335 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3337 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3338 if $attrs->{select};
3340 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3342 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_";
3345 # disqualify all $alias.col as-bits (collapser mandated)
3347 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_;
3350 # de-duplicate the result (remove *identical* select/as pairs)
3351 # and also die on duplicate {as} pointing to different {select}s
3352 # not using a c-style for as the condition is prone to shrinkage
3355 while ($i <= $dedup_stop_idx) {
3356 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3361 elsif ($seen->{$as[$i]}++) {
3362 $self->throw_exception(
3363 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3371 $attrs->{select} = \@sel;
3372 $attrs->{as} = \@as;
3374 $attrs->{from} ||= [{
3376 -alias => $self->{attrs}{alias},
3377 $self->{attrs}{alias} => $source->from,
3380 if ( $attrs->{join} || $attrs->{prefetch} ) {
3382 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3383 if ref $attrs->{from} ne 'ARRAY';
3385 my $join = (delete $attrs->{join}) || {};
3387 if ( defined $attrs->{prefetch} ) {
3388 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3391 $attrs->{from} = # have to copy here to avoid corrupting the original
3393 @{ $attrs->{from} },
3394 $source->_resolve_join(
3397 { %{ $attrs->{seen_join} || {} } },
3398 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3399 ? $attrs->{from}[-1][0]{-join_path}
3406 if ( defined $attrs->{order_by} ) {
3407 $attrs->{order_by} = (
3408 ref( $attrs->{order_by} ) eq 'ARRAY'
3409 ? [ @{ $attrs->{order_by} } ]
3410 : [ $attrs->{order_by} || () ]
3414 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3415 $attrs->{group_by} = [ $attrs->{group_by} ];
3418 # generate the distinct induced group_by early, as prefetch will be carried via a
3419 # subquery (since a group_by is present)
3420 if (delete $attrs->{distinct}) {
3421 if ($attrs->{group_by}) {
3422 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3425 # distinct affects only the main selection part, not what prefetch may
3427 $attrs->{group_by} = $source->storage->_group_over_selection (
3435 $attrs->{collapse} ||= {};
3436 if ($attrs->{prefetch}) {
3438 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3439 if $attrs->{_dark_selector};
3441 my $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} );
3443 my $prefetch_ordering = [];
3445 # this is a separate structure (we don't look in {from} directly)
3446 # as the resolver needs to shift things off the lists to work
3447 # properly (identical-prefetches on different branches)
3449 if (ref $attrs->{from} eq 'ARRAY') {
3451 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3453 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3454 next unless $j->[0]{-alias};
3455 next unless $j->[0]{-join_path};
3456 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3458 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3461 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3462 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3467 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
3469 # we need to somehow mark which columns came from prefetch
3471 my $sel_end = $#{$attrs->{select}};
3472 $attrs->{_prefetch_selector_range} = [ $sel_end + 1, $sel_end + @prefetch ];
3475 push @{ $attrs->{select} }, (map { $_->[0] } @prefetch);
3476 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3478 push( @{$attrs->{order_by}}, @$prefetch_ordering );
3479 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
3482 # if both page and offset are specified, produce a combined offset
3483 # even though it doesn't make much sense, this is what pre 081xx has
3485 if (my $page = delete $attrs->{page}) {
3487 ($attrs->{rows} * ($page - 1))
3489 ($attrs->{offset} || 0)
3493 return $self->{_attrs} = $attrs;
3497 my ($self, $attr) = @_;
3499 if (ref $attr eq 'HASH') {
3500 return $self->_rollout_hash($attr);
3501 } elsif (ref $attr eq 'ARRAY') {
3502 return $self->_rollout_array($attr);
3508 sub _rollout_array {
3509 my ($self, $attr) = @_;
3512 foreach my $element (@{$attr}) {
3513 if (ref $element eq 'HASH') {
3514 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3515 } elsif (ref $element eq 'ARRAY') {
3516 # XXX - should probably recurse here
3517 push( @rolled_array, @{$self->_rollout_array($element)} );
3519 push( @rolled_array, $element );
3522 return \@rolled_array;
3526 my ($self, $attr) = @_;
3529 foreach my $key (keys %{$attr}) {
3530 push( @rolled_array, { $key => $attr->{$key} } );
3532 return \@rolled_array;
3535 sub _calculate_score {
3536 my ($self, $a, $b) = @_;
3538 if (defined $a xor defined $b) {
3541 elsif (not defined $a) {
3545 if (ref $b eq 'HASH') {
3546 my ($b_key) = keys %{$b};
3547 if (ref $a eq 'HASH') {
3548 my ($a_key) = keys %{$a};
3549 if ($a_key eq $b_key) {
3550 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3555 return ($a eq $b_key) ? 1 : 0;
3558 if (ref $a eq 'HASH') {
3559 my ($a_key) = keys %{$a};
3560 return ($b eq $a_key) ? 1 : 0;
3562 return ($b eq $a) ? 1 : 0;
3567 sub _merge_joinpref_attr {
3568 my ($self, $orig, $import) = @_;
3570 return $import unless defined($orig);
3571 return $orig unless defined($import);
3573 $orig = $self->_rollout_attr($orig);
3574 $import = $self->_rollout_attr($import);
3577 foreach my $import_element ( @{$import} ) {
3578 # find best candidate from $orig to merge $b_element into
3579 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3580 foreach my $orig_element ( @{$orig} ) {
3581 my $score = $self->_calculate_score( $orig_element, $import_element );
3582 if ($score > $best_candidate->{score}) {
3583 $best_candidate->{position} = $position;
3584 $best_candidate->{score} = $score;
3588 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3589 $import_key = '' if not defined $import_key;
3591 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3592 push( @{$orig}, $import_element );
3594 my $orig_best = $orig->[$best_candidate->{position}];
3595 # merge orig_best and b_element together and replace original with merged
3596 if (ref $orig_best ne 'HASH') {
3597 $orig->[$best_candidate->{position}] = $import_element;
3598 } elsif (ref $import_element eq 'HASH') {
3599 my ($key) = keys %{$orig_best};
3600 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3603 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3614 require Hash::Merge;
3615 my $hm = Hash::Merge->new;
3617 $hm->specify_behavior({
3620 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3622 if ($defl xor $defr) {
3623 return [ $defl ? $_[0] : $_[1] ];
3628 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3632 return [$_[0], $_[1]];
3636 return $_[1] if !defined $_[0];
3637 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3638 return [$_[0], @{$_[1]}]
3641 return [] if !defined $_[0] and !keys %{$_[1]};
3642 return [ $_[1] ] if !defined $_[0];
3643 return [ $_[0] ] if !keys %{$_[1]};
3644 return [$_[0], $_[1]]
3649 return $_[0] if !defined $_[1];
3650 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3651 return [@{$_[0]}, $_[1]]
3654 my @ret = @{$_[0]} or return $_[1];
3655 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3656 my %idx = map { $_ => 1 } @ret;
3657 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3661 return [ $_[1] ] if ! @{$_[0]};
3662 return $_[0] if !keys %{$_[1]};
3663 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3664 return [ @{$_[0]}, $_[1] ];
3669 return [] if !keys %{$_[0]} and !defined $_[1];
3670 return [ $_[0] ] if !defined $_[1];
3671 return [ $_[1] ] if !keys %{$_[0]};
3672 return [$_[0], $_[1]]
3675 return [] if !keys %{$_[0]} and !@{$_[1]};
3676 return [ $_[0] ] if !@{$_[1]};
3677 return $_[1] if !keys %{$_[0]};
3678 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3679 return [ $_[0], @{$_[1]} ];
3682 return [] if !keys %{$_[0]} and !keys %{$_[1]};
3683 return [ $_[0] ] if !keys %{$_[1]};
3684 return [ $_[1] ] if !keys %{$_[0]};
3685 return [ $_[0] ] if $_[0] eq $_[1];
3686 return [ $_[0], $_[1] ];
3689 } => 'DBIC_RS_ATTR_MERGER');
3693 return $hm->merge ($_[1], $_[2]);
3697 sub STORABLE_freeze {
3698 my ($self, $cloning) = @_;
3699 my $to_serialize = { %$self };
3701 # A cursor in progress can't be serialized (and would make little sense anyway)
3702 delete $to_serialize->{cursor};
3704 # nor is it sensical to store a not-yet-fired-count pager
3705 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3706 delete $to_serialize->{pager};
3709 Storable::nfreeze($to_serialize);
3712 # need this hook for symmetry
3714 my ($self, $cloning, $serialized) = @_;
3716 %$self = %{ Storable::thaw($serialized) };
3722 =head2 throw_exception
3724 See L<DBIx::Class::Schema/throw_exception> for details.
3728 sub throw_exception {
3731 if (ref $self and my $rsrc = $self->result_source) {
3732 $rsrc->throw_exception(@_)
3735 DBIx::Class::Exception->throw(@_);
3739 # XXX: FIXME: Attributes docs need clearing up
3743 Attributes are used to refine a ResultSet in various ways when
3744 searching for data. They can be passed to any method which takes an
3745 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3748 Default attributes can be set on the result class using
3749 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
3750 the CAVEATS on that feature before using it!)
3752 These are in no particular order:
3758 =item Value: ( $order_by | \@order_by | \%order_by )
3762 Which column(s) to order the results by.
3764 [The full list of suitable values is documented in
3765 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3768 If a single column name, or an arrayref of names is supplied, the
3769 argument is passed through directly to SQL. The hashref syntax allows
3770 for connection-agnostic specification of ordering direction:
3772 For descending order:
3774 order_by => { -desc => [qw/col1 col2 col3/] }
3776 For explicit ascending order:
3778 order_by => { -asc => 'col' }
3780 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3781 supported, although you are strongly encouraged to use the hashref
3782 syntax as outlined above.
3788 =item Value: \@columns
3792 Shortcut to request a particular set of columns to be retrieved. Each
3793 column spec may be a string (a table column name), or a hash (in which
3794 case the key is the C<as> value, and the value is used as the C<select>
3795 expression). Adds C<me.> onto the start of any column without a C<.> in
3796 it and sets C<select> from that, then auto-populates C<as> from
3797 C<select> as normal. (You may also use the C<cols> attribute, as in
3798 earlier versions of DBIC.)
3800 Essentially C<columns> does the same as L</select> and L</as>.
3802 columns => [ 'foo', { bar => 'baz' } ]
3806 select => [qw/foo baz/],
3813 =item Value: \@columns
3817 Indicates additional columns to be selected from storage. Works the same
3818 as L</columns> but adds columns to the selection. (You may also use the
3819 C<include_columns> attribute, as in earlier versions of DBIC). For
3822 $schema->resultset('CD')->search(undef, {
3823 '+columns' => ['artist.name'],
3827 would return all CDs and include a 'name' column to the information
3828 passed to object inflation. Note that the 'artist' is the name of the
3829 column (or relationship) accessor, and 'name' is the name of the column
3830 accessor in the related table.
3832 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
3833 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
3834 unary plus operator before it.
3836 =head2 include_columns
3840 =item Value: \@columns
3844 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3850 =item Value: \@select_columns
3854 Indicates which columns should be selected from the storage. You can use
3855 column names, or in the case of RDBMS back ends, function or stored procedure
3858 $rs = $schema->resultset('Employee')->search(undef, {
3861 { count => 'employeeid' },
3862 { max => { length => 'name' }, -as => 'longest_name' }
3867 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3869 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3870 use L</select>, to instruct DBIx::Class how to store the result of the column.
3871 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3872 identifier aliasing. You can however alias a function, so you can use it in
3873 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3874 attribute> supplied as shown in the example above.
3876 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
3877 Not doing so causes Perl to incorrectly interpret them as a bareword with a
3878 unary plus operator before it.
3884 Indicates additional columns to be selected from storage. Works the same as
3885 L</select> but adds columns to the default selection, instead of specifying
3894 Indicates additional column names for those added via L</+select>. See L</as>.
3902 =item Value: \@inflation_names
3906 Indicates column names for object inflation. That is L</as> indicates the
3907 slot name in which the column value will be stored within the
3908 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3909 identifier by the C<get_column> method (or via the object accessor B<if one
3910 with the same name already exists>) as shown below. The L</as> attribute has
3911 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3913 $rs = $schema->resultset('Employee')->search(undef, {
3916 { count => 'employeeid' },
3917 { max => { length => 'name' }, -as => 'longest_name' }
3926 If the object against which the search is performed already has an accessor
3927 matching a column name specified in C<as>, the value can be retrieved using
3928 the accessor as normal:
3930 my $name = $employee->name();
3932 If on the other hand an accessor does not exist in the object, you need to
3933 use C<get_column> instead:
3935 my $employee_count = $employee->get_column('employee_count');
3937 You can create your own accessors if required - see
3938 L<DBIx::Class::Manual::Cookbook> for details.
3944 =item Value: ($rel_name | \@rel_names | \%rel_names)
3948 Contains a list of relationships that should be joined for this query. For
3951 # Get CDs by Nine Inch Nails
3952 my $rs = $schema->resultset('CD')->search(
3953 { 'artist.name' => 'Nine Inch Nails' },
3954 { join => 'artist' }
3957 Can also contain a hash reference to refer to the other relation's relations.
3960 package MyApp::Schema::Track;
3961 use base qw/DBIx::Class/;
3962 __PACKAGE__->table('track');
3963 __PACKAGE__->add_columns(qw/trackid cd position title/);
3964 __PACKAGE__->set_primary_key('trackid');
3965 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3968 # In your application
3969 my $rs = $schema->resultset('Artist')->search(
3970 { 'track.title' => 'Teardrop' },
3972 join => { cd => 'track' },
3973 order_by => 'artist.name',
3977 You need to use the relationship (not the table) name in conditions,
3978 because they are aliased as such. The current table is aliased as "me", so
3979 you need to use me.column_name in order to avoid ambiguity. For example:
3981 # Get CDs from 1984 with a 'Foo' track
3982 my $rs = $schema->resultset('CD')->search(
3985 'tracks.name' => 'Foo'
3987 { join => 'tracks' }
3990 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3991 similarly for a third time). For e.g.
3993 my $rs = $schema->resultset('Artist')->search({
3994 'cds.title' => 'Down to Earth',
3995 'cds_2.title' => 'Popular',
3997 join => [ qw/cds cds/ ],
4000 will return a set of all artists that have both a cd with title 'Down
4001 to Earth' and a cd with title 'Popular'.
4003 If you want to fetch related objects from other tables as well, see C<prefetch>
4006 NOTE: An internal join-chain pruner will discard certain joins while
4007 constructing the actual SQL query, as long as the joins in question do not
4008 affect the retrieved result. This for example includes 1:1 left joins
4009 that are not part of the restriction specification (WHERE/HAVING) nor are
4010 a part of the query selection.
4012 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4018 =item Value: ($rel_name | \@rel_names | \%rel_names)
4022 Contains one or more relationships that should be fetched along with
4023 the main query (when they are accessed afterwards the data will
4024 already be available, without extra queries to the database). This is
4025 useful for when you know you will need the related objects, because it
4026 saves at least one query:
4028 my $rs = $schema->resultset('Tag')->search(
4037 The initial search results in SQL like the following:
4039 SELECT tag.*, cd.*, artist.* FROM tag
4040 JOIN cd ON tag.cd = cd.cdid
4041 JOIN artist ON cd.artist = artist.artistid
4043 L<DBIx::Class> has no need to go back to the database when we access the
4044 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4047 Simple prefetches will be joined automatically, so there is no need
4048 for a C<join> attribute in the above search.
4050 L</prefetch> can be used with the any of the relationship types and
4051 multiple prefetches can be specified together. Below is a more complex
4052 example that prefetches a CD's artist, its liner notes (if present),
4053 the cover image, the tracks on that cd, and the guests on those
4057 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4058 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4059 My::Schema::CD->has_one( cover_image => 'My::Schema::Artwork' );
4060 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4062 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4064 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4067 my $rs = $schema->resultset('CD')->search(
4071 { artist => 'record_label'}, # belongs_to => belongs_to
4072 'liner_note', # might_have
4073 'cover_image', # has_one
4074 { tracks => 'guests' }, # has_many => has_many
4079 This will produce SQL like the following:
4081 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4085 ON artist.artistid = me.artistid
4086 JOIN record_label record_label
4087 ON record_label.labelid = artist.labelid
4088 LEFT JOIN track tracks
4089 ON tracks.cdid = me.cdid
4090 LEFT JOIN guest guests
4091 ON guests.trackid = track.trackid
4092 LEFT JOIN liner_notes liner_note
4093 ON liner_note.cdid = me.cdid
4094 JOIN cd_artwork cover_image
4095 ON cover_image.cdid = me.cdid
4098 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4099 C<tracks>, and C<guests> of the CD will all be available through the
4100 relationship accessors without the need for additional queries to the
4103 However, there is one caveat to be observed: it can be dangerous to
4104 prefetch more than one L<has_many|DBIx::Class::Relationship/has_many>
4105 relationship on a given level. e.g.:
4107 my $rs = $schema->resultset('CD')->search(
4111 'tracks', # has_many
4112 { cd_to_producer => 'producer' }, # has_many => belongs_to (i.e. m2m)
4117 The collapser currently can't identify duplicate tuples for multiple
4118 L<has_many|DBIx::Class::Relationship/has_many> relationships and as a
4119 result the second L<has_many|DBIx::Class::Relationship/has_many>
4120 relation could contain redundant objects.
4122 =head3 Using L</prefetch> with L</join>
4124 L</prefetch> implies a L</join> with the equivalent argument, and is
4125 properly merged with any existing L</join> specification. So the
4128 my $rs = $schema->resultset('CD')->search(
4129 {'record_label.name' => 'Music Product Ltd.'},
4131 join => {artist => 'record_label'},
4132 prefetch => 'artist',
4136 ... will work, searching on the record label's name, but only
4137 prefetching the C<artist>.
4139 =head3 Using L</prefetch> with L</select> / L</+select> / L</as> / L</+as>
4141 L</prefetch> implies a L</+select>/L</+as> with the fields of the
4142 prefetched relations. So given:
4144 my $rs = $schema->resultset('CD')->search(
4147 select => ['cd.title'],
4149 prefetch => 'artist',
4153 The L</select> becomes: C<'cd.title', 'artist.*'> and the L</as>
4154 becomes: C<'cd_title', 'artist.*'>.
4158 Prefetch does a lot of deep magic. As such, it may not behave exactly
4159 as you might expect.
4165 Prefetch uses the L</cache> to populate the prefetched relationships. This
4166 may or may not be what you want.
4170 If you specify a condition on a prefetched relationship, ONLY those
4171 rows that match the prefetched condition will be fetched into that relationship.
4172 This means that adding prefetch to a search() B<may alter> what is returned by
4173 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4175 my $artist_rs = $schema->resultset('Artist')->search({
4181 my $count = $artist_rs->first->cds->count;
4183 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4185 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4187 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4189 that cmp_ok() may or may not pass depending on the datasets involved. This
4190 behavior may or may not survive the 0.09 transition.
4198 =item Value: $source_alias
4202 Sets the source alias for the query. Normally, this defaults to C<me>, but
4203 nested search queries (sub-SELECTs) might need specific aliases set to
4204 reference inner queries. For example:
4207 ->related_resultset('CDs')
4208 ->related_resultset('Tracks')
4210 'track.id' => { -ident => 'none_search.id' },
4214 my $ids = $self->search({
4217 alias => 'none_search',
4218 group_by => 'none_search.id',
4219 })->get_column('id')->as_query;
4221 $self->search({ id => { -in => $ids } })
4223 This attribute is directly tied to L</current_source_alias>.
4233 Makes the resultset paged and specifies the page to retrieve. Effectively
4234 identical to creating a non-pages resultset and then calling ->page($page)
4237 If L</rows> attribute is not specified it defaults to 10 rows per page.
4239 When you have a paged resultset, L</count> will only return the number
4240 of rows in the page. To get the total, use the L</pager> and call
4241 C<total_entries> on it.
4251 Specifies the maximum number of rows for direct retrieval or the number of
4252 rows per page if the page attribute or method is used.
4258 =item Value: $offset
4262 Specifies the (zero-based) row number for the first row to be returned, or the
4263 of the first row of the first page if paging is used.
4265 =head2 software_limit
4269 =item Value: (0 | 1)
4273 When combined with L</rows> and/or L</offset> the generated SQL will not
4274 include any limit dialect stanzas. Instead the entire result will be selected
4275 as if no limits were specified, and DBIC will perform the limit locally, by
4276 artificially advancing and finishing the resulting L</cursor>.
4278 This is the recommended way of performing resultset limiting when no sane RDBMS
4279 implementation is available (e.g.
4280 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4281 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4287 =item Value: \@columns
4291 A arrayref of columns to group by. Can include columns of joined tables.
4293 group_by => [qw/ column1 column2 ... /]
4299 =item Value: $condition
4303 HAVING is a select statement attribute that is applied between GROUP BY and
4304 ORDER BY. It is applied to the after the grouping calculations have been
4307 having => { 'count_employee' => { '>=', 100 } }
4309 or with an in-place function in which case literal SQL is required:
4311 having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4317 =item Value: (0 | 1)
4321 Set to 1 to group by all columns. If the resultset already has a group_by
4322 attribute, this setting is ignored and an appropriate warning is issued.
4328 Adds to the WHERE clause.
4330 # only return rows WHERE deleted IS NULL for all searches
4331 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4333 Can be overridden by passing C<< { where => undef } >> as an attribute
4336 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4342 Set to 1 to cache search results. This prevents extra SQL queries if you
4343 revisit rows in your ResultSet:
4345 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4347 while( my $artist = $resultset->next ) {
4351 $rs->first; # without cache, this would issue a query
4353 By default, searches are not cached.
4355 For more examples of using these attributes, see
4356 L<DBIx::Class::Manual::Cookbook>.
4362 =item Value: ( 'update' | 'shared' | \$scalar )
4366 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4367 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4370 =head1 DBIC BIND VALUES
4372 Because DBIC may need more information to bind values than just the column name
4373 and value itself, it uses a special format for both passing and receiving bind
4374 values. Each bind value should be composed of an arrayref of
4375 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4381 If present (in any form), this is what is being passed directly to bind_param.
4382 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4383 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4385 If this is specified, all other bind options described below are ignored.
4389 If present, this is used to infer the actual bind attribute by passing to
4390 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4391 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4393 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4394 currently drivers are expected to "Do the Right Thing" when given a common
4395 datatype name. (Not ideal, but that's what we got at this point.)
4399 Currently used to correctly allocate buffers for bind_param_inout().
4400 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4401 or to a sensible value based on the "data_type".
4405 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4406 explicitly specified they are never overriden). Also used by some weird DBDs,
4407 where the column name should be available at bind_param time (e.g. Oracle).
4411 For backwards compatibility and convenience, the following shortcuts are
4414 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4415 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4416 [ undef, $val ] === [ {}, $val ]
4418 =head1 AUTHOR AND CONTRIBUTORS
4420 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
4424 You may distribute this code under the same terms as Perl itself.