1 package DBIx::Class::ResultSet;
6 use base 'DBIx::Class';
9 use DBIx::Class::ResultSetColumn;
10 use DBIx::Class::ResultClass::HashRefInflator;
11 use Scalar::Util qw( blessed reftype );
12 use SQL::Abstract 'is_literal_value';
13 use DBIx::Class::_Util qw(
14 dbic_internal_try dbic_internal_catch dump_value emit_loud_diag
15 fail_on_internal_wantarray fail_on_internal_call UNRESOLVABLE_CONDITION
17 use DBIx::Class::SQLMaker::Util qw( normalize_sqla_condition extract_equality_conditions );
18 use DBIx::Class::ResultSource::FromSpec::Util 'find_join_path_to_alias';
21 # De-duplication in _merge_attr() is disabled, but left in for reference
22 # (the merger is used for other things that ought not to be de-duped)
23 *__HM_DEDUP = sub () { 0 };
33 # this is real - CDBICompat overrides it with insanity
34 # yes, prototype won't matter, but that's for now ;)
37 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class result_source/);
41 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
45 my $users_rs = $schema->resultset('User');
46 while( $user = $users_rs->next) {
47 print $user->username;
50 my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
51 my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
55 A ResultSet is an object which stores a set of conditions representing
56 a query. It is the backbone of DBIx::Class (i.e. the really
57 important/useful bit).
59 No SQL is executed on the database when a ResultSet is created, it
60 just stores all the conditions needed to create the query.
62 A basic ResultSet representing the data of an entire table is returned
63 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
64 L<Source|DBIx::Class::Manual::Glossary/ResultSource> name.
66 my $users_rs = $schema->resultset('User');
68 A new ResultSet is returned from calling L</search> on an existing
69 ResultSet. The new one will contain all the conditions of the
70 original, plus any new conditions added in the C<search> call.
72 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
73 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
76 The query that the ResultSet represents is B<only> executed against
77 the database when these methods are called:
78 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
80 If a resultset is used in a numeric context it returns the L</count>.
81 However, if it is used in a boolean context it is B<always> true. So if
82 you want to check if a resultset has any results, you must use C<if $rs
87 =head2 Chaining resultsets
89 Let's say you've got a query that needs to be run to return some data
90 to the user. But, you have an authorization system in place that
91 prevents certain users from seeing certain information. So, you want
92 to construct the basic query in one method, but add constraints to it in
97 my $request = $self->get_request; # Get a request object somehow.
98 my $schema = $self->result_source->schema;
100 my $cd_rs = $schema->resultset('CD')->search({
101 title => $request->param('title'),
102 year => $request->param('year'),
105 $cd_rs = $self->apply_security_policy( $cd_rs );
107 return $cd_rs->all();
110 sub apply_security_policy {
119 =head3 Resolving conditions and attributes
121 When a resultset is chained from another resultset (e.g.:
122 C<< my $new_rs = $old_rs->search(\%extra_cond, \%attrs) >>), conditions
123 and attributes with the same keys need resolving.
125 If any of L</columns>, L</select>, L</as> are present, they reset the
126 original selection, and start the selection "clean".
128 The L</join>, L</prefetch>, L</+columns>, L</+select>, L</+as> attributes
129 are merged into the existing ones from the original resultset.
131 The L</where> and L</having> attributes, and any search conditions, are
132 merged with an SQL C<AND> to the existing condition from the original
135 All other attributes are overridden by any new ones supplied in the
138 =head2 Multiple queries
140 Since a resultset just defines a query, you can do all sorts of
141 things with it with the same object.
143 # Don't hit the DB yet.
144 my $cd_rs = $schema->resultset('CD')->search({
145 title => 'something',
149 # Each of these hits the DB individually.
150 my $count = $cd_rs->count;
151 my $most_recent = $cd_rs->get_column('date_released')->max();
152 my @records = $cd_rs->all;
154 And it's not just limited to SELECT statements.
160 $cd_rs->create({ artist => 'Fred' });
162 Which is the same as:
164 $schema->resultset('CD')->create({
165 title => 'something',
170 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
172 =head2 Custom ResultSet classes
174 To add methods to your resultsets, you can subclass L<DBIx::Class::ResultSet>, similar to:
176 package MyApp::Schema::ResultSet::User;
181 use base 'DBIx::Class::ResultSet';
185 $self->search({ $self->current_source_alias . '.active' => 1 });
190 $self->search({ $self->current_source_alias . '.verified' => 0 });
193 sub created_n_days_ago {
194 my ($self, $days_ago) = @_;
196 $self->current_source_alias . '.create_date' => {
198 $self->result_source->schema->storage->datetime_parser->format_datetime(
199 DateTime->now( time_zone => 'UTC' )->subtract( days => $days_ago )
204 sub users_to_warn { shift->active->unverified->created_n_days_ago(7) }
208 See L<DBIx::Class::Schema/load_namespaces> on how DBIC can discover and
209 automatically attach L<Result|DBIx::Class::Manual::ResultClass>-specific
210 L<ResulSet|DBIx::Class::ResultSet> classes.
212 =head3 ResultSet subclassing with Moose and similar constructor-providers
214 Using L<Moose> or L<Moo> in your ResultSet classes is usually overkill, but
215 you may find it useful if your ResultSets contain a lot of business logic
216 (e.g. C<has xml_parser>, C<has json>, etc) or if you just prefer to organize
219 In order to write custom ResultSet classes with L<Moo> you need to use the
220 following template. The L<BUILDARGS|Moo/BUILDARGS> is necessary due to the
221 unusual signature of the L<constructor provided by DBIC
222 |DBIx::Class::ResultSet/new> C<< ->new($source, \%args) >>.
225 extends 'DBIx::Class::ResultSet';
226 sub BUILDARGS { $_[2] } # ::RS::new() expects my ($class, $rsrc, $args) = @_
232 If you want to build your custom ResultSet classes with L<Moose>, you need
233 a similar, though a little more elaborate template in order to interface the
234 inlining of the L<Moose>-provided
235 L<object constructor|Moose::Manual::Construction/WHERE'S THE CONSTRUCTOR?>,
238 package MyApp::Schema::ResultSet::User;
241 use MooseX::NonMoose;
242 extends 'DBIx::Class::ResultSet';
244 sub BUILDARGS { $_[2] } # ::RS::new() expects my ($class, $rsrc, $args) = @_
248 __PACKAGE__->meta->make_immutable;
252 The L<MooseX::NonMoose> is necessary so that the L<Moose> constructor does not
253 entirely overwrite the DBIC one (in contrast L<Moo> does this automatically).
254 Alternatively, you can skip L<MooseX::NonMoose> and get by with just L<Moose>
257 __PACKAGE__->meta->make_immutable(inline_constructor => 0);
265 =item Arguments: L<$source|DBIx::Class::ResultSource>, L<\%attrs?|/ATTRIBUTES>
267 =item Return Value: L<$resultset|/search>
271 The resultset constructor. Takes a source object (usually a
272 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
273 L</ATTRIBUTES> below). Does not perform any queries -- these are
274 executed as needed by the other methods.
276 Generally you never construct a resultset manually. Instead you get one
278 C<< $schema->L<resultset|DBIx::Class::Schema/resultset>('$source_name') >>
279 or C<< $another_resultset->L<search|/search>(...) >> (the later called in
282 my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
288 If called on an object, proxies to L</new_result> instead, so
290 my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
292 will return a CD object, not a ResultSet, and is equivalent to:
294 my $cd = $schema->resultset('CD')->new_result({ title => 'Spoon' });
296 Please also keep in mind that many internals call L</new_result> directly,
297 so overloading this method with the idea of intercepting new result object
298 creation B<will not work>. See also warning pertaining to L</create>.
308 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
309 return $class->new_result(@_);
312 my ($source, $attrs) = @_;
313 $source = $source->resolve
314 if $source->isa('DBIx::Class::ResultSourceHandle');
316 $attrs = { %{$attrs||{}} };
317 delete @{$attrs}{qw(_last_sqlmaker_alias_map _simple_passthrough_construction)};
319 if ($attrs->{page}) {
320 $attrs->{rows} ||= 10;
323 $attrs->{alias} ||= 'me';
326 result_source => $source,
327 cond => $attrs->{where},
332 # if there is a dark selector, this means we are already in a
333 # chain and the cleanup/sanification was taken care of by
335 $self->_normalize_selection($attrs)
336 unless $attrs->{_dark_selector};
339 $attrs->{result_class} || $source->result_class
349 =item Arguments: L<$cond|DBIx::Class::SQLMaker> | undef, L<\%attrs?|/ATTRIBUTES>
351 =item Return Value: $resultset (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
355 my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
356 my $new_rs = $cd_rs->search({ year => 2005 });
358 my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
359 # year = 2005 OR year = 2004
361 In list context, C<< ->all() >> is called implicitly on the resultset, thus
362 returning a list of L<result|DBIx::Class::Manual::ResultClass> objects instead.
363 To avoid that, use L</search_rs>.
365 If you need to pass in additional attributes but no additional condition,
366 call it as C<search(undef, \%attrs)>.
368 # "SELECT name, artistid FROM $artist_table"
369 my @all_artists = $schema->resultset('Artist')->search(undef, {
370 columns => [qw/name artistid/],
373 For a list of attributes that can be passed to C<search>, see
374 L</ATTRIBUTES>. For more examples of using this function, see
375 L<Searching|DBIx::Class::Manual::Cookbook/SEARCHING>. For a complete
376 documentation for the first argument, see L<SQL::Abstract/"WHERE CLAUSES">
377 and its extension L<DBIx::Class::SQLMaker>.
379 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
383 Note that L</search> does not process/deflate any of the values passed in the
384 L<SQL::Abstract>-compatible search condition structure. This is unlike other
385 condition-bound methods L</new_result>, L</create> and L</find>. The user must ensure
386 manually that any value passed to this method will stringify to something the
387 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
388 objects, for more info see:
389 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
395 my $rs = $self->search_rs( @_ );
398 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_WANTARRAY and my $sog = fail_on_internal_wantarray;
401 elsif (defined wantarray) {
405 # we can be called by a relationship helper, which in
406 # turn may be called in void context due to some braindead
407 # overload or whatever else the user decided to be clever
408 # at this particular day. Thus limit the exception to
409 # external code calls only
410 $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
411 if (caller)[0] !~ /^\QDBIx::Class::/;
421 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
423 =item Return Value: L<$resultset|/search>
427 This method does the same exact thing as search() except it will
428 always return a resultset, even in list context.
435 my $rsrc = $self->result_source;
436 my ($call_cond, $call_attrs);
438 # Special-case handling for (undef, undef) or (undef)
439 # Note that (foo => undef) is valid deprecated syntax
440 @_ = () if not scalar grep { defined $_ } @_;
446 # fish out attrs in the ($condref, $attr) case
447 elsif (@_ == 2 and ( ! defined $_[0] or length ref $_[0] ) ) {
448 ($call_cond, $call_attrs) = @_;
451 $self->throw_exception('Odd number of arguments to search')
455 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
456 unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
458 for my $i (0 .. $#_) {
460 $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
461 if (! defined $_[$i] or length ref $_[$i] );
467 # see if we can keep the cache (no $rs changes)
469 my %safe = (alias => 1, cache => 1);
470 if ( ! grep { !$safe{$_} } keys %$call_attrs and (
473 ref $call_cond eq 'HASH' && ! keys %$call_cond
475 ref $call_cond eq 'ARRAY' && ! @$call_cond
477 $cache = $self->get_cache;
480 my $old_attrs = { %{$self->{attrs}} };
481 my ($old_having, $old_where) = delete @{$old_attrs}{qw(having where)};
483 my $new_attrs = { %$old_attrs };
485 # take care of call attrs (only if anything is changing)
486 if ($call_attrs and keys %$call_attrs) {
488 # copy for _normalize_selection
489 $call_attrs = { %$call_attrs };
491 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
493 # reset the current selector list if new selectors are supplied
494 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')}
495 if grep { exists $call_attrs->{$_} } qw(columns cols select as);
497 # Normalize the new selector list (operates on the passed-in attr structure)
498 # Need to do it on every chain instead of only once on _resolved_attrs, in
499 # order to allow detection of empty vs partial 'as'
500 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
501 if $old_attrs->{_dark_selector};
502 $self->_normalize_selection ($call_attrs);
504 # start with blind overwriting merge, exclude selector attrs
505 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
506 delete @{$new_attrs}{@selector_attrs};
508 for (@selector_attrs) {
509 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
510 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
513 # older deprecated name, use only if {columns} is not there
514 if (my $c = delete $new_attrs->{cols}) {
515 carp_unique( "Resultset attribute 'cols' is deprecated, use 'columns' instead" );
516 if ($new_attrs->{columns}) {
517 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
520 $new_attrs->{columns} = $c;
525 # join/prefetch use their own crazy merging heuristics
526 foreach my $key (qw/join prefetch/) {
527 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
528 if exists $call_attrs->{$key};
531 # stack binds together
532 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
536 for ($old_where, $call_cond) {
538 $new_attrs->{where} = $self->_stack_cond (
539 $_, $new_attrs->{where}
544 if (defined $old_having) {
545 $new_attrs->{having} = $self->_stack_cond (
546 $old_having, $new_attrs->{having}
550 my $rs = (ref $self)->new($rsrc, $new_attrs);
552 $rs->set_cache($cache) if ($cache);
557 sub _normalize_selection {
558 my ($self, $attrs) = @_;
561 if ( exists $attrs->{include_columns} ) {
562 carp_unique( "Resultset attribute 'include_columns' is deprecated, use '+columns' instead" );
563 $attrs->{'+columns'} = $self->_merge_attr(
564 $attrs->{'+columns'}, delete $attrs->{include_columns}
568 # columns are always placed first, however
570 # Keep the X vs +X separation until _resolved_attrs time - this allows to
571 # delay the decision on whether to use a default select list ($rsrc->columns)
572 # allowing stuff like the remove_columns helper to work
574 # select/as +select/+as pairs need special handling - the amount of select/as
575 # elements in each pair does *not* have to be equal (think multicolumn
576 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
577 # supplied at all) - try to infer the alias, either from the -as parameter
578 # of the selector spec, or use the parameter whole if it looks like a column
579 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
580 # is ok as well), but make sure no more additions to the 'as' chain take place
581 for my $pref ('', '+') {
583 my ($sel, $as) = map {
584 my $key = "${pref}${_}";
586 my $val = [ ref $attrs->{$key} eq 'ARRAY'
588 : $attrs->{$key} || ()
590 delete $attrs->{$key};
594 if (! @$as and ! @$sel ) {
597 elsif (@$as and ! @$sel) {
598 $self->throw_exception(
599 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
603 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
604 # if any @$as has been supplied we assume the user knows what (s)he is doing
605 # and blindly keep stacking up pieces
606 unless ($attrs->{_dark_selector}) {
609 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
610 push @$as, $_->{-as};
612 # assume any plain no-space, no-parenthesis string to be a column spec
613 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
614 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
617 # if all else fails - raise a flag that no more aliasing will be allowed
619 $attrs->{_dark_selector} = {
622 local $Data::Dumper::Indent = 0;
631 elsif (@$as < @$sel) {
632 $self->throw_exception(
633 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
636 elsif ($pref and $attrs->{_dark_selector}) {
637 $self->throw_exception(
638 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
644 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
645 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
650 my ($self, $left, $right) = @_;
653 (ref $_ eq 'ARRAY' and !@$_)
655 (ref $_ eq 'HASH' and ! keys %$_)
656 ) and $_ = undef for ($left, $right);
659 # either one of the two undef
660 ( (defined $left) xor (defined $right) ) ? ( defined $left ? $left : $right )
663 : ( ! defined $left ) ? undef
665 : { -and => [$left, $right] }
669 =head2 search_literal
671 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
672 should only be used in that context. C<search_literal> is a convenience
673 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
674 want to ensure columns are bound correctly, use L</search>.
676 See L<DBIx::Class::Manual::Cookbook/SEARCHING> and
677 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
678 require C<search_literal>.
682 =item Arguments: $sql_fragment, @standalone_bind_values
684 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
688 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
689 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
691 Pass a literal chunk of SQL to be added to the conditional part of the
694 Example of how to use C<search> instead of C<search_literal>
696 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
697 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
702 my ($self, $sql, @bind) = @_;
704 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
707 return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
714 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
716 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
720 Finds and returns a single row based on supplied criteria. Takes either a
721 hashref with the same format as L</create> (including inference of foreign
722 keys from related objects), or a list of primary key values in the same
723 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
724 declaration on the L</result_source>.
726 In either case an attempt is made to combine conditions already existing on
727 the resultset with the condition passed to this method.
729 To aid with preparing the correct query for the storage you may supply the
730 C<key> attribute, which is the name of a
731 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
732 unique constraint corresponding to the
733 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
734 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
735 to construct a query that satisfies the named unique constraint fully (
736 non-NULL values for each column member of the constraint) an exception is
739 If no C<key> is specified, the search is carried over all unique constraints
740 which are fully defined by the available condition.
742 If no such constraint is found, C<find> currently defaults to a simple
743 C<< search->(\%column_values) >> which may or may not do what you expect.
744 Note that this fallback behavior may be deprecated in further versions. If
745 you need to search with arbitrary conditions - use L</search>. If the query
746 resulting from this fallback produces more than one row, a warning to the
747 effect is issued, though only the first row is constructed and returned as
750 In addition to C<key>, L</find> recognizes and applies standard
751 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
753 Note that if you have extra concerns about the correctness of the resulting
754 query you need to specify the C<key> attribute and supply the entire condition
755 as an argument to find (since it is not always possible to perform the
756 combination of the resultset condition with the supplied one, especially if
757 the resultset condition contains literal sql).
759 For example, to find a row by its primary key:
761 my $cd = $schema->resultset('CD')->find(5);
763 You can also find a row by a specific unique constraint:
765 my $cd = $schema->resultset('CD')->find(
767 artist => 'Massive Attack',
768 title => 'Mezzanine',
770 { key => 'cd_artist_title' }
773 See also L</find_or_create> and L</update_or_create>.
779 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
783 if (exists $attrs->{key}) {
784 $constraint_name = defined $attrs->{key}
786 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
790 # Parse out the condition from input
793 my $rsrc = $self->result_source;
795 if (ref $_[0] eq 'HASH') {
796 $call_cond = { %{$_[0]} };
799 # if only values are supplied we need to default to 'primary'
800 $constraint_name = 'primary' unless defined $constraint_name;
802 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
804 $self->throw_exception(
805 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
808 $self->throw_exception (
809 'find() expects either a column/value hashref, or a list of values '
810 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
811 ) unless @c_cols == @_;
813 @{$call_cond}{@c_cols} = @_;
816 # process relationship data if any
819 for my $key (keys %$call_cond) {
821 # either a structure or a result-ish object
822 length ref($call_cond->{$key})
824 ( $rel_list ||= { map { $_ => 1 } $rsrc->relationships } )
827 ! is_literal_value( $call_cond->{$key} )
829 # implicitly skip has_many's (likely MC), via the delete()
830 ( ref( my $foreign_val = delete $call_cond->{$key} ) ne 'ARRAY' )
833 # FIXME: it seems wrong that relationship conditions take precedence...?
837 %{ $rsrc->_resolve_relationship_condition(
840 (! defined blessed $foreign_val) ? $foreign_val : do {
842 my $f_result_class = $rsrc->related_source($key)->result_class;
844 unless( $foreign_val->isa($f_result_class) ) {
846 $self->throw_exception(
847 'Objects supplied to find() must inherit from '
848 . "'$DBIx::Class::ResultSource::__expected_result_class_isa'"
849 ) unless $foreign_val->isa(
850 $DBIx::Class::ResultSource::__expected_result_class_isa
854 "Objects supplied to find() via '$key' usually should inherit from "
855 . "the related ResultClass ('$f_result_class'), perhaps you've made "
860 +{ $foreign_val->get_columns };
863 infer_values_based_on => {},
865 self_alias => "\xFE", # irrelevant
866 foreign_alias => "\xFF", # irrelevant
867 )->{inferred_values} },
872 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
874 if (defined $constraint_name) {
875 $final_cond = $self->_qualify_cond_columns (
877 $rsrc->_minimal_valueset_satisfying_constraint(
878 constraint_name => $constraint_name,
879 values => ($self->_merge_with_rscond($call_cond))[0],
886 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
887 # This means that we got here after a merger of relationship conditions
888 # in ::Relationship::Base::search_related (the row method), and furthermore
889 # the relationship is of the 'single' type. This means that the condition
890 # provided by the relationship (already attached to $self) is sufficient,
891 # as there can be only one row in the database that would satisfy the
895 my (@unique_queries, %seen_column_combinations, $ci, @fc_exceptions);
897 # no key was specified - fall down to heuristics mode:
898 # run through all unique queries registered on the resultset, and
899 # 'OR' all qualifying queries together
901 # always start from 'primary' if it exists at all
902 for my $c_name ( sort {
904 : $b eq 'primary' ? 1
906 } $rsrc->unique_constraint_names) {
908 next if $seen_column_combinations{
909 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
913 push @unique_queries, $self->_qualify_cond_columns(
914 $rsrc->_minimal_valueset_satisfying_constraint(
915 constraint_name => $c_name,
916 values => ($self->_merge_with_rscond($call_cond))[0],
917 columns_info => ($ci ||= $rsrc->columns_info),
922 dbic_internal_catch {
923 push @fc_exceptions, $_ if $_ =~ /\bFilterColumn\b/;
928 @unique_queries ? \@unique_queries
929 : @fc_exceptions ? $self->throw_exception(join "; ", map { $_ =~ /(.*) at .+ line \d+$/s } @fc_exceptions )
930 : $self->_non_unique_find_fallback ($call_cond, $attrs)
934 # Run the query, passing the result_class since it should propagate for find
935 my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
936 if ($rs->_resolved_attrs->{collapse}) {
938 carp "Query returned more than one row" if $rs->next;
946 # This is a stop-gap method as agreed during the discussion on find() cleanup:
947 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
949 # It is invoked when find() is called in legacy-mode with insufficiently-unique
950 # condition. It is provided for overrides until a saner way forward is devised
952 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
953 # the road. Please adjust your tests accordingly to catch this situation early
954 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
956 # The method will not be removed without an adequately complete replacement
957 # for strict-mode enforcement
958 sub _non_unique_find_fallback {
959 my ($self, $cond, $attrs) = @_;
961 return $self->_qualify_cond_columns(
963 exists $attrs->{alias}
965 : $self->{attrs}{alias}
970 sub _qualify_cond_columns {
971 my ($self, $cond, $alias) = @_;
973 my %aliased = %$cond;
974 for (keys %aliased) {
975 $aliased{"$alias.$_"} = delete $aliased{$_}
982 sub _build_unique_cond {
984 '_build_unique_cond is a private method, and moreover is about to go '
985 . 'away. Please contact the development team at %s if you believe you '
986 . 'have a genuine use for this method, in order to discuss alternatives.',
987 DBIx::Class::_ENV_::HELP_URL,
990 my ($self, $constraint_name, $cond, $croak_on_null) = @_;
992 $self->result_source->_minimal_valueset_satisfying_constraint(
993 constraint_name => $constraint_name,
995 carp_on_nulls => !$croak_on_null
999 =head2 search_related
1003 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
1005 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1009 $new_rs = $cd_rs->search_related('artist', {
1013 Searches the specified relationship, optionally specifying a condition and
1014 attributes for matching records. See L</ATTRIBUTES> for more information.
1016 In list context, C<< ->all() >> is called implicitly on the resultset, thus
1017 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
1019 See also L</search_related_rs>.
1023 sub search_related :DBIC_method_is_indirect_sugar {
1024 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1025 return shift->related_resultset(shift)->search(@_);
1028 =head2 search_related_rs
1030 This method works exactly the same as search_related, except that
1031 it guarantees a resultset, even in list context.
1035 sub search_related_rs :DBIC_method_is_indirect_sugar {
1036 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1037 return shift->related_resultset(shift)->search_rs(@_);
1044 =item Arguments: none
1046 =item Return Value: L<$cursor|DBIx::Class::Cursor>
1050 Returns a storage-driven cursor to the given resultset. See
1051 L<DBIx::Class::Cursor> for more information.
1058 return $self->{cursor} ||= do {
1059 my $attrs = $self->_resolved_attrs;
1060 $self->result_source->schema->storage->select(
1061 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
1070 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1072 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1076 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1078 Inflates the first result without creating a cursor if the resultset has
1079 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1082 While this method can take an optional search condition (just like L</search>)
1083 being a fast-code-path it does not recognize search attributes. If you need to
1084 add extra joins or similar, call L</search> and then chain-call L</single> on the
1085 L<DBIx::Class::ResultSet> returned.
1091 As of 0.08100, this method enforces the assumption that the preceding
1092 query returns only one row. If more than one row is returned, you will receive
1095 Query returned more than one row
1097 In this case, you should be using L</next> or L</find> instead, or if you really
1098 know what you are doing, use the L</rows> attribute to explicitly limit the size
1101 This method will also throw an exception if it is called on a resultset prefetching
1102 has_many, as such a prefetch implies fetching multiple rows from the database in
1103 order to assemble the resulting object.
1110 my ($self, $where) = @_;
1112 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1115 my $attrs = { %{$self->_resolved_attrs} };
1117 $self->throw_exception(
1118 'single() can not be used on resultsets collapsing a has_many. Use find( \%cond ) or next() instead'
1119 ) if $attrs->{collapse};
1122 if (defined $attrs->{where}) {
1125 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1126 $where, delete $attrs->{where} ]
1129 $attrs->{where} = $where;
1133 my $data = [ $self->result_source->schema->storage->select_single(
1134 $attrs->{from}, $attrs->{select},
1135 $attrs->{where}, $attrs
1138 return undef unless @$data;
1139 $self->{_stashed_rows} = [ $data ];
1140 $self->_construct_results->[0];
1147 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1149 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1153 my $max_length = $rs->get_column('length')->max;
1155 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1160 DBIx::Class::ResultSetColumn->new(@_);
1167 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1169 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1173 # WHERE title LIKE '%blue%'
1174 $cd_rs = $rs->search_like({ title => '%blue%'});
1176 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1177 that this is simply a convenience method retained for ex Class::DBI users.
1178 You most likely want to use L</search> with specific operators.
1180 For more information, see L<DBIx::Class::Manual::Cookbook>.
1182 This method is deprecated and will be removed in 0.09. Use L<search()|/search>
1183 instead. An example conversion is:
1185 ->search_like({ foo => 'bar' });
1189 ->search({ foo => { like => 'bar' } });
1196 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1197 .' Instead use ->search({ x => { -like => "y%" } })'
1198 .' (note the outer pair of {}s - they are important!)'
1200 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
1201 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1202 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1203 return $class->search($query, { %$attrs });
1210 =item Arguments: $first, $last
1212 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1216 Returns a resultset or object list representing a subset of elements from the
1217 resultset slice is called on. Indexes are from 0, i.e., to get the first
1218 three records, call:
1220 my ($one, $two, $three) = $rs->slice(0, 2);
1225 my ($self, $min, $max) = @_;
1226 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1227 $attrs->{offset} = $self->{attrs}{offset} || 0;
1228 $attrs->{offset} += $min;
1229 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1230 return $self->search(undef, $attrs);
1237 =item Arguments: none
1239 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1243 Returns the next element in the resultset (C<undef> is there is none).
1245 Can be used to efficiently iterate over records in the resultset:
1247 my $rs = $schema->resultset('CD')->search;
1248 while (my $cd = $rs->next) {
1252 Note that you need to store the resultset object, and call C<next> on it.
1253 Calling C<< resultset('Table')->next >> repeatedly will always return the
1254 first record from the resultset.
1261 if (my $cache = $self->get_cache) {
1262 $self->{all_cache_position} ||= 0;
1263 return $cache->[$self->{all_cache_position}++];
1266 if ($self->{attrs}{cache}) {
1267 delete $self->{pager};
1268 $self->{all_cache_position} = 1;
1269 return ($self->all)[0];
1272 return shift(@{$self->{_stashed_results}}) if @{ $self->{_stashed_results}||[] };
1274 $self->{_stashed_results} = $self->_construct_results
1277 return shift @{$self->{_stashed_results}};
1280 # Constructs as many results as it can in one pass while respecting
1281 # cursor laziness. Several modes of operation:
1283 # * Always builds everything present in @{$self->{_stashed_rows}}
1284 # * If called with $fetch_all true - pulls everything off the cursor and
1285 # builds all result structures (or objects) in one pass
1286 # * If $self->_resolved_attrs->{collapse} is true, checks the order_by
1287 # and if the resultset is ordered properly by the left side:
1288 # * Fetches stuff off the cursor until the "master object" changes,
1289 # and saves the last extra row (if any) in @{$self->{_stashed_rows}}
1291 # * Just fetches, and collapses/constructs everything as if $fetch_all
1292 # was requested (there is no other way to collapse except for an
1294 # * If no collapse is requested - just get the next row, construct and
1296 sub _construct_results {
1297 my ($self, $fetch_all) = @_;
1299 my $rsrc = $self->result_source;
1300 my $attrs = $self->_resolved_attrs;
1305 ! $attrs->{order_by}
1309 my @pcols = $rsrc->primary_columns
1311 # default order for collapsing unless the user asked for something
1312 $attrs->{order_by} = [ map { join '.', $attrs->{alias}, $_} @pcols ];
1313 $attrs->{_ordered_for_collapse} = 1;
1314 $attrs->{_order_is_artificial} = 1;
1317 # this will be used as both initial raw-row collector AND as a RV of
1318 # _construct_results. Not regrowing the array twice matters a lot...
1319 # a surprising amount actually
1320 my $rows = delete $self->{_stashed_rows};
1322 my $cursor; # we may not need one at all
1324 my $did_fetch_all = $fetch_all;
1327 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1328 $rows = [ ($rows ? @$rows : ()), $self->cursor->all ];
1330 elsif( $attrs->{collapse} ) {
1332 # a cursor will need to be closed over in case of collapse
1333 $cursor = $self->cursor;
1335 $attrs->{_ordered_for_collapse} = (
1341 ->_extract_colinfo_of_stable_main_source_order_by_portion($attrs)
1343 ) unless defined $attrs->{_ordered_for_collapse};
1345 if (! $attrs->{_ordered_for_collapse}) {
1348 # instead of looping over ->next, use ->all in stealth mode
1349 # *without* calling a ->reset afterwards
1350 # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1351 if (! $cursor->{_done}) {
1352 $rows = [ ($rows ? @$rows : ()), $cursor->all ];
1353 $cursor->{_done} = 1;
1358 if (! $did_fetch_all and ! @{$rows||[]} ) {
1359 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1360 $cursor ||= $self->cursor;
1361 if (scalar (my @r = $cursor->next) ) {
1366 return undef unless @{$rows||[]};
1368 # sanity check - people are too clever for their own good
1369 if ($attrs->{collapse} and my $aliastypes = $attrs->{_last_sqlmaker_alias_map} ) {
1371 my $multiplied_selectors;
1372 for my $sel_alias ( grep { $_ ne $attrs->{alias} } keys %{ $aliastypes->{selecting} } ) {
1374 $aliastypes->{multiplying}{$sel_alias}
1376 $aliastypes->{premultiplied}{$sel_alias}
1378 $multiplied_selectors->{$_} = 1 for values %{$aliastypes->{selecting}{$sel_alias}{-seen_columns}}
1382 for my $i (0 .. $#{$attrs->{as}} ) {
1383 my $sel = $attrs->{select}[$i];
1385 if (ref $sel eq 'SCALAR') {
1388 elsif( ref $sel eq 'REF' and ref $$sel eq 'ARRAY' ) {
1392 $self->throw_exception(
1393 'Result collapse not possible - selection from a has_many source redirected to the main object'
1394 ) if ($multiplied_selectors->{$sel} and $attrs->{as}[$i] !~ /\./);
1398 # hotspot - skip the setter
1399 my $res_class = $self->_result_class;
1401 my $inflator_cref = $self->{_result_inflator}{cref} ||= do {
1402 $res_class->can ('inflate_result')
1403 or $self->throw_exception("Inflator $res_class does not provide an inflate_result() method");
1406 my $infmap = $attrs->{as};
1408 $self->{_result_inflator}{is_core_row} = ( (
1411 ( \&DBIx::Class::Row::inflate_result || die "No ::Row::inflate_result() - can't happen" )
1412 ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_core_row};
1414 $self->{_result_inflator}{is_hri} = ( (
1415 ! $self->{_result_inflator}{is_core_row}
1417 $inflator_cref == \&DBIx::Class::ResultClass::HashRefInflator::inflate_result
1418 ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_hri};
1421 if ($attrs->{_simple_passthrough_construction}) {
1422 # construct a much simpler array->hash folder for the one-table HRI cases right here
1423 if ($self->{_result_inflator}{is_hri}) {
1424 for my $r (@$rows) {
1425 $r = { map { $infmap->[$_] => $r->[$_] } 0..$#$infmap };
1428 # FIXME SUBOPTIMAL this is a very very very hot spot
1429 # while rather optimal we can *still* do much better, by
1430 # building a smarter Row::inflate_result(), and
1431 # switch to feeding it data via a much leaner interface
1433 # crude unscientific benchmarking indicated the shortcut eval is not worth it for
1434 # this particular resultset size
1435 elsif ( $self->{_result_inflator}{is_core_row} and @$rows < 60 ) {
1436 for my $r (@$rows) {
1437 $r = $inflator_cref->($res_class, $rsrc, { map { $infmap->[$_] => $r->[$_] } (0..$#$infmap) } );
1442 ( $self->{_result_inflator}{is_core_row}
1443 ? '$_ = $inflator_cref->($res_class, $rsrc, { %s }) for @$rows'
1444 # a custom inflator may be a multiplier/reductor - put it in direct list ctx
1445 : '@$rows = map { $inflator_cref->($res_class, $rsrc, { %s } ) } @$rows'
1447 ( join (', ', map { "\$infmap->[$_] => \$_->[$_]" } 0..$#$infmap ) )
1453 $self->{_result_inflator}{is_hri} ? 'hri'
1454 : $self->{_result_inflator}{is_core_row} ? 'classic_pruning'
1455 : 'classic_nonpruning'
1458 unless( $self->{_row_parser}{$parser_type}{cref} ) {
1460 # $args and $attrs to _mk_row_parser are separated to delineate what is
1461 # core collapser stuff and what is dbic $rs specific
1462 $self->{_row_parser}{$parser_type}{src} = $rsrc->_mk_row_parser({
1463 inflate_map => $infmap,
1464 collapse => $attrs->{collapse},
1465 premultiplied => $attrs->{_main_source_premultiplied},
1466 hri_style => $self->{_result_inflator}{is_hri},
1467 prune_null_branches => $self->{_result_inflator}{is_hri} || $self->{_result_inflator}{is_core_row},
1470 $self->{_row_parser}{$parser_type}{cref} = do {
1471 package # hide form PAUSE
1472 DBIx::Class::__GENERATED_ROW_PARSER__;
1474 eval $self->{_row_parser}{$parser_type}{src};
1478 # this needs to close over the *current* cursor, hence why it is not cached above
1479 my $next_cref = ($did_fetch_all or ! $attrs->{collapse})
1482 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1483 my @r = $cursor->next or return;
1488 $self->{_row_parser}{$parser_type}{cref}->(
1491 ( $self->{_stashed_rows} = [] ),
1492 ( my $null_violations = {} ),
1495 $self->throw_exception(
1496 'Collapse aborted - the following columns are declared (or defaulted to) '
1497 . 'non-nullable within DBIC but NULLs were retrieved from storage: '
1498 . join( ', ', map { "'$infmap->[$_]'" } sort { $a <=> $b } keys %$null_violations )
1499 . ' within data row ' . dump_value({
1502 ( ! defined $self->{_stashed_rows}[0][$_] or length $self->{_stashed_rows}[0][$_] < 50 )
1503 ? $self->{_stashed_rows}[0][$_]
1504 : substr( $self->{_stashed_rows}[0][$_], 0, 50 ) . '...'
1505 } 0 .. $#{$self->{_stashed_rows}[0]}
1507 ) if keys %$null_violations;
1509 # simple in-place substitution, does not regrow $rows
1510 if ($self->{_result_inflator}{is_core_row}) {
1511 $_ = $inflator_cref->($res_class, $rsrc, @$_) for @$rows
1513 # Special-case multi-object HRI - there is no $inflator_cref pass at all
1514 elsif ( ! $self->{_result_inflator}{is_hri} ) {
1515 # the inflator may be a multiplier/reductor - put it in list ctx
1516 @$rows = map { $inflator_cref->($res_class, $rsrc, @$_) } @$rows;
1520 # The @$rows check seems odd at first - why wouldn't we want to warn
1521 # regardless? The issue is things like find() etc, where the user
1522 # *knows* only one result will come back. In these cases the ->all
1523 # is not a pessimization, but rather something we actually want
1525 'Unable to properly collapse has_many results in iterator mode due '
1526 . 'to order criteria - performed an eager cursor slurp underneath. '
1527 . 'Consider using ->all() instead'
1528 ) if ( ! $fetch_all and @$rows > 1 );
1533 =head2 result_source
1537 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1539 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1543 An accessor for the primary ResultSource object from which this ResultSet
1550 =item Arguments: $result_class?
1552 =item Return Value: $result_class
1556 An accessor for the class to use when creating result objects. Defaults to
1557 C<< result_source->result_class >> - which in most cases is the name of the
1558 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1560 Note that changing the result_class will also remove any components
1561 that were originally loaded in the source class via
1562 L<load_components|Class::C3::Componentised/load_components( @comps )>.
1563 Any overloaded methods in the original source class will not run.
1568 my ($self, $result_class) = @_;
1569 if ($result_class) {
1571 # don't fire this for an object
1572 $self->ensure_class_loaded($result_class)
1573 unless ref($result_class);
1575 if ($self->get_cache) {
1576 carp_unique('Changing the result_class of a ResultSet instance with cached results is a noop - the cache contents will not be altered');
1578 # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1579 elsif ($self->{cursor} && $self->{cursor}{_pos}) {
1580 $self->throw_exception('Changing the result_class of a ResultSet instance with an active cursor is not supported');
1583 $self->_result_class($result_class);
1585 delete $self->{_result_inflator};
1587 $self->_result_class;
1594 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1596 =item Return Value: $count
1600 Performs an SQL C<COUNT> with the same query as the resultset was built
1601 with to find the number of elements. Passing arguments is equivalent to
1602 C<< $rs->search ($cond, \%attrs)->count >>
1608 return $self->search(@_)->count if @_ and defined $_[0];
1609 return scalar @{ $self->get_cache } if $self->get_cache;
1611 my $attrs = { %{ $self->_resolved_attrs } };
1613 # this is a little optimization - it is faster to do the limit
1614 # adjustments in software, instead of a subquery
1615 my ($rows, $offset) = delete @{$attrs}{qw/rows offset/};
1618 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1619 $crs = $self->_count_subq_rs ($attrs);
1622 $crs = $self->_count_rs ($attrs);
1624 my $count = $crs->next;
1626 $count -= $offset if $offset;
1627 $count = $rows if $rows and $rows < $count;
1628 $count = 0 if ($count < 0);
1637 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1639 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1643 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1644 This can be very handy for subqueries:
1646 ->search( { amount => $some_rs->count_rs->as_query } )
1648 As with regular resultsets the SQL query will be executed only after
1649 the resultset is accessed via L</next> or L</all>. That would return
1650 the same single value obtainable via L</count>.
1656 return $self->search(@_)->count_rs if @_;
1658 # this may look like a lack of abstraction (count() does about the same)
1659 # but in fact an _rs *must* use a subquery for the limits, as the
1660 # software based limiting can not be ported if this $rs is to be used
1661 # in a subquery itself (i.e. ->as_query)
1662 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1663 return $self->_count_subq_rs($self->{_attrs});
1666 return $self->_count_rs($self->{_attrs});
1671 # returns a ResultSetColumn object tied to the count query
1674 my ($self, $attrs) = @_;
1676 my $rsrc = $self->result_source;
1678 my $tmp_attrs = { %$attrs };
1679 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1680 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1682 # overwrite the selector (supplied by the storage)
1683 $rsrc->resultset_class->new($rsrc, {
1685 select => $rsrc->schema->storage->_count_select ($rsrc, $attrs),
1687 })->get_column ('count');
1691 # same as above but uses a subquery
1693 sub _count_subq_rs {
1694 my ($self, $attrs) = @_;
1696 my $rsrc = $self->result_source;
1698 my $sub_attrs = { %$attrs };
1699 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1700 delete @{$sub_attrs}{qw/collapse columns as select order_by for/};
1702 # if we multi-prefetch we group_by something unique, as this is what we would
1703 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1704 if ( $attrs->{collapse} ) {
1705 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1706 $rsrc->_identifying_column_set || $self->throw_exception(
1707 'Unable to construct a unique group_by criteria properly collapsing the '
1708 . 'has_many prefetch before count()'
1713 # Calculate subquery selector
1714 if (my $g = $sub_attrs->{group_by}) {
1716 my $sql_maker = $rsrc->schema->storage->sql_maker;
1718 # necessary as the group_by may refer to aliased functions
1720 for my $sel (@{$attrs->{select}}) {
1721 $sel_index->{$sel->{-as}} = $sel
1722 if (ref $sel eq 'HASH' and $sel->{-as});
1725 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1726 # also look for named aggregates referred in the having clause
1727 # having often contains scalarrefs - thus parse it out entirely
1729 if ($attrs->{having}) {
1730 local $sql_maker->{having_bind};
1731 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1732 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1733 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1734 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1735 # if we don't unset it we screw up retarded but unfortunately working
1736 # 'MAX(foo.bar)' => { '>', 3 }
1737 $sql_maker->{name_sep} = '';
1740 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1742 my $having_sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1745 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1746 # and if all fails for an utterly naive quoted scalar-with-function
1747 while ($having_sql =~ /
1748 $rquote $sep $lquote (.+?) $rquote
1750 [\s,] \w+ \. (\w+) [\s,]
1752 [\s,] $lquote (.+?) $rquote [\s,]
1754 my $part = $1 || $2 || $3; # one of them matched if we got here
1755 unless ($seen_having{$part}++) {
1762 my $colpiece = $sel_index->{$_} || $_;
1764 # unqualify join-based group_by's. Arcane but possible query
1765 # also horrible horrible hack to alias a column (not a func.)
1766 # (probably need to introduce SQLA syntax)
1767 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1770 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1772 push @{$sub_attrs->{select}}, $colpiece;
1776 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1777 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1780 return $rsrc->resultset_class
1781 ->new ($rsrc, $sub_attrs)
1783 ->search ({}, { columns => { count => $rsrc->schema->storage->_count_select ($rsrc, $attrs) } })
1784 ->get_column ('count');
1788 =head2 count_literal
1790 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1791 should only be used in that context. See L</search_literal> for further info.
1795 =item Arguments: $sql_fragment, @standalone_bind_values
1797 =item Return Value: $count
1801 Counts the results in a literal query. Equivalent to calling L</search_literal>
1802 with the passed arguments, then L</count>.
1806 sub count_literal :DBIC_method_is_indirect_sugar {
1807 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1808 shift->search_literal(@_)->count
1815 =item Arguments: none
1817 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1821 Returns all elements in the resultset.
1828 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1831 delete @{$self}{qw/_stashed_rows _stashed_results/};
1833 if (my $c = $self->get_cache) {
1837 $self->cursor->reset;
1839 my $objs = $self->_construct_results('fetch_all') || [];
1841 $self->set_cache($objs) if $self->{attrs}{cache};
1850 =item Arguments: none
1852 =item Return Value: $self
1856 Resets the resultset's cursor, so you can iterate through the elements again.
1857 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1865 delete @{$self}{qw/_stashed_rows _stashed_results/};
1866 $self->{all_cache_position} = 0;
1867 $self->cursor->reset;
1875 =item Arguments: none
1877 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1881 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1882 an object for the first result (or C<undef> if the resultset is empty).
1886 sub first :DBIC_method_is_indirect_sugar {
1887 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1888 return $_[0]->reset->next;
1894 # Determines whether and what type of subquery is required for the $rs operation.
1895 # If grouping is necessary either supplies its own, or verifies the current one
1896 # After all is done delegates to the proper storage method.
1898 sub _rs_update_delete {
1899 my ($self, $op, $values) = @_;
1901 my $rsrc = $self->result_source;
1902 my $storage = $rsrc->schema->storage;
1904 my $attrs = { %{$self->_resolved_attrs} };
1906 my $join_classifications;
1907 my ($existing_group_by) = delete @{$attrs}{qw(group_by _grouped_by_distinct)};
1909 # do we need a subquery for any reason?
1911 defined $existing_group_by
1913 # if {from} is unparseable wrap a subq
1914 ref($attrs->{from}) ne 'ARRAY'
1916 # limits call for a subq
1917 $self->_has_resolved_attr(qw/rows offset/)
1920 # simplify the joinmap, so we can further decide if a subq is necessary
1921 if (!$needs_subq and @{$attrs->{from}} > 1) {
1923 ($attrs->{from}, $join_classifications) =
1924 $storage->_prune_unused_joins ($attrs);
1926 # any non-pruneable non-local restricting joins imply subq
1927 $needs_subq = grep { $_ ne $attrs->{alias} } keys %{ $join_classifications->{restricting} || {} };
1930 # check if the head is composite (by now all joins are thrown out unless $needs_subq)
1932 (ref $attrs->{from}[0]) ne 'HASH'
1934 ref $attrs->{from}[0]{ $attrs->{from}[0]{-alias} }
1938 # do we need anything like a subquery?
1939 if (! $needs_subq) {
1940 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1941 # a condition containing 'me' or other table prefixes will not work
1942 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1944 my $sqla = $rsrc->schema->storage->sql_maker;
1945 local $sqla->{_dequalify_idents} = 1;
1946 \[ $sqla->_recurse_where($self->{cond}) ];
1950 # we got this far - means it is time to wrap a subquery
1951 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1953 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1959 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1960 delete $attrs->{$_} for qw/select as collapse/;
1961 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1963 # this will be consumed by the pruner waaaaay down the stack
1964 $attrs->{_force_prune_multiplying_joins} = 1;
1966 my $subrs = (ref $self)->new($rsrc, $attrs);
1968 if (@$idcols == 1) {
1969 $cond = { $idcols->[0] => { -in => $subrs->as_query } };
1971 elsif ($storage->_use_multicolumn_in) {
1972 # no syntax for calling this properly yet
1973 # !!! EXPERIMENTAL API !!! WILL CHANGE !!!
1974 $cond = $storage->sql_maker->_where_op_multicolumn_in (
1975 $idcols, # how do I convey a list of idents...? can binds reside on lhs?
1980 # if all else fails - get all primary keys and operate over a ORed set
1981 # wrap in a transaction for consistency
1982 # this is where the group_by/multiplication starts to matter
1986 # we do not need to check pre-multipliers, since if the premulti is there, its
1987 # parent (who is multi) will be there too
1988 keys %{ $join_classifications->{multiplying} || {} }
1990 # make sure if there is a supplied group_by it matches the columns compiled above
1991 # perfectly. Anything else can not be sanely executed on most databases so croak
1992 # right then and there
1993 if ($existing_group_by) {
1994 my @current_group_by = map
1995 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
2000 join ("\x00", sort @current_group_by)
2002 join ("\x00", sort @{$attrs->{columns}} )
2004 $self->throw_exception (
2005 "You have just attempted a $op operation on a resultset which does group_by"
2006 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
2007 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
2008 . ' kind of queries. Please retry the operation with a modified group_by or'
2009 . ' without using one at all.'
2014 $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
2017 $guard = $storage->txn_scope_guard;
2019 for my $row ($subrs->cursor->all) {
2021 { $idcols->[$_] => $row->[$_] }
2028 my $res = $cond ? $storage->$op (
2030 $op eq 'update' ? $values : (),
2034 $guard->commit if $guard;
2043 =item Arguments: \%values
2045 =item Return Value: $underlying_storage_rv
2049 Sets the specified columns in the resultset to the supplied values in a
2050 single query. Note that this will not run any accessor/set_column/update
2051 triggers, nor will it update any result object instances derived from this
2052 resultset (this includes the contents of the L<resultset cache|/set_cache>
2053 if any). See L</update_all> if you need to execute any on-update
2054 triggers or cascades defined either by you or a
2055 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2057 The return value is a pass through of what the underlying
2058 storage backend returned, and may vary. See L<DBI/execute> for the most
2063 Note that L</update> does not process/deflate any of the values passed in.
2064 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
2065 ensure manually that any value passed to this method will stringify to
2066 something the RDBMS knows how to deal with. A notable example is the
2067 handling of L<DateTime> objects, for more info see:
2068 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
2073 my ($self, $values) = @_;
2074 $self->throw_exception('Values for update must be a hash')
2075 unless ref $values eq 'HASH';
2077 return $self->_rs_update_delete ('update', $values);
2084 =item Arguments: \%values
2086 =item Return Value: 1
2090 Fetches all objects and updates them one at a time via
2091 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
2092 triggers, while L</update> will not.
2097 my ($self, $values) = @_;
2098 $self->throw_exception('Values for update_all must be a hash')
2099 unless ref $values eq 'HASH';
2101 my $guard = $self->result_source->schema->txn_scope_guard;
2102 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
2111 =item Arguments: none
2113 =item Return Value: $underlying_storage_rv
2117 Deletes the rows matching this resultset in a single query. Note that this
2118 will not run any delete triggers, nor will it alter the
2119 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
2120 derived from this resultset (this includes the contents of the
2121 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
2122 execute any on-delete triggers or cascades defined either by you or a
2123 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2125 The return value is a pass through of what the underlying storage backend
2126 returned, and may vary. See L<DBI/execute> for the most common case.
2132 $self->throw_exception('delete does not accept any arguments')
2135 return $self->_rs_update_delete ('delete');
2142 =item Arguments: none
2144 =item Return Value: 1
2148 Fetches all objects and deletes them one at a time via
2149 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2150 triggers, while L</delete> will not.
2156 $self->throw_exception('delete_all does not accept any arguments')
2159 my $guard = $self->result_source->schema->txn_scope_guard;
2160 $_->delete for $self->all;
2169 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2171 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2175 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2182 The context of this method call has an important effect on what is
2183 submitted to storage. In void context data is fed directly to fastpath
2184 insertion routines provided by the underlying storage (most often
2185 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2186 L<insert|DBIx::Class::Row/insert> calls on the
2187 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2188 augmentation of these methods provided by components. For example if you
2189 are using something like L<DBIx::Class::UUIDColumns> to create primary
2190 keys for you, you will find that your PKs are empty. In this case you
2191 will have to explicitly force scalar or list context in order to create
2196 In non-void (scalar or list) context, this method is simply a wrapper
2197 for L</create>. Depending on list or scalar context either a list of
2198 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2199 containing these objects is returned.
2201 When supplying data in "arrayref of arrayrefs" invocation style, the
2202 first element should be a list of column names and each subsequent
2203 element should be a data value in the earlier specified column order.
2206 $schema->resultset("Artist")->populate([
2207 [ qw( artistid name ) ],
2208 [ 100, 'A Formally Unknown Singer' ],
2209 [ 101, 'A singer that jumped the shark two albums ago' ],
2210 [ 102, 'An actually cool singer' ],
2213 For the arrayref of hashrefs style each hashref should be a structure
2214 suitable for passing to L</create>. Multi-create is also permitted with
2217 $schema->resultset("Artist")->populate([
2218 { artistid => 4, name => 'Manufactured Crap', cds => [
2219 { title => 'My First CD', year => 2006 },
2220 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2223 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2224 { title => 'My parents sold me to a record company', year => 2005 },
2225 { title => 'Why Am I So Ugly?', year => 2006 },
2226 { title => 'I Got Surgery and am now Popular', year => 2007 }
2231 If you attempt a void-context multi-create as in the example above (each
2232 Artist also has the related list of CDs), and B<do not> supply the
2233 necessary autoinc foreign key information, this method will proxy to the
2234 less efficient L</create>, and then throw the Result objects away. In this
2235 case there are obviously no benefits to using this method over L</create>.
2242 # this is naive and just a quick check
2243 # the types will need to be checked more thoroughly when the
2244 # multi-source populate gets added
2246 ref $_[0] eq 'ARRAY'
2248 ( @{$_[0]} or return )
2250 ( ref $_[0][0] eq 'HASH' or ref $_[0][0] eq 'ARRAY' )
2253 ) or $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2255 # FIXME - no cref handling
2256 # At this point assume either hashes or arrays
2258 my $rsrc = $self->result_source;
2259 my $storage = $rsrc->schema->storage;
2261 if(defined wantarray) {
2262 my (@results, $guard);
2264 if (ref $data->[0] eq 'ARRAY') {
2265 # column names only, nothing to do
2266 return if @$data == 1;
2268 $guard = $storage->txn_scope_guard
2272 { my $vals = $_; $self->new_result({ map { $data->[0][$_] => $vals->[$_] } 0..$#{$data->[0]} })->insert }
2273 @{$data}[1 .. $#$data]
2278 $guard = $storage->txn_scope_guard
2281 @results = map { $self->new_result($_)->insert } @$data;
2284 $guard->commit if $guard;
2285 return wantarray ? @results : \@results;
2288 # we have to deal with *possibly incomplete* related data
2289 # this means we have to walk the data structure twice
2290 # whether we want this or not
2291 # jnap, I hate you ;)
2292 my $rel_info = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2294 my ($colinfo, $colnames, $slices_with_rels);
2298 for my $i (0 .. $#$data) {
2300 my $current_slice_seen_rel_infos;
2302 ### Determine/Supplement collists
2303 ### BEWARE - This is a hot piece of code, a lot of weird idioms were used
2304 if( ref $data->[$i] eq 'ARRAY' ) {
2306 # positional(!) explicit column list
2308 # column names only, nothing to do
2309 return if @$data == 1;
2311 $colinfo->{$data->[0][$_]} = { pos => $_, name => $data->[0][$_] } and push @$colnames, $data->[0][$_]
2312 for 0 .. $#{$data->[0]};
2319 for (values %$colinfo) {
2320 if ($_->{is_rel} ||= (
2321 $rel_info->{$_->{name}}
2324 ref $data->[$i][$_->{pos}] eq 'ARRAY'
2326 ref $data->[$i][$_->{pos}] eq 'HASH'
2329 defined blessed $data->[$i][$_->{pos}]
2331 $data->[$i][$_->{pos}]->isa(
2332 $DBIx::Class::ResultSource::__expected_result_class_isa
2336 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2345 # moar sanity check... sigh
2346 for ( ref $data->[$i][$_->{pos}] eq 'ARRAY' ? @{$data->[$i][$_->{pos}]} : $data->[$i][$_->{pos}] ) {
2351 $DBIx::Class::ResultSource::__expected_result_class_isa
2355 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2359 carp_unique("Fast-path populate() with supplied related objects is not possible - falling back to regular create()");
2360 return my $throwaway = $self->populate(@_);
2364 push @$current_slice_seen_rel_infos, $rel_info->{$_->{name}};
2369 if ($current_slice_seen_rel_infos) {
2370 push @$slices_with_rels, { map { $colnames->[$_] => $data->[$i][$_] } 0 .. $#$colnames };
2372 # this is needed further down to decide whether or not to fallback to create()
2373 $colinfo->{$colnames->[$_]}{seen_null} ||= ! defined $data->[$i][$_]
2374 for 0 .. $#$colnames;
2377 elsif( ref $data->[$i] eq 'HASH' ) {
2379 for ( sort keys %{$data->[$i]} ) {
2381 $colinfo->{$_} ||= do {
2383 $self->throw_exception("Column '$_' must be present in supplied explicit column list")
2384 if $data_start; # it will be 0 on AoH, 1 on AoA
2386 push @$colnames, $_;
2389 { pos => $#$colnames, name => $_ }
2392 if ($colinfo->{$_}{is_rel} ||= (
2396 ref $data->[$i]{$_} eq 'ARRAY'
2398 ref $data->[$i]{$_} eq 'HASH'
2401 defined blessed $data->[$i]{$_}
2403 $data->[$i]{$_}->isa(
2404 $DBIx::Class::ResultSource::__expected_result_class_isa
2408 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2417 # moar sanity check... sigh
2418 for ( ref $data->[$i]{$_} eq 'ARRAY' ? @{$data->[$i]{$_}} : $data->[$i]{$_} ) {
2423 $DBIx::Class::ResultSource::__expected_result_class_isa
2427 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2431 carp_unique("Fast-path populate() with supplied related objects is not possible - falling back to regular create()");
2432 return my $throwaway = $self->populate(@_);
2436 push @$current_slice_seen_rel_infos, $rel_info->{$_};
2440 if ($current_slice_seen_rel_infos) {
2441 push @$slices_with_rels, $data->[$i];
2443 # this is needed further down to decide whether or not to fallback to create()
2444 $colinfo->{$_}{seen_null} ||= ! defined $data->[$i]{$_}
2445 for keys %{$data->[$i]};
2449 $self->throw_exception('Unexpected populate() data structure member type: ' . ref $data->[$i] );
2453 { $_->{attrs}{is_depends_on} }
2454 @{ $current_slice_seen_rel_infos || [] }
2456 carp_unique("Fast-path populate() of belongs_to relationship data is not possible - falling back to regular create()");
2457 return my $throwaway = $self->populate(@_);
2461 if( $slices_with_rels ) {
2463 # need to exclude the rel "columns"
2464 $colnames = [ grep { ! $colinfo->{$_}{is_rel} } @$colnames ];
2466 # extra sanity check - ensure the main source is in fact identifiable
2467 # the localizing of nullability is insane, but oh well... the use-case is legit
2468 my $ci = $rsrc->columns_info($colnames);
2470 $ci->{$_} = { %{$ci->{$_}}, is_nullable => 0 }
2471 for grep { ! $colinfo->{$_}{seen_null} } keys %$ci;
2473 unless( $rsrc->_identifying_column_set($ci) ) {
2474 carp_unique("Fast-path populate() of non-uniquely identifiable rows with related data is not possible - falling back to regular create()");
2475 return my $throwaway = $self->populate(@_);
2479 ### inherit the data locked in the conditions of the resultset
2480 my ($rs_data) = $self->_merge_with_rscond({});
2481 delete @{$rs_data}{@$colnames}; # passed-in stuff takes precedence
2483 # if anything left - decompose rs_data
2485 if (keys %$rs_data) {
2486 push @$rs_data_vals, $rs_data->{$_}
2487 for sort keys %$rs_data;
2492 $guard = $storage->txn_scope_guard
2493 if $slices_with_rels;
2495 ### main source data
2496 # FIXME - need to switch entirely to a coderef-based thing,
2497 # so that large sets aren't copied several times... I think
2498 $storage->_insert_bulk(
2500 [ @$colnames, sort keys %$rs_data ],
2502 ref $data->[$_] eq 'ARRAY'
2504 $slices_with_rels ? [ @{$data->[$_]}[0..$#$colnames], @{$rs_data_vals||[]} ] # the collist changed
2505 : $rs_data_vals ? [ @{$data->[$_]}, @$rs_data_vals ]
2508 : [ @{$data->[$_]}{@$colnames}, @{$rs_data_vals||[]} ]
2509 } $data_start .. $#$data ],
2512 ### do the children relationships
2513 if ( $slices_with_rels ) {
2514 my @rels = grep { $colinfo->{$_}{is_rel} } keys %$colinfo
2515 or die 'wtf... please report a bug with DBIC_TRACE=1 output (stacktrace)';
2517 for my $sl (@$slices_with_rels) {
2519 my ($main_proto, $main_proto_rs);
2520 for my $rel (@rels) {
2521 next unless defined $sl->{$rel};
2525 (map { $_ => $sl->{$_} } @$colnames),
2528 unless (defined $colinfo->{$rel}{rs}) {
2530 $colinfo->{$rel}{rs} = $rsrc->related_source($rel)->resultset;
2532 $colinfo->{$rel}{fk_map} = { reverse %{ $rsrc->_resolve_relationship_condition(
2534 self_alias => "\xFE", # irrelevant
2535 foreign_alias => "\xFF", # irrelevant
2536 )->{identity_map} || {} } };
2540 $colinfo->{$rel}{rs}->search({ map # only so that we inherit them values properly, no actual search
2543 ( $main_proto_rs ||= $rsrc->resultset->search($main_proto) )
2544 ->get_column( $colinfo->{$rel}{fk_map}{$_} )
2548 keys %{$colinfo->{$rel}{fk_map}}
2549 })->populate( ref $sl->{$rel} eq 'ARRAY' ? $sl->{$rel} : [ $sl->{$rel} ] );
2556 $guard->commit if $guard;
2563 =item Arguments: none
2565 =item Return Value: L<$pager|Data::Page>
2569 Returns a L<Data::Page> object for the current resultset. Only makes
2570 sense for queries with a C<page> attribute.
2572 To get the full count of entries for a paged resultset, call
2573 C<total_entries> on the L<Data::Page> object.
2580 return $self->{pager} if $self->{pager};
2582 my $attrs = $self->{attrs};
2583 if (!defined $attrs->{page}) {
2584 $self->throw_exception("Can't create pager for non-paged rs");
2586 elsif ($attrs->{page} <= 0) {
2587 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2589 $attrs->{rows} ||= 10;
2591 # throw away the paging flags and re-run the count (possibly
2592 # with a subselect) to get the real total count
2593 my $count_attrs = { %$attrs };
2594 delete @{$count_attrs}{qw/rows offset page pager/};
2596 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2598 require DBIx::Class::ResultSet::Pager;
2599 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2600 sub { $total_rs->count }, #lazy-get the total
2602 $self->{attrs}{page},
2610 =item Arguments: $page_number
2612 =item Return Value: L<$resultset|/search>
2616 Returns a resultset for the $page_number page of the resultset on which page
2617 is called, where each page contains a number of rows equal to the 'rows'
2618 attribute set on the resultset (10 by default).
2623 my ($self, $page) = @_;
2624 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2631 =item Arguments: \%col_data
2633 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2637 Creates a new result object in the resultset's result class and returns
2638 it. The row is not inserted into the database at this point, call
2639 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2640 will tell you whether the result object has been inserted or not.
2642 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2647 my ($self, $values) = @_;
2649 $self->throw_exception( "Result object instantiation requires a single hashref argument" )
2650 if @_ > 2 or ref $values ne 'HASH';
2652 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2654 my $new = $self->result_class->new({
2656 ( @$cols_from_relations
2657 ? (-cols_from_relations => $cols_from_relations)
2660 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2664 reftype($new) eq 'HASH'
2670 carp_unique (sprintf (
2671 "%s->new returned a blessed empty hashref - a strong indicator something is wrong with its inheritance chain",
2672 $self->result_class,
2679 # _merge_with_rscond
2681 # Takes a simple hash of K/V data and returns its copy merged with the
2682 # condition already present on the resultset. Additionally returns an
2683 # arrayref of value/condition names, which were inferred from related
2684 # objects (this is needed for in-memory related objects)
2685 sub _merge_with_rscond {
2686 my ($self, $data) = @_;
2688 my ($implied_data, @cols_from_relations);
2690 my $alias = $self->{attrs}{alias};
2692 if (! defined $self->{cond}) {
2693 # just massage $data below
2695 elsif ($self->{cond} eq UNRESOLVABLE_CONDITION) {
2696 $implied_data = $self->{attrs}{related_objects}; # nothing might have been inserted yet
2697 @cols_from_relations = keys %{ $implied_data || {} };
2700 my $eqs = extract_equality_conditions( $self->{cond}, 'consider_nulls' );
2701 $implied_data = { map {
2702 ( ($eqs->{$_}||'') eq UNRESOLVABLE_CONDITION ) ? () : ( $_ => $eqs->{$_} )
2708 { %{ $self->_remove_alias($_, $alias) } }
2709 # precedence must be given to passed values over values inherited from
2710 # the cond, so the order here is important.
2711 ( $implied_data||(), $data)
2713 \@cols_from_relations
2717 # _has_resolved_attr
2719 # determines if the resultset defines at least one
2720 # of the attributes supplied
2722 # used to determine if a subquery is necessary
2724 # supports some virtual attributes:
2726 # This will scan for any joins being present on the resultset.
2727 # It is not a mere key-search but a deep inspection of {from}
2730 sub _has_resolved_attr {
2731 my ($self, @attr_names) = @_;
2733 my $attrs = $self->_resolved_attrs;
2737 for my $n (@attr_names) {
2738 if (grep { $n eq $_ } (qw/-join/) ) {
2739 $extra_checks{$n}++;
2743 my $attr = $attrs->{$n};
2745 next if not defined $attr;
2747 if (ref $attr eq 'HASH') {
2748 return 1 if keys %$attr;
2750 elsif (ref $attr eq 'ARRAY') {
2758 # a resolved join is expressed as a multi-level from
2760 $extra_checks{-join}
2762 ref $attrs->{from} eq 'ARRAY'
2764 @{$attrs->{from}} > 1
2772 # Remove the specified alias from the specified query hash. A copy is made so
2773 # the original query is not modified.
2776 my ($self, $query, $alias) = @_;
2778 my %orig = %{ $query || {} };
2781 foreach my $key (keys %orig) {
2783 $unaliased{$key} = $orig{$key};
2786 $unaliased{$1} = $orig{$key}
2787 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2797 =item Arguments: none
2799 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2803 Returns the SQL query and bind vars associated with the invocant.
2805 This is generally used as the RHS for a subquery.
2812 my $attrs = { %{ $self->_resolved_attrs } };
2814 my $aq = $self->result_source->schema->storage->_select_args_to_query (
2815 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
2825 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2827 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2831 my $artist = $schema->resultset('Artist')->find_or_new(
2832 { artist => 'fred' }, { key => 'artists' });
2834 $cd->cd_to_producer->find_or_new({ producer => $producer },
2835 { key => 'primary' });
2837 Find an existing record from this resultset using L</find>. if none exists,
2838 instantiate a new result object and return it. The object will not be saved
2839 into your storage until you call L<DBIx::Class::Row/insert> on it.
2841 You most likely want this method when looking for existing rows using a unique
2842 constraint that is not the primary key, or looking for related rows.
2844 If you want objects to be saved immediately, use L</find_or_create> instead.
2846 B<Note>: Make sure to read the documentation of L</find> and understand the
2847 significance of the C<key> attribute, as its lack may skew your search, and
2848 subsequently result in spurious new objects.
2850 B<Note>: Take care when using C<find_or_new> with a table having
2851 columns with default values that you intend to be automatically
2852 supplied by the database (e.g. an auto_increment primary key column).
2853 In normal usage, the value of such columns should NOT be included at
2854 all in the call to C<find_or_new>, even when set to C<undef>.
2860 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
2861 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2862 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2865 return $self->new_result($hash);
2872 =item Arguments: \%col_data
2874 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2878 Attempt to create a single new row or a row with multiple related rows
2879 in the table represented by the resultset (and related tables). This
2880 will not check for duplicate rows before inserting, use
2881 L</find_or_create> to do that.
2883 To create one row for this resultset, pass a hashref of key/value
2884 pairs representing the columns of the table and the values you wish to
2885 store. If the appropriate relationships are set up, foreign key fields
2886 can also be passed an object representing the foreign row, and the
2887 value will be set to its primary key.
2889 To create related objects, pass a hashref of related-object column values
2890 B<keyed on the relationship name>. If the relationship is of type C<multi>
2891 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2892 The process will correctly identify columns holding foreign keys, and will
2893 transparently populate them from the keys of the corresponding relation.
2894 This can be applied recursively, and will work correctly for a structure
2895 with an arbitrary depth and width, as long as the relationships actually
2896 exists and the correct column data has been supplied.
2898 Instead of hashrefs of plain related data (key/value pairs), you may
2899 also pass new or inserted objects. New objects (not inserted yet, see
2900 L</new_result>), will be inserted into their appropriate tables.
2902 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2904 Example of creating a new row.
2906 $person_rs->create({
2907 name=>"Some Person",
2908 email=>"somebody@someplace.com"
2911 Example of creating a new row and also creating rows in a related C<has_many>
2912 or C<has_one> resultset. Note Arrayref.
2915 { artistid => 4, name => 'Manufactured Crap', cds => [
2916 { title => 'My First CD', year => 2006 },
2917 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2922 Example of creating a new row and also creating a row in a related
2923 C<belongs_to> resultset. Note Hashref.
2926 title=>"Music for Silly Walks",
2929 name=>"Silly Musician",
2937 When subclassing ResultSet never attempt to override this method. Since
2938 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2939 lot of the internals simply never call it, so your override will be
2940 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2941 or L<DBIx::Class::Row/insert> depending on how early in the
2942 L</create> process you need to intervene. See also warning pertaining to
2949 sub create :DBIC_method_is_indirect_sugar {
2950 #my ($self, $col_data) = @_;
2951 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
2952 return shift->new_result(shift)->insert;
2955 =head2 find_or_create
2959 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2961 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2965 $cd->cd_to_producer->find_or_create({ producer => $producer },
2966 { key => 'primary' });
2968 Tries to find a record based on its primary key or unique constraints; if none
2969 is found, creates one and returns that instead.
2971 my $cd = $schema->resultset('CD')->find_or_create({
2973 artist => 'Massive Attack',
2974 title => 'Mezzanine',
2978 Also takes an optional C<key> attribute, to search by a specific key or unique
2979 constraint. For example:
2981 my $cd = $schema->resultset('CD')->find_or_create(
2983 artist => 'Massive Attack',
2984 title => 'Mezzanine',
2986 { key => 'cd_artist_title' }
2989 B<Note>: Make sure to read the documentation of L</find> and understand the
2990 significance of the C<key> attribute, as its lack may skew your search, and
2991 subsequently result in spurious row creation.
2993 B<Note>: Because find_or_create() reads from the database and then
2994 possibly inserts based on the result, this method is subject to a race
2995 condition. Another process could create a record in the table after
2996 the find has completed and before the create has started. To avoid
2997 this problem, use find_or_create() inside a transaction.
2999 B<Note>: Take care when using C<find_or_create> with a table having
3000 columns with default values that you intend to be automatically
3001 supplied by the database (e.g. an auto_increment primary key column).
3002 In normal usage, the value of such columns should NOT be included at
3003 all in the call to C<find_or_create>, even when set to C<undef>.
3005 See also L</find> and L</update_or_create>. For information on how to declare
3006 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
3008 If you need to know if an existing row was found or a new one created use
3009 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
3010 to call L<DBIx::Class::Row/insert> to save the newly created row to the
3013 my $cd = $schema->resultset('CD')->find_or_new({
3015 artist => 'Massive Attack',
3016 title => 'Mezzanine',
3020 if( !$cd->in_storage ) {
3027 sub find_or_create {
3029 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
3030 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
3031 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
3034 return $self->new_result($hash)->insert;
3037 =head2 update_or_create
3041 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
3043 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
3047 $resultset->update_or_create({ col => $val, ... });
3049 Like L</find_or_create>, but if a row is found it is immediately updated via
3050 C<< $found_row->update (\%col_data) >>.
3053 Takes an optional C<key> attribute to search on a specific unique constraint.
3056 # In your application
3057 my $cd = $schema->resultset('CD')->update_or_create(
3059 artist => 'Massive Attack',
3060 title => 'Mezzanine',
3063 { key => 'cd_artist_title' }
3066 $cd->cd_to_producer->update_or_create({
3067 producer => $producer,
3073 B<Note>: Make sure to read the documentation of L</find> and understand the
3074 significance of the C<key> attribute, as its lack may skew your search, and
3075 subsequently result in spurious row creation.
3077 B<Note>: Take care when using C<update_or_create> with a table having
3078 columns with default values that you intend to be automatically
3079 supplied by the database (e.g. an auto_increment primary key column).
3080 In normal usage, the value of such columns should NOT be included at
3081 all in the call to C<update_or_create>, even when set to C<undef>.
3083 See also L</find> and L</find_or_create>. For information on how to declare
3084 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
3086 If you need to know if an existing row was updated or a new one created use
3087 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
3088 to call L<DBIx::Class::Row/insert> to save the newly created row to the
3093 sub update_or_create {
3095 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
3096 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
3098 my $row = $self->find($cond, $attrs);
3100 $row->update($cond);
3104 return $self->new_result($cond)->insert;
3107 =head2 update_or_new
3111 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
3113 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
3117 $resultset->update_or_new({ col => $val, ... });
3119 Like L</find_or_new> but if a row is found it is immediately updated via
3120 C<< $found_row->update (\%col_data) >>.
3124 # In your application
3125 my $cd = $schema->resultset('CD')->update_or_new(
3127 artist => 'Massive Attack',
3128 title => 'Mezzanine',
3131 { key => 'cd_artist_title' }
3134 if ($cd->in_storage) {
3135 # the cd was updated
3138 # the cd is not yet in the database, let's insert it
3142 B<Note>: Make sure to read the documentation of L</find> and understand the
3143 significance of the C<key> attribute, as its lack may skew your search, and
3144 subsequently result in spurious new objects.
3146 B<Note>: Take care when using C<update_or_new> with a table having
3147 columns with default values that you intend to be automatically
3148 supplied by the database (e.g. an auto_increment primary key column).
3149 In normal usage, the value of such columns should NOT be included at
3150 all in the call to C<update_or_new>, even when set to C<undef>.
3152 See also L</find>, L</find_or_create> and L</find_or_new>.
3158 my $attrs = ( @_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {} );
3159 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
3161 my $row = $self->find( $cond, $attrs );
3162 if ( defined $row ) {
3163 $row->update($cond);
3167 return $self->new_result($cond);
3174 =item Arguments: none
3176 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
3180 Gets the contents of the cache for the resultset, if the cache is set.
3182 The cache is populated either by using the L</prefetch> attribute to
3183 L</search> or by calling L</set_cache>.
3195 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3197 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3201 Sets the contents of the cache for the resultset. Expects an arrayref
3202 of objects of the same class as those produced by the resultset. Note that
3203 if the cache is set, the resultset will return the cached objects rather
3204 than re-querying the database even if the cache attr is not set.
3206 The contents of the cache can also be populated by using the
3207 L</prefetch> attribute to L</search>.
3212 my ( $self, $data ) = @_;
3213 $self->throw_exception("set_cache requires an arrayref")
3214 if defined($data) && (ref $data ne 'ARRAY');
3215 $self->{all_cache} = $data;
3222 =item Arguments: none
3224 =item Return Value: undef
3228 Clears the cache for the resultset.
3233 shift->set_cache(undef);
3240 =item Arguments: none
3242 =item Return Value: true, if the resultset has been paginated
3250 return !!$self->{attrs}{page};
3257 =item Arguments: none
3259 =item Return Value: true, if the resultset has been ordered with C<order_by>.
3267 return scalar $self->result_source->schema->storage->_extract_order_criteria($self->{attrs}{order_by});
3270 =head2 related_resultset
3274 =item Arguments: $rel_name
3276 =item Return Value: L<$resultset|/search>
3280 Returns a related resultset for the supplied relationship name.
3282 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3286 sub related_resultset {
3287 $_[0]->throw_exception(
3288 'Extra arguments to $rs->related_resultset() were always quietly '
3289 . 'discarded without consideration, you need to switch to '
3290 . '...->related_resultset( $relname )->search_rs( $search, $args ) instead.'
3293 return $_[0]->{related_resultsets}{$_[1]}
3294 if defined $_[0]->{related_resultsets}{$_[1]};
3296 my ($self, $rel) = @_;
3298 return $self->{related_resultsets}{$rel} = do {
3299 my $rsrc = $self->result_source;
3300 my $rel_info = $rsrc->relationship_info($rel);
3302 $self->throw_exception(
3303 "search_related: result source '" . $rsrc->source_name .
3304 "' has no such relationship $rel")
3307 my $attrs = $self->_chain_relationship($rel);
3309 # Previously this atribute was deleted (instead of being set as it is now)
3310 # Doing so seems to be harmless in all available test permutations
3311 # See also 01d59a6a6 and mst's comment below
3313 $attrs->{alias} = $rsrc->schema->storage->relname_to_table_alias(
3315 $attrs->{seen_join}{$rel}
3318 # since this is search_related, and we already slid the select window inwards
3319 # (the select/as attrs were deleted in the beginning), we need to flip all
3320 # left joins to inner, so we get the expected results
3322 # The DBIC relationship chaining implementation is pretty simple - every
3323 # new related_relationship is pushed onto the {from} stack, and the {select}
3324 # window simply slides further in. This means that when we count somewhere
3325 # in the middle, we got to make sure that everything in the join chain is an
3326 # actual inner join, otherwise the count will come back with unpredictable
3327 # results (a resultset may be generated with _some_ rows regardless of if
3328 # the relation which the $rs currently selects has rows or not). E.g.
3329 # $artist_rs->cds->count - normally generates:
3330 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
3331 # which actually returns the number of artists * (number of cds || 1)
3333 # So what we do here is crawl {from}, determine if the current alias is at
3334 # the top of the stack, and if not - make sure the chain is inner-joined down
3337 my $switch_branch = find_join_path_to_alias(
3342 if ( @{ $switch_branch || [] } ) {
3344 # So it looks like we will have to switch some stuff around.
3345 # local() is useless here as we will be leaving the scope
3346 # anyway, and deep cloning is just too fucking expensive
3347 # So replace the first hashref in the node arrayref manually
3348 my @new_from = $attrs->{from}[0];
3349 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
3351 for my $j ( @{$attrs->{from}}[ 1 .. $#{$attrs->{from}} ] ) {
3352 my $jalias = $j->[0]{-alias};
3354 if ($sw_idx->{$jalias}) {
3355 my %attrs = %{$j->[0]};
3356 delete $attrs{-join_type};
3367 $attrs->{from} = \@new_from;
3371 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3372 delete $attrs->{result_class};
3376 # The reason we do this now instead of passing the alias to the
3377 # search_rs below is that if you wrap/overload resultset on the
3378 # source you need to know what alias it's -going- to have for things
3379 # to work sanely (e.g. RestrictWithObject wants to be able to add
3380 # extra query restrictions, and these may need to be $alias.)
3381 # -- mst ~ 2007 (01d59a6a6)
3383 # FIXME - this seems to be no longer neccessary (perhaps due to the
3384 # advances in relcond resolution. Testing DBIC::S::RWO and its only
3385 # dependent (as of Jun 2015 ) does not yield any difference with or
3386 # without this line. Nevertheless keep it as is for now, to minimize
3387 # churn, there is enough potential for breakage in 0.0829xx as it is
3388 # -- ribasushi Jun 2015
3390 my $rel_source = $rsrc->related_source($rel);
3391 local $rel_source->resultset_attributes->{alias} = $attrs->{alias};
3393 $rel_source->resultset->search_rs( undef, $attrs );
3396 if (my $cache = $self->get_cache) {
3397 my @related_cache = map
3398 { $_->related_resultset($rel)->get_cache || () }
3402 $new->set_cache([ map @$_, @related_cache ]) if @related_cache == @$cache;
3409 =head2 current_source_alias
3413 =item Arguments: none
3415 =item Return Value: $source_alias
3419 Returns the current table alias for the result source this resultset is built
3420 on, that will be used in the SQL query. Usually it is C<me>.
3422 Currently the source alias that refers to the result set returned by a
3423 L</search>/L</find> family method depends on how you got to the resultset: it's
3424 C<me> by default, but eg. L</search_related> aliases it to the related result
3425 source name (and keeps C<me> referring to the original result set). The long
3426 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3427 (and make this method unnecessary).
3429 Thus it's currently necessary to use this method in predefined queries (see
3430 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3431 source alias of the current result set:
3433 # in a result set class
3435 my ($self, $user) = @_;
3437 my $me = $self->current_source_alias;
3439 return $self->search({
3440 "$me.modified" => $user->id,
3444 The alias of L<newly created resultsets|/search> can be altered by the
3445 L<alias attribute|/alias>.
3449 sub current_source_alias {
3450 return (shift->{attrs} || {})->{alias} || 'me';
3453 =head2 as_subselect_rs
3457 =item Arguments: none
3459 =item Return Value: L<$resultset|/search>
3463 Act as a barrier to SQL symbols. The resultset provided will be made into a
3464 "virtual view" by including it as a subquery within the from clause. From this
3465 point on, any joined tables are inaccessible to ->search on the resultset (as if
3466 it were simply where-filtered without joins). For example:
3468 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3470 # 'x' now pollutes the query namespace
3472 # So the following works as expected
3473 my $ok_rs = $rs->search({'x.other' => 1});
3475 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3476 # def) we look for one row with contradictory terms and join in another table
3477 # (aliased 'x_2') which we never use
3478 my $broken_rs = $rs->search({'x.name' => 'def'});
3480 my $rs2 = $rs->as_subselect_rs;
3482 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3483 my $not_joined_rs = $rs2->search({'x.other' => 1});
3485 # works as expected: finds a 'table' row related to two x rows (abc and def)
3486 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3488 Another example of when one might use this would be to select a subset of
3489 columns in a group by clause:
3491 my $rs = $schema->resultset('Bar')->search(undef, {
3492 group_by => [qw{ id foo_id baz_id }],
3493 })->as_subselect_rs->search(undef, {
3494 columns => [qw{ id foo_id }]
3497 In the above example normally columns would have to be equal to the group by,
3498 but because we isolated the group by into a subselect the above works.
3502 sub as_subselect_rs {
3505 my $attrs = $self->_resolved_attrs;
3507 my $fresh_rs = (ref $self)->new (
3508 $self->result_source
3511 # these pieces will be locked in the subquery
3512 delete $fresh_rs->{cond};
3513 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3515 return $fresh_rs->search( {}, {
3517 $attrs->{alias} => $self->as_query,
3518 -alias => $attrs->{alias},
3519 -rsrc => $self->result_source,
3521 alias => $attrs->{alias},
3525 # This code is called by search_related, and makes sure there
3526 # is clear separation between the joins before, during, and
3527 # after the relationship. This information is needed later
3528 # in order to properly resolve prefetch aliases (any alias
3529 # with a relation_chain_depth less than the depth of the
3530 # current prefetch is not considered)
3532 # The increments happen twice per join. An even number means a
3533 # relationship specified via a search_related, whereas an odd
3534 # number indicates a join/prefetch added via attributes
3536 # Also this code will wrap the current resultset (the one we
3537 # chain to) in a subselect IFF it contains limiting attributes
3538 sub _chain_relationship {
3539 my ($self, $rel) = @_;
3540 my $source = $self->result_source;
3541 my $attrs = { %{$self->{attrs}||{}} };
3543 # we need to take the prefetch the attrs into account before we
3544 # ->_resolve_join as otherwise they get lost - captainL
3545 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3547 delete @{$attrs}{qw/join prefetch collapse group_by distinct _grouped_by_distinct select as columns +select +as +columns/};
3549 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3552 my @force_subq_attrs = qw/offset rows group_by having/;
3555 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3557 $self->_has_resolved_attr (@force_subq_attrs)
3559 # Nuke the prefetch (if any) before the new $rs attrs
3560 # are resolved (prefetch is useless - we are wrapping
3561 # a subquery anyway).
3562 my $rs_copy = $self->search;
3563 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3564 $rs_copy->{attrs}{join},
3565 delete $rs_copy->{attrs}{prefetch},
3570 -alias => $attrs->{alias},
3571 $attrs->{alias} => $rs_copy->as_query,
3573 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3574 $seen->{-relation_chain_depth} = 0;
3576 elsif ($attrs->{from}) { #shallow copy suffices
3577 $from = [ @{$attrs->{from}} ];
3582 -alias => $attrs->{alias},
3583 $attrs->{alias} => $source->from,
3587 my $jpath = ($seen->{-relation_chain_depth})
3588 ? $from->[-1][0]{-join_path}
3591 my @requested_joins = $source->_resolve_join(
3598 push @$from, @requested_joins;
3600 $seen->{-relation_chain_depth}++;
3602 # if $self already had a join/prefetch specified on it, the requested
3603 # $rel might very well be already included. What we do in this case
3604 # is effectively a no-op (except that we bump up the chain_depth on
3605 # the join in question so we could tell it *is* the search_related)
3608 # we consider the last one thus reverse
3609 for my $j (reverse @requested_joins) {
3610 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3611 if ($rel eq $last_j) {
3612 $j->[0]{-relation_chain_depth}++;
3618 unless ($already_joined) {
3619 push @$from, $source->_resolve_join(
3627 $seen->{-relation_chain_depth}++;
3629 return {%$attrs, from => $from, seen_join => $seen};
3632 sub _resolved_attrs {
3634 return $self->{_attrs} if $self->{_attrs};
3636 my $attrs = { %{ $self->{attrs} || {} } };
3637 my $source = $attrs->{result_source} = $self->result_source;
3638 my $alias = $attrs->{alias};
3640 $self->throw_exception("Specifying distinct => 1 in conjunction with collapse => 1 is unsupported")
3641 if $attrs->{collapse} and $attrs->{distinct};
3644 # Sanity check the paging attributes
3645 # SQLMaker does it too, but in case of a software_limit we'll never get there
3646 if (defined $attrs->{offset}) {
3647 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
3648 if ( $attrs->{offset} =~ /[^0-9]/ or $attrs->{offset} < 0 );
3650 if (defined $attrs->{rows}) {
3651 $self->throw_exception("The rows attribute must be a positive integer if present")
3652 if ( $attrs->{rows} =~ /[^0-9]/ or $attrs->{rows} <= 0 );
3655 # normalize where condition
3656 $attrs->{where} = normalize_sqla_condition( $attrs->{where} )
3659 # default selection list
3660 $attrs->{columns} = [ $source->columns ]
3661 unless grep { exists $attrs->{$_} } qw/columns cols select as/;
3663 # merge selectors together
3664 for (qw/columns select as/) {
3665 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3666 if $attrs->{$_} or $attrs->{"+$_"};
3669 # disassemble columns
3671 if (my $cols = delete $attrs->{columns}) {
3672 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3673 if (ref $c eq 'HASH') {
3674 for my $as (sort keys %$c) {
3675 push @sel, $c->{$as};
3686 # when trying to weed off duplicates later do not go past this point -
3687 # everything added from here on is unbalanced "anyone's guess" stuff
3688 my $dedup_stop_idx = $#as;
3690 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3692 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3693 if $attrs->{select};
3695 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3696 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_" for @sel;
3698 # disqualify all $alias.col as-bits (inflate-map mandated)
3699 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_ for @as;
3701 # de-duplicate the result (remove *identical* select/as pairs)
3702 # and also die on duplicate {as} pointing to different {select}s
3703 # not using a c-style for as the condition is prone to shrinkage
3706 while ($i <= $dedup_stop_idx) {
3707 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3712 elsif ($seen->{$as[$i]}++) {
3713 $self->throw_exception(
3714 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3722 $attrs->{select} = \@sel;
3723 $attrs->{as} = \@as;
3725 $attrs->{from} ||= [{
3727 -alias => $self->{attrs}{alias},
3728 $self->{attrs}{alias} => $source->from,
3731 if ( $attrs->{join} || $attrs->{prefetch} ) {
3733 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3734 if ref $attrs->{from} ne 'ARRAY';
3736 my $join = (delete $attrs->{join}) || {};
3738 if ( defined $attrs->{prefetch} ) {
3739 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3742 $attrs->{from} = # have to copy here to avoid corrupting the original
3744 @{ $attrs->{from} },
3745 $source->_resolve_join(
3748 { %{ $attrs->{seen_join} || {} } },
3749 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3750 ? $attrs->{from}[-1][0]{-join_path}
3758 for my $attr (qw(order_by group_by)) {
3760 if ( defined $attrs->{$attr} ) {
3762 ref( $attrs->{$attr} ) eq 'ARRAY'
3763 ? [ @{ $attrs->{$attr} } ]
3764 : [ $attrs->{$attr} || () ]
3767 delete $attrs->{$attr} unless @{$attrs->{$attr}};
3772 # set collapse default based on presence of prefetch
3775 defined $attrs->{prefetch}
3777 $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} )
3779 $self->throw_exception("Specifying prefetch in conjunction with an explicit collapse => 0 is unsupported")
3780 if defined $attrs->{collapse} and ! $attrs->{collapse};
3782 $attrs->{collapse} = 1;
3786 # run through the resulting joinstructure (starting from our current slot)
3787 # and unset collapse if proven unnecessary
3789 # also while we are at it find out if the current root source has
3790 # been premultiplied by previous related_source chaining
3792 # this allows to predict whether a root object with all other relation
3793 # data set to NULL is in fact unique
3794 if ($attrs->{collapse}) {
3796 if (ref $attrs->{from} eq 'ARRAY') {
3798 if (@{$attrs->{from}} == 1) {
3799 # no joins - no collapse
3800 $attrs->{collapse} = 0;
3803 # find where our table-spec starts
3804 my @fromlist = @{$attrs->{from}};
3806 my $t = shift @fromlist;
3809 # me vs join from-spec distinction - a ref means non-root
3810 if (ref $t eq 'ARRAY') {
3812 $is_multi ||= ! $t->{-is_single};
3814 last if ($t->{-alias} && $t->{-alias} eq $alias);
3815 $attrs->{_main_source_premultiplied} ||= $is_multi;
3818 # no non-singles remaining, nor any premultiplication - nothing to collapse
3820 ! $attrs->{_main_source_premultiplied}
3822 ! grep { ! $_->[0]{-is_single} } @fromlist
3824 $attrs->{collapse} = 0;
3830 # if we can not analyze the from - err on the side of safety
3831 $attrs->{_main_source_premultiplied} = 1;
3836 # generate the distinct induced group_by before injecting the prefetched select/as parts
3837 if (delete $attrs->{distinct}) {
3838 if ($attrs->{group_by}) {
3839 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3842 $attrs->{_grouped_by_distinct} = 1;
3843 # distinct affects only the main selection part, not what prefetch may add below
3844 ($attrs->{group_by}, my $new_order) = $source->schema->storage->_group_over_selection($attrs);
3846 # FIXME possibly ignore a rewritten order_by (may turn out to be an issue)
3847 # The thinking is: if we are collapsing the subquerying prefetch engine will
3848 # rip stuff apart for us anyway, and we do not want to have a potentially
3849 # function-converted external order_by
3850 # ( there is an explicit if ( collapse && _grouped_by_distinct ) check in DBIHacks )
3851 $attrs->{order_by} = $new_order unless $attrs->{collapse};
3856 # generate selections based on the prefetch helper
3859 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3860 if $attrs->{_dark_selector};
3862 # this is a separate structure (we don't look in {from} directly)
3863 # as the resolver needs to shift things off the lists to work
3864 # properly (identical-prefetches on different branches)
3865 my $joined_node_aliases_map = {};
3866 if (ref $attrs->{from} eq 'ARRAY') {
3868 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3870 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3871 next unless $j->[0]{-alias};
3872 next unless $j->[0]{-join_path};
3873 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3875 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3877 my $p = $joined_node_aliases_map;
3878 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3879 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3883 ( push @{$attrs->{select}}, $_->[0] ) and ( push @{$attrs->{as}}, $_->[1] )
3884 for $source->_resolve_selection_from_prefetch( $prefetch, $joined_node_aliases_map );
3888 $attrs->{_simple_passthrough_construction} = !(
3891 grep { $_ =~ /\./ } @{$attrs->{as}}
3895 # if both page and offset are specified, produce a combined offset
3896 # even though it doesn't make much sense, this is what pre 081xx has
3898 if (my $page = delete $attrs->{page}) {
3900 ($attrs->{rows} * ($page - 1))
3902 ($attrs->{offset} || 0)
3906 return $self->{_attrs} = $attrs;
3910 my ($self, $attr) = @_;
3912 if (ref $attr eq 'HASH') {
3913 return $self->_rollout_hash($attr);
3914 } elsif (ref $attr eq 'ARRAY') {
3915 return $self->_rollout_array($attr);
3921 sub _rollout_array {
3922 my ($self, $attr) = @_;
3925 foreach my $element (@{$attr}) {
3926 if (ref $element eq 'HASH') {
3927 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3928 } elsif (ref $element eq 'ARRAY') {
3929 # XXX - should probably recurse here
3930 push( @rolled_array, @{$self->_rollout_array($element)} );
3932 push( @rolled_array, $element );
3935 return \@rolled_array;
3939 my ($self, $attr) = @_;
3942 foreach my $key (keys %{$attr}) {
3943 push( @rolled_array, { $key => $attr->{$key} } );
3945 return \@rolled_array;
3948 sub _calculate_score {
3949 my ($self, $a, $b) = @_;
3951 if (defined $a xor defined $b) {
3954 elsif (not defined $a) {
3958 if (ref $b eq 'HASH') {
3959 my ($b_key) = keys %{$b};
3960 $b_key = '' if ! defined $b_key;
3961 if (ref $a eq 'HASH') {
3962 my ($a_key) = keys %{$a};
3963 $a_key = '' if ! defined $a_key;
3964 if ($a_key eq $b_key) {
3965 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3970 return ($a eq $b_key) ? 1 : 0;
3973 if (ref $a eq 'HASH') {
3974 my ($a_key) = keys %{$a};
3975 return ($b eq $a_key) ? 1 : 0;
3977 return ($b eq $a) ? 1 : 0;
3982 sub _merge_joinpref_attr {
3983 my ($self, $orig, $import) = @_;
3985 return $import unless defined($orig);
3986 return $orig unless defined($import);
3988 $orig = $self->_rollout_attr($orig);
3989 $import = $self->_rollout_attr($import);
3992 foreach my $import_element ( @{$import} ) {
3993 # find best candidate from $orig to merge $b_element into
3994 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3995 foreach my $orig_element ( @{$orig} ) {
3996 my $score = $self->_calculate_score( $orig_element, $import_element );
3997 if ($score > $best_candidate->{score}) {
3998 $best_candidate->{position} = $position;
3999 $best_candidate->{score} = $score;
4003 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
4004 $import_key = '' if not defined $import_key;
4006 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
4007 push( @{$orig}, $import_element );
4009 my $orig_best = $orig->[$best_candidate->{position}];
4010 # merge orig_best and b_element together and replace original with merged
4011 if (ref $orig_best ne 'HASH') {
4012 $orig->[$best_candidate->{position}] = $import_element;
4013 } elsif (ref $import_element eq 'HASH') {
4014 my ($key) = keys %{$orig_best};
4015 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
4018 $seen_keys->{$import_key} = 1; # don't merge the same key twice
4021 return @$orig ? $orig : ();
4029 require Hash::Merge;
4030 my $hm = Hash::Merge->new;
4032 $hm->specify_behavior({
4035 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
4037 if ($defl xor $defr) {
4038 return [ $defl ? $_[0] : $_[1] ];
4043 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
4047 return [$_[0], $_[1]];
4051 return $_[1] if !defined $_[0];
4052 return $_[1] if __HM_DEDUP and grep { $_ eq $_[0] } @{$_[1]};
4053 return [$_[0], @{$_[1]}]
4056 return [] if !defined $_[0] and !keys %{$_[1]};
4057 return [ $_[1] ] if !defined $_[0];
4058 return [ $_[0] ] if !keys %{$_[1]};
4059 return [$_[0], $_[1]]
4064 return $_[0] if !defined $_[1];
4065 return $_[0] if __HM_DEDUP and grep { $_ eq $_[1] } @{$_[0]};
4066 return [@{$_[0]}, $_[1]]
4069 my @ret = @{$_[0]} or return $_[1];
4070 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
4071 my %idx = map { $_ => 1 } @ret;
4072 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
4076 return [ $_[1] ] if ! @{$_[0]};
4077 return $_[0] if !keys %{$_[1]};
4078 return $_[0] if __HM_DEDUP and grep { $_ eq $_[1] } @{$_[0]};
4079 return [ @{$_[0]}, $_[1] ];
4084 return [] if !keys %{$_[0]} and !defined $_[1];
4085 return [ $_[0] ] if !defined $_[1];
4086 return [ $_[1] ] if !keys %{$_[0]};
4087 return [$_[0], $_[1]]
4090 return [] if !keys %{$_[0]} and !@{$_[1]};
4091 return [ $_[0] ] if !@{$_[1]};
4092 return $_[1] if !keys %{$_[0]};
4093 return $_[1] if __HM_DEDUP and grep { $_ eq $_[0] } @{$_[1]};
4094 return [ $_[0], @{$_[1]} ];
4097 return [] if !keys %{$_[0]} and !keys %{$_[1]};
4098 return [ $_[0] ] if !keys %{$_[1]};
4099 return [ $_[1] ] if !keys %{$_[0]};
4100 return [ $_[0] ] if $_[0] eq $_[1];
4101 return [ $_[0], $_[1] ];
4104 } => 'DBIC_RS_ATTR_MERGER');
4108 return $hm->merge ($_[1], $_[2]);
4112 sub STORABLE_freeze {
4113 my ($self, $cloning) = @_;
4114 my $to_serialize = { %$self };
4116 # A cursor in progress can't be serialized (and would make little sense anyway)
4117 # the parser can be regenerated (and can't be serialized)
4118 delete @{$to_serialize}{qw/cursor _row_parser _result_inflator/};
4120 # nor is it sensical to store a not-yet-fired-count pager
4121 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
4122 delete $to_serialize->{pager};
4125 Storable::nfreeze($to_serialize);
4128 # need this hook for symmetry
4130 my ($self, $cloning, $serialized) = @_;
4132 %$self = %{ Storable::thaw($serialized) };
4138 =head2 throw_exception
4140 See L<DBIx::Class::Schema/throw_exception> for details.
4144 sub throw_exception {
4147 if (ref $self and my $rsrc = $self->result_source) {
4148 $rsrc->throw_exception(@_)
4151 DBIx::Class::Exception->throw(@_);
4159 # XXX: FIXME: Attributes docs need clearing up
4163 Attributes are used to refine a ResultSet in various ways when
4164 searching for data. They can be passed to any method which takes an
4165 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
4168 Default attributes can be set on the result class using
4169 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
4170 the CAVEATS on that feature before using it!)
4172 These are in no particular order:
4178 =item Value: ( $order_by | \@order_by | \%order_by )
4182 Which column(s) to order the results by.
4184 [The full list of suitable values is documented in
4185 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
4188 If a single column name, or an arrayref of names is supplied, the
4189 argument is passed through directly to SQL. The hashref syntax allows
4190 for connection-agnostic specification of ordering direction:
4192 For descending order:
4194 order_by => { -desc => [qw/col1 col2 col3/] }
4196 For explicit ascending order:
4198 order_by => { -asc => 'col' }
4200 The old scalarref syntax (i.e. order_by => \'year DESC') is still
4201 supported, although you are strongly encouraged to use the hashref
4202 syntax as outlined above.
4208 =item Value: \@columns | \%columns | $column
4212 Shortcut to request a particular set of columns to be retrieved. Each
4213 column spec may be a string (a table column name), or a hash (in which
4214 case the key is the C<as> value, and the value is used as the C<select>
4215 expression). Adds the L</current_source_alias> onto the start of any column without a C<.> in
4216 it and sets C<select> from that, then auto-populates C<as> from
4217 C<select> as normal. (You may also use the C<cols> attribute, as in
4218 earlier versions of DBIC, but this is deprecated)
4220 Essentially C<columns> does the same as L</select> and L</as>.
4222 columns => [ 'some_column', { dbic_slot => 'another_column' } ]
4226 select => [qw(some_column another_column)],
4227 as => [qw(some_column dbic_slot)]
4229 If you want to individually retrieve related columns (in essence perform
4230 manual L</prefetch>) you have to make sure to specify the correct inflation slot
4231 chain such that it matches existing relationships:
4233 my $rs = $schema->resultset('Artist')->search({}, {
4234 # required to tell DBIC to collapse has_many relationships
4236 join => { cds => 'tracks' },
4238 'cds.cdid' => 'cds.cdid',
4239 'cds.tracks.title' => 'tracks.title',
4243 Like elsewhere, literal SQL or literal values can be included by using a
4244 scalar reference or a literal bind value, and these values will be available
4245 in the result with C<get_column> (see also
4246 L<SQL::Abstract/Literal SQL and value type operators>):
4248 # equivalent SQL: SELECT 1, 'a string', IF(my_column,?,?) ...
4249 # bind values: $true_value, $false_value
4253 bar => \q{'a string'},
4254 baz => \[ 'IF(my_column,?,?)', $true_value, $false_value ],
4260 B<NOTE:> You B<MUST> explicitly quote C<'+columns'> when using this attribute.
4261 Not doing so causes Perl to incorrectly interpret C<+columns> as a bareword
4262 with a unary plus operator before it, which is the same as simply C<columns>.
4266 =item Value: \@extra_columns
4270 Indicates additional columns to be selected from storage. Works the same as
4271 L</columns> but adds columns to the current selection. (You may also use the
4272 C<include_columns> attribute, as in earlier versions of DBIC, but this is
4275 $schema->resultset('CD')->search(undef, {
4276 '+columns' => ['artist.name'],
4280 would return all CDs and include a 'name' column to the information
4281 passed to object inflation. Note that the 'artist' is the name of the
4282 column (or relationship) accessor, and 'name' is the name of the column
4283 accessor in the related table.
4289 =item Value: \@select_columns
4293 Indicates which columns should be selected from the storage. You can use
4294 column names, or in the case of RDBMS back ends, function or stored procedure
4297 $rs = $schema->resultset('Employee')->search(undef, {
4300 { count => 'employeeid' },
4301 { max => { length => 'name' }, -as => 'longest_name' }
4306 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
4308 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
4309 use L</select>, to instruct DBIx::Class how to store the result of the column.
4311 Also note that the L</as> attribute has B<nothing to do> with the SQL-side
4312 C<AS> identifier aliasing. You B<can> alias a function (so you can use it e.g.
4313 in an C<ORDER BY> clause), however this is done via the C<-as> B<select
4314 function attribute> supplied as shown in the example above.
4318 B<NOTE:> You B<MUST> explicitly quote C<'+select'> when using this attribute.
4319 Not doing so causes Perl to incorrectly interpret C<+select> as a bareword
4320 with a unary plus operator before it, which is the same as simply C<select>.
4324 =item Value: \@extra_select_columns
4328 Indicates additional columns to be selected from storage. Works the same as
4329 L</select> but adds columns to the current selection, instead of specifying
4330 a new explicit list.
4336 =item Value: \@inflation_names
4340 Indicates DBIC-side names for object inflation. That is L</as> indicates the
4341 slot name in which the column value will be stored within the
4342 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
4343 identifier by the C<get_column> method (or via the object accessor B<if one
4344 with the same name already exists>) as shown below.
4346 The L</as> attribute has B<nothing to do> with the SQL-side identifier
4347 aliasing C<AS>. See L</select> for details.
4349 $rs = $schema->resultset('Employee')->search(undef, {
4352 { count => 'employeeid' },
4353 { max => { length => 'name' }, -as => 'longest_name' }
4362 If the object against which the search is performed already has an accessor
4363 matching a column name specified in C<as>, the value can be retrieved using
4364 the accessor as normal:
4366 my $name = $employee->name();
4368 If on the other hand an accessor does not exist in the object, you need to
4369 use C<get_column> instead:
4371 my $employee_count = $employee->get_column('employee_count');
4373 You can create your own accessors if required - see
4374 L<DBIx::Class::Manual::Cookbook> for details.
4378 B<NOTE:> You B<MUST> explicitly quote C<'+as'> when using this attribute.
4379 Not doing so causes Perl to incorrectly interpret C<+as> as a bareword
4380 with a unary plus operator before it, which is the same as simply C<as>.
4384 =item Value: \@extra_inflation_names
4388 Indicates additional inflation names for selectors added via L</+select>. See L</as>.
4394 =item Value: ($rel_name | \@rel_names | \%rel_names)
4398 Contains a list of relationships that should be joined for this query. For
4401 # Get CDs by Nine Inch Nails
4402 my $rs = $schema->resultset('CD')->search(
4403 { 'artist.name' => 'Nine Inch Nails' },
4404 { join => 'artist' }
4407 Can also contain a hash reference to refer to the other relation's relations.
4410 package MyApp::Schema::Track;
4411 use base qw/DBIx::Class/;
4412 __PACKAGE__->table('track');
4413 __PACKAGE__->add_columns(qw/trackid cd position title/);
4414 __PACKAGE__->set_primary_key('trackid');
4415 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
4418 # In your application
4419 my $rs = $schema->resultset('Artist')->search(
4420 { 'track.title' => 'Teardrop' },
4422 join => { cd => 'track' },
4423 order_by => 'artist.name',
4427 You need to use the relationship (not the table) name in conditions,
4428 because they are aliased as such. The current table is aliased as "me", so
4429 you need to use me.column_name in order to avoid ambiguity. For example:
4431 # Get CDs from 1984 with a 'Foo' track
4432 my $rs = $schema->resultset('CD')->search(
4435 'tracks.name' => 'Foo'
4437 { join => 'tracks' }
4440 If the same join is supplied twice, it will be aliased to <rel>_2 (and
4441 similarly for a third time). For e.g.
4443 my $rs = $schema->resultset('Artist')->search({
4444 'cds.title' => 'Down to Earth',
4445 'cds_2.title' => 'Popular',
4447 join => [ qw/cds cds/ ],
4450 will return a set of all artists that have both a cd with title 'Down
4451 to Earth' and a cd with title 'Popular'.
4453 If you want to fetch related objects from other tables as well, see L</prefetch>
4456 NOTE: An internal join-chain pruner will discard certain joins while
4457 constructing the actual SQL query, as long as the joins in question do not
4458 affect the retrieved result. This for example includes 1:1 left joins
4459 that are not part of the restriction specification (WHERE/HAVING) nor are
4460 a part of the query selection.
4462 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4468 =item Value: (0 | 1)
4472 When set to a true value, indicates that any rows fetched from joined has_many
4473 relationships are to be aggregated into the corresponding "parent" object. For
4474 example, the resultset:
4476 my $rs = $schema->resultset('CD')->search({}, {
4477 '+columns' => [ qw/ tracks.title tracks.position / ],
4482 While executing the following query:
4484 SELECT me.*, tracks.title, tracks.position
4486 LEFT JOIN track tracks
4487 ON tracks.cdid = me.cdid
4489 Will return only as many objects as there are rows in the CD source, even
4490 though the result of the query may span many rows. Each of these CD objects
4491 will in turn have multiple "Track" objects hidden behind the has_many
4492 generated accessor C<tracks>. Without C<< collapse => 1 >>, the return values
4493 of this resultset would be as many CD objects as there are tracks (a "Cartesian
4494 product"), with each CD object containing exactly one of all fetched Track data.
4496 When a collapse is requested on a non-ordered resultset, an order by some
4497 unique part of the main source (the left-most table) is inserted automatically.
4498 This is done so that the resultset is allowed to be "lazy" - calling
4499 L<< $rs->next|/next >> will fetch only as many rows as it needs to build the next
4500 object with all of its related data.
4502 If an L</order_by> is already declared, and orders the resultset in a way that
4503 makes collapsing as described above impossible (e.g. C<< ORDER BY
4504 has_many_rel.column >> or C<ORDER BY RANDOM()>), DBIC will automatically
4505 switch to "eager" mode and slurp the entire resultset before constructing the
4506 first object returned by L</next>.
4508 Setting this attribute on a resultset that does not join any has_many
4509 relations is a no-op.
4511 For a more in-depth discussion, see L</PREFETCHING>.
4517 =item Value: ($rel_name | \@rel_names | \%rel_names)
4521 This attribute is a shorthand for specifying a L</join> spec, adding all
4522 columns from the joined related sources as L</+columns> and setting
4523 L</collapse> to a true value. It can be thought of as a rough B<superset>
4524 of the L</join> attribute.
4526 For example, the following two queries are equivalent:
4528 my $rs = $schema->resultset('Artist')->search({}, {
4529 prefetch => { cds => ['genre', 'tracks' ] },
4534 my $rs = $schema->resultset('Artist')->search({}, {
4535 join => { cds => ['genre', 'tracks' ] },
4539 { +{ "cds.$_" => "cds.$_" } }
4540 $schema->source('Artist')->related_source('cds')->columns
4543 { +{ "cds.genre.$_" => "genre.$_" } }
4544 $schema->source('Artist')->related_source('cds')->related_source('genre')->columns
4547 { +{ "cds.tracks.$_" => "tracks.$_" } }
4548 $schema->source('Artist')->related_source('cds')->related_source('tracks')->columns
4553 Both producing the following SQL:
4555 SELECT me.artistid, me.name, me.rank, me.charfield,
4556 cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track,
4557 genre.genreid, genre.name,
4558 tracks.trackid, tracks.cd, tracks.position, tracks.title, tracks.last_updated_on, tracks.last_updated_at
4561 ON cds.artist = me.artistid
4562 LEFT JOIN genre genre
4563 ON genre.genreid = cds.genreid
4564 LEFT JOIN track tracks
4565 ON tracks.cd = cds.cdid
4566 ORDER BY me.artistid
4568 While L</prefetch> implies a L</join>, it is ok to mix the two together, as
4569 the arguments are properly merged and generally do the right thing. For
4570 example, you may want to do the following:
4572 my $artists_and_cds_without_genre = $schema->resultset('Artist')->search(
4573 { 'genre.genreid' => undef },
4575 join => { cds => 'genre' },
4580 Which generates the following SQL:
4582 SELECT me.artistid, me.name, me.rank, me.charfield,
4583 cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track
4586 ON cds.artist = me.artistid
4587 LEFT JOIN genre genre
4588 ON genre.genreid = cds.genreid
4589 WHERE genre.genreid IS NULL
4590 ORDER BY me.artistid
4592 For a more in-depth discussion, see L</PREFETCHING>.
4598 =item Value: $source_alias
4602 Sets the source alias for the query. Normally, this defaults to C<me>, but
4603 nested search queries (sub-SELECTs) might need specific aliases set to
4604 reference inner queries. For example:
4607 ->related_resultset('CDs')
4608 ->related_resultset('Tracks')
4610 'track.id' => { -ident => 'none_search.id' },
4614 my $ids = $self->search({
4617 alias => 'none_search',
4618 group_by => 'none_search.id',
4619 })->get_column('id')->as_query;
4621 $self->search({ id => { -in => $ids } })
4623 This attribute is directly tied to L</current_source_alias>.
4633 Makes the resultset paged and specifies the page to retrieve. Effectively
4634 identical to creating a non-pages resultset and then calling ->page($page)
4637 If L</rows> attribute is not specified it defaults to 10 rows per page.
4639 When you have a paged resultset, L</count> will only return the number
4640 of rows in the page. To get the total, use the L</pager> and call
4641 C<total_entries> on it.
4651 Specifies the maximum number of rows for direct retrieval or the number of
4652 rows per page if the page attribute or method is used.
4658 =item Value: $offset
4662 Specifies the (zero-based) row number for the first row to be returned, or the
4663 of the first row of the first page if paging is used.
4665 =head2 software_limit
4669 =item Value: (0 | 1)
4673 When combined with L</rows> and/or L</offset> the generated SQL will not
4674 include any limit dialect stanzas. Instead the entire result will be selected
4675 as if no limits were specified, and DBIC will perform the limit locally, by
4676 artificially advancing and finishing the resulting L</cursor>.
4678 This is the recommended way of performing resultset limiting when no sane RDBMS
4679 implementation is available (e.g.
4680 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4681 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4687 =item Value: \@columns
4691 A arrayref of columns to group by. Can include columns of joined tables.
4693 group_by => [qw/ column1 column2 ... /]
4699 =item Value: $condition
4703 The HAVING operator specifies a B<secondary> condition applied to the set
4704 after the grouping calculations have been done. In other words it is a
4705 constraint just like L</where> (and accepting the same
4706 L<SQL::Abstract syntax|SQL::Abstract/WHERE CLAUSES>) applied to the data
4707 as it exists after GROUP BY has taken place. Specifying L</having> without
4708 L</group_by> is a logical mistake, and a fatal error on most RDBMS engines.
4712 having => { 'count_employee' => { '>=', 100 } }
4714 or with an in-place function in which case literal SQL is required:
4716 having => \[ 'count(employee) >= ?', 100 ]
4722 =item Value: (0 | 1)
4726 Set to 1 to automatically generate a L</group_by> clause based on the selection
4727 (including intelligent handling of L</order_by> contents). Note that the group
4728 criteria calculation takes place over the B<final> selection. This includes
4729 any L</+columns>, L</+select> or L</order_by> additions in subsequent
4730 L</search> calls, and standalone columns selected via
4731 L<DBIx::Class::ResultSetColumn> (L</get_column>). A notable exception are the
4732 extra selections specified via L</prefetch> - such selections are explicitly
4733 excluded from group criteria calculations.
4735 If the final ResultSet also explicitly defines a L</group_by> attribute, this
4736 setting is ignored and an appropriate warning is issued.
4740 Adds extra conditions to the resultset, combined with the preexisting C<WHERE>
4741 conditions, same as the B<first> argument to the L<search operator|/search>
4743 # only return rows WHERE deleted IS NULL for all searches
4744 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4746 Note that the above example is
4747 L<strongly discouraged|DBIx::Class::ResultSource/resultset_attributes>.
4751 Set to 1 to cache search results. This prevents extra SQL queries if you
4752 revisit rows in your ResultSet:
4754 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4756 while( my $artist = $resultset->next ) {
4760 $resultset->first; # without cache, this would issue a query
4762 By default, searches are not cached.
4764 For more examples of using these attributes, see
4765 L<DBIx::Class::Manual::Cookbook>.
4771 =item Value: ( 'update' | 'shared' | \$scalar )
4775 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4776 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4781 DBIx::Class supports arbitrary related data prefetching from multiple related
4782 sources. Any combination of relationship types and column sets are supported.
4783 If L<collapsing|/collapse> is requested, there is an additional requirement of
4784 selecting enough data to make every individual object uniquely identifiable.
4786 Here are some more involved examples, based on the following relationship map:
4789 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4790 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4791 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4793 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4795 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4799 my $rs = $schema->resultset('Tag')->search(
4808 The initial search results in SQL like the following:
4810 SELECT tag.*, cd.*, artist.* FROM tag
4811 JOIN cd ON tag.cd = cd.cdid
4812 JOIN artist ON cd.artist = artist.artistid
4814 L<DBIx::Class> has no need to go back to the database when we access the
4815 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4818 Simple prefetches will be joined automatically, so there is no need
4819 for a C<join> attribute in the above search.
4821 The L</prefetch> attribute can be used with any of the relationship types
4822 and multiple prefetches can be specified together. Below is a more complex
4823 example that prefetches a CD's artist, its liner notes (if present),
4824 the cover image, the tracks on that CD, and the guests on those
4827 my $rs = $schema->resultset('CD')->search(
4831 { artist => 'record_label'}, # belongs_to => belongs_to
4832 'liner_note', # might_have
4833 'cover_image', # has_one
4834 { tracks => 'guests' }, # has_many => has_many
4839 This will produce SQL like the following:
4841 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4845 ON artist.artistid = me.artistid
4846 JOIN record_label record_label
4847 ON record_label.labelid = artist.labelid
4848 LEFT JOIN track tracks
4849 ON tracks.cdid = me.cdid
4850 LEFT JOIN guest guests
4851 ON guests.trackid = track.trackid
4852 LEFT JOIN liner_notes liner_note
4853 ON liner_note.cdid = me.cdid
4854 JOIN cd_artwork cover_image
4855 ON cover_image.cdid = me.cdid
4858 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4859 C<tracks>, and C<guests> of the CD will all be available through the
4860 relationship accessors without the need for additional queries to the
4865 Prefetch does a lot of deep magic. As such, it may not behave exactly
4866 as you might expect.
4872 Prefetch uses the L</cache> to populate the prefetched relationships. This
4873 may or may not be what you want.
4877 If you specify a condition on a prefetched relationship, ONLY those
4878 rows that match the prefetched condition will be fetched into that relationship.
4879 This means that adding prefetch to a search() B<may alter> what is returned by
4880 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4882 my $artist_rs = $schema->resultset('Artist')->search({
4888 my $count = $artist_rs->first->cds->count;
4890 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4892 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4894 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4896 That cmp_ok() may or may not pass depending on the datasets involved. In other
4897 words the C<WHERE> condition would apply to the entire dataset, just like
4898 it would in regular SQL. If you want to add a condition only to the "right side"
4899 of a C<LEFT JOIN> - consider declaring and using a L<relationship with a custom
4900 condition|DBIx::Class::Relationship::Base/condition>
4904 =head1 DBIC BIND VALUES
4906 Because DBIC may need more information to bind values than just the column name
4907 and value itself, it uses a special format for both passing and receiving bind
4908 values. Each bind value should be composed of an arrayref of
4909 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4915 If present (in any form), this is what is being passed directly to bind_param.
4916 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4917 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4919 If this is specified, all other bind options described below are ignored.
4923 If present, this is used to infer the actual bind attribute by passing to
4924 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4925 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4927 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4928 currently drivers are expected to "Do the Right Thing" when given a common
4929 datatype name. (Not ideal, but that's what we got at this point.)
4933 Currently used to correctly allocate buffers for bind_param_inout().
4934 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4935 or to a sensible value based on the "data_type".
4939 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4940 explicitly specified they are never overridden). Also used by some weird DBDs,
4941 where the column name should be available at bind_param time (e.g. Oracle).
4945 For backwards compatibility and convenience, the following shortcuts are
4948 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4949 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4950 [ undef, $val ] === [ {}, $val ]
4951 $val === [ {}, $val ]
4953 =head1 FURTHER QUESTIONS?
4955 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
4957 =head1 COPYRIGHT AND LICENSE
4959 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
4960 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
4961 redistribute it and/or modify it under the same terms as the
4962 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.