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 my $attrs = $self->_resolved_attrs_copy;
995 return $self->{cursor}
996 ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
997 $attrs->{where},$attrs);
1004 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1006 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1010 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1012 Inflates the first result without creating a cursor if the resultset has
1013 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1016 While this method can take an optional search condition (just like L</search>)
1017 being a fast-code-path it does not recognize search attributes. If you need to
1018 add extra joins or similar, call L</search> and then chain-call L</single> on the
1019 L<DBIx::Class::ResultSet> returned.
1025 As of 0.08100, this method enforces the assumption that the preceding
1026 query returns only one row. If more than one row is returned, you will receive
1029 Query returned more than one row
1031 In this case, you should be using L</next> or L</find> instead, or if you really
1032 know what you are doing, use the L</rows> attribute to explicitly limit the size
1035 This method will also throw an exception if it is called on a resultset prefetching
1036 has_many, as such a prefetch implies fetching multiple rows from the database in
1037 order to assemble the resulting object.
1044 my ($self, $where) = @_;
1046 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1049 my $attrs = $self->_resolved_attrs_copy;
1051 if (keys %{$attrs->{collapse}}) {
1052 $self->throw_exception(
1053 'single() can not be used on resultsets prefetching has_many. Use find( \%cond ) or next() instead'
1058 if (defined $attrs->{where}) {
1061 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1062 $where, delete $attrs->{where} ]
1065 $attrs->{where} = $where;
1069 my @data = $self->result_source->storage->select_single(
1070 $attrs->{from}, $attrs->{select},
1071 $attrs->{where}, $attrs
1074 return (@data ? ($self->_construct_object(@data))[0] : undef);
1080 # Recursively collapse the query, accumulating values for each column.
1082 sub _collapse_query {
1083 my ($self, $query, $collapsed) = @_;
1087 if (ref $query eq 'ARRAY') {
1088 foreach my $subquery (@$query) {
1089 next unless ref $subquery; # -or
1090 $collapsed = $self->_collapse_query($subquery, $collapsed);
1093 elsif (ref $query eq 'HASH') {
1094 if (keys %$query and (keys %$query)[0] eq '-and') {
1095 foreach my $subquery (@{$query->{-and}}) {
1096 $collapsed = $self->_collapse_query($subquery, $collapsed);
1100 foreach my $col (keys %$query) {
1101 my $value = $query->{$col};
1102 $collapsed->{$col}{$value}++;
1114 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1116 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1120 my $max_length = $rs->get_column('length')->max;
1122 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1127 my ($self, $column) = @_;
1128 my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1136 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1138 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1142 # WHERE title LIKE '%blue%'
1143 $cd_rs = $rs->search_like({ title => '%blue%'});
1145 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1146 that this is simply a convenience method retained for ex Class::DBI users.
1147 You most likely want to use L</search> with specific operators.
1149 For more information, see L<DBIx::Class::Manual::Cookbook>.
1151 This method is deprecated and will be removed in 0.09. Use L</search()>
1152 instead. An example conversion is:
1154 ->search_like({ foo => 'bar' });
1158 ->search({ foo => { like => 'bar' } });
1165 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1166 .' Instead use ->search({ x => { -like => "y%" } })'
1167 .' (note the outer pair of {}s - they are important!)'
1169 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1170 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1171 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1172 return $class->search($query, { %$attrs });
1179 =item Arguments: $first, $last
1181 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1185 Returns a resultset or object list representing a subset of elements from the
1186 resultset slice is called on. Indexes are from 0, i.e., to get the first
1187 three records, call:
1189 my ($one, $two, $three) = $rs->slice(0, 2);
1194 my ($self, $min, $max) = @_;
1195 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1196 $attrs->{offset} = $self->{attrs}{offset} || 0;
1197 $attrs->{offset} += $min;
1198 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1199 return $self->search(undef, $attrs);
1200 #my $slice = (ref $self)->new($self->result_source, $attrs);
1201 #return (wantarray ? $slice->all : $slice);
1208 =item Arguments: none
1210 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1214 Returns the next element in the resultset (C<undef> is there is none).
1216 Can be used to efficiently iterate over records in the resultset:
1218 my $rs = $schema->resultset('CD')->search;
1219 while (my $cd = $rs->next) {
1223 Note that you need to store the resultset object, and call C<next> on it.
1224 Calling C<< resultset('Table')->next >> repeatedly will always return the
1225 first record from the resultset.
1231 if (my $cache = $self->get_cache) {
1232 $self->{all_cache_position} ||= 0;
1233 return $cache->[$self->{all_cache_position}++];
1235 if ($self->{attrs}{cache}) {
1236 delete $self->{pager};
1237 $self->{all_cache_position} = 1;
1238 return ($self->all)[0];
1240 if ($self->{stashed_objects}) {
1241 my $obj = shift(@{$self->{stashed_objects}});
1242 delete $self->{stashed_objects} unless @{$self->{stashed_objects}};
1246 exists $self->{stashed_row}
1247 ? @{delete $self->{stashed_row}}
1248 : $self->cursor->next
1250 return undef unless (@row);
1251 my ($row, @more) = $self->_construct_object(@row);
1252 $self->{stashed_objects} = \@more if @more;
1256 sub _construct_object {
1257 my ($self, @row) = @_;
1259 my $info = $self->_collapse_result($self->{_attrs}{as}, \@row)
1261 my @new = $self->result_class->inflate_result($self->result_source, @$info);
1262 @new = $self->{_attrs}{record_filter}->(@new)
1263 if exists $self->{_attrs}{record_filter};
1267 sub _collapse_result {
1268 my ($self, $as_proto, $row) = @_;
1272 # 'foo' => [ undef, 'foo' ]
1273 # 'foo.bar' => [ 'foo', 'bar' ]
1274 # 'foo.bar.baz' => [ 'foo.bar', 'baz' ]
1276 my @construct_as = map { [ (/^(?:(.*)\.)?([^.]+)$/) ] } @$as_proto;
1278 my %collapse = %{$self->{_attrs}{collapse}||{}};
1282 # if we're doing collapsing (has_many prefetch) we need to grab records
1283 # until the PK changes, so fill @pri_index. if not, we leave it empty so
1284 # we know we don't have to bother.
1286 # the reason for not using the collapse stuff directly is because if you
1287 # had for e.g. two artists in a row with no cds, the collapse info for
1288 # both would be NULL (undef) so you'd lose the second artist
1290 # store just the index so we can check the array positions from the row
1291 # without having to contruct the full hash
1293 if (keys %collapse) {
1294 my %pri = map { ($_ => 1) } $self->result_source->_pri_cols;
1295 foreach my $i (0 .. $#construct_as) {
1296 next if defined($construct_as[$i][0]); # only self table
1297 if (delete $pri{$construct_as[$i][1]}) {
1298 push(@pri_index, $i);
1300 last unless keys %pri; # short circuit (Johnny Five Is Alive!)
1304 # no need to do an if, it'll be empty if @pri_index is empty anyway
1306 my %pri_vals = map { ($_ => $copy[$_]) } @pri_index;
1310 do { # no need to check anything at the front, we always want the first row
1314 foreach my $this_as (@construct_as) {
1315 $const{$this_as->[0]||''}{$this_as->[1]} = shift(@copy);
1318 push(@const_rows, \%const);
1320 } until ( # no pri_index => no collapse => drop straight out
1323 do { # get another row, stash it, drop out if different PK
1325 @copy = $self->cursor->next;
1326 $self->{stashed_row} = \@copy;
1328 # last thing in do block, counts as true if anything doesn't match
1330 # check xor defined first for NULL vs. NOT NULL then if one is
1331 # defined the other must be so check string equality
1334 (defined $pri_vals{$_} ^ defined $copy[$_])
1335 || (defined $pri_vals{$_} && ($pri_vals{$_} ne $copy[$_]))
1340 my $alias = $self->{attrs}{alias};
1347 foreach my $const (@const_rows) {
1348 scalar @const_keys or do {
1349 @const_keys = sort { length($a) <=> length($b) } keys %$const;
1351 foreach my $key (@const_keys) {
1354 my @parts = split(/\./, $key);
1356 my $data = $const->{$key};
1357 foreach my $p (@parts) {
1358 $target = $target->[1]->{$p} ||= [];
1360 if ($cur eq ".${key}" && (my @ckey = @{$collapse{$cur}||[]})) {
1361 # collapsing at this point and on final part
1362 my $pos = $collapse_pos{$cur};
1363 CK: foreach my $ck (@ckey) {
1364 if (!defined $pos->{$ck} || $pos->{$ck} ne $data->{$ck}) {
1365 $collapse_pos{$cur} = $data;
1366 delete @collapse_pos{ # clear all positioning for sub-entries
1367 grep { m/^\Q${cur}.\E/ } keys %collapse_pos
1374 if (exists $collapse{$cur}) {
1375 $target = $target->[-1];
1378 $target->[0] = $data;
1380 $info->[0] = $const->{$key};
1388 =head2 result_source
1392 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1394 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1398 An accessor for the primary ResultSource object from which this ResultSet
1405 =item Arguments: $result_class?
1407 =item Return Value: $result_class
1411 An accessor for the class to use when creating result objects. Defaults to
1412 C<< result_source->result_class >> - which in most cases is the name of the
1413 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1415 Note that changing the result_class will also remove any components
1416 that were originally loaded in the source class via
1417 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1418 in the original source class will not run.
1423 my ($self, $result_class) = @_;
1424 if ($result_class) {
1425 unless (ref $result_class) { # don't fire this for an object
1426 $self->ensure_class_loaded($result_class);
1428 $self->_result_class($result_class);
1429 # THIS LINE WOULD BE A BUG - this accessor specifically exists to
1430 # permit the user to set result class on one result set only; it only
1431 # chains if provided to search()
1432 #$self->{attrs}{result_class} = $result_class if ref $self;
1434 $self->_result_class;
1441 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1443 =item Return Value: $count
1447 Performs an SQL C<COUNT> with the same query as the resultset was built
1448 with to find the number of elements. Passing arguments is equivalent to
1449 C<< $rs->search ($cond, \%attrs)->count >>
1455 return $self->search(@_)->count if @_ and defined $_[0];
1456 return scalar @{ $self->get_cache } if $self->get_cache;
1458 my $attrs = $self->_resolved_attrs_copy;
1460 # this is a little optimization - it is faster to do the limit
1461 # adjustments in software, instead of a subquery
1462 my $rows = delete $attrs->{rows};
1463 my $offset = delete $attrs->{offset};
1466 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1467 $crs = $self->_count_subq_rs ($attrs);
1470 $crs = $self->_count_rs ($attrs);
1472 my $count = $crs->next;
1474 $count -= $offset if $offset;
1475 $count = $rows if $rows and $rows < $count;
1476 $count = 0 if ($count < 0);
1485 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1487 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1491 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1492 This can be very handy for subqueries:
1494 ->search( { amount => $some_rs->count_rs->as_query } )
1496 As with regular resultsets the SQL query will be executed only after
1497 the resultset is accessed via L</next> or L</all>. That would return
1498 the same single value obtainable via L</count>.
1504 return $self->search(@_)->count_rs if @_;
1506 # this may look like a lack of abstraction (count() does about the same)
1507 # but in fact an _rs *must* use a subquery for the limits, as the
1508 # software based limiting can not be ported if this $rs is to be used
1509 # in a subquery itself (i.e. ->as_query)
1510 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1511 return $self->_count_subq_rs;
1514 return $self->_count_rs;
1519 # returns a ResultSetColumn object tied to the count query
1522 my ($self, $attrs) = @_;
1524 my $rsrc = $self->result_source;
1525 $attrs ||= $self->_resolved_attrs;
1527 my $tmp_attrs = { %$attrs };
1528 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1529 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1531 # overwrite the selector (supplied by the storage)
1532 $tmp_attrs->{select} = $rsrc->storage->_count_select ($rsrc, $attrs);
1533 $tmp_attrs->{as} = 'count';
1534 delete @{$tmp_attrs}{qw/columns/};
1536 my $tmp_rs = $rsrc->resultset_class->new($rsrc, $tmp_attrs)->get_column ('count');
1542 # same as above but uses a subquery
1544 sub _count_subq_rs {
1545 my ($self, $attrs) = @_;
1547 my $rsrc = $self->result_source;
1548 $attrs ||= $self->_resolved_attrs;
1550 my $sub_attrs = { %$attrs };
1551 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1552 delete @{$sub_attrs}{qw/collapse columns as select _prefetch_selector_range order_by for/};
1554 # if we multi-prefetch we group_by something unique, as this is what we would
1555 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1556 if ( keys %{$attrs->{collapse}} ) {
1557 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1558 $rsrc->_identifying_column_set || $self->throw_exception(
1559 'Unable to construct a unique group_by criteria properly collapsing the '
1560 . 'has_many prefetch before count()'
1565 # Calculate subquery selector
1566 if (my $g = $sub_attrs->{group_by}) {
1568 my $sql_maker = $rsrc->storage->sql_maker;
1570 # necessary as the group_by may refer to aliased functions
1572 for my $sel (@{$attrs->{select}}) {
1573 $sel_index->{$sel->{-as}} = $sel
1574 if (ref $sel eq 'HASH' and $sel->{-as});
1577 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1578 # also look for named aggregates referred in the having clause
1579 # having often contains scalarrefs - thus parse it out entirely
1581 if ($attrs->{having}) {
1582 local $sql_maker->{having_bind};
1583 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1584 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1585 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1586 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1587 # if we don't unset it we screw up retarded but unfortunately working
1588 # 'MAX(foo.bar)' => { '>', 3 }
1589 $sql_maker->{name_sep} = '';
1592 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1594 my $sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1596 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1597 # and if all fails for an utterly naive quoted scalar-with-function
1599 $rquote $sep $lquote (.+?) $rquote
1601 [\s,] \w+ \. (\w+) [\s,]
1603 [\s,] $lquote (.+?) $rquote [\s,]
1605 push @parts, ($1 || $2 || $3); # one of them matched if we got here
1610 my $colpiece = $sel_index->{$_} || $_;
1612 # unqualify join-based group_by's. Arcane but possible query
1613 # also horrible horrible hack to alias a column (not a func.)
1614 # (probably need to introduce SQLA syntax)
1615 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1618 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1620 push @{$sub_attrs->{select}}, $colpiece;
1624 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1625 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1628 return $rsrc->resultset_class
1629 ->new ($rsrc, $sub_attrs)
1631 ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1632 ->get_column ('count');
1639 =head2 count_literal
1641 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1642 should only be used in that context. See L</search_literal> for further info.
1646 =item Arguments: $sql_fragment, @standalone_bind_values
1648 =item Return Value: $count
1652 Counts the results in a literal query. Equivalent to calling L</search_literal>
1653 with the passed arguments, then L</count>.
1657 sub count_literal { shift->search_literal(@_)->count; }
1663 =item Arguments: none
1665 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1669 Returns all elements in the resultset.
1676 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1679 return @{ $self->get_cache } if $self->get_cache;
1683 if (keys %{$self->_resolved_attrs->{collapse}}) {
1684 # Using $self->cursor->all is really just an optimisation.
1685 # If we're collapsing has_many prefetches it probably makes
1686 # very little difference, and this is cleaner than hacking
1687 # _construct_object to survive the approach
1688 $self->cursor->reset;
1689 my @row = $self->cursor->next;
1691 push(@obj, $self->_construct_object(@row));
1692 @row = (exists $self->{stashed_row}
1693 ? @{delete $self->{stashed_row}}
1694 : $self->cursor->next);
1697 @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
1700 $self->set_cache(\@obj) if $self->{attrs}{cache};
1709 =item Arguments: none
1711 =item Return Value: $self
1715 Resets the resultset's cursor, so you can iterate through the elements again.
1716 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1723 delete $self->{_attrs} if exists $self->{_attrs};
1724 $self->{all_cache_position} = 0;
1725 $self->cursor->reset;
1733 =item Arguments: none
1735 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1739 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1740 an object for the first result (or C<undef> if the resultset is empty).
1745 return $_[0]->reset->next;
1751 # Determines whether and what type of subquery is required for the $rs operation.
1752 # If grouping is necessary either supplies its own, or verifies the current one
1753 # After all is done delegates to the proper storage method.
1755 sub _rs_update_delete {
1756 my ($self, $op, $values) = @_;
1758 my $cond = $self->{cond};
1759 my $rsrc = $self->result_source;
1760 my $storage = $rsrc->schema->storage;
1762 my $attrs = { %{$self->_resolved_attrs} };
1764 my $existing_group_by = delete $attrs->{group_by};
1765 my $needs_subq = defined $existing_group_by;
1767 # simplify the joinmap and maybe decide if a subquery is necessary
1768 my $relation_classifications = {};
1770 if (ref($attrs->{from}) eq 'ARRAY') {
1771 # if we already know we need a subq, no point of classifying relations
1772 if (!$needs_subq and @{$attrs->{from}} > 1) {
1773 $attrs->{from} = $storage->_prune_unused_joins ($attrs->{from}, $attrs->{select}, $cond, $attrs);
1775 $relation_classifications = $storage->_resolve_aliastypes_from_select_args (
1776 [ @{$attrs->{from}}[1 .. $#{$attrs->{from}}] ],
1784 $needs_subq ||= 1; # if {from} is unparseable assume the worst
1787 # do we need anything like a subquery?
1791 ! keys %{ $relation_classifications->{restricting} || {} }
1793 ! $self->_has_resolved_attr(qw/rows offset/) # limits call for a subq
1795 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1796 # a condition containing 'me' or other table prefixes will not work
1797 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1799 my $sqla = $rsrc->storage->sql_maker;
1800 local $sqla->{_dequalify_idents} = 1;
1801 \[ $sqla->_recurse_where($self->{cond}) ];
1803 return $rsrc->storage->$op(
1805 $op eq 'update' ? $values : (),
1810 # we got this far - means it is time to wrap a subquery
1811 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1813 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1819 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1820 delete $attrs->{$_} for qw/collapse _collapse_order_by select _prefetch_selector_range as/;
1821 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1822 $attrs->{group_by} = \ ''; # FIXME - this is an evil hack, it causes the optimiser to kick in and throw away the LEFT joins
1823 my $subrs = (ref $self)->new($rsrc, $attrs);
1825 if (@$idcols == 1) {
1826 return $storage->$op (
1828 $op eq 'update' ? $values : (),
1829 { $idcols->[0] => { -in => $subrs->as_query } },
1832 elsif ($storage->_use_multicolumn_in) {
1833 # This is hideously ugly, but SQLA does not understand multicol IN expressions
1834 my $sql_maker = $storage->sql_maker;
1835 my ($sql, @bind) = @${$subrs->as_query};
1836 $sql = sprintf ('(%s) IN %s', # the as_query already comes with a set of parenthesis
1837 join (', ', map { $sql_maker->_quote ($_) } @$idcols),
1841 return $storage->$op (
1843 $op eq 'update' ? $values : (),
1849 # if all else fails - get all primary keys and operate over a ORed set
1850 # wrap in a transaction for consistency
1851 # this is where the group_by starts to matter
1855 keys %{ $relation_classifications->{multiplying} || {} }
1857 # make sure if there is a supplied group_by it matches the columns compiled above
1858 # perfectly. Anything else can not be sanely executed on most databases so croak
1859 # right then and there
1860 if ($existing_group_by) {
1861 my @current_group_by = map
1862 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1867 join ("\x00", sort @current_group_by)
1869 join ("\x00", sort @{$attrs->{columns}} )
1871 $self->throw_exception (
1872 "You have just attempted a $op operation on a resultset which does group_by"
1873 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1874 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1875 . ' kind of queries. Please retry the operation with a modified group_by or'
1876 . ' without using one at all.'
1881 $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
1884 my $guard = $storage->txn_scope_guard;
1887 for my $row ($subrs->cursor->all) {
1888 push @op_condition, { map
1889 { $idcols->[$_] => $row->[$_] }
1894 my $res = $storage->$op (
1896 $op eq 'update' ? $values : (),
1910 =item Arguments: \%values
1912 =item Return Value: $underlying_storage_rv
1916 Sets the specified columns in the resultset to the supplied values in a
1917 single query. Note that this will not run any accessor/set_column/update
1918 triggers, nor will it update any result object instances derived from this
1919 resultset (this includes the contents of the L<resultset cache|/set_cache>
1920 if any). See L</update_all> if you need to execute any on-update
1921 triggers or cascades defined either by you or a
1922 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1924 The return value is a pass through of what the underlying
1925 storage backend returned, and may vary. See L<DBI/execute> for the most
1930 Note that L</update> does not process/deflate any of the values passed in.
1931 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
1932 ensure manually that any value passed to this method will stringify to
1933 something the RDBMS knows how to deal with. A notable example is the
1934 handling of L<DateTime> objects, for more info see:
1935 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
1940 my ($self, $values) = @_;
1941 $self->throw_exception('Values for update must be a hash')
1942 unless ref $values eq 'HASH';
1944 return $self->_rs_update_delete ('update', $values);
1951 =item Arguments: \%values
1953 =item Return Value: 1
1957 Fetches all objects and updates them one at a time via
1958 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
1959 triggers, while L</update> will not.
1964 my ($self, $values) = @_;
1965 $self->throw_exception('Values for update_all must be a hash')
1966 unless ref $values eq 'HASH';
1968 my $guard = $self->result_source->schema->txn_scope_guard;
1969 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
1978 =item Arguments: none
1980 =item Return Value: $underlying_storage_rv
1984 Deletes the rows matching this resultset in a single query. Note that this
1985 will not run any delete triggers, nor will it alter the
1986 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
1987 derived from this resultset (this includes the contents of the
1988 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
1989 execute any on-delete triggers or cascades defined either by you or a
1990 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
1992 The return value is a pass through of what the underlying storage backend
1993 returned, and may vary. See L<DBI/execute> for the most common case.
1999 $self->throw_exception('delete does not accept any arguments')
2002 return $self->_rs_update_delete ('delete');
2009 =item Arguments: none
2011 =item Return Value: 1
2015 Fetches all objects and deletes them one at a time via
2016 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2017 triggers, while L</delete> will not.
2023 $self->throw_exception('delete_all does not accept any arguments')
2026 my $guard = $self->result_source->schema->txn_scope_guard;
2027 $_->delete for $self->all;
2036 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2038 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2042 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2049 The context of this method call has an important effect on what is
2050 submitted to storage. In void context data is fed directly to fastpath
2051 insertion routines provided by the underlying storage (most often
2052 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2053 L<insert|DBIx::Class::Row/insert> calls on the
2054 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2055 augmentation of these methods provided by components. For example if you
2056 are using something like L<DBIx::Class::UUIDColumns> to create primary
2057 keys for you, you will find that your PKs are empty. In this case you
2058 will have to explicitly force scalar or list context in order to create
2063 In non-void (scalar or list) context, this method is simply a wrapper
2064 for L</create>. Depending on list or scalar context either a list of
2065 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2066 containing these objects is returned.
2068 When supplying data in "arrayref of arrayrefs" invocation style, the
2069 first element should be a list of column names and each subsequent
2070 element should be a data value in the earlier specified column order.
2073 $Arstist_rs->populate([
2074 [ qw( artistid name ) ],
2075 [ 100, 'A Formally Unknown Singer' ],
2076 [ 101, 'A singer that jumped the shark two albums ago' ],
2077 [ 102, 'An actually cool singer' ],
2080 For the arrayref of hashrefs style each hashref should be a structure
2081 suitable for passing to L</create>. Multi-create is also permitted with
2084 $schema->resultset("Artist")->populate([
2085 { artistid => 4, name => 'Manufactured Crap', cds => [
2086 { title => 'My First CD', year => 2006 },
2087 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2090 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2091 { title => 'My parents sold me to a record company', year => 2005 },
2092 { title => 'Why Am I So Ugly?', year => 2006 },
2093 { title => 'I Got Surgery and am now Popular', year => 2007 }
2098 If you attempt a void-context multi-create as in the example above (each
2099 Artist also has the related list of CDs), and B<do not> supply the
2100 necessary autoinc foreign key information, this method will proxy to the
2101 less efficient L</create>, and then throw the Result objects away. In this
2102 case there are obviously no benefits to using this method over L</create>.
2109 # cruft placed in standalone method
2110 my $data = $self->_normalize_populate_args(@_);
2112 return unless @$data;
2114 if(defined wantarray) {
2116 foreach my $item (@$data) {
2117 push(@created, $self->create($item));
2119 return wantarray ? @created : \@created;
2122 my $first = $data->[0];
2124 # if a column is a registered relationship, and is a non-blessed hash/array, consider
2125 # it relationship data
2126 my (@rels, @columns);
2127 my $rsrc = $self->result_source;
2128 my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2129 for (keys %$first) {
2130 my $ref = ref $first->{$_};
2131 $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2137 my @pks = $rsrc->primary_columns;
2139 ## do the belongs_to relationships
2140 foreach my $index (0..$#$data) {
2142 # delegate to create() for any dataset without primary keys with specified relationships
2143 if (grep { !defined $data->[$index]->{$_} } @pks ) {
2145 if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) { # a related set must be a HASH or AoH
2146 my @ret = $self->populate($data);
2152 foreach my $rel (@rels) {
2153 next unless ref $data->[$index]->{$rel} eq "HASH";
2154 my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2155 my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2156 my $related = $result->result_source->_resolve_condition(
2157 $reverse_relinfo->{cond},
2163 delete $data->[$index]->{$rel};
2164 $data->[$index] = {%{$data->[$index]}, %$related};
2166 push @columns, keys %$related if $index == 0;
2170 ## inherit the data locked in the conditions of the resultset
2171 my ($rs_data) = $self->_merge_with_rscond({});
2172 delete @{$rs_data}{@columns};
2173 my @inherit_cols = keys %$rs_data;
2174 my @inherit_data = values %$rs_data;
2176 ## do bulk insert on current row
2177 $rsrc->storage->insert_bulk(
2179 [@columns, @inherit_cols],
2180 [ map { [ @$_{@columns}, @inherit_data ] } @$data ],
2183 ## do the has_many relationships
2184 foreach my $item (@$data) {
2188 foreach my $rel (@rels) {
2189 next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2191 $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2193 my $child = $main_row->$rel;
2195 my $related = $child->result_source->_resolve_condition(
2196 $rels->{$rel}{cond},
2202 my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2203 my @populate = map { {%$_, %$related} } @rows_to_add;
2205 $child->populate( \@populate );
2212 # populate() argumnets went over several incarnations
2213 # What we ultimately support is AoH
2214 sub _normalize_populate_args {
2215 my ($self, $arg) = @_;
2217 if (ref $arg eq 'ARRAY') {
2221 elsif (ref $arg->[0] eq 'HASH') {
2224 elsif (ref $arg->[0] eq 'ARRAY') {
2226 my @colnames = @{$arg->[0]};
2227 foreach my $values (@{$arg}[1 .. $#$arg]) {
2228 push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2234 $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2241 =item Arguments: none
2243 =item Return Value: L<$pager|Data::Page>
2247 Returns a L<Data::Page> object for the current resultset. Only makes
2248 sense for queries with a C<page> attribute.
2250 To get the full count of entries for a paged resultset, call
2251 C<total_entries> on the L<Data::Page> object.
2258 return $self->{pager} if $self->{pager};
2260 my $attrs = $self->{attrs};
2261 if (!defined $attrs->{page}) {
2262 $self->throw_exception("Can't create pager for non-paged rs");
2264 elsif ($attrs->{page} <= 0) {
2265 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2267 $attrs->{rows} ||= 10;
2269 # throw away the paging flags and re-run the count (possibly
2270 # with a subselect) to get the real total count
2271 my $count_attrs = { %$attrs };
2272 delete $count_attrs->{$_} for qw/rows offset page pager/;
2274 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2276 require DBIx::Class::ResultSet::Pager;
2277 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2278 sub { $total_rs->count }, #lazy-get the total
2280 $self->{attrs}{page},
2288 =item Arguments: $page_number
2290 =item Return Value: L<$resultset|/search>
2294 Returns a resultset for the $page_number page of the resultset on which page
2295 is called, where each page contains a number of rows equal to the 'rows'
2296 attribute set on the resultset (10 by default).
2301 my ($self, $page) = @_;
2302 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2309 =item Arguments: \%col_data
2311 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2315 Creates a new result object in the resultset's result class and returns
2316 it. The row is not inserted into the database at this point, call
2317 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2318 will tell you whether the result object has been inserted or not.
2320 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2325 my ($self, $values) = @_;
2327 $self->throw_exception( "new_result takes only one argument - a hashref of values" )
2330 $self->throw_exception( "new_result expects a hashref" )
2331 unless (ref $values eq 'HASH');
2333 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2337 @$cols_from_relations
2338 ? (-cols_from_relations => $cols_from_relations)
2340 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2343 return $self->result_class->new(\%new);
2346 # _merge_with_rscond
2348 # Takes a simple hash of K/V data and returns its copy merged with the
2349 # condition already present on the resultset. Additionally returns an
2350 # arrayref of value/condition names, which were inferred from related
2351 # objects (this is needed for in-memory related objects)
2352 sub _merge_with_rscond {
2353 my ($self, $data) = @_;
2355 my (%new_data, @cols_from_relations);
2357 my $alias = $self->{attrs}{alias};
2359 if (! defined $self->{cond}) {
2360 # just massage $data below
2362 elsif ($self->{cond} eq $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION) {
2363 %new_data = %{ $self->{attrs}{related_objects} || {} }; # nothing might have been inserted yet
2364 @cols_from_relations = keys %new_data;
2366 elsif (ref $self->{cond} ne 'HASH') {
2367 $self->throw_exception(
2368 "Can't abstract implicit construct, resultset condition not a hash"
2372 # precendence must be given to passed values over values inherited from
2373 # the cond, so the order here is important.
2374 my $collapsed_cond = $self->_collapse_cond($self->{cond});
2375 my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2377 while ( my($col, $value) = each %implied ) {
2378 my $vref = ref $value;
2384 (keys %$value)[0] eq '='
2386 $new_data{$col} = $value->{'='};
2388 elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2389 $new_data{$col} = $value;
2396 %{ $self->_remove_alias($data, $alias) },
2399 return (\%new_data, \@cols_from_relations);
2402 # _has_resolved_attr
2404 # determines if the resultset defines at least one
2405 # of the attributes supplied
2407 # used to determine if a subquery is neccessary
2409 # supports some virtual attributes:
2411 # This will scan for any joins being present on the resultset.
2412 # It is not a mere key-search but a deep inspection of {from}
2415 sub _has_resolved_attr {
2416 my ($self, @attr_names) = @_;
2418 my $attrs = $self->_resolved_attrs;
2422 for my $n (@attr_names) {
2423 if (grep { $n eq $_ } (qw/-join/) ) {
2424 $extra_checks{$n}++;
2428 my $attr = $attrs->{$n};
2430 next if not defined $attr;
2432 if (ref $attr eq 'HASH') {
2433 return 1 if keys %$attr;
2435 elsif (ref $attr eq 'ARRAY') {
2443 # a resolved join is expressed as a multi-level from
2445 $extra_checks{-join}
2447 ref $attrs->{from} eq 'ARRAY'
2449 @{$attrs->{from}} > 1
2457 # Recursively collapse the condition.
2459 sub _collapse_cond {
2460 my ($self, $cond, $collapsed) = @_;
2464 if (ref $cond eq 'ARRAY') {
2465 foreach my $subcond (@$cond) {
2466 next unless ref $subcond; # -or
2467 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2470 elsif (ref $cond eq 'HASH') {
2471 if (keys %$cond and (keys %$cond)[0] eq '-and') {
2472 foreach my $subcond (@{$cond->{-and}}) {
2473 $collapsed = $self->_collapse_cond($subcond, $collapsed);
2477 foreach my $col (keys %$cond) {
2478 my $value = $cond->{$col};
2479 $collapsed->{$col} = $value;
2489 # Remove the specified alias from the specified query hash. A copy is made so
2490 # the original query is not modified.
2493 my ($self, $query, $alias) = @_;
2495 my %orig = %{ $query || {} };
2498 foreach my $key (keys %orig) {
2500 $unaliased{$key} = $orig{$key};
2503 $unaliased{$1} = $orig{$key}
2504 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2514 =item Arguments: none
2516 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2520 Returns the SQL query and bind vars associated with the invocant.
2522 This is generally used as the RHS for a subquery.
2529 my $attrs = $self->_resolved_attrs_copy;
2534 # my ($sql, \@bind, \%dbi_bind_attrs) = _select_args_to_query (...)
2535 # $sql also has no wrapping parenthesis in list ctx
2537 my $sqlbind = $self->result_source->storage
2538 ->_select_args_to_query ($attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs);
2547 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2549 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2553 my $artist = $schema->resultset('Artist')->find_or_new(
2554 { artist => 'fred' }, { key => 'artists' });
2556 $cd->cd_to_producer->find_or_new({ producer => $producer },
2557 { key => 'primary });
2559 Find an existing record from this resultset using L</find>. if none exists,
2560 instantiate a new result object and return it. The object will not be saved
2561 into your storage until you call L<DBIx::Class::Row/insert> on it.
2563 You most likely want this method when looking for existing rows using a unique
2564 constraint that is not the primary key, or looking for related rows.
2566 If you want objects to be saved immediately, use L</find_or_create> instead.
2568 B<Note>: Make sure to read the documentation of L</find> and understand the
2569 significance of the C<key> attribute, as its lack may skew your search, and
2570 subsequently result in spurious new objects.
2572 B<Note>: Take care when using C<find_or_new> with a table having
2573 columns with default values that you intend to be automatically
2574 supplied by the database (e.g. an auto_increment primary key column).
2575 In normal usage, the value of such columns should NOT be included at
2576 all in the call to C<find_or_new>, even when set to C<undef>.
2582 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2583 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2584 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2587 return $self->new_result($hash);
2594 =item Arguments: \%col_data
2596 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2600 Attempt to create a single new row or a row with multiple related rows
2601 in the table represented by the resultset (and related tables). This
2602 will not check for duplicate rows before inserting, use
2603 L</find_or_create> to do that.
2605 To create one row for this resultset, pass a hashref of key/value
2606 pairs representing the columns of the table and the values you wish to
2607 store. If the appropriate relationships are set up, foreign key fields
2608 can also be passed an object representing the foreign row, and the
2609 value will be set to its primary key.
2611 To create related objects, pass a hashref of related-object column values
2612 B<keyed on the relationship name>. If the relationship is of type C<multi>
2613 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2614 The process will correctly identify columns holding foreign keys, and will
2615 transparently populate them from the keys of the corresponding relation.
2616 This can be applied recursively, and will work correctly for a structure
2617 with an arbitrary depth and width, as long as the relationships actually
2618 exists and the correct column data has been supplied.
2620 Instead of hashrefs of plain related data (key/value pairs), you may
2621 also pass new or inserted objects. New objects (not inserted yet, see
2622 L</new_result>), will be inserted into their appropriate tables.
2624 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2626 Example of creating a new row.
2628 $person_rs->create({
2629 name=>"Some Person",
2630 email=>"somebody@someplace.com"
2633 Example of creating a new row and also creating rows in a related C<has_many>
2634 or C<has_one> resultset. Note Arrayref.
2637 { artistid => 4, name => 'Manufactured Crap', cds => [
2638 { title => 'My First CD', year => 2006 },
2639 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2644 Example of creating a new row and also creating a row in a related
2645 C<belongs_to> resultset. Note Hashref.
2648 title=>"Music for Silly Walks",
2651 name=>"Silly Musician",
2659 When subclassing ResultSet never attempt to override this method. Since
2660 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2661 lot of the internals simply never call it, so your override will be
2662 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2663 or L<DBIx::Class::Row/insert> depending on how early in the
2664 L</create> process you need to intervene. See also warning pertaining to
2672 my ($self, $attrs) = @_;
2673 $self->throw_exception( "create needs a hashref" )
2674 unless ref $attrs eq 'HASH';
2675 return $self->new_result($attrs)->insert;
2678 =head2 find_or_create
2682 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2684 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2688 $cd->cd_to_producer->find_or_create({ producer => $producer },
2689 { key => 'primary' });
2691 Tries to find a record based on its primary key or unique constraints; if none
2692 is found, creates one and returns that instead.
2694 my $cd = $schema->resultset('CD')->find_or_create({
2696 artist => 'Massive Attack',
2697 title => 'Mezzanine',
2701 Also takes an optional C<key> attribute, to search by a specific key or unique
2702 constraint. For example:
2704 my $cd = $schema->resultset('CD')->find_or_create(
2706 artist => 'Massive Attack',
2707 title => 'Mezzanine',
2709 { key => 'cd_artist_title' }
2712 B<Note>: Make sure to read the documentation of L</find> and understand the
2713 significance of the C<key> attribute, as its lack may skew your search, and
2714 subsequently result in spurious row creation.
2716 B<Note>: Because find_or_create() reads from the database and then
2717 possibly inserts based on the result, this method is subject to a race
2718 condition. Another process could create a record in the table after
2719 the find has completed and before the create has started. To avoid
2720 this problem, use find_or_create() inside a transaction.
2722 B<Note>: Take care when using C<find_or_create> with a table having
2723 columns with default values that you intend to be automatically
2724 supplied by the database (e.g. an auto_increment primary key column).
2725 In normal usage, the value of such columns should NOT be included at
2726 all in the call to C<find_or_create>, even when set to C<undef>.
2728 See also L</find> and L</update_or_create>. For information on how to declare
2729 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2731 If you need to know if an existing row was found or a new one created use
2732 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2733 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2736 my $cd = $schema->resultset('CD')->find_or_new({
2738 artist => 'Massive Attack',
2739 title => 'Mezzanine',
2743 if( !$cd->in_storage ) {
2750 sub find_or_create {
2752 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2753 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2754 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2757 return $self->create($hash);
2760 =head2 update_or_create
2764 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2766 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2770 $resultset->update_or_create({ col => $val, ... });
2772 Like L</find_or_create>, but if a row is found it is immediately updated via
2773 C<< $found_row->update (\%col_data) >>.
2776 Takes an optional C<key> attribute to search on a specific unique constraint.
2779 # In your application
2780 my $cd = $schema->resultset('CD')->update_or_create(
2782 artist => 'Massive Attack',
2783 title => 'Mezzanine',
2786 { key => 'cd_artist_title' }
2789 $cd->cd_to_producer->update_or_create({
2790 producer => $producer,
2796 B<Note>: Make sure to read the documentation of L</find> and understand the
2797 significance of the C<key> attribute, as its lack may skew your search, and
2798 subsequently result in spurious row creation.
2800 B<Note>: Take care when using C<update_or_create> with a table having
2801 columns with default values that you intend to be automatically
2802 supplied by the database (e.g. an auto_increment primary key column).
2803 In normal usage, the value of such columns should NOT be included at
2804 all in the call to C<update_or_create>, even when set to C<undef>.
2806 See also L</find> and L</find_or_create>. For information on how to declare
2807 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2809 If you need to know if an existing row was updated or a new one created use
2810 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2811 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2816 sub update_or_create {
2818 my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2819 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2821 my $row = $self->find($cond, $attrs);
2823 $row->update($cond);
2827 return $self->create($cond);
2830 =head2 update_or_new
2834 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2836 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2840 $resultset->update_or_new({ col => $val, ... });
2842 Like L</find_or_new> but if a row is found it is immediately updated via
2843 C<< $found_row->update (\%col_data) >>.
2847 # In your application
2848 my $cd = $schema->resultset('CD')->update_or_new(
2850 artist => 'Massive Attack',
2851 title => 'Mezzanine',
2854 { key => 'cd_artist_title' }
2857 if ($cd->in_storage) {
2858 # the cd was updated
2861 # the cd is not yet in the database, let's insert it
2865 B<Note>: Make sure to read the documentation of L</find> and understand the
2866 significance of the C<key> attribute, as its lack may skew your search, and
2867 subsequently result in spurious new objects.
2869 B<Note>: Take care when using C<update_or_new> with a table having
2870 columns with default values that you intend to be automatically
2871 supplied by the database (e.g. an auto_increment primary key column).
2872 In normal usage, the value of such columns should NOT be included at
2873 all in the call to C<update_or_new>, even when set to C<undef>.
2875 See also L</find>, L</find_or_create> and L</find_or_new>.
2881 my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
2882 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2884 my $row = $self->find( $cond, $attrs );
2885 if ( defined $row ) {
2886 $row->update($cond);
2890 return $self->new_result($cond);
2897 =item Arguments: none
2899 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
2903 Gets the contents of the cache for the resultset, if the cache is set.
2905 The cache is populated either by using the L</prefetch> attribute to
2906 L</search> or by calling L</set_cache>.
2918 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2920 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
2924 Sets the contents of the cache for the resultset. Expects an arrayref
2925 of objects of the same class as those produced by the resultset. Note that
2926 if the cache is set, the resultset will return the cached objects rather
2927 than re-querying the database even if the cache attr is not set.
2929 The contents of the cache can also be populated by using the
2930 L</prefetch> attribute to L</search>.
2935 my ( $self, $data ) = @_;
2936 $self->throw_exception("set_cache requires an arrayref")
2937 if defined($data) && (ref $data ne 'ARRAY');
2938 $self->{all_cache} = $data;
2945 =item Arguments: none
2947 =item Return Value: undef
2951 Clears the cache for the resultset.
2956 shift->set_cache(undef);
2963 =item Arguments: none
2965 =item Return Value: true, if the resultset has been paginated
2973 return !!$self->{attrs}{page};
2980 =item Arguments: none
2982 =item Return Value: true, if the resultset has been ordered with C<order_by>.
2990 return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
2993 =head2 related_resultset
2997 =item Arguments: $rel_name
2999 =item Return Value: L<$resultset|/search>
3003 Returns a related resultset for the supplied relationship name.
3005 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3009 sub related_resultset {
3010 my ($self, $rel) = @_;
3012 $self->{related_resultsets} ||= {};
3013 return $self->{related_resultsets}{$rel} ||= do {
3014 my $rsrc = $self->result_source;
3015 my $rel_info = $rsrc->relationship_info($rel);
3017 $self->throw_exception(
3018 "search_related: result source '" . $rsrc->source_name .
3019 "' has no such relationship $rel")
3022 my $attrs = $self->_chain_relationship($rel);
3024 my $join_count = $attrs->{seen_join}{$rel};
3026 my $alias = $self->result_source->storage
3027 ->relname_to_table_alias($rel, $join_count);
3029 # since this is search_related, and we already slid the select window inwards
3030 # (the select/as attrs were deleted in the beginning), we need to flip all
3031 # left joins to inner, so we get the expected results
3032 # read the comment on top of the actual function to see what this does
3033 $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3036 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3037 delete @{$attrs}{qw(result_class alias)};
3041 if (my $cache = $self->get_cache) {
3042 if ($cache->[0] && $cache->[0]->related_resultset($rel)->get_cache) {
3043 $new_cache = [ map { @{$_->related_resultset($rel)->get_cache} }
3048 my $rel_source = $rsrc->related_source($rel);
3052 # The reason we do this now instead of passing the alias to the
3053 # search_rs below is that if you wrap/overload resultset on the
3054 # source you need to know what alias it's -going- to have for things
3055 # to work sanely (e.g. RestrictWithObject wants to be able to add
3056 # extra query restrictions, and these may need to be $alias.)
3058 my $rel_attrs = $rel_source->resultset_attributes;
3059 local $rel_attrs->{alias} = $alias;
3061 $rel_source->resultset
3065 where => $attrs->{where},
3068 $new->set_cache($new_cache) if $new_cache;
3073 =head2 current_source_alias
3077 =item Arguments: none
3079 =item Return Value: $source_alias
3083 Returns the current table alias for the result source this resultset is built
3084 on, that will be used in the SQL query. Usually it is C<me>.
3086 Currently the source alias that refers to the result set returned by a
3087 L</search>/L</find> family method depends on how you got to the resultset: it's
3088 C<me> by default, but eg. L</search_related> aliases it to the related result
3089 source name (and keeps C<me> referring to the original result set). The long
3090 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3091 (and make this method unnecessary).
3093 Thus it's currently necessary to use this method in predefined queries (see
3094 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3095 source alias of the current result set:
3097 # in a result set class
3099 my ($self, $user) = @_;
3101 my $me = $self->current_source_alias;
3103 return $self->search({
3104 "$me.modified" => $user->id,
3110 sub current_source_alias {
3113 return ($self->{attrs} || {})->{alias} || 'me';
3116 =head2 as_subselect_rs
3120 =item Arguments: none
3122 =item Return Value: L<$resultset|/search>
3126 Act as a barrier to SQL symbols. The resultset provided will be made into a
3127 "virtual view" by including it as a subquery within the from clause. From this
3128 point on, any joined tables are inaccessible to ->search on the resultset (as if
3129 it were simply where-filtered without joins). For example:
3131 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3133 # 'x' now pollutes the query namespace
3135 # So the following works as expected
3136 my $ok_rs = $rs->search({'x.other' => 1});
3138 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3139 # def) we look for one row with contradictory terms and join in another table
3140 # (aliased 'x_2') which we never use
3141 my $broken_rs = $rs->search({'x.name' => 'def'});
3143 my $rs2 = $rs->as_subselect_rs;
3145 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3146 my $not_joined_rs = $rs2->search({'x.other' => 1});
3148 # works as expected: finds a 'table' row related to two x rows (abc and def)
3149 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3151 Another example of when one might use this would be to select a subset of
3152 columns in a group by clause:
3154 my $rs = $schema->resultset('Bar')->search(undef, {
3155 group_by => [qw{ id foo_id baz_id }],
3156 })->as_subselect_rs->search(undef, {
3157 columns => [qw{ id foo_id }]
3160 In the above example normally columns would have to be equal to the group by,
3161 but because we isolated the group by into a subselect the above works.
3165 sub as_subselect_rs {
3168 my $attrs = $self->_resolved_attrs;
3170 my $fresh_rs = (ref $self)->new (
3171 $self->result_source
3174 # these pieces will be locked in the subquery
3175 delete $fresh_rs->{cond};
3176 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3178 return $fresh_rs->search( {}, {
3180 $attrs->{alias} => $self->as_query,
3181 -alias => $attrs->{alias},
3182 -rsrc => $self->result_source,
3184 alias => $attrs->{alias},
3188 # This code is called by search_related, and makes sure there
3189 # is clear separation between the joins before, during, and
3190 # after the relationship. This information is needed later
3191 # in order to properly resolve prefetch aliases (any alias
3192 # with a relation_chain_depth less than the depth of the
3193 # current prefetch is not considered)
3195 # The increments happen twice per join. An even number means a
3196 # relationship specified via a search_related, whereas an odd
3197 # number indicates a join/prefetch added via attributes
3199 # Also this code will wrap the current resultset (the one we
3200 # chain to) in a subselect IFF it contains limiting attributes
3201 sub _chain_relationship {
3202 my ($self, $rel) = @_;
3203 my $source = $self->result_source;
3204 my $attrs = { %{$self->{attrs}||{}} };
3206 # we need to take the prefetch the attrs into account before we
3207 # ->_resolve_join as otherwise they get lost - captainL
3208 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3210 delete @{$attrs}{qw/join prefetch collapse group_by distinct select as columns +select +as +columns/};
3212 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3215 my @force_subq_attrs = qw/offset rows group_by having/;
3218 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3220 $self->_has_resolved_attr (@force_subq_attrs)
3222 # Nuke the prefetch (if any) before the new $rs attrs
3223 # are resolved (prefetch is useless - we are wrapping
3224 # a subquery anyway).
3225 my $rs_copy = $self->search;
3226 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3227 $rs_copy->{attrs}{join},
3228 delete $rs_copy->{attrs}{prefetch},
3233 -alias => $attrs->{alias},
3234 $attrs->{alias} => $rs_copy->as_query,
3236 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3237 $seen->{-relation_chain_depth} = 0;
3239 elsif ($attrs->{from}) { #shallow copy suffices
3240 $from = [ @{$attrs->{from}} ];
3245 -alias => $attrs->{alias},
3246 $attrs->{alias} => $source->from,
3250 my $jpath = ($seen->{-relation_chain_depth})
3251 ? $from->[-1][0]{-join_path}
3254 my @requested_joins = $source->_resolve_join(
3261 push @$from, @requested_joins;
3263 $seen->{-relation_chain_depth}++;
3265 # if $self already had a join/prefetch specified on it, the requested
3266 # $rel might very well be already included. What we do in this case
3267 # is effectively a no-op (except that we bump up the chain_depth on
3268 # the join in question so we could tell it *is* the search_related)
3271 # we consider the last one thus reverse
3272 for my $j (reverse @requested_joins) {
3273 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3274 if ($rel eq $last_j) {
3275 $j->[0]{-relation_chain_depth}++;
3281 unless ($already_joined) {
3282 push @$from, $source->_resolve_join(
3290 $seen->{-relation_chain_depth}++;
3292 return {%$attrs, from => $from, seen_join => $seen};
3295 # too many times we have to do $attrs = { %{$self->_resolved_attrs} }
3296 sub _resolved_attrs_copy {
3298 return { %{$self->_resolved_attrs (@_)} };
3301 sub _resolved_attrs {
3303 return $self->{_attrs} if $self->{_attrs};
3305 my $attrs = { %{ $self->{attrs} || {} } };
3306 my $source = $self->result_source;
3307 my $alias = $attrs->{alias};
3309 # default selection list
3310 $attrs->{columns} = [ $source->columns ]
3311 unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3313 # merge selectors together
3314 for (qw/columns select as/) {
3315 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3316 if $attrs->{$_} or $attrs->{"+$_"};
3319 # disassemble columns
3321 if (my $cols = delete $attrs->{columns}) {
3322 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3323 if (ref $c eq 'HASH') {
3324 for my $as (sort keys %$c) {
3325 push @sel, $c->{$as};
3336 # when trying to weed off duplicates later do not go past this point -
3337 # everything added from here on is unbalanced "anyone's guess" stuff
3338 my $dedup_stop_idx = $#as;
3340 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3342 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3343 if $attrs->{select};
3345 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3347 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_";
3350 # disqualify all $alias.col as-bits (collapser mandated)
3352 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_;
3355 # de-duplicate the result (remove *identical* select/as pairs)
3356 # and also die on duplicate {as} pointing to different {select}s
3357 # not using a c-style for as the condition is prone to shrinkage
3360 while ($i <= $dedup_stop_idx) {
3361 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3366 elsif ($seen->{$as[$i]}++) {
3367 $self->throw_exception(
3368 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3376 $attrs->{select} = \@sel;
3377 $attrs->{as} = \@as;
3379 $attrs->{from} ||= [{
3381 -alias => $self->{attrs}{alias},
3382 $self->{attrs}{alias} => $source->from,
3385 if ( $attrs->{join} || $attrs->{prefetch} ) {
3387 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3388 if ref $attrs->{from} ne 'ARRAY';
3390 my $join = (delete $attrs->{join}) || {};
3392 if ( defined $attrs->{prefetch} ) {
3393 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3396 $attrs->{from} = # have to copy here to avoid corrupting the original
3398 @{ $attrs->{from} },
3399 $source->_resolve_join(
3402 { %{ $attrs->{seen_join} || {} } },
3403 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3404 ? $attrs->{from}[-1][0]{-join_path}
3411 if ( defined $attrs->{order_by} ) {
3412 $attrs->{order_by} = (
3413 ref( $attrs->{order_by} ) eq 'ARRAY'
3414 ? [ @{ $attrs->{order_by} } ]
3415 : [ $attrs->{order_by} || () ]
3419 if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3420 $attrs->{group_by} = [ $attrs->{group_by} ];
3423 # generate the distinct induced group_by early, as prefetch will be carried via a
3424 # subquery (since a group_by is present)
3425 if (delete $attrs->{distinct}) {
3426 if ($attrs->{group_by}) {
3427 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3430 # distinct affects only the main selection part, not what prefetch may
3432 $attrs->{group_by} = $source->storage->_group_over_selection (
3440 $attrs->{collapse} ||= {};
3441 if ($attrs->{prefetch}) {
3443 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3444 if $attrs->{_dark_selector};
3446 my $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} );
3448 my $prefetch_ordering = [];
3450 # this is a separate structure (we don't look in {from} directly)
3451 # as the resolver needs to shift things off the lists to work
3452 # properly (identical-prefetches on different branches)
3454 if (ref $attrs->{from} eq 'ARRAY') {
3456 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3458 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3459 next unless $j->[0]{-alias};
3460 next unless $j->[0]{-join_path};
3461 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3463 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3466 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3467 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3472 $source->_resolve_prefetch( $prefetch, $alias, $join_map, $prefetch_ordering, $attrs->{collapse} );
3474 # we need to somehow mark which columns came from prefetch
3476 my $sel_end = $#{$attrs->{select}};
3477 $attrs->{_prefetch_selector_range} = [ $sel_end + 1, $sel_end + @prefetch ];
3480 push @{ $attrs->{select} }, (map { $_->[0] } @prefetch);
3481 push @{ $attrs->{as} }, (map { $_->[1] } @prefetch);
3483 push( @{$attrs->{order_by}}, @$prefetch_ordering );
3484 $attrs->{_collapse_order_by} = \@$prefetch_ordering;
3487 # if both page and offset are specified, produce a combined offset
3488 # even though it doesn't make much sense, this is what pre 081xx has
3490 if (my $page = delete $attrs->{page}) {
3492 ($attrs->{rows} * ($page - 1))
3494 ($attrs->{offset} || 0)
3498 return $self->{_attrs} = $attrs;
3502 my ($self, $attr) = @_;
3504 if (ref $attr eq 'HASH') {
3505 return $self->_rollout_hash($attr);
3506 } elsif (ref $attr eq 'ARRAY') {
3507 return $self->_rollout_array($attr);
3513 sub _rollout_array {
3514 my ($self, $attr) = @_;
3517 foreach my $element (@{$attr}) {
3518 if (ref $element eq 'HASH') {
3519 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3520 } elsif (ref $element eq 'ARRAY') {
3521 # XXX - should probably recurse here
3522 push( @rolled_array, @{$self->_rollout_array($element)} );
3524 push( @rolled_array, $element );
3527 return \@rolled_array;
3531 my ($self, $attr) = @_;
3534 foreach my $key (keys %{$attr}) {
3535 push( @rolled_array, { $key => $attr->{$key} } );
3537 return \@rolled_array;
3540 sub _calculate_score {
3541 my ($self, $a, $b) = @_;
3543 if (defined $a xor defined $b) {
3546 elsif (not defined $a) {
3550 if (ref $b eq 'HASH') {
3551 my ($b_key) = keys %{$b};
3552 if (ref $a eq 'HASH') {
3553 my ($a_key) = keys %{$a};
3554 if ($a_key eq $b_key) {
3555 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3560 return ($a eq $b_key) ? 1 : 0;
3563 if (ref $a eq 'HASH') {
3564 my ($a_key) = keys %{$a};
3565 return ($b eq $a_key) ? 1 : 0;
3567 return ($b eq $a) ? 1 : 0;
3572 sub _merge_joinpref_attr {
3573 my ($self, $orig, $import) = @_;
3575 return $import unless defined($orig);
3576 return $orig unless defined($import);
3578 $orig = $self->_rollout_attr($orig);
3579 $import = $self->_rollout_attr($import);
3582 foreach my $import_element ( @{$import} ) {
3583 # find best candidate from $orig to merge $b_element into
3584 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3585 foreach my $orig_element ( @{$orig} ) {
3586 my $score = $self->_calculate_score( $orig_element, $import_element );
3587 if ($score > $best_candidate->{score}) {
3588 $best_candidate->{position} = $position;
3589 $best_candidate->{score} = $score;
3593 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3594 $import_key = '' if not defined $import_key;
3596 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3597 push( @{$orig}, $import_element );
3599 my $orig_best = $orig->[$best_candidate->{position}];
3600 # merge orig_best and b_element together and replace original with merged
3601 if (ref $orig_best ne 'HASH') {
3602 $orig->[$best_candidate->{position}] = $import_element;
3603 } elsif (ref $import_element eq 'HASH') {
3604 my ($key) = keys %{$orig_best};
3605 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3608 $seen_keys->{$import_key} = 1; # don't merge the same key twice
3619 require Hash::Merge;
3620 my $hm = Hash::Merge->new;
3622 $hm->specify_behavior({
3625 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3627 if ($defl xor $defr) {
3628 return [ $defl ? $_[0] : $_[1] ];
3633 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3637 return [$_[0], $_[1]];
3641 return $_[1] if !defined $_[0];
3642 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3643 return [$_[0], @{$_[1]}]
3646 return [] if !defined $_[0] and !keys %{$_[1]};
3647 return [ $_[1] ] if !defined $_[0];
3648 return [ $_[0] ] if !keys %{$_[1]};
3649 return [$_[0], $_[1]]
3654 return $_[0] if !defined $_[1];
3655 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3656 return [@{$_[0]}, $_[1]]
3659 my @ret = @{$_[0]} or return $_[1];
3660 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3661 my %idx = map { $_ => 1 } @ret;
3662 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3666 return [ $_[1] ] if ! @{$_[0]};
3667 return $_[0] if !keys %{$_[1]};
3668 return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3669 return [ @{$_[0]}, $_[1] ];
3674 return [] if !keys %{$_[0]} and !defined $_[1];
3675 return [ $_[0] ] if !defined $_[1];
3676 return [ $_[1] ] if !keys %{$_[0]};
3677 return [$_[0], $_[1]]
3680 return [] if !keys %{$_[0]} and !@{$_[1]};
3681 return [ $_[0] ] if !@{$_[1]};
3682 return $_[1] if !keys %{$_[0]};
3683 return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3684 return [ $_[0], @{$_[1]} ];
3687 return [] if !keys %{$_[0]} and !keys %{$_[1]};
3688 return [ $_[0] ] if !keys %{$_[1]};
3689 return [ $_[1] ] if !keys %{$_[0]};
3690 return [ $_[0] ] if $_[0] eq $_[1];
3691 return [ $_[0], $_[1] ];
3694 } => 'DBIC_RS_ATTR_MERGER');
3698 return $hm->merge ($_[1], $_[2]);
3702 sub STORABLE_freeze {
3703 my ($self, $cloning) = @_;
3704 my $to_serialize = { %$self };
3706 # A cursor in progress can't be serialized (and would make little sense anyway)
3707 delete $to_serialize->{cursor};
3709 # nor is it sensical to store a not-yet-fired-count pager
3710 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3711 delete $to_serialize->{pager};
3714 Storable::nfreeze($to_serialize);
3717 # need this hook for symmetry
3719 my ($self, $cloning, $serialized) = @_;
3721 %$self = %{ Storable::thaw($serialized) };
3727 =head2 throw_exception
3729 See L<DBIx::Class::Schema/throw_exception> for details.
3733 sub throw_exception {
3736 if (ref $self and my $rsrc = $self->result_source) {
3737 $rsrc->throw_exception(@_)
3740 DBIx::Class::Exception->throw(@_);
3744 # XXX: FIXME: Attributes docs need clearing up
3748 Attributes are used to refine a ResultSet in various ways when
3749 searching for data. They can be passed to any method which takes an
3750 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3753 Default attributes can be set on the result class using
3754 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
3755 the CAVEATS on that feature before using it!)
3757 These are in no particular order:
3763 =item Value: ( $order_by | \@order_by | \%order_by )
3767 Which column(s) to order the results by.
3769 [The full list of suitable values is documented in
3770 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3773 If a single column name, or an arrayref of names is supplied, the
3774 argument is passed through directly to SQL. The hashref syntax allows
3775 for connection-agnostic specification of ordering direction:
3777 For descending order:
3779 order_by => { -desc => [qw/col1 col2 col3/] }
3781 For explicit ascending order:
3783 order_by => { -asc => 'col' }
3785 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3786 supported, although you are strongly encouraged to use the hashref
3787 syntax as outlined above.
3793 =item Value: \@columns
3797 Shortcut to request a particular set of columns to be retrieved. Each
3798 column spec may be a string (a table column name), or a hash (in which
3799 case the key is the C<as> value, and the value is used as the C<select>
3800 expression). Adds C<me.> onto the start of any column without a C<.> in
3801 it and sets C<select> from that, then auto-populates C<as> from
3802 C<select> as normal. (You may also use the C<cols> attribute, as in
3803 earlier versions of DBIC.)
3805 Essentially C<columns> does the same as L</select> and L</as>.
3807 columns => [ 'foo', { bar => 'baz' } ]
3811 select => [qw/foo baz/],
3818 =item Value: \@columns
3822 Indicates additional columns to be selected from storage. Works the same
3823 as L</columns> but adds columns to the selection. (You may also use the
3824 C<include_columns> attribute, as in earlier versions of DBIC). For
3827 $schema->resultset('CD')->search(undef, {
3828 '+columns' => ['artist.name'],
3832 would return all CDs and include a 'name' column to the information
3833 passed to object inflation. Note that the 'artist' is the name of the
3834 column (or relationship) accessor, and 'name' is the name of the column
3835 accessor in the related table.
3837 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
3838 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
3839 unary plus operator before it.
3841 =head2 include_columns
3845 =item Value: \@columns
3849 Deprecated. Acts as a synonym for L</+columns> for backward compatibility.
3855 =item Value: \@select_columns
3859 Indicates which columns should be selected from the storage. You can use
3860 column names, or in the case of RDBMS back ends, function or stored procedure
3863 $rs = $schema->resultset('Employee')->search(undef, {
3866 { count => 'employeeid' },
3867 { max => { length => 'name' }, -as => 'longest_name' }
3872 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
3874 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
3875 use L</select>, to instruct DBIx::Class how to store the result of the column.
3876 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
3877 identifier aliasing. You can however alias a function, so you can use it in
3878 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
3879 attribute> supplied as shown in the example above.
3881 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
3882 Not doing so causes Perl to incorrectly interpret them as a bareword with a
3883 unary plus operator before it.
3889 Indicates additional columns to be selected from storage. Works the same as
3890 L</select> but adds columns to the default selection, instead of specifying
3899 Indicates additional column names for those added via L</+select>. See L</as>.
3907 =item Value: \@inflation_names
3911 Indicates column names for object inflation. That is L</as> indicates the
3912 slot name in which the column value will be stored within the
3913 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
3914 identifier by the C<get_column> method (or via the object accessor B<if one
3915 with the same name already exists>) as shown below. The L</as> attribute has
3916 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
3918 $rs = $schema->resultset('Employee')->search(undef, {
3921 { count => 'employeeid' },
3922 { max => { length => 'name' }, -as => 'longest_name' }
3931 If the object against which the search is performed already has an accessor
3932 matching a column name specified in C<as>, the value can be retrieved using
3933 the accessor as normal:
3935 my $name = $employee->name();
3937 If on the other hand an accessor does not exist in the object, you need to
3938 use C<get_column> instead:
3940 my $employee_count = $employee->get_column('employee_count');
3942 You can create your own accessors if required - see
3943 L<DBIx::Class::Manual::Cookbook> for details.
3949 =item Value: ($rel_name | \@rel_names | \%rel_names)
3953 Contains a list of relationships that should be joined for this query. For
3956 # Get CDs by Nine Inch Nails
3957 my $rs = $schema->resultset('CD')->search(
3958 { 'artist.name' => 'Nine Inch Nails' },
3959 { join => 'artist' }
3962 Can also contain a hash reference to refer to the other relation's relations.
3965 package MyApp::Schema::Track;
3966 use base qw/DBIx::Class/;
3967 __PACKAGE__->table('track');
3968 __PACKAGE__->add_columns(qw/trackid cd position title/);
3969 __PACKAGE__->set_primary_key('trackid');
3970 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
3973 # In your application
3974 my $rs = $schema->resultset('Artist')->search(
3975 { 'track.title' => 'Teardrop' },
3977 join => { cd => 'track' },
3978 order_by => 'artist.name',
3982 You need to use the relationship (not the table) name in conditions,
3983 because they are aliased as such. The current table is aliased as "me", so
3984 you need to use me.column_name in order to avoid ambiguity. For example:
3986 # Get CDs from 1984 with a 'Foo' track
3987 my $rs = $schema->resultset('CD')->search(
3990 'tracks.name' => 'Foo'
3992 { join => 'tracks' }
3995 If the same join is supplied twice, it will be aliased to <rel>_2 (and
3996 similarly for a third time). For e.g.
3998 my $rs = $schema->resultset('Artist')->search({
3999 'cds.title' => 'Down to Earth',
4000 'cds_2.title' => 'Popular',
4002 join => [ qw/cds cds/ ],
4005 will return a set of all artists that have both a cd with title 'Down
4006 to Earth' and a cd with title 'Popular'.
4008 If you want to fetch related objects from other tables as well, see C<prefetch>
4011 NOTE: An internal join-chain pruner will discard certain joins while
4012 constructing the actual SQL query, as long as the joins in question do not
4013 affect the retrieved result. This for example includes 1:1 left joins
4014 that are not part of the restriction specification (WHERE/HAVING) nor are
4015 a part of the query selection.
4017 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4023 =item Value: ($rel_name | \@rel_names | \%rel_names)
4027 Contains one or more relationships that should be fetched along with
4028 the main query (when they are accessed afterwards the data will
4029 already be available, without extra queries to the database). This is
4030 useful for when you know you will need the related objects, because it
4031 saves at least one query:
4033 my $rs = $schema->resultset('Tag')->search(
4042 The initial search results in SQL like the following:
4044 SELECT tag.*, cd.*, artist.* FROM tag
4045 JOIN cd ON tag.cd = cd.cdid
4046 JOIN artist ON cd.artist = artist.artistid
4048 L<DBIx::Class> has no need to go back to the database when we access the
4049 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4052 Simple prefetches will be joined automatically, so there is no need
4053 for a C<join> attribute in the above search.
4055 L</prefetch> can be used with the any of the relationship types and
4056 multiple prefetches can be specified together. Below is a more complex
4057 example that prefetches a CD's artist, its liner notes (if present),
4058 the cover image, the tracks on that cd, and the guests on those
4062 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4063 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4064 My::Schema::CD->has_one( cover_image => 'My::Schema::Artwork' );
4065 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4067 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4069 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4072 my $rs = $schema->resultset('CD')->search(
4076 { artist => 'record_label'}, # belongs_to => belongs_to
4077 'liner_note', # might_have
4078 'cover_image', # has_one
4079 { tracks => 'guests' }, # has_many => has_many
4084 This will produce SQL like the following:
4086 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4090 ON artist.artistid = me.artistid
4091 JOIN record_label record_label
4092 ON record_label.labelid = artist.labelid
4093 LEFT JOIN track tracks
4094 ON tracks.cdid = me.cdid
4095 LEFT JOIN guest guests
4096 ON guests.trackid = track.trackid
4097 LEFT JOIN liner_notes liner_note
4098 ON liner_note.cdid = me.cdid
4099 JOIN cd_artwork cover_image
4100 ON cover_image.cdid = me.cdid
4103 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4104 C<tracks>, and C<guests> of the CD will all be available through the
4105 relationship accessors without the need for additional queries to the
4108 However, there is one caveat to be observed: it can be dangerous to
4109 prefetch more than one L<has_many|DBIx::Class::Relationship/has_many>
4110 relationship on a given level. e.g.:
4112 my $rs = $schema->resultset('CD')->search(
4116 'tracks', # has_many
4117 { cd_to_producer => 'producer' }, # has_many => belongs_to (i.e. m2m)
4122 The collapser currently can't identify duplicate tuples for multiple
4123 L<has_many|DBIx::Class::Relationship/has_many> relationships and as a
4124 result the second L<has_many|DBIx::Class::Relationship/has_many>
4125 relation could contain redundant objects.
4127 =head3 Using L</prefetch> with L</join>
4129 L</prefetch> implies a L</join> with the equivalent argument, and is
4130 properly merged with any existing L</join> specification. So the
4133 my $rs = $schema->resultset('CD')->search(
4134 {'record_label.name' => 'Music Product Ltd.'},
4136 join => {artist => 'record_label'},
4137 prefetch => 'artist',
4141 ... will work, searching on the record label's name, but only
4142 prefetching the C<artist>.
4144 =head3 Using L</prefetch> with L</select> / L</+select> / L</as> / L</+as>
4146 L</prefetch> implies a L</+select>/L</+as> with the fields of the
4147 prefetched relations. So given:
4149 my $rs = $schema->resultset('CD')->search(
4152 select => ['cd.title'],
4154 prefetch => 'artist',
4158 The L</select> becomes: C<'cd.title', 'artist.*'> and the L</as>
4159 becomes: C<'cd_title', 'artist.*'>.
4163 Prefetch does a lot of deep magic. As such, it may not behave exactly
4164 as you might expect.
4170 Prefetch uses the L</cache> to populate the prefetched relationships. This
4171 may or may not be what you want.
4175 If you specify a condition on a prefetched relationship, ONLY those
4176 rows that match the prefetched condition will be fetched into that relationship.
4177 This means that adding prefetch to a search() B<may alter> what is returned by
4178 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4180 my $artist_rs = $schema->resultset('Artist')->search({
4186 my $count = $artist_rs->first->cds->count;
4188 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4190 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4192 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4194 that cmp_ok() may or may not pass depending on the datasets involved. This
4195 behavior may or may not survive the 0.09 transition.
4203 =item Value: $source_alias
4207 Sets the source alias for the query. Normally, this defaults to C<me>, but
4208 nested search queries (sub-SELECTs) might need specific aliases set to
4209 reference inner queries. For example:
4212 ->related_resultset('CDs')
4213 ->related_resultset('Tracks')
4215 'track.id' => { -ident => 'none_search.id' },
4219 my $ids = $self->search({
4222 alias => 'none_search',
4223 group_by => 'none_search.id',
4224 })->get_column('id')->as_query;
4226 $self->search({ id => { -in => $ids } })
4228 This attribute is directly tied to L</current_source_alias>.
4238 Makes the resultset paged and specifies the page to retrieve. Effectively
4239 identical to creating a non-pages resultset and then calling ->page($page)
4242 If L</rows> attribute is not specified it defaults to 10 rows per page.
4244 When you have a paged resultset, L</count> will only return the number
4245 of rows in the page. To get the total, use the L</pager> and call
4246 C<total_entries> on it.
4256 Specifies the maximum number of rows for direct retrieval or the number of
4257 rows per page if the page attribute or method is used.
4263 =item Value: $offset
4267 Specifies the (zero-based) row number for the first row to be returned, or the
4268 of the first row of the first page if paging is used.
4270 =head2 software_limit
4274 =item Value: (0 | 1)
4278 When combined with L</rows> and/or L</offset> the generated SQL will not
4279 include any limit dialect stanzas. Instead the entire result will be selected
4280 as if no limits were specified, and DBIC will perform the limit locally, by
4281 artificially advancing and finishing the resulting L</cursor>.
4283 This is the recommended way of performing resultset limiting when no sane RDBMS
4284 implementation is available (e.g.
4285 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4286 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4292 =item Value: \@columns
4296 A arrayref of columns to group by. Can include columns of joined tables.
4298 group_by => [qw/ column1 column2 ... /]
4304 =item Value: $condition
4308 HAVING is a select statement attribute that is applied between GROUP BY and
4309 ORDER BY. It is applied to the after the grouping calculations have been
4312 having => { 'count_employee' => { '>=', 100 } }
4314 or with an in-place function in which case literal SQL is required:
4316 having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4322 =item Value: (0 | 1)
4326 Set to 1 to group by all columns. If the resultset already has a group_by
4327 attribute, this setting is ignored and an appropriate warning is issued.
4333 Adds to the WHERE clause.
4335 # only return rows WHERE deleted IS NULL for all searches
4336 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4338 Can be overridden by passing C<< { where => undef } >> as an attribute
4341 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4347 Set to 1 to cache search results. This prevents extra SQL queries if you
4348 revisit rows in your ResultSet:
4350 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4352 while( my $artist = $resultset->next ) {
4356 $rs->first; # without cache, this would issue a query
4358 By default, searches are not cached.
4360 For more examples of using these attributes, see
4361 L<DBIx::Class::Manual::Cookbook>.
4367 =item Value: ( 'update' | 'shared' | \$scalar )
4371 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4372 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4375 =head1 DBIC BIND VALUES
4377 Because DBIC may need more information to bind values than just the column name
4378 and value itself, it uses a special format for both passing and receiving bind
4379 values. Each bind value should be composed of an arrayref of
4380 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4386 If present (in any form), this is what is being passed directly to bind_param.
4387 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4388 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4390 If this is specified, all other bind options described below are ignored.
4394 If present, this is used to infer the actual bind attribute by passing to
4395 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4396 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4398 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4399 currently drivers are expected to "Do the Right Thing" when given a common
4400 datatype name. (Not ideal, but that's what we got at this point.)
4404 Currently used to correctly allocate buffers for bind_param_inout().
4405 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4406 or to a sensible value based on the "data_type".
4410 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4411 explicitly specified they are never overriden). Also used by some weird DBDs,
4412 where the column name should be available at bind_param time (e.g. Oracle).
4416 For backwards compatibility and convenience, the following shortcuts are
4419 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4420 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4421 [ undef, $val ] === [ {}, $val ]
4423 =head1 AUTHOR AND CONTRIBUTORS
4425 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
4429 You may distribute this code under the same terms as Perl itself.