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_call UNRESOLVABLE_CONDITION DUMMY_ALIASPAIR
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>.
393 sub search :DBIC_method_is_indirect_sugar {
394 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
396 my $rs = shift->search_rs( @_ );
402 if defined wantarray;
404 # we can be called by a relationship helper, which in
405 # turn may be called in void context due to some braindead
406 # overload or whatever else the user decided to be clever
407 # at this particular day. Thus limit the exception to
408 # external code calls only
409 $rs->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
410 if (caller)[0] !~ /^\QDBIx::Class::/;
412 # we are in void ctx here, but just in case
420 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
422 =item Return Value: L<$resultset|/search>
426 This method does the same exact thing as search() except it will
427 always return a resultset, even in list context.
434 my $rsrc = $self->result_source;
435 my ($call_cond, $call_attrs);
437 # Special-case handling for (undef, undef) or (undef)
438 # Note that (foo => undef) is valid deprecated syntax
439 @_ = () if not scalar grep { defined $_ } @_;
445 # fish out attrs in the ($condref, $attr) case
446 elsif (@_ == 2 and ( ! defined $_[0] or length ref $_[0] ) ) {
447 ($call_cond, $call_attrs) = @_;
450 $self->throw_exception('Odd number of arguments to search')
454 carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
455 unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
457 for my $i (0 .. $#_) {
459 $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
460 if (! defined $_[$i] or length ref $_[$i] );
466 # see if we can keep the cache (no $rs changes)
468 my %safe = (alias => 1, cache => 1);
469 if ( ! grep { !$safe{$_} } keys %$call_attrs and (
472 ref $call_cond eq 'HASH' && ! keys %$call_cond
474 ref $call_cond eq 'ARRAY' && ! @$call_cond
476 $cache = $self->get_cache;
479 my $old_attrs = { %{$self->{attrs}} };
480 my ($old_having, $old_where) = delete @{$old_attrs}{qw(having where)};
482 my $new_attrs = { %$old_attrs };
484 # take care of call attrs (only if anything is changing)
485 if ($call_attrs and keys %$call_attrs) {
487 # copy for _normalize_selection
488 $call_attrs = { %$call_attrs };
490 my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
492 # reset the current selector list if new selectors are supplied
493 delete @{$old_attrs}{(@selector_attrs, '_dark_selector')}
494 if grep { exists $call_attrs->{$_} } qw(columns cols select as);
496 # Normalize the new selector list (operates on the passed-in attr structure)
497 # Need to do it on every chain instead of only once on _resolved_attrs, in
498 # order to allow detection of empty vs partial 'as'
499 $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
500 if $old_attrs->{_dark_selector};
501 $self->_normalize_selection ($call_attrs);
503 # start with blind overwriting merge, exclude selector attrs
504 $new_attrs = { %{$old_attrs}, %{$call_attrs} };
505 delete @{$new_attrs}{@selector_attrs};
507 for (@selector_attrs) {
508 $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
509 if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
512 # older deprecated name, use only if {columns} is not there
513 if (my $c = delete $new_attrs->{cols}) {
514 carp_unique( "Resultset attribute 'cols' is deprecated, use 'columns' instead" );
515 if ($new_attrs->{columns}) {
516 carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
519 $new_attrs->{columns} = $c;
524 # join/prefetch use their own crazy merging heuristics
525 foreach my $key (qw/join prefetch/) {
526 $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
527 if exists $call_attrs->{$key};
530 # stack binds together
531 $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
535 for ($old_where, $call_cond) {
537 $new_attrs->{where} = $self->_stack_cond (
538 $_, $new_attrs->{where}
543 if (defined $old_having) {
544 $new_attrs->{having} = $self->_stack_cond (
545 $old_having, $new_attrs->{having}
549 my $rs = (ref $self)->new($rsrc, $new_attrs);
551 $rs->set_cache($cache) if ($cache);
556 sub _normalize_selection {
557 my ($self, $attrs) = @_;
560 if ( exists $attrs->{include_columns} ) {
561 carp_unique( "Resultset attribute 'include_columns' is deprecated, use '+columns' instead" );
562 $attrs->{'+columns'} = $self->_merge_attr(
563 $attrs->{'+columns'}, delete $attrs->{include_columns}
567 # columns are always placed first, however
569 # Keep the X vs +X separation until _resolved_attrs time - this allows to
570 # delay the decision on whether to use a default select list ($rsrc->columns)
571 # allowing stuff like the remove_columns helper to work
573 # select/as +select/+as pairs need special handling - the amount of select/as
574 # elements in each pair does *not* have to be equal (think multicolumn
575 # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
576 # supplied at all) - try to infer the alias, either from the -as parameter
577 # of the selector spec, or use the parameter whole if it looks like a column
578 # name (ugly legacy heuristic). If all fails - leave the selector bare (which
579 # is ok as well), but make sure no more additions to the 'as' chain take place
580 for my $pref ('', '+') {
582 my ($sel, $as) = map {
583 my $key = "${pref}${_}";
585 my $val = [ ref $attrs->{$key} eq 'ARRAY'
587 : $attrs->{$key} || ()
589 delete $attrs->{$key};
593 if (! @$as and ! @$sel ) {
596 elsif (@$as and ! @$sel) {
597 $self->throw_exception(
598 "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
602 # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
603 # if any @$as has been supplied we assume the user knows what (s)he is doing
604 # and blindly keep stacking up pieces
605 unless ($attrs->{_dark_selector}) {
608 if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
609 push @$as, $_->{-as};
611 # assume any plain no-space, no-parenthesis string to be a column spec
612 # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
613 elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
616 # if all else fails - raise a flag that no more aliasing will be allowed
618 $attrs->{_dark_selector} = {
621 local $Data::Dumper::Indent = 0;
630 elsif (@$as < @$sel) {
631 $self->throw_exception(
632 "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
635 elsif ($pref and $attrs->{_dark_selector}) {
636 $self->throw_exception(
637 "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
643 $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
644 $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
649 my ($self, $left, $right) = @_;
652 (ref $_ eq 'ARRAY' and !@$_)
654 (ref $_ eq 'HASH' and ! keys %$_)
655 ) and $_ = undef for ($left, $right);
658 # either one of the two undef
659 ( (defined $left) xor (defined $right) ) ? ( defined $left ? $left : $right )
662 : ( ! defined $left ) ? undef
664 : { -and => [$left, $right] }
668 =head2 search_literal
670 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
671 should only be used in that context. C<search_literal> is a convenience
672 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
673 want to ensure columns are bound correctly, use L</search>.
675 See L<DBIx::Class::Manual::Cookbook/SEARCHING> and
676 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
677 require C<search_literal>.
681 =item Arguments: $sql_fragment, @standalone_bind_values
683 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
687 my @cds = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
688 my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
690 Pass a literal chunk of SQL to be added to the conditional part of the
693 Example of how to use C<search> instead of C<search_literal>
695 my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
696 my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
700 sub search_literal :DBIC_method_is_indirect_sugar {
701 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
703 my ($self, $sql, @bind) = @_;
705 if ( @bind && ref($bind[-1]) eq 'HASH' ) {
708 return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
715 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
717 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
721 Finds and returns a single row based on supplied criteria. Takes either a
722 hashref with the same format as L</create> (including inference of foreign
723 keys from related objects), or a list of primary key values in the same
724 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
725 declaration on the L</result_source>.
727 In either case an attempt is made to combine conditions already existing on
728 the resultset with the condition passed to this method.
730 To aid with preparing the correct query for the storage you may supply the
731 C<key> attribute, which is the name of a
732 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
733 unique constraint corresponding to the
734 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
735 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
736 to construct a query that satisfies the named unique constraint fully (
737 non-NULL values for each column member of the constraint) an exception is
740 If no C<key> is specified, the search is carried over all unique constraints
741 which are fully defined by the available condition.
743 If no such constraint is found, C<find> currently defaults to a simple
744 C<< search->(\%column_values) >> which may or may not do what you expect.
745 Note that this fallback behavior may be deprecated in further versions. If
746 you need to search with arbitrary conditions - use L</search>. If the query
747 resulting from this fallback produces more than one row, a warning to the
748 effect is issued, though only the first row is constructed and returned as
751 In addition to C<key>, L</find> recognizes and applies standard
752 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
754 Note that if you have extra concerns about the correctness of the resulting
755 query you need to specify the C<key> attribute and supply the entire condition
756 as an argument to find (since it is not always possible to perform the
757 combination of the resultset condition with the supplied one, especially if
758 the resultset condition contains literal sql).
760 For example, to find a row by its primary key:
762 my $cd = $schema->resultset('CD')->find(5);
764 You can also find a row by a specific unique constraint:
766 my $cd = $schema->resultset('CD')->find(
768 artist => 'Massive Attack',
769 title => 'Mezzanine',
771 { key => 'cd_artist_title' }
774 See also L</find_or_create> and L</update_or_create>.
780 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
784 if (exists $attrs->{key}) {
785 $constraint_name = defined $attrs->{key}
787 : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
791 # Parse out the condition from input
794 my $rsrc = $self->result_source;
796 if (ref $_[0] eq 'HASH') {
797 $call_cond = { %{$_[0]} };
800 # if only values are supplied we need to default to 'primary'
801 $constraint_name = 'primary' unless defined $constraint_name;
803 my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
805 $self->throw_exception(
806 "No constraint columns, maybe a malformed '$constraint_name' constraint?"
809 $self->throw_exception (
810 'find() expects either a column/value hashref, or a list of values '
811 . "corresponding to the columns of the specified unique constraint '$constraint_name'"
812 ) unless @c_cols == @_;
814 @{$call_cond}{@c_cols} = @_;
817 # process relationship data if any
820 for my $key (keys %$call_cond) {
822 # either a structure or a result-ish object
823 length ref($call_cond->{$key})
825 ( $rel_list ||= { map { $_ => 1 } $rsrc->relationships } )
828 ! is_literal_value( $call_cond->{$key} )
830 # implicitly skip has_many's (likely MC), via the delete()
831 ( ref( my $foreign_val = delete $call_cond->{$key} ) ne 'ARRAY' )
834 # FIXME: it seems wrong that relationship conditions take precedence...?
838 %{ $rsrc->resolve_relationship_condition(
839 require_join_free_values => 1,
842 (! defined blessed $foreign_val) ? $foreign_val : do {
844 my $f_result_class = $rsrc->related_source($key)->result_class;
846 unless( $foreign_val->isa($f_result_class) ) {
848 $self->throw_exception(
849 'Objects supplied to find() must inherit from '
850 . "'$DBIx::Class::ResultSource::__expected_result_class_isa'"
851 ) unless $foreign_val->isa(
852 $DBIx::Class::ResultSource::__expected_result_class_isa
856 "Objects supplied to find() via '$key' usually should inherit from "
857 . "the related ResultClass ('$f_result_class'), perhaps you've made "
862 +{ $foreign_val->get_columns };
866 # an API where these are optional would be too cumbersome,
867 # instead always pass in some dummy values
869 )->{join_free_values} },
874 my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
876 if (defined $constraint_name) {
877 $final_cond = $self->_qualify_cond_columns (
879 $rsrc->_minimal_valueset_satisfying_constraint(
880 constraint_name => $constraint_name,
881 values => ($self->_merge_with_rscond($call_cond))[0],
888 elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
889 # This means that we got here after a merger of relationship conditions
890 # in ::Relationship::Base::search_related (the row method), and furthermore
891 # the relationship is of the 'single' type. This means that the condition
892 # provided by the relationship (already attached to $self) is sufficient,
893 # as there can be only one row in the database that would satisfy the
897 my (@unique_queries, %seen_column_combinations, $ci, @fc_exceptions);
899 # no key was specified - fall down to heuristics mode:
900 # run through all unique queries registered on the resultset, and
901 # 'OR' all qualifying queries together
903 # always start from 'primary' if it exists at all
904 for my $c_name ( sort {
906 : $b eq 'primary' ? 1
908 } $rsrc->unique_constraint_names) {
910 next if $seen_column_combinations{
911 join "\x00", sort $rsrc->unique_constraint_columns($c_name)
915 push @unique_queries, $self->_qualify_cond_columns(
916 $rsrc->_minimal_valueset_satisfying_constraint(
917 constraint_name => $c_name,
918 values => ($self->_merge_with_rscond($call_cond))[0],
919 columns_info => ($ci ||= $rsrc->columns_info),
924 dbic_internal_catch {
925 push @fc_exceptions, $_ if $_ =~ /\bFilterColumn\b/;
930 @unique_queries ? \@unique_queries
931 : @fc_exceptions ? $self->throw_exception(join "; ", map { $_ =~ /(.*) at .+ line \d+$/s } @fc_exceptions )
932 : $self->_non_unique_find_fallback ($call_cond, $attrs)
936 # Run the query, passing the result_class since it should propagate for find
937 my $rs = $self->search_rs( $final_cond, {result_class => $self->result_class, %$attrs} );
938 if ($rs->_resolved_attrs->{collapse}) {
940 carp "Query returned more than one row" if $rs->next;
948 # This is a stop-gap method as agreed during the discussion on find() cleanup:
949 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
951 # It is invoked when find() is called in legacy-mode with insufficiently-unique
952 # condition. It is provided for overrides until a saner way forward is devised
954 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
955 # the road. Please adjust your tests accordingly to catch this situation early
956 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
958 # The method will not be removed without an adequately complete replacement
959 # for strict-mode enforcement
960 sub _non_unique_find_fallback {
961 my ($self, $cond, $attrs) = @_;
963 return $self->_qualify_cond_columns(
965 exists $attrs->{alias}
967 : $self->{attrs}{alias}
972 sub _qualify_cond_columns {
973 my ($self, $cond, $alias) = @_;
975 my %aliased = %$cond;
976 for (keys %aliased) {
977 $aliased{"$alias.$_"} = delete $aliased{$_}
984 sub _build_unique_cond {
986 '_build_unique_cond is a private method, and moreover is about to go '
987 . 'away. Please contact the development team at %s if you believe you '
988 . 'have a genuine use for this method, in order to discuss alternatives.',
989 DBIx::Class::_ENV_::HELP_URL,
992 my ($self, $constraint_name, $cond, $croak_on_null) = @_;
994 $self->result_source->_minimal_valueset_satisfying_constraint(
995 constraint_name => $constraint_name,
997 carp_on_nulls => !$croak_on_null
1001 =head2 search_related
1005 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
1007 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1011 $new_rs = $cd_rs->search_related('artist', {
1015 Searches the specified relationship, optionally specifying a condition and
1016 attributes for matching records. See L</ATTRIBUTES> for more information.
1018 In list context, C<< ->all() >> is called implicitly on the resultset, thus
1019 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
1021 See also L</search_related_rs>.
1025 sub search_related :DBIC_method_is_indirect_sugar {
1026 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1027 return shift->related_resultset(shift)->search(@_);
1030 =head2 search_related_rs
1032 This method works exactly the same as search_related, except that
1033 it guarantees a resultset, even in list context.
1037 sub search_related_rs :DBIC_method_is_indirect_sugar {
1038 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1039 return shift->related_resultset(shift)->search_rs(@_);
1046 =item Arguments: none
1048 =item Return Value: L<$cursor|DBIx::Class::Cursor>
1052 Returns a storage-driven cursor to the given resultset. See
1053 L<DBIx::Class::Cursor> for more information.
1060 return $self->{cursor} ||= do {
1061 my $attrs = $self->_resolved_attrs;
1062 $self->result_source->schema->storage->select(
1063 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
1072 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1074 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1078 my $cd = $schema->resultset('CD')->single({ year => 2001 });
1080 Inflates the first result without creating a cursor if the resultset has
1081 any records in it; if not returns C<undef>. Used by L</find> as a lean version
1084 While this method can take an optional search condition (just like L</search>)
1085 being a fast-code-path it does not recognize search attributes. If you need to
1086 add extra joins or similar, call L</search> and then chain-call L</single> on the
1087 L<DBIx::Class::ResultSet> returned.
1093 As of 0.08100, this method enforces the assumption that the preceding
1094 query returns only one row. If more than one row is returned, you will receive
1097 Query returned more than one row
1099 In this case, you should be using L</next> or L</find> instead, or if you really
1100 know what you are doing, use the L</rows> attribute to explicitly limit the size
1103 This method will also throw an exception if it is called on a resultset prefetching
1104 has_many, as such a prefetch implies fetching multiple rows from the database in
1105 order to assemble the resulting object.
1112 my ($self, $where) = @_;
1114 $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1117 my $attrs = { %{$self->_resolved_attrs} };
1119 $self->throw_exception(
1120 'single() can not be used on resultsets collapsing a has_many. Use find( \%cond ) or next() instead'
1121 ) if $attrs->{collapse};
1124 if (defined $attrs->{where}) {
1127 [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1128 $where, delete $attrs->{where} ]
1131 $attrs->{where} = $where;
1135 my $data = [ $self->result_source->schema->storage->select_single(
1136 $attrs->{from}, $attrs->{select},
1137 $attrs->{where}, $attrs
1140 return undef unless @$data;
1141 $self->{_stashed_rows} = [ $data ];
1142 $self->_construct_results->[0];
1149 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1151 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1155 my $max_length = $rs->get_column('length')->max;
1157 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1162 DBIx::Class::ResultSetColumn->new(@_);
1169 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1171 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1175 # WHERE title LIKE '%blue%'
1176 $cd_rs = $rs->search_like({ title => '%blue%'});
1178 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1179 that this is simply a convenience method retained for ex Class::DBI users.
1180 You most likely want to use L</search> with specific operators.
1182 For more information, see L<DBIx::Class::Manual::Cookbook>.
1184 This method is deprecated and will be removed in 0.09. Use L<search()|/search>
1185 instead. An example conversion is:
1187 ->search_like({ foo => 'bar' });
1191 ->search({ foo => { like => 'bar' } });
1195 sub search_like :DBIC_method_is_indirect_sugar {
1196 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1200 'search_like() is deprecated and will be removed in DBIC version 0.09.'
1201 .' Instead use ->search({ x => { -like => "y%" } })'
1202 .' (note the outer pair of {}s - they are important!)'
1204 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
1205 my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1206 $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1207 return $class->search($query, { %$attrs });
1214 =item Arguments: $first, $last
1216 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1220 Returns a resultset or object list representing a subset of elements from the
1221 resultset slice is called on. Indexes are from 0, i.e., to get the first
1222 three records, call:
1224 my ($one, $two, $three) = $rs->slice(0, 2);
1228 sub slice :DBIC_method_is_indirect_sugar {
1229 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1231 my ($self, $min, $max) = @_;
1232 my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1233 $attrs->{offset} = $self->{attrs}{offset} || 0;
1234 $attrs->{offset} += $min;
1235 $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1236 return $self->search(undef, $attrs);
1243 =item Arguments: none
1245 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1249 Returns the next element in the resultset (C<undef> is there is none).
1251 Can be used to efficiently iterate over records in the resultset:
1253 my $rs = $schema->resultset('CD')->search;
1254 while (my $cd = $rs->next) {
1258 Note that you need to store the resultset object, and call C<next> on it.
1259 Calling C<< resultset('Table')->next >> repeatedly will always return the
1260 first record from the resultset.
1267 if (my $cache = $self->get_cache) {
1268 $self->{all_cache_position} ||= 0;
1269 return $cache->[$self->{all_cache_position}++];
1272 if ($self->{attrs}{cache}) {
1273 delete $self->{pager};
1274 $self->{all_cache_position} = 1;
1275 return ($self->all)[0];
1278 return shift(@{$self->{_stashed_results}}) if @{ $self->{_stashed_results}||[] };
1280 $self->{_stashed_results} = $self->_construct_results
1283 return shift @{$self->{_stashed_results}};
1286 # Constructs as many results as it can in one pass while respecting
1287 # cursor laziness. Several modes of operation:
1289 # * Always builds everything present in @{$self->{_stashed_rows}}
1290 # * If called with $fetch_all true - pulls everything off the cursor and
1291 # builds all result structures (or objects) in one pass
1292 # * If $self->_resolved_attrs->{collapse} is true, checks the order_by
1293 # and if the resultset is ordered properly by the left side:
1294 # * Fetches stuff off the cursor until the "master object" changes,
1295 # and saves the last extra row (if any) in @{$self->{_stashed_rows}}
1297 # * Just fetches, and collapses/constructs everything as if $fetch_all
1298 # was requested (there is no other way to collapse except for an
1300 # * If no collapse is requested - just get the next row, construct and
1302 sub _construct_results {
1303 my ($self, $fetch_all) = @_;
1305 my $rsrc = $self->result_source;
1306 my $attrs = $self->_resolved_attrs;
1311 ! $attrs->{order_by}
1315 my @pcols = $rsrc->primary_columns
1317 # default order for collapsing unless the user asked for something
1318 $attrs->{order_by} = [ map { join '.', $attrs->{alias}, $_} @pcols ];
1319 $attrs->{_ordered_for_collapse} = 1;
1320 $attrs->{_order_is_artificial} = 1;
1323 # this will be used as both initial raw-row collector AND as a RV of
1324 # _construct_results. Not regrowing the array twice matters a lot...
1325 # a surprising amount actually
1326 my $rows = delete $self->{_stashed_rows};
1328 my $cursor; # we may not need one at all
1330 my $did_fetch_all = $fetch_all;
1333 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1334 $rows = [ ($rows ? @$rows : ()), $self->cursor->all ];
1336 elsif( $attrs->{collapse} ) {
1338 # a cursor will need to be closed over in case of collapse
1339 $cursor = $self->cursor;
1341 $attrs->{_ordered_for_collapse} = (
1347 ->_extract_colinfo_of_stable_main_source_order_by_portion($attrs)
1349 ) unless defined $attrs->{_ordered_for_collapse};
1351 if (! $attrs->{_ordered_for_collapse}) {
1354 # instead of looping over ->next, use ->all in stealth mode
1355 # *without* calling a ->reset afterwards
1356 # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1357 if (! $cursor->{_done}) {
1358 $rows = [ ($rows ? @$rows : ()), $cursor->all ];
1359 $cursor->{_done} = 1;
1364 if (! $did_fetch_all and ! @{$rows||[]} ) {
1365 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1366 $cursor ||= $self->cursor;
1367 if (scalar (my @r = $cursor->next) ) {
1372 return undef unless @{$rows||[]};
1374 # sanity check - people are too clever for their own good
1375 if ($attrs->{collapse} and my $aliastypes = $attrs->{_last_sqlmaker_alias_map} ) {
1377 my $multiplied_selectors;
1378 for my $sel_alias ( grep { $_ ne $attrs->{alias} } keys %{ $aliastypes->{selecting} } ) {
1380 $aliastypes->{multiplying}{$sel_alias}
1382 $aliastypes->{premultiplied}{$sel_alias}
1384 $multiplied_selectors->{$_} = 1 for values %{$aliastypes->{selecting}{$sel_alias}{-seen_columns}}
1388 for my $i (0 .. $#{$attrs->{as}} ) {
1389 my $sel = $attrs->{select}[$i];
1391 if (ref $sel eq 'SCALAR') {
1394 elsif( ref $sel eq 'REF' and ref $$sel eq 'ARRAY' ) {
1398 $self->throw_exception(
1399 'Result collapse not possible - selection from a has_many source redirected to the main object'
1400 ) if ($multiplied_selectors->{$sel} and $attrs->{as}[$i] !~ /\./);
1404 # hotspot - skip the setter
1405 my $res_class = $self->_result_class;
1407 my $inflator_cref = $self->{_result_inflator}{cref} ||= do {
1408 $res_class->can ('inflate_result')
1409 or $self->throw_exception("Inflator $res_class does not provide an inflate_result() method");
1412 my $infmap = $attrs->{as};
1414 $self->{_result_inflator}{is_core_row} = ( (
1417 ( \&DBIx::Class::Row::inflate_result || die "No ::Row::inflate_result() - can't happen" )
1418 ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_core_row};
1420 $self->{_result_inflator}{is_hri} = ( (
1421 ! $self->{_result_inflator}{is_core_row}
1423 $inflator_cref == \&DBIx::Class::ResultClass::HashRefInflator::inflate_result
1424 ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_hri};
1427 if ($attrs->{_simple_passthrough_construction}) {
1428 # construct a much simpler array->hash folder for the one-table HRI cases right here
1429 if ($self->{_result_inflator}{is_hri}) {
1430 for my $r (@$rows) {
1431 $r = { map { $infmap->[$_] => $r->[$_] } 0..$#$infmap };
1434 # FIXME SUBOPTIMAL this is a very very very hot spot
1435 # while rather optimal we can *still* do much better, by
1436 # building a smarter Row::inflate_result(), and
1437 # switch to feeding it data via a much leaner interface
1439 # crude unscientific benchmarking indicated the shortcut eval is not worth it for
1440 # this particular resultset size
1441 elsif ( $self->{_result_inflator}{is_core_row} and @$rows < 60 ) {
1442 for my $r (@$rows) {
1443 $r = $inflator_cref->($res_class, $rsrc, { map { $infmap->[$_] => $r->[$_] } (0..$#$infmap) } );
1448 ( $self->{_result_inflator}{is_core_row}
1449 ? '$_ = $inflator_cref->($res_class, $rsrc, { %s }) for @$rows'
1450 # a custom inflator may be a multiplier/reductor - put it in direct list ctx
1451 : '@$rows = map { $inflator_cref->($res_class, $rsrc, { %s } ) } @$rows'
1453 ( join (', ', map { "\$infmap->[$_] => \$_->[$_]" } 0..$#$infmap ) )
1459 $self->{_result_inflator}{is_hri} ? 'hri'
1460 : $self->{_result_inflator}{is_core_row} ? 'classic_pruning'
1461 : 'classic_nonpruning'
1464 unless( $self->{_row_parser}{$parser_type}{cref} ) {
1466 # $args and $attrs to _mk_row_parser are separated to delineate what is
1467 # core collapser stuff and what is dbic $rs specific
1468 $self->{_row_parser}{$parser_type}{src} = $rsrc->_mk_row_parser({
1469 inflate_map => $infmap,
1470 collapse => $attrs->{collapse},
1471 premultiplied => $attrs->{_main_source_premultiplied},
1472 hri_style => $self->{_result_inflator}{is_hri},
1473 prune_null_branches => $self->{_result_inflator}{is_hri} || $self->{_result_inflator}{is_core_row},
1476 $self->{_row_parser}{$parser_type}{cref} = do {
1477 package # hide form PAUSE
1478 DBIx::Class::__GENERATED_ROW_PARSER__;
1480 eval $self->{_row_parser}{$parser_type}{src};
1484 # this needs to close over the *current* cursor, hence why it is not cached above
1485 my $next_cref = ($did_fetch_all or ! $attrs->{collapse})
1488 # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1489 my @r = $cursor->next or return;
1494 $self->{_row_parser}{$parser_type}{cref}->(
1497 ( $self->{_stashed_rows} = [] ),
1498 ( my $null_violations = {} ),
1501 $self->throw_exception(
1502 'Collapse aborted - the following columns are declared (or defaulted to) '
1503 . 'non-nullable within DBIC but NULLs were retrieved from storage: '
1504 . join( ', ', map { "'$infmap->[$_]'" } sort { $a <=> $b } keys %$null_violations )
1505 . ' within data row ' . dump_value({
1508 ( ! defined $self->{_stashed_rows}[0][$_] or length $self->{_stashed_rows}[0][$_] < 50 )
1509 ? $self->{_stashed_rows}[0][$_]
1510 : substr( $self->{_stashed_rows}[0][$_], 0, 50 ) . '...'
1511 } 0 .. $#{$self->{_stashed_rows}[0]}
1513 ) if keys %$null_violations;
1515 # simple in-place substitution, does not regrow $rows
1516 if ($self->{_result_inflator}{is_core_row}) {
1517 $_ = $inflator_cref->($res_class, $rsrc, @$_) for @$rows
1519 # Special-case multi-object HRI - there is no $inflator_cref pass at all
1520 elsif ( ! $self->{_result_inflator}{is_hri} ) {
1521 # the inflator may be a multiplier/reductor - put it in list ctx
1522 @$rows = map { $inflator_cref->($res_class, $rsrc, @$_) } @$rows;
1526 # The @$rows check seems odd at first - why wouldn't we want to warn
1527 # regardless? The issue is things like find() etc, where the user
1528 # *knows* only one result will come back. In these cases the ->all
1529 # is not a pessimization, but rather something we actually want
1531 'Unable to properly collapse has_many results in iterator mode due '
1532 . 'to order criteria - performed an eager cursor slurp underneath. '
1533 . 'Consider using ->all() instead'
1534 ) if ( ! $fetch_all and @$rows > 1 );
1539 =head2 result_source
1543 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1545 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1549 An accessor for the primary ResultSource object from which this ResultSet
1556 =item Arguments: $result_class?
1558 =item Return Value: $result_class
1562 An accessor for the class to use when creating result objects. Defaults to
1563 C<< result_source->result_class >> - which in most cases is the name of the
1564 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1566 Note that changing the result_class will also remove any components
1567 that were originally loaded in the source class via
1568 L<load_components|Class::C3::Componentised/load_components( @comps )>.
1569 Any overloaded methods in the original source class will not run.
1574 my ($self, $result_class) = @_;
1575 if ($result_class) {
1577 # don't fire this for an object
1578 $self->ensure_class_loaded($result_class)
1579 unless ref($result_class);
1581 if ($self->get_cache) {
1582 carp_unique('Changing the result_class of a ResultSet instance with cached results is a noop - the cache contents will not be altered');
1584 # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1585 elsif ($self->{cursor} && $self->{cursor}{_pos}) {
1586 $self->throw_exception('Changing the result_class of a ResultSet instance with an active cursor is not supported');
1589 $self->_result_class($result_class);
1591 delete $self->{_result_inflator};
1593 $self->_result_class;
1600 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1602 =item Return Value: $count
1606 Performs an SQL C<COUNT> with the same query as the resultset was built
1607 with to find the number of elements. Passing arguments is equivalent to
1608 C<< $rs->search ($cond, \%attrs)->count >>
1614 return $self->search_rs(@_)->count if @_ and defined $_[0];
1615 return scalar @{ $self->get_cache } if $self->get_cache;
1617 my $attrs = { %{ $self->_resolved_attrs } };
1619 # this is a little optimization - it is faster to do the limit
1620 # adjustments in software, instead of a subquery
1621 my ($rows, $offset) = delete @{$attrs}{qw/rows offset/};
1624 if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1625 $crs = $self->_count_subq_rs ($attrs);
1628 $crs = $self->_count_rs ($attrs);
1630 my $count = $crs->next;
1632 $count -= $offset if $offset;
1633 $count = $rows if $rows and $rows < $count;
1634 $count = 0 if ($count < 0);
1643 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1645 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1649 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1650 This can be very handy for subqueries:
1652 ->search( { amount => $some_rs->count_rs->as_query } )
1654 As with regular resultsets the SQL query will be executed only after
1655 the resultset is accessed via L</next> or L</all>. That would return
1656 the same single value obtainable via L</count>.
1662 return $self->search_rs(@_)->count_rs if @_;
1664 # this may look like a lack of abstraction (count() does about the same)
1665 # but in fact an _rs *must* use a subquery for the limits, as the
1666 # software based limiting can not be ported if this $rs is to be used
1667 # in a subquery itself (i.e. ->as_query)
1668 if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1669 return $self->_count_subq_rs($self->{_attrs});
1672 return $self->_count_rs($self->{_attrs});
1677 # returns a ResultSetColumn object tied to the count query
1680 my ($self, $attrs) = @_;
1682 my $rsrc = $self->result_source;
1684 my $tmp_attrs = { %$attrs };
1685 # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1686 delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1688 # overwrite the selector (supplied by the storage)
1689 $rsrc->resultset_class->new($rsrc, {
1691 select => $rsrc->schema->storage->_count_select ($rsrc, $attrs),
1693 })->get_column ('count');
1697 # same as above but uses a subquery
1699 sub _count_subq_rs {
1700 my ($self, $attrs) = @_;
1702 my $rsrc = $self->result_source;
1704 my $sub_attrs = { %$attrs };
1705 # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1706 delete @{$sub_attrs}{qw/collapse columns as select order_by for/};
1708 # if we multi-prefetch we group_by something unique, as this is what we would
1709 # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1710 if ( $attrs->{collapse} ) {
1711 $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1712 $rsrc->_identifying_column_set || $self->throw_exception(
1713 'Unable to construct a unique group_by criteria properly collapsing the '
1714 . 'has_many prefetch before count()'
1719 # Calculate subquery selector
1720 if (my $g = $sub_attrs->{group_by}) {
1722 my $sql_maker = $rsrc->schema->storage->sql_maker;
1724 # necessary as the group_by may refer to aliased functions
1726 for my $sel (@{$attrs->{select}}) {
1727 $sel_index->{$sel->{-as}} = $sel
1728 if (ref $sel eq 'HASH' and $sel->{-as});
1731 # anything from the original select mentioned on the group-by needs to make it to the inner selector
1732 # also look for named aggregates referred in the having clause
1733 # having often contains scalarrefs - thus parse it out entirely
1735 if ($attrs->{having}) {
1736 local $sql_maker->{having_bind};
1737 local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1738 local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1739 unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1740 $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1741 # if we don't unset it we screw up retarded but unfortunately working
1742 # 'MAX(foo.bar)' => { '>', 3 }
1743 $sql_maker->{name_sep} = '';
1746 my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1748 my $having_sql = $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} });
1751 # search for both a proper quoted qualified string, for a naive unquoted scalarref
1752 # and if all fails for an utterly naive quoted scalar-with-function
1753 while ($having_sql =~ /
1754 $rquote $sep $lquote (.+?) $rquote
1756 [\s,] \w+ \. (\w+) [\s,]
1758 [\s,] $lquote (.+?) $rquote [\s,]
1760 my $part = $1 || $2 || $3; # one of them matched if we got here
1761 unless ($seen_having{$part}++) {
1768 my $colpiece = $sel_index->{$_} || $_;
1770 # unqualify join-based group_by's. Arcane but possible query
1771 # also horrible horrible hack to alias a column (not a func.)
1772 # (probably need to introduce SQLA syntax)
1773 if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1776 $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1778 push @{$sub_attrs->{select}}, $colpiece;
1782 my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1783 $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1786 return $rsrc->resultset_class
1787 ->new ($rsrc, $sub_attrs)
1789 ->search_rs ({}, { columns => { count => $rsrc->schema->storage->_count_select ($rsrc, $attrs) } })
1790 ->get_column ('count');
1794 =head2 count_literal
1796 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1797 should only be used in that context. See L</search_literal> for further info.
1801 =item Arguments: $sql_fragment, @standalone_bind_values
1803 =item Return Value: $count
1807 Counts the results in a literal query. Equivalent to calling L</search_literal>
1808 with the passed arguments, then L</count>.
1812 sub count_literal :DBIC_method_is_indirect_sugar {
1813 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1814 shift->search_literal(@_)->count
1821 =item Arguments: none
1823 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1827 Returns all elements in the resultset.
1834 $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1837 delete @{$self}{qw/_stashed_rows _stashed_results/};
1839 if (my $c = $self->get_cache) {
1843 $self->cursor->reset;
1845 my $objs = $self->_construct_results('fetch_all') || [];
1847 $self->set_cache($objs) if $self->{attrs}{cache};
1856 =item Arguments: none
1858 =item Return Value: $self
1862 Resets the resultset's cursor, so you can iterate through the elements again.
1863 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1871 delete @{$self}{qw/_stashed_rows _stashed_results/};
1872 $self->{all_cache_position} = 0;
1873 $self->cursor->reset;
1881 =item Arguments: none
1883 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1887 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1888 an object for the first result (or C<undef> if the resultset is empty).
1892 sub first :DBIC_method_is_indirect_sugar {
1893 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
1894 return $_[0]->reset->next;
1900 # Determines whether and what type of subquery is required for the $rs operation.
1901 # If grouping is necessary either supplies its own, or verifies the current one
1902 # After all is done delegates to the proper storage method.
1904 sub _rs_update_delete {
1905 my ($self, $op, $values) = @_;
1907 my $rsrc = $self->result_source;
1908 my $storage = $rsrc->schema->storage;
1910 my $attrs = { %{$self->_resolved_attrs} };
1912 my $join_classifications;
1913 my ($existing_group_by) = delete @{$attrs}{qw(group_by _grouped_by_distinct)};
1915 # do we need a subquery for any reason?
1917 defined $existing_group_by
1919 # if {from} is unparseable wrap a subq
1920 ref($attrs->{from}) ne 'ARRAY'
1922 # limits call for a subq
1923 $self->_has_resolved_attr(qw/rows offset/)
1926 # simplify the joinmap, so we can further decide if a subq is necessary
1927 if (!$needs_subq and @{$attrs->{from}} > 1) {
1929 ($attrs->{from}, $join_classifications) =
1930 $storage->_prune_unused_joins ($attrs);
1932 # any non-pruneable non-local restricting joins imply subq
1933 $needs_subq = grep { $_ ne $attrs->{alias} } keys %{ $join_classifications->{restricting} || {} };
1936 # check if the head is composite (by now all joins are thrown out unless $needs_subq)
1938 (ref $attrs->{from}[0]) ne 'HASH'
1940 ref $attrs->{from}[0]{ $attrs->{from}[0]{-alias} }
1944 # do we need anything like a subquery?
1945 if (! $needs_subq) {
1946 # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1947 # a condition containing 'me' or other table prefixes will not work
1948 # at all. Tell SQLMaker to dequalify idents via a gross hack.
1950 my $sqla = $rsrc->schema->storage->sql_maker;
1951 local $sqla->{_dequalify_idents} = 1;
1952 \[ $sqla->_recurse_where($self->{cond}) ];
1956 # we got this far - means it is time to wrap a subquery
1957 my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1959 "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1965 # make a new $rs selecting only the PKs (that's all we really need for the subq)
1966 delete $attrs->{$_} for qw/select as collapse/;
1967 $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1969 # this will be consumed by the pruner waaaaay down the stack
1970 $attrs->{_force_prune_multiplying_joins} = 1;
1972 my $subrs = (ref $self)->new($rsrc, $attrs);
1974 if (@$idcols == 1) {
1975 $cond = { $idcols->[0] => { -in => $subrs->as_query } };
1977 elsif ($storage->_use_multicolumn_in) {
1978 # no syntax for calling this properly yet
1979 # !!! EXPERIMENTAL API !!! WILL CHANGE !!!
1980 $cond = $storage->sql_maker->_where_op_multicolumn_in (
1981 $idcols, # how do I convey a list of idents...? can binds reside on lhs?
1986 # if all else fails - get all primary keys and operate over a ORed set
1987 # wrap in a transaction for consistency
1988 # this is where the group_by/multiplication starts to matter
1992 # we do not need to check pre-multipliers, since if the premulti is there, its
1993 # parent (who is multi) will be there too
1994 keys %{ $join_classifications->{multiplying} || {} }
1996 # make sure if there is a supplied group_by it matches the columns compiled above
1997 # perfectly. Anything else can not be sanely executed on most databases so croak
1998 # right then and there
1999 if ($existing_group_by) {
2000 my @current_group_by = map
2001 { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
2006 join ("\x00", sort @current_group_by)
2008 join ("\x00", sort @{$attrs->{columns}} )
2010 $self->throw_exception (
2011 "You have just attempted a $op operation on a resultset which does group_by"
2012 . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
2013 . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
2014 . ' kind of queries. Please retry the operation with a modified group_by or'
2015 . ' without using one at all.'
2020 $subrs = $subrs->search_rs({}, { group_by => $attrs->{columns} });
2023 $guard = $storage->txn_scope_guard;
2025 for my $row ($subrs->cursor->all) {
2027 { $idcols->[$_] => $row->[$_] }
2034 my $res = $cond ? $storage->$op (
2036 $op eq 'update' ? $values : (),
2040 $guard->commit if $guard;
2049 =item Arguments: \%values
2051 =item Return Value: $underlying_storage_rv
2055 Sets the specified columns in the resultset to the supplied values in a
2056 single query. Note that this will not run any accessor/set_column/update
2057 triggers, nor will it update any result object instances derived from this
2058 resultset (this includes the contents of the L<resultset cache|/set_cache>
2059 if any). See L</update_all> if you need to execute any on-update
2060 triggers or cascades defined either by you or a
2061 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2063 The return value is a pass through of what the underlying
2064 storage backend returned, and may vary. See L<DBI/execute> for the most
2069 Note that L</update> does not process/deflate any of the values passed in.
2070 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
2071 ensure manually that any value passed to this method will stringify to
2072 something the RDBMS knows how to deal with. A notable example is the
2073 handling of L<DateTime> objects, for more info see:
2074 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
2079 my ($self, $values) = @_;
2080 $self->throw_exception('Values for update must be a hash')
2081 unless ref $values eq 'HASH';
2083 return $self->_rs_update_delete ('update', $values);
2090 =item Arguments: \%values
2092 =item Return Value: 1
2096 Fetches all objects and updates them one at a time via
2097 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
2098 triggers, while L</update> will not.
2103 my ($self, $values) = @_;
2104 $self->throw_exception('Values for update_all must be a hash')
2105 unless ref $values eq 'HASH';
2107 my $guard = $self->result_source->schema->txn_scope_guard;
2108 $_->update({%$values}) for $self->all; # shallow copy - update will mangle it
2117 =item Arguments: none
2119 =item Return Value: $underlying_storage_rv
2123 Deletes the rows matching this resultset in a single query. Note that this
2124 will not run any delete triggers, nor will it alter the
2125 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
2126 derived from this resultset (this includes the contents of the
2127 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
2128 execute any on-delete triggers or cascades defined either by you or a
2129 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2131 The return value is a pass through of what the underlying storage backend
2132 returned, and may vary. See L<DBI/execute> for the most common case.
2138 $self->throw_exception('delete does not accept any arguments')
2141 return $self->_rs_update_delete ('delete');
2148 =item Arguments: none
2150 =item Return Value: 1
2154 Fetches all objects and deletes them one at a time via
2155 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2156 triggers, while L</delete> will not.
2162 $self->throw_exception('delete_all does not accept any arguments')
2165 my $guard = $self->result_source->schema->txn_scope_guard;
2166 $_->delete for $self->all;
2175 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2177 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2181 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2188 The context of this method call has an important effect on what is
2189 submitted to storage. In void context data is fed directly to fastpath
2190 insertion routines provided by the underlying storage (most often
2191 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2192 L<insert|DBIx::Class::Row/insert> calls on the
2193 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2194 augmentation of these methods provided by components. For example if you
2195 are using something like L<DBIx::Class::UUIDColumns> to create primary
2196 keys for you, you will find that your PKs are empty. In this case you
2197 will have to explicitly force scalar or list context in order to create
2202 In non-void (scalar or list) context, this method is simply a wrapper
2203 for L</create>. Depending on list or scalar context either a list of
2204 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2205 containing these objects is returned.
2207 When supplying data in "arrayref of arrayrefs" invocation style, the
2208 first element should be a list of column names and each subsequent
2209 element should be a data value in the earlier specified column order.
2212 $schema->resultset("Artist")->populate([
2213 [ qw( artistid name ) ],
2214 [ 100, 'A Formally Unknown Singer' ],
2215 [ 101, 'A singer that jumped the shark two albums ago' ],
2216 [ 102, 'An actually cool singer' ],
2219 For the arrayref of hashrefs style each hashref should be a structure
2220 suitable for passing to L</create>. Multi-create is also permitted with
2223 $schema->resultset("Artist")->populate([
2224 { artistid => 4, name => 'Manufactured Crap', cds => [
2225 { title => 'My First CD', year => 2006 },
2226 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2229 { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2230 { title => 'My parents sold me to a record company', year => 2005 },
2231 { title => 'Why Am I So Ugly?', year => 2006 },
2232 { title => 'I Got Surgery and am now Popular', year => 2007 }
2237 If you attempt a void-context multi-create as in the example above (each
2238 Artist also has the related list of CDs), and B<do not> supply the
2239 necessary autoinc foreign key information, this method will proxy to the
2240 less efficient L</create>, and then throw the Result objects away. In this
2241 case there are obviously no benefits to using this method over L</create>.
2248 # this is naive and just a quick check
2249 # the types will need to be checked more thoroughly when the
2250 # multi-source populate gets added
2252 ref $_[0] eq 'ARRAY'
2254 ( @{$_[0]} or return )
2256 ( ref $_[0][0] eq 'HASH' or ref $_[0][0] eq 'ARRAY' )
2259 ) or $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2261 # FIXME - no cref handling
2262 # At this point assume either hashes or arrays
2264 my $rsrc = $self->result_source;
2265 my $storage = $rsrc->schema->storage;
2267 if(defined wantarray) {
2268 my (@results, $guard);
2270 if (ref $data->[0] eq 'ARRAY') {
2271 # column names only, nothing to do
2272 return if @$data == 1;
2274 $guard = $storage->txn_scope_guard
2278 { my $vals = $_; $self->new_result({ map { $data->[0][$_] => $vals->[$_] } 0..$#{$data->[0]} })->insert }
2279 @{$data}[1 .. $#$data]
2284 $guard = $storage->txn_scope_guard
2287 @results = map { $self->new_result($_)->insert } @$data;
2290 $guard->commit if $guard;
2291 return wantarray ? @results : \@results;
2294 # we have to deal with *possibly incomplete* related data
2295 # this means we have to walk the data structure twice
2296 # whether we want this or not
2297 # jnap, I hate you ;)
2298 my $rel_info = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2300 my ($colinfo, $colnames, $slices_with_rels);
2304 for my $i (0 .. $#$data) {
2306 my $current_slice_seen_rel_infos;
2308 ### Determine/Supplement collists
2309 ### BEWARE - This is a hot piece of code, a lot of weird idioms were used
2310 if( ref $data->[$i] eq 'ARRAY' ) {
2312 # positional(!) explicit column list
2314 # column names only, nothing to do
2315 return if @$data == 1;
2317 $colinfo->{$data->[0][$_]} = { pos => $_, name => $data->[0][$_] } and push @$colnames, $data->[0][$_]
2318 for 0 .. $#{$data->[0]};
2325 for (values %$colinfo) {
2326 if ($_->{is_rel} ||= (
2327 $rel_info->{$_->{name}}
2330 ref $data->[$i][$_->{pos}] eq 'ARRAY'
2332 ref $data->[$i][$_->{pos}] eq 'HASH'
2335 defined blessed $data->[$i][$_->{pos}]
2337 $data->[$i][$_->{pos}]->isa(
2338 $DBIx::Class::ResultSource::__expected_result_class_isa
2342 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2351 # moar sanity check... sigh
2352 for ( ref $data->[$i][$_->{pos}] eq 'ARRAY' ? @{$data->[$i][$_->{pos}]} : $data->[$i][$_->{pos}] ) {
2357 $DBIx::Class::ResultSource::__expected_result_class_isa
2361 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2365 carp_unique("Fast-path populate() with supplied related objects is not possible - falling back to regular create()");
2366 return my $throwaway = $self->populate(@_);
2370 push @$current_slice_seen_rel_infos, $rel_info->{$_->{name}};
2375 if ($current_slice_seen_rel_infos) {
2376 push @$slices_with_rels, { map { $colnames->[$_] => $data->[$i][$_] } 0 .. $#$colnames };
2378 # this is needed further down to decide whether or not to fallback to create()
2379 $colinfo->{$colnames->[$_]}{seen_null} ||= ! defined $data->[$i][$_]
2380 for 0 .. $#$colnames;
2383 elsif( ref $data->[$i] eq 'HASH' ) {
2385 for ( sort keys %{$data->[$i]} ) {
2387 $colinfo->{$_} ||= do {
2389 $self->throw_exception("Column '$_' must be present in supplied explicit column list")
2390 if $data_start; # it will be 0 on AoH, 1 on AoA
2392 push @$colnames, $_;
2395 { pos => $#$colnames, name => $_ }
2398 if ($colinfo->{$_}{is_rel} ||= (
2402 ref $data->[$i]{$_} eq 'ARRAY'
2404 ref $data->[$i]{$_} eq 'HASH'
2407 defined blessed $data->[$i]{$_}
2409 $data->[$i]{$_}->isa(
2410 $DBIx::Class::ResultSource::__expected_result_class_isa
2414 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2423 # moar sanity check... sigh
2424 for ( ref $data->[$i]{$_} eq 'ARRAY' ? @{$data->[$i]{$_}} : $data->[$i]{$_} ) {
2429 $DBIx::Class::ResultSource::__expected_result_class_isa
2433 msg => 'Global $DBIx::Class::ResultSource::__expected_result_class_isa unexpectedly unset...'
2437 carp_unique("Fast-path populate() with supplied related objects is not possible - falling back to regular create()");
2438 return my $throwaway = $self->populate(@_);
2442 push @$current_slice_seen_rel_infos, $rel_info->{$_};
2446 if ($current_slice_seen_rel_infos) {
2447 push @$slices_with_rels, $data->[$i];
2449 # this is needed further down to decide whether or not to fallback to create()
2450 $colinfo->{$_}{seen_null} ||= ! defined $data->[$i]{$_}
2451 for keys %{$data->[$i]};
2455 $self->throw_exception('Unexpected populate() data structure member type: ' . ref $data->[$i] );
2459 { $_->{attrs}{is_depends_on} }
2460 @{ $current_slice_seen_rel_infos || [] }
2462 carp_unique("Fast-path populate() of belongs_to relationship data is not possible - falling back to regular create()");
2463 return my $throwaway = $self->populate(@_);
2467 if( $slices_with_rels ) {
2469 # need to exclude the rel "columns"
2470 $colnames = [ grep { ! $colinfo->{$_}{is_rel} } @$colnames ];
2472 # extra sanity check - ensure the main source is in fact identifiable
2473 # the localizing of nullability is insane, but oh well... the use-case is legit
2474 my $ci = $rsrc->columns_info($colnames);
2476 $ci->{$_} = { %{$ci->{$_}}, is_nullable => 0 }
2477 for grep { ! $colinfo->{$_}{seen_null} } keys %$ci;
2479 unless( $rsrc->_identifying_column_set($ci) ) {
2480 carp_unique("Fast-path populate() of non-uniquely identifiable rows with related data is not possible - falling back to regular create()");
2481 return my $throwaway = $self->populate(@_);
2485 ### inherit the data locked in the conditions of the resultset
2486 my ($rs_data) = $self->_merge_with_rscond({});
2487 delete @{$rs_data}{@$colnames}; # passed-in stuff takes precedence
2489 # if anything left - decompose rs_data
2491 if (keys %$rs_data) {
2492 push @$rs_data_vals, $rs_data->{$_}
2493 for sort keys %$rs_data;
2498 $guard = $storage->txn_scope_guard
2499 if $slices_with_rels;
2501 ### main source data
2502 # FIXME - need to switch entirely to a coderef-based thing,
2503 # so that large sets aren't copied several times... I think
2504 $storage->_insert_bulk(
2506 [ @$colnames, sort keys %$rs_data ],
2508 ref $data->[$_] eq 'ARRAY'
2510 $slices_with_rels ? [ @{$data->[$_]}[0..$#$colnames], @{$rs_data_vals||[]} ] # the collist changed
2511 : $rs_data_vals ? [ @{$data->[$_]}, @$rs_data_vals ]
2514 : [ @{$data->[$_]}{@$colnames}, @{$rs_data_vals||[]} ]
2515 } $data_start .. $#$data ],
2518 ### do the children relationships
2519 if ( $slices_with_rels ) {
2520 my @rels = grep { $colinfo->{$_}{is_rel} } keys %$colinfo
2521 or die 'wtf... please report a bug with DBIC_TRACE=1 output (stacktrace)';
2523 for my $sl (@$slices_with_rels) {
2525 my ($main_proto, $main_proto_rs);
2526 for my $rel (@rels) {
2527 next unless defined $sl->{$rel};
2531 (map { $_ => $sl->{$_} } @$colnames),
2534 unless (defined $colinfo->{$rel}{rs}) {
2536 $colinfo->{$rel}{rs} = $rsrc->related_source($rel)->resultset;
2538 $colinfo->{$rel}{fk_map} = { reverse %{ $rsrc->resolve_relationship_condition(
2541 # an API where these are optional would be too cumbersome,
2542 # instead always pass in some dummy values
2544 )->{identity_map} || {} } };
2548 $colinfo->{$rel}{rs}->search_rs({ map # only so that we inherit them values properly, no actual search
2551 ( $main_proto_rs ||= $rsrc->resultset->search_rs($main_proto) )
2552 ->get_column( $colinfo->{$rel}{fk_map}{$_} )
2556 keys %{$colinfo->{$rel}{fk_map}}
2557 })->populate( ref $sl->{$rel} eq 'ARRAY' ? $sl->{$rel} : [ $sl->{$rel} ] );
2564 $guard->commit if $guard;
2571 =item Arguments: none
2573 =item Return Value: L<$pager|Data::Page>
2577 Returns a L<Data::Page> object for the current resultset. Only makes
2578 sense for queries with a C<page> attribute.
2580 To get the full count of entries for a paged resultset, call
2581 C<total_entries> on the L<Data::Page> object.
2588 return $self->{pager} if $self->{pager};
2590 my $attrs = $self->{attrs};
2591 if (!defined $attrs->{page}) {
2592 $self->throw_exception("Can't create pager for non-paged rs");
2594 elsif ($attrs->{page} <= 0) {
2595 $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2597 $attrs->{rows} ||= 10;
2599 # throw away the paging flags and re-run the count (possibly
2600 # with a subselect) to get the real total count
2601 my $count_attrs = { %$attrs };
2602 delete @{$count_attrs}{qw/rows offset page pager/};
2604 my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2606 require DBIx::Class::ResultSet::Pager;
2607 return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2608 sub { $total_rs->count }, #lazy-get the total
2610 $self->{attrs}{page},
2618 =item Arguments: $page_number
2620 =item Return Value: L<$resultset|/search>
2624 Returns a resultset for the $page_number page of the resultset on which page
2625 is called, where each page contains a number of rows equal to the 'rows'
2626 attribute set on the resultset (10 by default).
2631 my ($self, $page) = @_;
2632 return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2639 =item Arguments: \%col_data
2641 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2645 Creates a new result object in the resultset's result class and returns
2646 it. The row is not inserted into the database at this point, call
2647 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2648 will tell you whether the result object has been inserted or not.
2650 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2655 my ($self, $values) = @_;
2657 $self->throw_exception( "Result object instantiation requires a single hashref argument" )
2658 if @_ > 2 or ref $values ne 'HASH';
2660 my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2662 my $new = $self->result_class->new({
2664 ( @$cols_from_relations
2665 ? (-cols_from_relations => $cols_from_relations)
2668 -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2672 reftype($new) eq 'HASH'
2678 carp_unique (sprintf (
2679 "%s->new returned a blessed empty hashref - a strong indicator something is wrong with its inheritance chain",
2680 $self->result_class,
2687 # _merge_with_rscond
2689 # Takes a simple hash of K/V data and returns its copy merged with the
2690 # condition already present on the resultset. Additionally returns an
2691 # arrayref of value/condition names, which were inferred from related
2692 # objects (this is needed for in-memory related objects)
2693 sub _merge_with_rscond {
2694 my ($self, $data) = @_;
2696 my ($implied_data, @cols_from_relations);
2698 my $alias = $self->{attrs}{alias};
2700 if (! defined $self->{cond}) {
2701 # just massage $data below
2703 elsif ($self->{cond} eq UNRESOLVABLE_CONDITION) {
2704 $implied_data = $self->{attrs}{related_objects}; # nothing might have been inserted yet
2705 @cols_from_relations = keys %{ $implied_data || {} };
2708 my $eqs = extract_equality_conditions( $self->{cond}, 'consider_nulls' );
2709 $implied_data = { map {
2710 ( ($eqs->{$_}||'') eq UNRESOLVABLE_CONDITION ) ? () : ( $_ => $eqs->{$_} )
2716 { %{ $self->_remove_alias($_, $alias) } }
2717 # precedence must be given to passed values over values inherited from
2718 # the cond, so the order here is important.
2719 ( $implied_data||(), $data)
2721 \@cols_from_relations
2725 # _has_resolved_attr
2727 # determines if the resultset defines at least one
2728 # of the attributes supplied
2730 # used to determine if a subquery is necessary
2732 # supports some virtual attributes:
2734 # This will scan for any joins being present on the resultset.
2735 # It is not a mere key-search but a deep inspection of {from}
2738 sub _has_resolved_attr {
2739 my ($self, @attr_names) = @_;
2741 my $attrs = $self->_resolved_attrs;
2745 for my $n (@attr_names) {
2746 if (grep { $n eq $_ } (qw/-join/) ) {
2747 $extra_checks{$n}++;
2751 my $attr = $attrs->{$n};
2753 next if not defined $attr;
2755 if (ref $attr eq 'HASH') {
2756 return 1 if keys %$attr;
2758 elsif (ref $attr eq 'ARRAY') {
2766 # a resolved join is expressed as a multi-level from
2768 $extra_checks{-join}
2770 ref $attrs->{from} eq 'ARRAY'
2772 @{$attrs->{from}} > 1
2780 # Remove the specified alias from the specified query hash. A copy is made so
2781 # the original query is not modified.
2784 my ($self, $query, $alias) = @_;
2786 my %orig = %{ $query || {} };
2789 foreach my $key (keys %orig) {
2791 $unaliased{$key} = $orig{$key};
2794 $unaliased{$1} = $orig{$key}
2795 if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2805 =item Arguments: none
2807 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2811 Returns the SQL query and bind vars associated with the invocant.
2813 This is generally used as the RHS for a subquery.
2820 my $attrs = { %{ $self->_resolved_attrs } };
2822 my $aq = $self->result_source->schema->storage->_select_args_to_query (
2823 $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
2833 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2835 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2839 my $artist = $schema->resultset('Artist')->find_or_new(
2840 { artist => 'fred' }, { key => 'artists' });
2842 $cd->cd_to_producer->find_or_new({ producer => $producer },
2843 { key => 'primary' });
2845 Find an existing record from this resultset using L</find>. if none exists,
2846 instantiate a new result object and return it. The object will not be saved
2847 into your storage until you call L<DBIx::Class::Row/insert> on it.
2849 You most likely want this method when looking for existing rows using a unique
2850 constraint that is not the primary key, or looking for related rows.
2852 If you want objects to be saved immediately, use L</find_or_create> instead.
2854 B<Note>: Make sure to read the documentation of L</find> and understand the
2855 significance of the C<key> attribute, as its lack may skew your search, and
2856 subsequently result in spurious new objects.
2858 B<Note>: Take care when using C<find_or_new> with a table having
2859 columns with default values that you intend to be automatically
2860 supplied by the database (e.g. an auto_increment primary key column).
2861 In normal usage, the value of such columns should NOT be included at
2862 all in the call to C<find_or_new>, even when set to C<undef>.
2868 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
2869 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
2870 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2873 return $self->new_result($hash);
2880 =item Arguments: \%col_data
2882 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2886 Attempt to create a single new row or a row with multiple related rows
2887 in the table represented by the resultset (and related tables). This
2888 will not check for duplicate rows before inserting, use
2889 L</find_or_create> to do that.
2891 To create one row for this resultset, pass a hashref of key/value
2892 pairs representing the columns of the table and the values you wish to
2893 store. If the appropriate relationships are set up, foreign key fields
2894 can also be passed an object representing the foreign row, and the
2895 value will be set to its primary key.
2897 To create related objects, pass a hashref of related-object column values
2898 B<keyed on the relationship name>. If the relationship is of type C<multi>
2899 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2900 The process will correctly identify columns holding foreign keys, and will
2901 transparently populate them from the keys of the corresponding relation.
2902 This can be applied recursively, and will work correctly for a structure
2903 with an arbitrary depth and width, as long as the relationships actually
2904 exists and the correct column data has been supplied.
2906 Instead of hashrefs of plain related data (key/value pairs), you may
2907 also pass new or inserted objects. New objects (not inserted yet, see
2908 L</new_result>), will be inserted into their appropriate tables.
2910 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2912 Example of creating a new row.
2914 $person_rs->create({
2915 name=>"Some Person",
2916 email=>"somebody@someplace.com"
2919 Example of creating a new row and also creating rows in a related C<has_many>
2920 or C<has_one> resultset. Note Arrayref.
2923 { artistid => 4, name => 'Manufactured Crap', cds => [
2924 { title => 'My First CD', year => 2006 },
2925 { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2930 Example of creating a new row and also creating a row in a related
2931 C<belongs_to> resultset. Note Hashref.
2934 title=>"Music for Silly Walks",
2937 name=>"Silly Musician",
2945 When subclassing ResultSet never attempt to override this method. Since
2946 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2947 lot of the internals simply never call it, so your override will be
2948 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2949 or L<DBIx::Class::Row/insert> depending on how early in the
2950 L</create> process you need to intervene. See also warning pertaining to
2957 sub create :DBIC_method_is_indirect_sugar {
2958 #my ($self, $col_data) = @_;
2959 DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_INDIRECT_CALLS and fail_on_internal_call;
2960 return shift->new_result(shift)->insert;
2963 =head2 find_or_create
2967 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2969 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2973 $cd->cd_to_producer->find_or_create({ producer => $producer },
2974 { key => 'primary' });
2976 Tries to find a record based on its primary key or unique constraints; if none
2977 is found, creates one and returns that instead.
2979 my $cd = $schema->resultset('CD')->find_or_create({
2981 artist => 'Massive Attack',
2982 title => 'Mezzanine',
2986 Also takes an optional C<key> attribute, to search by a specific key or unique
2987 constraint. For example:
2989 my $cd = $schema->resultset('CD')->find_or_create(
2991 artist => 'Massive Attack',
2992 title => 'Mezzanine',
2994 { key => 'cd_artist_title' }
2997 B<Note>: Make sure to read the documentation of L</find> and understand the
2998 significance of the C<key> attribute, as its lack may skew your search, and
2999 subsequently result in spurious row creation.
3001 B<Note>: Because find_or_create() reads from the database and then
3002 possibly inserts based on the result, this method is subject to a race
3003 condition. Another process could create a record in the table after
3004 the find has completed and before the create has started. To avoid
3005 this problem, use find_or_create() inside a transaction.
3007 B<Note>: Take care when using C<find_or_create> with a table having
3008 columns with default values that you intend to be automatically
3009 supplied by the database (e.g. an auto_increment primary key column).
3010 In normal usage, the value of such columns should NOT be included at
3011 all in the call to C<find_or_create>, even when set to C<undef>.
3013 See also L</find> and L</update_or_create>. For information on how to declare
3014 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
3016 If you need to know if an existing row was found or a new one created use
3017 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
3018 to call L<DBIx::Class::Row/insert> to save the newly created row to the
3021 my $cd = $schema->resultset('CD')->find_or_new({
3023 artist => 'Massive Attack',
3024 title => 'Mezzanine',
3028 if( !$cd->in_storage ) {
3035 sub find_or_create {
3037 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
3038 my $hash = ref $_[0] eq 'HASH' ? shift : {@_};
3039 if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
3042 return $self->new_result($hash)->insert;
3045 =head2 update_or_create
3049 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
3051 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
3055 $resultset->update_or_create({ col => $val, ... });
3057 Like L</find_or_create>, but if a row is found it is immediately updated via
3058 C<< $found_row->update (\%col_data) >>.
3061 Takes an optional C<key> attribute to search on a specific unique constraint.
3064 # In your application
3065 my $cd = $schema->resultset('CD')->update_or_create(
3067 artist => 'Massive Attack',
3068 title => 'Mezzanine',
3071 { key => 'cd_artist_title' }
3074 $cd->cd_to_producer->update_or_create({
3075 producer => $producer,
3081 B<Note>: Make sure to read the documentation of L</find> and understand the
3082 significance of the C<key> attribute, as its lack may skew your search, and
3083 subsequently result in spurious row creation.
3085 B<Note>: Take care when using C<update_or_create> with a table having
3086 columns with default values that you intend to be automatically
3087 supplied by the database (e.g. an auto_increment primary key column).
3088 In normal usage, the value of such columns should NOT be included at
3089 all in the call to C<update_or_create>, even when set to C<undef>.
3091 See also L</find> and L</find_or_create>. For information on how to declare
3092 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
3094 If you need to know if an existing row was updated or a new one created use
3095 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
3096 to call L<DBIx::Class::Row/insert> to save the newly created row to the
3101 sub update_or_create {
3103 my $attrs = (@_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {});
3104 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
3106 my $row = $self->find($cond, $attrs);
3108 $row->update($cond);
3112 return $self->new_result($cond)->insert;
3115 =head2 update_or_new
3119 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
3121 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
3125 $resultset->update_or_new({ col => $val, ... });
3127 Like L</find_or_new> but if a row is found it is immediately updated via
3128 C<< $found_row->update (\%col_data) >>.
3132 # In your application
3133 my $cd = $schema->resultset('CD')->update_or_new(
3135 artist => 'Massive Attack',
3136 title => 'Mezzanine',
3139 { key => 'cd_artist_title' }
3142 if ($cd->in_storage) {
3143 # the cd was updated
3146 # the cd is not yet in the database, let's insert it
3150 B<Note>: Make sure to read the documentation of L</find> and understand the
3151 significance of the C<key> attribute, as its lack may skew your search, and
3152 subsequently result in spurious new objects.
3154 B<Note>: Take care when using C<update_or_new> with a table having
3155 columns with default values that you intend to be automatically
3156 supplied by the database (e.g. an auto_increment primary key column).
3157 In normal usage, the value of such columns should NOT be included at
3158 all in the call to C<update_or_new>, even when set to C<undef>.
3160 See also L</find>, L</find_or_create> and L</find_or_new>.
3166 my $attrs = ( @_ > 1 && ref $_[-1] eq 'HASH' ? pop(@_) : {} );
3167 my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
3169 my $row = $self->find( $cond, $attrs );
3170 if ( defined $row ) {
3171 $row->update($cond);
3175 return $self->new_result($cond);
3182 =item Arguments: none
3184 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
3188 Gets the contents of the cache for the resultset, if the cache is set.
3190 The cache is populated either by using the L</prefetch> attribute to
3191 L</search> or by calling L</set_cache>.
3203 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3205 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3209 Sets the contents of the cache for the resultset. Expects an arrayref
3210 of objects of the same class as those produced by the resultset. Note that
3211 if the cache is set, the resultset will return the cached objects rather
3212 than re-querying the database even if the cache attr is not set.
3214 The contents of the cache can also be populated by using the
3215 L</prefetch> attribute to L</search>.
3220 my ( $self, $data ) = @_;
3221 $self->throw_exception("set_cache requires an arrayref")
3222 if defined($data) && (ref $data ne 'ARRAY');
3223 $self->{all_cache} = $data;
3230 =item Arguments: none
3232 =item Return Value: undef
3236 Clears the cache for the resultset.
3241 shift->set_cache(undef);
3248 =item Arguments: none
3250 =item Return Value: true, if the resultset has been paginated
3258 return !!$self->{attrs}{page};
3265 =item Arguments: none
3267 =item Return Value: true, if the resultset has been ordered with C<order_by>.
3275 return scalar $self->result_source->schema->storage->_extract_order_criteria($self->{attrs}{order_by});
3278 =head2 related_resultset
3282 =item Arguments: $rel_name
3284 =item Return Value: L<$resultset|/search>
3288 Returns a related resultset for the supplied relationship name.
3290 $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3294 sub related_resultset {
3295 $_[0]->throw_exception(
3296 'Extra arguments to $rs->related_resultset() were always quietly '
3297 . 'discarded without consideration, you need to switch to '
3298 . '...->related_resultset( $relname )->search_rs( $search, $args ) instead.'
3301 return $_[0]->{related_resultsets}{$_[1]}
3302 if defined $_[0]->{related_resultsets}{$_[1]};
3304 my ($self, $rel) = @_;
3306 return $self->{related_resultsets}{$rel} = do {
3307 my $rsrc = $self->result_source;
3308 my $rel_info = $rsrc->relationship_info($rel);
3310 $self->throw_exception(
3311 "search_related: result source '" . $rsrc->source_name .
3312 "' has no such relationship $rel")
3315 my $attrs = $self->_chain_relationship($rel);
3317 # Previously this atribute was deleted (instead of being set as it is now)
3318 # Doing so seems to be harmless in all available test permutations
3319 # See also 01d59a6a6 and mst's comment below
3321 $attrs->{alias} = $rsrc->schema->storage->relname_to_table_alias(
3323 $attrs->{seen_join}{$rel}
3326 # since this is search_related, and we already slid the select window inwards
3327 # (the select/as attrs were deleted in the beginning), we need to flip all
3328 # left joins to inner, so we get the expected results
3330 # The DBIC relationship chaining implementation is pretty simple - every
3331 # new related_relationship is pushed onto the {from} stack, and the {select}
3332 # window simply slides further in. This means that when we count somewhere
3333 # in the middle, we got to make sure that everything in the join chain is an
3334 # actual inner join, otherwise the count will come back with unpredictable
3335 # results (a resultset may be generated with _some_ rows regardless of if
3336 # the relation which the $rs currently selects has rows or not). E.g.
3337 # $artist_rs->cds->count - normally generates:
3338 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
3339 # which actually returns the number of artists * (number of cds || 1)
3341 # So what we do here is crawl {from}, determine if the current alias is at
3342 # the top of the stack, and if not - make sure the chain is inner-joined down
3345 my $switch_branch = find_join_path_to_alias(
3350 if ( @{ $switch_branch || [] } ) {
3352 # So it looks like we will have to switch some stuff around.
3353 # local() is useless here as we will be leaving the scope
3354 # anyway, and deep cloning is just too fucking expensive
3355 # So replace the first hashref in the node arrayref manually
3356 my @new_from = $attrs->{from}[0];
3357 my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
3359 for my $j ( @{$attrs->{from}}[ 1 .. $#{$attrs->{from}} ] ) {
3360 my $jalias = $j->[0]{-alias};
3362 if ($sw_idx->{$jalias}) {
3363 my %attrs = %{$j->[0]};
3364 delete $attrs{-join_type};
3375 $attrs->{from} = \@new_from;
3379 #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3380 delete $attrs->{result_class};
3384 # The reason we do this now instead of passing the alias to the
3385 # search_rs below is that if you wrap/overload resultset on the
3386 # source you need to know what alias it's -going- to have for things
3387 # to work sanely (e.g. RestrictWithObject wants to be able to add
3388 # extra query restrictions, and these may need to be $alias.)
3389 # -- mst ~ 2007 (01d59a6a6)
3391 # FIXME - this seems to be no longer neccessary (perhaps due to the
3392 # advances in relcond resolution. Testing DBIC::S::RWO and its only
3393 # dependent (as of Jun 2015 ) does not yield any difference with or
3394 # without this line. Nevertheless keep it as is for now, to minimize
3395 # churn, there is enough potential for breakage in 0.0829xx as it is
3396 # -- ribasushi Jun 2015
3398 my $rel_source = $rsrc->related_source($rel);
3399 local $rel_source->resultset_attributes->{alias} = $attrs->{alias};
3401 $rel_source->resultset->search_rs( undef, $attrs );
3404 if (my $cache = $self->get_cache) {
3405 my @related_cache = map
3406 { $_->related_resultset($rel)->get_cache || () }
3410 $new->set_cache([ map @$_, @related_cache ]) if @related_cache == @$cache;
3417 =head2 current_source_alias
3421 =item Arguments: none
3423 =item Return Value: $source_alias
3427 Returns the current table alias for the result source this resultset is built
3428 on, that will be used in the SQL query. Usually it is C<me>.
3430 Currently the source alias that refers to the result set returned by a
3431 L</search>/L</find> family method depends on how you got to the resultset: it's
3432 C<me> by default, but eg. L</search_related> aliases it to the related result
3433 source name (and keeps C<me> referring to the original result set). The long
3434 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3435 (and make this method unnecessary).
3437 Thus it's currently necessary to use this method in predefined queries (see
3438 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3439 source alias of the current result set:
3441 # in a result set class
3443 my ($self, $user) = @_;
3445 my $me = $self->current_source_alias;
3447 return $self->search({
3448 "$me.modified" => $user->id,
3452 The alias of L<newly created resultsets|/search> can be altered by the
3453 L<alias attribute|/alias>.
3457 sub current_source_alias {
3458 return (shift->{attrs} || {})->{alias} || 'me';
3461 =head2 as_subselect_rs
3465 =item Arguments: none
3467 =item Return Value: L<$resultset|/search>
3471 Act as a barrier to SQL symbols. The resultset provided will be made into a
3472 "virtual view" by including it as a subquery within the from clause. From this
3473 point on, any joined tables are inaccessible to ->search on the resultset (as if
3474 it were simply where-filtered without joins). For example:
3476 my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3478 # 'x' now pollutes the query namespace
3480 # So the following works as expected
3481 my $ok_rs = $rs->search({'x.other' => 1});
3483 # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3484 # def) we look for one row with contradictory terms and join in another table
3485 # (aliased 'x_2') which we never use
3486 my $broken_rs = $rs->search({'x.name' => 'def'});
3488 my $rs2 = $rs->as_subselect_rs;
3490 # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3491 my $not_joined_rs = $rs2->search({'x.other' => 1});
3493 # works as expected: finds a 'table' row related to two x rows (abc and def)
3494 my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3496 Another example of when one might use this would be to select a subset of
3497 columns in a group by clause:
3499 my $rs = $schema->resultset('Bar')->search(undef, {
3500 group_by => [qw{ id foo_id baz_id }],
3501 })->as_subselect_rs->search(undef, {
3502 columns => [qw{ id foo_id }]
3505 In the above example normally columns would have to be equal to the group by,
3506 but because we isolated the group by into a subselect the above works.
3510 sub as_subselect_rs {
3512 # FIXME - remove at some point in the future (2018-ish)
3516 'Starting with DBIC@0.082900 as_subselect_rs() always returns a ResultSet '
3517 . 'instance regardless of calling context. Please force scalar() context to '
3518 . 'silence this warning'
3523 my $alias = $self->current_source_alias;
3525 my $fresh_rs = (ref $self)->new (
3526 $self->result_source
3529 # these pieces will be locked in the subquery
3530 delete $fresh_rs->{cond};
3531 delete @{$fresh_rs->{attrs}}{qw/where bind/};
3533 $fresh_rs->search_rs( {}, {
3535 $alias => $self->as_query,
3537 -rsrc => $self->result_source,
3543 # This code is called by search_related, and makes sure there
3544 # is clear separation between the joins before, during, and
3545 # after the relationship. This information is needed later
3546 # in order to properly resolve prefetch aliases (any alias
3547 # with a relation_chain_depth less than the depth of the
3548 # current prefetch is not considered)
3550 # The increments happen twice per join. An even number means a
3551 # relationship specified via a search_related, whereas an odd
3552 # number indicates a join/prefetch added via attributes
3554 # Also this code will wrap the current resultset (the one we
3555 # chain to) in a subselect IFF it contains limiting attributes
3556 sub _chain_relationship {
3557 my ($self, $rel) = @_;
3558 my $source = $self->result_source;
3559 my $attrs = { %{$self->{attrs}||{}} };
3561 # we need to take the prefetch the attrs into account before we
3562 # ->_resolve_join as otherwise they get lost - captainL
3563 my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3565 delete @{$attrs}{qw/join prefetch collapse group_by distinct _grouped_by_distinct select as columns +select +as +columns/};
3567 my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3570 my @force_subq_attrs = qw/offset rows group_by having/;
3573 ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3575 $self->_has_resolved_attr (@force_subq_attrs)
3577 # Nuke the prefetch (if any) before the new $rs attrs
3578 # are resolved (prefetch is useless - we are wrapping
3579 # a subquery anyway).
3580 my $rs_copy = $self->search_rs;
3581 $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3582 $rs_copy->{attrs}{join},
3583 delete $rs_copy->{attrs}{prefetch},
3588 -alias => $attrs->{alias},
3589 $attrs->{alias} => $rs_copy->as_query,
3591 delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3592 $seen->{-relation_chain_depth} = 0;
3594 elsif ($attrs->{from}) { #shallow copy suffices
3595 $from = [ @{$attrs->{from}} ];
3600 -alias => $attrs->{alias},
3601 $attrs->{alias} => $source->from,
3605 my $jpath = ($seen->{-relation_chain_depth})
3606 ? $from->[-1][0]{-join_path}
3609 my @requested_joins = $source->_resolve_join(
3616 push @$from, @requested_joins;
3618 $seen->{-relation_chain_depth}++;
3620 # if $self already had a join/prefetch specified on it, the requested
3621 # $rel might very well be already included. What we do in this case
3622 # is effectively a no-op (except that we bump up the chain_depth on
3623 # the join in question so we could tell it *is* the search_related)
3626 # we consider the last one thus reverse
3627 for my $j (reverse @requested_joins) {
3628 my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3629 if ($rel eq $last_j) {
3630 $j->[0]{-relation_chain_depth}++;
3636 unless ($already_joined) {
3637 push @$from, $source->_resolve_join(
3645 $seen->{-relation_chain_depth}++;
3647 return {%$attrs, from => $from, seen_join => $seen};
3650 sub _resolved_attrs {
3652 return $self->{_attrs} if $self->{_attrs};
3654 my $attrs = { %{ $self->{attrs} || {} } };
3655 my $source = $attrs->{result_source} = $self->result_source;
3656 my $alias = $attrs->{alias};
3658 $self->throw_exception("Specifying distinct => 1 in conjunction with collapse => 1 is unsupported")
3659 if $attrs->{collapse} and $attrs->{distinct};
3662 # Sanity check the paging attributes
3663 # SQLMaker does it too, but in case of a software_limit we'll never get there
3664 if (defined $attrs->{offset}) {
3665 $self->throw_exception('A supplied offset attribute must be a non-negative integer')
3666 if ( $attrs->{offset} =~ /[^0-9]/ or $attrs->{offset} < 0 );
3668 if (defined $attrs->{rows}) {
3669 $self->throw_exception("The rows attribute must be a positive integer if present")
3670 if ( $attrs->{rows} =~ /[^0-9]/ or $attrs->{rows} <= 0 );
3673 # normalize where condition
3674 $attrs->{where} = normalize_sqla_condition( $attrs->{where} )
3677 # default selection list
3678 $attrs->{columns} = [ $source->columns ]
3679 unless grep { exists $attrs->{$_} } qw/columns cols select as/;
3681 # merge selectors together
3682 for (qw/columns select as/) {
3683 $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3684 if $attrs->{$_} or $attrs->{"+$_"};
3687 # disassemble columns
3689 if (my $cols = delete $attrs->{columns}) {
3690 for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3691 if (ref $c eq 'HASH') {
3692 for my $as (sort keys %$c) {
3693 push @sel, $c->{$as};
3704 # when trying to weed off duplicates later do not go past this point -
3705 # everything added from here on is unbalanced "anyone's guess" stuff
3706 my $dedup_stop_idx = $#as;
3708 push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3710 push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3711 if $attrs->{select};
3713 # assume all unqualified selectors to apply to the current alias (legacy stuff)
3714 $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_" for @sel;
3716 # disqualify all $alias.col as-bits (inflate-map mandated)
3717 $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_ for @as;
3719 # de-duplicate the result (remove *identical* select/as pairs)
3720 # and also die on duplicate {as} pointing to different {select}s
3721 # not using a c-style for as the condition is prone to shrinkage
3724 while ($i <= $dedup_stop_idx) {
3725 if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3730 elsif ($seen->{$as[$i]}++) {
3731 $self->throw_exception(
3732 "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3740 $attrs->{select} = \@sel;
3741 $attrs->{as} = \@as;
3743 $attrs->{from} ||= [{
3745 -alias => $self->{attrs}{alias},
3746 $self->{attrs}{alias} => $source->from,
3749 if ( $attrs->{join} || $attrs->{prefetch} ) {
3751 $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3752 if ref $attrs->{from} ne 'ARRAY';
3754 my $join = (delete $attrs->{join}) || {};
3756 if ( defined $attrs->{prefetch} ) {
3757 $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3760 $attrs->{from} = # have to copy here to avoid corrupting the original
3762 @{ $attrs->{from} },
3763 $source->_resolve_join(
3766 { %{ $attrs->{seen_join} || {} } },
3767 ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3768 ? $attrs->{from}[-1][0]{-join_path}
3776 for my $attr (qw(order_by group_by)) {
3778 if ( defined $attrs->{$attr} ) {
3780 ref( $attrs->{$attr} ) eq 'ARRAY'
3781 ? [ @{ $attrs->{$attr} } ]
3782 : [ $attrs->{$attr} || () ]
3785 delete $attrs->{$attr} unless @{$attrs->{$attr}};
3790 # set collapse default based on presence of prefetch
3793 defined $attrs->{prefetch}
3795 $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} )
3797 $self->throw_exception("Specifying prefetch in conjunction with an explicit collapse => 0 is unsupported")
3798 if defined $attrs->{collapse} and ! $attrs->{collapse};
3800 $attrs->{collapse} = 1;
3804 # run through the resulting joinstructure (starting from our current slot)
3805 # and unset collapse if proven unnecessary
3807 # also while we are at it find out if the current root source has
3808 # been premultiplied by previous related_source chaining
3810 # this allows to predict whether a root object with all other relation
3811 # data set to NULL is in fact unique
3812 if ($attrs->{collapse}) {
3814 if (ref $attrs->{from} eq 'ARRAY') {
3816 if (@{$attrs->{from}} == 1) {
3817 # no joins - no collapse
3818 $attrs->{collapse} = 0;
3821 # find where our table-spec starts
3822 my @fromlist = @{$attrs->{from}};
3824 my $t = shift @fromlist;
3827 # me vs join from-spec distinction - a ref means non-root
3828 if (ref $t eq 'ARRAY') {
3830 $is_multi ||= ! $t->{-is_single};
3832 last if ($t->{-alias} && $t->{-alias} eq $alias);
3833 $attrs->{_main_source_premultiplied} ||= $is_multi;
3836 # no non-singles remaining, nor any premultiplication - nothing to collapse
3838 ! $attrs->{_main_source_premultiplied}
3840 ! grep { ! $_->[0]{-is_single} } @fromlist
3842 $attrs->{collapse} = 0;
3848 # if we can not analyze the from - err on the side of safety
3849 $attrs->{_main_source_premultiplied} = 1;
3854 # generate the distinct induced group_by before injecting the prefetched select/as parts
3855 if (delete $attrs->{distinct}) {
3856 if ($attrs->{group_by}) {
3857 carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3860 $attrs->{_grouped_by_distinct} = 1;
3861 # distinct affects only the main selection part, not what prefetch may add below
3862 ($attrs->{group_by}, my $new_order) = $source->schema->storage->_group_over_selection($attrs);
3864 # FIXME possibly ignore a rewritten order_by (may turn out to be an issue)
3865 # The thinking is: if we are collapsing the subquerying prefetch engine will
3866 # rip stuff apart for us anyway, and we do not want to have a potentially
3867 # function-converted external order_by
3868 # ( there is an explicit if ( collapse && _grouped_by_distinct ) check in DBIHacks )
3869 $attrs->{order_by} = $new_order unless $attrs->{collapse};
3874 # generate selections based on the prefetch helper
3877 $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3878 if $attrs->{_dark_selector};
3880 # this is a separate structure (we don't look in {from} directly)
3881 # as the resolver needs to shift things off the lists to work
3882 # properly (identical-prefetches on different branches)
3883 my $joined_node_aliases_map = {};
3884 if (ref $attrs->{from} eq 'ARRAY') {
3886 my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3888 for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3889 next unless $j->[0]{-alias};
3890 next unless $j->[0]{-join_path};
3891 next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3893 my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3895 my $p = $joined_node_aliases_map;
3896 $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3897 push @{$p->{-join_aliases} }, $j->[0]{-alias};
3901 ( push @{$attrs->{select}}, $_->[0] ) and ( push @{$attrs->{as}}, $_->[1] )
3902 for $source->_resolve_selection_from_prefetch( $prefetch, $joined_node_aliases_map );
3906 $attrs->{_simple_passthrough_construction} = !(
3909 grep { $_ =~ /\./ } @{$attrs->{as}}
3913 # if both page and offset are specified, produce a combined offset
3914 # even though it doesn't make much sense, this is what pre 081xx has
3916 if (my $page = delete $attrs->{page}) {
3918 ($attrs->{rows} * ($page - 1))
3920 ($attrs->{offset} || 0)
3924 return $self->{_attrs} = $attrs;
3928 my ($self, $attr) = @_;
3930 if (ref $attr eq 'HASH') {
3931 return $self->_rollout_hash($attr);
3932 } elsif (ref $attr eq 'ARRAY') {
3933 return $self->_rollout_array($attr);
3939 sub _rollout_array {
3940 my ($self, $attr) = @_;
3943 foreach my $element (@{$attr}) {
3944 if (ref $element eq 'HASH') {
3945 push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3946 } elsif (ref $element eq 'ARRAY') {
3947 # XXX - should probably recurse here
3948 push( @rolled_array, @{$self->_rollout_array($element)} );
3950 push( @rolled_array, $element );
3953 return \@rolled_array;
3957 my ($self, $attr) = @_;
3960 foreach my $key (keys %{$attr}) {
3961 push( @rolled_array, { $key => $attr->{$key} } );
3963 return \@rolled_array;
3966 sub _calculate_score {
3967 my ($self, $a, $b) = @_;
3969 if (defined $a xor defined $b) {
3972 elsif (not defined $a) {
3976 if (ref $b eq 'HASH') {
3977 my ($b_key) = keys %{$b};
3978 $b_key = '' if ! defined $b_key;
3979 if (ref $a eq 'HASH') {
3980 my ($a_key) = keys %{$a};
3981 $a_key = '' if ! defined $a_key;
3982 if ($a_key eq $b_key) {
3983 return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3988 return ($a eq $b_key) ? 1 : 0;
3991 if (ref $a eq 'HASH') {
3992 my ($a_key) = keys %{$a};
3993 return ($b eq $a_key) ? 1 : 0;
3995 return ($b eq $a) ? 1 : 0;
4000 sub _merge_joinpref_attr {
4001 my ($self, $orig, $import) = @_;
4003 return $import unless defined($orig);
4004 return $orig unless defined($import);
4006 $orig = $self->_rollout_attr($orig);
4007 $import = $self->_rollout_attr($import);
4010 foreach my $import_element ( @{$import} ) {
4011 # find best candidate from $orig to merge $b_element into
4012 my $best_candidate = { position => undef, score => 0 }; my $position = 0;
4013 foreach my $orig_element ( @{$orig} ) {
4014 my $score = $self->_calculate_score( $orig_element, $import_element );
4015 if ($score > $best_candidate->{score}) {
4016 $best_candidate->{position} = $position;
4017 $best_candidate->{score} = $score;
4021 my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
4022 $import_key = '' if not defined $import_key;
4024 if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
4025 push( @{$orig}, $import_element );
4027 my $orig_best = $orig->[$best_candidate->{position}];
4028 # merge orig_best and b_element together and replace original with merged
4029 if (ref $orig_best ne 'HASH') {
4030 $orig->[$best_candidate->{position}] = $import_element;
4031 } elsif (ref $import_element eq 'HASH') {
4032 my ($key) = keys %{$orig_best};
4033 $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
4036 $seen_keys->{$import_key} = 1; # don't merge the same key twice
4039 return @$orig ? $orig : ();
4047 require Hash::Merge;
4048 my $hm = Hash::Merge->new;
4050 $hm->specify_behavior({
4053 my ($defl, $defr) = map { defined $_ } (@_[0,1]);
4055 if ($defl xor $defr) {
4056 return [ $defl ? $_[0] : $_[1] ];
4061 elsif (__HM_DEDUP and $_[0] eq $_[1]) {
4065 return [$_[0], $_[1]];
4069 return $_[1] if !defined $_[0];
4070 return $_[1] if __HM_DEDUP and grep { $_ eq $_[0] } @{$_[1]};
4071 return [$_[0], @{$_[1]}]
4074 return [] if !defined $_[0] and !keys %{$_[1]};
4075 return [ $_[1] ] if !defined $_[0];
4076 return [ $_[0] ] if !keys %{$_[1]};
4077 return [$_[0], $_[1]]
4082 return $_[0] if !defined $_[1];
4083 return $_[0] if __HM_DEDUP and grep { $_ eq $_[1] } @{$_[0]};
4084 return [@{$_[0]}, $_[1]]
4087 my @ret = @{$_[0]} or return $_[1];
4088 return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
4089 my %idx = map { $_ => 1 } @ret;
4090 push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
4094 return [ $_[1] ] if ! @{$_[0]};
4095 return $_[0] if !keys %{$_[1]};
4096 return $_[0] if __HM_DEDUP and grep { $_ eq $_[1] } @{$_[0]};
4097 return [ @{$_[0]}, $_[1] ];
4102 return [] if !keys %{$_[0]} and !defined $_[1];
4103 return [ $_[0] ] if !defined $_[1];
4104 return [ $_[1] ] if !keys %{$_[0]};
4105 return [$_[0], $_[1]]
4108 return [] if !keys %{$_[0]} and !@{$_[1]};
4109 return [ $_[0] ] if !@{$_[1]};
4110 return $_[1] if !keys %{$_[0]};
4111 return $_[1] if __HM_DEDUP and grep { $_ eq $_[0] } @{$_[1]};
4112 return [ $_[0], @{$_[1]} ];
4115 return [] if !keys %{$_[0]} and !keys %{$_[1]};
4116 return [ $_[0] ] if !keys %{$_[1]};
4117 return [ $_[1] ] if !keys %{$_[0]};
4118 return [ $_[0] ] if $_[0] eq $_[1];
4119 return [ $_[0], $_[1] ];
4122 } => 'DBIC_RS_ATTR_MERGER');
4126 return $hm->merge ($_[1], $_[2]);
4130 sub STORABLE_freeze {
4131 my ($self, $cloning) = @_;
4132 my $to_serialize = { %$self };
4134 # A cursor in progress can't be serialized (and would make little sense anyway)
4135 # the parser can be regenerated (and can't be serialized)
4136 delete @{$to_serialize}{qw/cursor _row_parser _result_inflator/};
4138 # nor is it sensical to store a not-yet-fired-count pager
4139 if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
4140 delete $to_serialize->{pager};
4143 Storable::nfreeze($to_serialize);
4146 # need this hook for symmetry
4148 my ($self, $cloning, $serialized) = @_;
4150 %$self = %{ Storable::thaw($serialized) };
4156 =head2 throw_exception
4158 See L<DBIx::Class::Schema/throw_exception> for details.
4162 sub throw_exception {
4165 if (ref $self and my $rsrc = $self->result_source) {
4166 $rsrc->throw_exception(@_)
4169 DBIx::Class::Exception->throw(@_);
4177 # XXX: FIXME: Attributes docs need clearing up
4181 Attributes are used to refine a ResultSet in various ways when
4182 searching for data. They can be passed to any method which takes an
4183 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
4186 Default attributes can be set on the result class using
4187 L<DBIx::Class::ResultSource/resultset_attributes>. (Please read
4188 the CAVEATS on that feature before using it!)
4190 These are in no particular order:
4196 =item Value: ( $order_by | \@order_by | \%order_by )
4200 Which column(s) to order the results by.
4202 [The full list of suitable values is documented in
4203 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
4206 If a single column name, or an arrayref of names is supplied, the
4207 argument is passed through directly to SQL. The hashref syntax allows
4208 for connection-agnostic specification of ordering direction:
4210 For descending order:
4212 order_by => { -desc => [qw/col1 col2 col3/] }
4214 For explicit ascending order:
4216 order_by => { -asc => 'col' }
4218 The old scalarref syntax (i.e. order_by => \'year DESC') is still
4219 supported, although you are strongly encouraged to use the hashref
4220 syntax as outlined above.
4226 =item Value: \@columns | \%columns | $column
4230 Shortcut to request a particular set of columns to be retrieved. Each
4231 column spec may be a string (a table column name), or a hash (in which
4232 case the key is the C<as> value, and the value is used as the C<select>
4233 expression). Adds the L</current_source_alias> onto the start of any column without a C<.> in
4234 it and sets C<select> from that, then auto-populates C<as> from
4235 C<select> as normal. (You may also use the C<cols> attribute, as in
4236 earlier versions of DBIC, but this is deprecated)
4238 Essentially C<columns> does the same as L</select> and L</as>.
4240 columns => [ 'some_column', { dbic_slot => 'another_column' } ]
4244 select => [qw(some_column another_column)],
4245 as => [qw(some_column dbic_slot)]
4247 If you want to individually retrieve related columns (in essence perform
4248 manual L</prefetch>) you have to make sure to specify the correct inflation slot
4249 chain such that it matches existing relationships:
4251 my $rs = $schema->resultset('Artist')->search({}, {
4252 # required to tell DBIC to collapse has_many relationships
4254 join => { cds => 'tracks' },
4256 'cds.cdid' => 'cds.cdid',
4257 'cds.tracks.title' => 'tracks.title',
4261 Like elsewhere, literal SQL or literal values can be included by using a
4262 scalar reference or a literal bind value, and these values will be available
4263 in the result with C<get_column> (see also
4264 L<SQL::Abstract/Literal SQL and value type operators>):
4266 # equivalent SQL: SELECT 1, 'a string', IF(my_column,?,?) ...
4267 # bind values: $true_value, $false_value
4271 bar => \q{'a string'},
4272 baz => \[ 'IF(my_column,?,?)', $true_value, $false_value ],
4278 B<NOTE:> You B<MUST> explicitly quote C<'+columns'> when using this attribute.
4279 Not doing so causes Perl to incorrectly interpret C<+columns> as a bareword
4280 with a unary plus operator before it, which is the same as simply C<columns>.
4284 =item Value: \@extra_columns
4288 Indicates additional columns to be selected from storage. Works the same as
4289 L</columns> but adds columns to the current selection. (You may also use the
4290 C<include_columns> attribute, as in earlier versions of DBIC, but this is
4293 $schema->resultset('CD')->search(undef, {
4294 '+columns' => ['artist.name'],
4298 would return all CDs and include a 'name' column to the information
4299 passed to object inflation. Note that the 'artist' is the name of the
4300 column (or relationship) accessor, and 'name' is the name of the column
4301 accessor in the related table.
4307 =item Value: \@select_columns
4311 Indicates which columns should be selected from the storage. You can use
4312 column names, or in the case of RDBMS back ends, function or stored procedure
4315 $rs = $schema->resultset('Employee')->search(undef, {
4318 { count => 'employeeid' },
4319 { max => { length => 'name' }, -as => 'longest_name' }
4324 SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
4326 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
4327 use L</select>, to instruct DBIx::Class how to store the result of the column.
4329 Also note that the L</as> attribute has B<nothing to do> with the SQL-side
4330 C<AS> identifier aliasing. You B<can> alias a function (so you can use it e.g.
4331 in an C<ORDER BY> clause), however this is done via the C<-as> B<select
4332 function attribute> supplied as shown in the example above.
4336 B<NOTE:> You B<MUST> explicitly quote C<'+select'> when using this attribute.
4337 Not doing so causes Perl to incorrectly interpret C<+select> as a bareword
4338 with a unary plus operator before it, which is the same as simply C<select>.
4342 =item Value: \@extra_select_columns
4346 Indicates additional columns to be selected from storage. Works the same as
4347 L</select> but adds columns to the current selection, instead of specifying
4348 a new explicit list.
4354 =item Value: \@inflation_names
4358 Indicates DBIC-side names for object inflation. That is L</as> indicates the
4359 slot name in which the column value will be stored within the
4360 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
4361 identifier by the C<get_column> method (or via the object accessor B<if one
4362 with the same name already exists>) as shown below.
4364 The L</as> attribute has B<nothing to do> with the SQL-side identifier
4365 aliasing C<AS>. See L</select> for details.
4367 $rs = $schema->resultset('Employee')->search(undef, {
4370 { count => 'employeeid' },
4371 { max => { length => 'name' }, -as => 'longest_name' }
4380 If the object against which the search is performed already has an accessor
4381 matching a column name specified in C<as>, the value can be retrieved using
4382 the accessor as normal:
4384 my $name = $employee->name();
4386 If on the other hand an accessor does not exist in the object, you need to
4387 use C<get_column> instead:
4389 my $employee_count = $employee->get_column('employee_count');
4391 You can create your own accessors if required - see
4392 L<DBIx::Class::Manual::Cookbook> for details.
4396 B<NOTE:> You B<MUST> explicitly quote C<'+as'> when using this attribute.
4397 Not doing so causes Perl to incorrectly interpret C<+as> as a bareword
4398 with a unary plus operator before it, which is the same as simply C<as>.
4402 =item Value: \@extra_inflation_names
4406 Indicates additional inflation names for selectors added via L</+select>. See L</as>.
4412 =item Value: ($rel_name | \@rel_names | \%rel_names)
4416 Contains a list of relationships that should be joined for this query. For
4419 # Get CDs by Nine Inch Nails
4420 my $rs = $schema->resultset('CD')->search(
4421 { 'artist.name' => 'Nine Inch Nails' },
4422 { join => 'artist' }
4425 Can also contain a hash reference to refer to the other relation's relations.
4428 package MyApp::Schema::Track;
4429 use base qw/DBIx::Class/;
4430 __PACKAGE__->table('track');
4431 __PACKAGE__->add_columns(qw/trackid cd position title/);
4432 __PACKAGE__->set_primary_key('trackid');
4433 __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
4436 # In your application
4437 my $rs = $schema->resultset('Artist')->search(
4438 { 'track.title' => 'Teardrop' },
4440 join => { cd => 'track' },
4441 order_by => 'artist.name',
4445 You need to use the relationship (not the table) name in conditions,
4446 because they are aliased as such. The current table is aliased as "me", so
4447 you need to use me.column_name in order to avoid ambiguity. For example:
4449 # Get CDs from 1984 with a 'Foo' track
4450 my $rs = $schema->resultset('CD')->search(
4453 'tracks.name' => 'Foo'
4455 { join => 'tracks' }
4458 If the same join is supplied twice, it will be aliased to <rel>_2 (and
4459 similarly for a third time). For e.g.
4461 my $rs = $schema->resultset('Artist')->search({
4462 'cds.title' => 'Down to Earth',
4463 'cds_2.title' => 'Popular',
4465 join => [ qw/cds cds/ ],
4468 will return a set of all artists that have both a cd with title 'Down
4469 to Earth' and a cd with title 'Popular'.
4471 If you want to fetch related objects from other tables as well, see L</prefetch>
4474 NOTE: An internal join-chain pruner will discard certain joins while
4475 constructing the actual SQL query, as long as the joins in question do not
4476 affect the retrieved result. This for example includes 1:1 left joins
4477 that are not part of the restriction specification (WHERE/HAVING) nor are
4478 a part of the query selection.
4480 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4486 =item Value: (0 | 1)
4490 When set to a true value, indicates that any rows fetched from joined has_many
4491 relationships are to be aggregated into the corresponding "parent" object. For
4492 example, the resultset:
4494 my $rs = $schema->resultset('CD')->search({}, {
4495 '+columns' => [ qw/ tracks.title tracks.position / ],
4500 While executing the following query:
4502 SELECT me.*, tracks.title, tracks.position
4504 LEFT JOIN track tracks
4505 ON tracks.cdid = me.cdid
4507 Will return only as many objects as there are rows in the CD source, even
4508 though the result of the query may span many rows. Each of these CD objects
4509 will in turn have multiple "Track" objects hidden behind the has_many
4510 generated accessor C<tracks>. Without C<< collapse => 1 >>, the return values
4511 of this resultset would be as many CD objects as there are tracks (a "Cartesian
4512 product"), with each CD object containing exactly one of all fetched Track data.
4514 When a collapse is requested on a non-ordered resultset, an order by some
4515 unique part of the main source (the left-most table) is inserted automatically.
4516 This is done so that the resultset is allowed to be "lazy" - calling
4517 L<< $rs->next|/next >> will fetch only as many rows as it needs to build the next
4518 object with all of its related data.
4520 If an L</order_by> is already declared, and orders the resultset in a way that
4521 makes collapsing as described above impossible (e.g. C<< ORDER BY
4522 has_many_rel.column >> or C<ORDER BY RANDOM()>), DBIC will automatically
4523 switch to "eager" mode and slurp the entire resultset before constructing the
4524 first object returned by L</next>.
4526 Setting this attribute on a resultset that does not join any has_many
4527 relations is a no-op.
4529 For a more in-depth discussion, see L</PREFETCHING>.
4535 =item Value: ($rel_name | \@rel_names | \%rel_names)
4539 This attribute is a shorthand for specifying a L</join> spec, adding all
4540 columns from the joined related sources as L</+columns> and setting
4541 L</collapse> to a true value. It can be thought of as a rough B<superset>
4542 of the L</join> attribute.
4544 For example, the following two queries are equivalent:
4546 my $rs = $schema->resultset('Artist')->search({}, {
4547 prefetch => { cds => ['genre', 'tracks' ] },
4552 my $rs = $schema->resultset('Artist')->search({}, {
4553 join => { cds => ['genre', 'tracks' ] },
4557 { +{ "cds.$_" => "cds.$_" } }
4558 $schema->source('Artist')->related_source('cds')->columns
4561 { +{ "cds.genre.$_" => "genre.$_" } }
4562 $schema->source('Artist')->related_source('cds')->related_source('genre')->columns
4565 { +{ "cds.tracks.$_" => "tracks.$_" } }
4566 $schema->source('Artist')->related_source('cds')->related_source('tracks')->columns
4571 Both producing the following SQL:
4573 SELECT me.artistid, me.name, me.rank, me.charfield,
4574 cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track,
4575 genre.genreid, genre.name,
4576 tracks.trackid, tracks.cd, tracks.position, tracks.title, tracks.last_updated_on, tracks.last_updated_at
4579 ON cds.artist = me.artistid
4580 LEFT JOIN genre genre
4581 ON genre.genreid = cds.genreid
4582 LEFT JOIN track tracks
4583 ON tracks.cd = cds.cdid
4584 ORDER BY me.artistid
4586 While L</prefetch> implies a L</join>, it is ok to mix the two together, as
4587 the arguments are properly merged and generally do the right thing. For
4588 example, you may want to do the following:
4590 my $artists_and_cds_without_genre = $schema->resultset('Artist')->search(
4591 { 'genre.genreid' => undef },
4593 join => { cds => 'genre' },
4598 Which generates the following SQL:
4600 SELECT me.artistid, me.name, me.rank, me.charfield,
4601 cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track
4604 ON cds.artist = me.artistid
4605 LEFT JOIN genre genre
4606 ON genre.genreid = cds.genreid
4607 WHERE genre.genreid IS NULL
4608 ORDER BY me.artistid
4610 For a more in-depth discussion, see L</PREFETCHING>.
4616 =item Value: $source_alias
4620 Sets the source alias for the query. Normally, this defaults to C<me>, but
4621 nested search queries (sub-SELECTs) might need specific aliases set to
4622 reference inner queries. For example:
4625 ->related_resultset('CDs')
4626 ->related_resultset('Tracks')
4628 'track.id' => { -ident => 'none_search.id' },
4632 my $ids = $self->search({
4635 alias => 'none_search',
4636 group_by => 'none_search.id',
4637 })->get_column('id')->as_query;
4639 $self->search({ id => { -in => $ids } })
4641 This attribute is directly tied to L</current_source_alias>.
4651 Makes the resultset paged and specifies the page to retrieve. Effectively
4652 identical to creating a non-pages resultset and then calling ->page($page)
4655 If L</rows> attribute is not specified it defaults to 10 rows per page.
4657 When you have a paged resultset, L</count> will only return the number
4658 of rows in the page. To get the total, use the L</pager> and call
4659 C<total_entries> on it.
4669 Specifies the maximum number of rows for direct retrieval or the number of
4670 rows per page if the page attribute or method is used.
4676 =item Value: $offset
4680 Specifies the (zero-based) row number for the first row to be returned, or the
4681 of the first row of the first page if paging is used.
4683 =head2 software_limit
4687 =item Value: (0 | 1)
4691 When combined with L</rows> and/or L</offset> the generated SQL will not
4692 include any limit dialect stanzas. Instead the entire result will be selected
4693 as if no limits were specified, and DBIC will perform the limit locally, by
4694 artificially advancing and finishing the resulting L</cursor>.
4696 This is the recommended way of performing resultset limiting when no sane RDBMS
4697 implementation is available (e.g.
4698 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4699 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4705 =item Value: \@columns
4709 A arrayref of columns to group by. Can include columns of joined tables.
4711 group_by => [qw/ column1 column2 ... /]
4717 =item Value: $condition
4721 The HAVING operator specifies a B<secondary> condition applied to the set
4722 after the grouping calculations have been done. In other words it is a
4723 constraint just like L</where> (and accepting the same
4724 L<SQL::Abstract syntax|SQL::Abstract/WHERE CLAUSES>) applied to the data
4725 as it exists after GROUP BY has taken place. Specifying L</having> without
4726 L</group_by> is a logical mistake, and a fatal error on most RDBMS engines.
4730 having => { 'count_employee' => { '>=', 100 } }
4732 or with an in-place function in which case literal SQL is required:
4734 having => \[ 'count(employee) >= ?', 100 ]
4740 =item Value: (0 | 1)
4744 Set to 1 to automatically generate a L</group_by> clause based on the selection
4745 (including intelligent handling of L</order_by> contents). Note that the group
4746 criteria calculation takes place over the B<final> selection. This includes
4747 any L</+columns>, L</+select> or L</order_by> additions in subsequent
4748 L</search> calls, and standalone columns selected via
4749 L<DBIx::Class::ResultSetColumn> (L</get_column>). A notable exception are the
4750 extra selections specified via L</prefetch> - such selections are explicitly
4751 excluded from group criteria calculations.
4753 If the final ResultSet also explicitly defines a L</group_by> attribute, this
4754 setting is ignored and an appropriate warning is issued.
4758 Adds extra conditions to the resultset, combined with the preexisting C<WHERE>
4759 conditions, same as the B<first> argument to the L<search operator|/search>
4761 # only return rows WHERE deleted IS NULL for all searches
4762 __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4764 Note that the above example is
4765 L<strongly discouraged|DBIx::Class::ResultSource/resultset_attributes>.
4769 Set to 1 to cache search results. This prevents extra SQL queries if you
4770 revisit rows in your ResultSet:
4772 my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4774 while( my $artist = $resultset->next ) {
4778 $resultset->first; # without cache, this would issue a query
4780 By default, searches are not cached.
4782 For more examples of using these attributes, see
4783 L<DBIx::Class::Manual::Cookbook>.
4789 =item Value: ( 'update' | 'shared' | \$scalar )
4793 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4794 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4799 DBIx::Class supports arbitrary related data prefetching from multiple related
4800 sources. Any combination of relationship types and column sets are supported.
4801 If L<collapsing|/collapse> is requested, there is an additional requirement of
4802 selecting enough data to make every individual object uniquely identifiable.
4804 Here are some more involved examples, based on the following relationship map:
4807 My::Schema::CD->belongs_to( artist => 'My::Schema::Artist' );
4808 My::Schema::CD->might_have( liner_note => 'My::Schema::LinerNotes' );
4809 My::Schema::CD->has_many( tracks => 'My::Schema::Track' );
4811 My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4813 My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4817 my $rs = $schema->resultset('Tag')->search(
4826 The initial search results in SQL like the following:
4828 SELECT tag.*, cd.*, artist.* FROM tag
4829 JOIN cd ON tag.cd = cd.cdid
4830 JOIN artist ON cd.artist = artist.artistid
4832 L<DBIx::Class> has no need to go back to the database when we access the
4833 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4836 Simple prefetches will be joined automatically, so there is no need
4837 for a C<join> attribute in the above search.
4839 The L</prefetch> attribute can be used with any of the relationship types
4840 and multiple prefetches can be specified together. Below is a more complex
4841 example that prefetches a CD's artist, its liner notes (if present),
4842 the cover image, the tracks on that CD, and the guests on those
4845 my $rs = $schema->resultset('CD')->search(
4849 { artist => 'record_label'}, # belongs_to => belongs_to
4850 'liner_note', # might_have
4851 'cover_image', # has_one
4852 { tracks => 'guests' }, # has_many => has_many
4857 This will produce SQL like the following:
4859 SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4863 ON artist.artistid = me.artistid
4864 JOIN record_label record_label
4865 ON record_label.labelid = artist.labelid
4866 LEFT JOIN track tracks
4867 ON tracks.cdid = me.cdid
4868 LEFT JOIN guest guests
4869 ON guests.trackid = track.trackid
4870 LEFT JOIN liner_notes liner_note
4871 ON liner_note.cdid = me.cdid
4872 JOIN cd_artwork cover_image
4873 ON cover_image.cdid = me.cdid
4876 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4877 C<tracks>, and C<guests> of the CD will all be available through the
4878 relationship accessors without the need for additional queries to the
4883 Prefetch does a lot of deep magic. As such, it may not behave exactly
4884 as you might expect.
4890 Prefetch uses the L</cache> to populate the prefetched relationships. This
4891 may or may not be what you want.
4895 If you specify a condition on a prefetched relationship, ONLY those
4896 rows that match the prefetched condition will be fetched into that relationship.
4897 This means that adding prefetch to a search() B<may alter> what is returned by
4898 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4900 my $artist_rs = $schema->resultset('Artist')->search({
4906 my $count = $artist_rs->first->cds->count;
4908 my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4910 my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4912 cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4914 That cmp_ok() may or may not pass depending on the datasets involved. In other
4915 words the C<WHERE> condition would apply to the entire dataset, just like
4916 it would in regular SQL. If you want to add a condition only to the "right side"
4917 of a C<LEFT JOIN> - consider declaring and using a L<relationship with a custom
4918 condition|DBIx::Class::Relationship::Base/condition>
4922 =head1 DBIC BIND VALUES
4924 Because DBIC may need more information to bind values than just the column name
4925 and value itself, it uses a special format for both passing and receiving bind
4926 values. Each bind value should be composed of an arrayref of
4927 C<< [ \%args => $val ] >>. The format of C<< \%args >> is currently:
4933 If present (in any form), this is what is being passed directly to bind_param.
4934 Note that different DBD's expect different bind args. (e.g. DBD::SQLite takes
4935 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4937 If this is specified, all other bind options described below are ignored.
4941 If present, this is used to infer the actual bind attribute by passing to
4942 C<< $resolved_storage->bind_attribute_by_data_type() >>. Defaults to the
4943 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4945 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4946 currently drivers are expected to "Do the Right Thing" when given a common
4947 datatype name. (Not ideal, but that's what we got at this point.)
4951 Currently used to correctly allocate buffers for bind_param_inout().
4952 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4953 or to a sensible value based on the "data_type".
4957 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4958 explicitly specified they are never overridden). Also used by some weird DBDs,
4959 where the column name should be available at bind_param time (e.g. Oracle).
4963 For backwards compatibility and convenience, the following shortcuts are
4966 [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4967 [ \$dt => $val ] === [ { sqlt_datatype => $dt }, $val ]
4968 [ undef, $val ] === [ {}, $val ]
4969 $val === [ {}, $val ]
4971 =head1 FURTHER QUESTIONS?
4973 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
4975 =head1 COPYRIGHT AND LICENSE
4977 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
4978 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
4979 redistribute it and/or modify it under the same terms as the
4980 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.