lib/DBIx/Class/ResultSet.pm

   1 package DBIx::Class::ResultSet;
   2
   3 use strict;
   4 use warnings;
   5 use base qw/DBIx::Class/;
   6 use DBIx::Class::Carp;
   7 use DBIx::Class::ResultSetColumn;
   8 use Scalar::Util qw/blessed weaken reftype/;
   9 use DBIx::Class::_Util 'fail_on_internal_wantarray';
  10 use Try::Tiny;
  11 use Data::Dumper::Concise ();
  12 use Data::Query::Constants;
  13 use Data::Query::ExprHelpers;
  14 # not importing first() as it will clash with our own method
  15 use List::Util ();
  16
  17 BEGIN {
  18   # De-duplication in _merge_attr() is disabled, but left in for reference
  19   # (the merger is used for other things that ought not to be de-duped)
  20   *__HM_DEDUP = sub () { 0 };
  21 }
  22
  23 use namespace::clean;
  24
  25 use overload
  26         '0+'     => "count",
  27         'bool'   => "_bool",
  28         fallback => 1;
  29
  30 # this is real - CDBICompat overrides it with insanity
  31 # yes, prototype won't matter, but that's for now ;)
  32 sub _bool () { 1 }
  33
  34 __PACKAGE__->mk_group_accessors('simple' => qw/_result_class result_source/);
  35
  36 =head1 NAME
  37
  38 DBIx::Class::ResultSet - Represents a query used for fetching a set of results.
  39
  40 =head1 SYNOPSIS
  41
  42   my $users_rs = $schema->resultset('User');
  43   while( $user = $users_rs->next) {
  44     print $user->username;
  45   }
  46
  47   my $registered_users_rs = $schema->resultset('User')->search({ registered => 1 });
  48   my @cds_in_2005 = $schema->resultset('CD')->search({ year => 2005 })->all();
  49
  50 =head1 DESCRIPTION
  51
  52 A ResultSet is an object which stores a set of conditions representing
  53 a query. It is the backbone of DBIx::Class (i.e. the really
  54 important/useful bit).
  55
  56 No SQL is executed on the database when a ResultSet is created, it
  57 just stores all the conditions needed to create the query.
  58
  59 A basic ResultSet representing the data of an entire table is returned
  60 by calling C<resultset> on a L<DBIx::Class::Schema> and passing in a
  61 L<Source|DBIx::Class::Manual::Glossary/Source> name.
  62
  63   my $users_rs = $schema->resultset('User');
  64
  65 A new ResultSet is returned from calling L</search> on an existing
  66 ResultSet. The new one will contain all the conditions of the
  67 original, plus any new conditions added in the C<search> call.
  68
  69 A ResultSet also incorporates an implicit iterator. L</next> and L</reset>
  70 can be used to walk through all the L<DBIx::Class::Row>s the ResultSet
  71 represents.
  72
  73 The query that the ResultSet represents is B<only> executed against
  74 the database when these methods are called:
  75 L</find>, L</next>, L</all>, L</first>, L</single>, L</count>.
  76
  77 If a resultset is used in a numeric context it returns the L</count>.
  78 However, if it is used in a boolean context it is B<always> true.  So if
  79 you want to check if a resultset has any results, you must use C<if $rs
  80 != 0>.
  81
  82 =head1 CUSTOM ResultSet CLASSES THAT USE Moose
  83
  84 If you want to make your custom ResultSet classes with L<Moose>, use a template
  85 similar to:
  86
  87     package MyApp::Schema::ResultSet::User;
  88
  89     use Moose;
  90     use namespace::autoclean;
  91     use MooseX::NonMoose;
  92     extends 'DBIx::Class::ResultSet';
  93
  94     sub BUILDARGS { $_[2] }
  95
  96     ...your code...
  97
  98     __PACKAGE__->meta->make_immutable;
  99
 100     1;
 101
 102 The L<MooseX::NonMoose> is necessary so that the L<Moose> constructor does not
 103 clash with the regular ResultSet constructor. Alternatively, you can use:
 104
 105     __PACKAGE__->meta->make_immutable(inline_constructor => 0);
 106
 107 The L<BUILDARGS|Moose::Manual::Construction/BUILDARGS> is necessary because the
 108 signature of the ResultSet C<new> is C<< ->new($source, \%args) >>.
 109
 110 =head1 EXAMPLES
 111
 112 =head2 Chaining resultsets
 113
 114 Let's say you've got a query that needs to be run to return some data
 115 to the user. But, you have an authorization system in place that
 116 prevents certain users from seeing certain information. So, you want
 117 to construct the basic query in one method, but add constraints to it in
 118 another.
 119
 120   sub get_data {
 121     my $self = shift;
 122     my $request = $self->get_request; # Get a request object somehow.
 123     my $schema = $self->result_source->schema;
 124
 125     my $cd_rs = $schema->resultset('CD')->search({
 126       title => $request->param('title'),
 127       year => $request->param('year'),
 128     });
 129
 130     $cd_rs = $self->apply_security_policy( $cd_rs );
 131
 132     return $cd_rs->all();
 133   }
 134
 135   sub apply_security_policy {
 136     my $self = shift;
 137     my ($rs) = @_;
 138
 139     return $rs->search({
 140       subversive => 0,
 141     });
 142   }
 143
 144 =head3 Resolving conditions and attributes
 145
 146 When a resultset is chained from another resultset (e.g.:
 147 C<< my $new_rs = $old_rs->search(\%extra_cond, \%attrs) >>), conditions
 148 and attributes with the same keys need resolving.
 149
 150 If any of L</columns>, L</select>, L</as> are present, they reset the
 151 original selection, and start the selection "clean".
 152
 153 The L</join>, L</prefetch>, L</+columns>, L</+select>, L</+as> attributes
 154 are merged into the existing ones from the original resultset.
 155
 156 The L</where> and L</having> attributes, and any search conditions, are
 157 merged with an SQL C<AND> to the existing condition from the original
 158 resultset.
 159
 160 All other attributes are overridden by any new ones supplied in the
 161 search attributes.
 162
 163 =head2 Multiple queries
 164
 165 Since a resultset just defines a query, you can do all sorts of
 166 things with it with the same object.
 167
 168   # Don't hit the DB yet.
 169   my $cd_rs = $schema->resultset('CD')->search({
 170     title => 'something',
 171     year => 2009,
 172   });
 173
 174   # Each of these hits the DB individually.
 175   my $count = $cd_rs->count;
 176   my $most_recent = $cd_rs->get_column('date_released')->max();
 177   my @records = $cd_rs->all;
 178
 179 And it's not just limited to SELECT statements.
 180
 181   $cd_rs->delete();
 182
 183 This is even cooler:
 184
 185   $cd_rs->create({ artist => 'Fred' });
 186
 187 Which is the same as:
 188
 189   $schema->resultset('CD')->create({
 190     title => 'something',
 191     year => 2009,
 192     artist => 'Fred'
 193   });
 194
 195 See: L</search>, L</count>, L</get_column>, L</all>, L</create>.
 196
 197 =head1 METHODS
 198
 199 =head2 new
 200
 201 =over 4
 202
 203 =item Arguments: L<$source|DBIx::Class::ResultSource>, L<\%attrs?|/ATTRIBUTES>
 204
 205 =item Return Value: L<$resultset|/search>
 206
 207 =back
 208
 209 The resultset constructor. Takes a source object (usually a
 210 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
 211 L</ATTRIBUTES> below).  Does not perform any queries -- these are
 212 executed as needed by the other methods.
 213
 214 Generally you never construct a resultset manually. Instead you get one
 215 from e.g. a
 216 C<< $schema->L<resultset|DBIx::Class::Schema/resultset>('$source_name') >>
 217 or C<< $another_resultset->L<search|/search>(...) >> (the later called in
 218 scalar context):
 219
 220   my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
 221
 222 =over
 223
 224 =item WARNING
 225
 226 If called on an object, proxies to L</new_result> instead, so
 227
 228   my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
 229
 230 will return a CD object, not a ResultSet, and is equivalent to:
 231
 232   my $cd = $schema->resultset('CD')->new_result({ title => 'Spoon' });
 233
 234 Please also keep in mind that many internals call L</new_result> directly,
 235 so overloading this method with the idea of intercepting new result object
 236 creation B<will not work>. See also warning pertaining to L</create>.
 237
 238 =back
 239
 240 =cut
 241
 242 sub new {
 243   my $class = shift;
 244   return $class->new_result(@_) if ref $class;
 245
 246   my ($source, $attrs) = @_;
 247   $source = $source->resolve
 248     if $source->isa('DBIx::Class::ResultSourceHandle');
 249
 250   $attrs = { %{$attrs||{}} };
 251   delete @{$attrs}{qw(_sqlmaker_select_args _related_results_construction)};
 252
 253   if ($attrs->{page}) {
 254     $attrs->{rows} ||= 10;
 255   }
 256
 257   $attrs->{alias} ||= 'me';
 258
 259   my $self = bless {
 260     result_source => $source,
 261     cond => $attrs->{where},
 262     pager => undef,
 263     attrs => $attrs,
 264   }, $class;
 265
 266   # if there is a dark selector, this means we are already in a
 267   # chain and the cleanup/sanification was taken care of by
 268   # _search_rs already
 269   $self->_normalize_selection($attrs)
 270     unless $attrs->{_dark_selector};
 271
 272   $self->result_class(
 273     $attrs->{result_class} || $source->result_class
 274   );
 275
 276   $self;
 277 }
 278
 279 =head2 search
 280
 281 =over 4
 282
 283 =item Arguments: L<$cond|DBIx::Class::SQLMaker> | undef, L<\%attrs?|/ATTRIBUTES>
 284
 285 =item Return Value: $resultset (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
 286
 287 =back
 288
 289   my @cds    = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
 290   my $new_rs = $cd_rs->search({ year => 2005 });
 291
 292   my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
 293                  # year = 2005 OR year = 2004
 294
 295 In list context, C<< ->all() >> is called implicitly on the resultset, thus
 296 returning a list of L<result|DBIx::Class::Manual::ResultClass> objects instead.
 297 To avoid that, use L</search_rs>.
 298
 299 If you need to pass in additional attributes but no additional condition,
 300 call it as C<search(undef, \%attrs)>.
 301
 302   # "SELECT name, artistid FROM $artist_table"
 303   my @all_artists = $schema->resultset('Artist')->search(undef, {
 304     columns => [qw/name artistid/],
 305   });
 306
 307 For a list of attributes that can be passed to C<search>, see
 308 L</ATTRIBUTES>. For more examples of using this function, see
 309 L<Searching|DBIx::Class::Manual::Cookbook/SEARCHING>. For a complete
 310 documentation for the first argument, see L<SQL::Abstract/"WHERE CLAUSES">
 311 and its extension L<DBIx::Class::SQLMaker>.
 312
 313 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
 314
 315 =head3 CAVEAT
 316
 317 Note that L</search> does not process/deflate any of the values passed in the
 318 L<SQL::Abstract>-compatible search condition structure. This is unlike other
 319 condition-bound methods L</new_result>, L</create> and L</find>. The user must ensure
 320 manually that any value passed to this method will stringify to something the
 321 RDBMS knows how to deal with. A notable example is the handling of L<DateTime>
 322 objects, for more info see:
 323 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
 324
 325 =cut
 326
 327 sub search {
 328   my $self = shift;
 329   my $rs = $self->search_rs( @_ );
 330
 331   if (wantarray) {
 332     DBIx::Class::_ENV_::ASSERT_NO_INTERNAL_WANTARRAY and my $sog = fail_on_internal_wantarray($rs);
 333     return $rs->all;
 334   }
 335   elsif (defined wantarray) {
 336     return $rs;
 337   }
 338   else {
 339     # we can be called by a relationship helper, which in
 340     # turn may be called in void context due to some braindead
 341     # overload or whatever else the user decided to be clever
 342     # at this particular day. Thus limit the exception to
 343     # external code calls only
 344     $self->throw_exception ('->search is *not* a mutator, calling it in void context makes no sense')
 345       if (caller)[0] !~ /^\QDBIx::Class::/;
 346
 347     return ();
 348   }
 349 }
 350
 351 =head2 search_rs
 352
 353 =over 4
 354
 355 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
 356
 357 =item Return Value: L<$resultset|/search>
 358
 359 =back
 360
 361 This method does the same exact thing as search() except it will
 362 always return a resultset, even in list context.
 363
 364 =cut
 365
 366 sub search_rs {
 367   my $self = shift;
 368
 369   my $rsrc = $self->result_source;
 370   my ($call_cond, $call_attrs);
 371
 372   # Special-case handling for (undef, undef) or (undef)
 373   # Note that (foo => undef) is valid deprecated syntax
 374   @_ = () if not scalar grep { defined $_ } @_;
 375
 376   # just a cond
 377   if (@_ == 1) {
 378     $call_cond = shift;
 379   }
 380   # fish out attrs in the ($condref, $attr) case
 381   elsif (@_ == 2 and ( ! defined $_[0] or (ref $_[0]) ne '') ) {
 382     ($call_cond, $call_attrs) = @_;
 383   }
 384   elsif (@_ % 2) {
 385     $self->throw_exception('Odd number of arguments to search')
 386   }
 387   # legacy search
 388   elsif (@_) {
 389     carp_unique 'search( %condition ) is deprecated, use search( \%condition ) instead'
 390       unless $rsrc->result_class->isa('DBIx::Class::CDBICompat');
 391
 392     for my $i (0 .. $#_) {
 393       next if $i % 2;
 394       $self->throw_exception ('All keys in condition key/value pairs must be plain scalars')
 395         if (! defined $_[$i] or ref $_[$i] ne '');
 396     }
 397
 398     $call_cond = { @_ };
 399   }
 400
 401   if (blessed($call_cond) and $call_cond->isa('Data::Query::ExprBuilder')) {
 402     $call_cond = \$call_cond->{expr};
 403   }
 404
 405   # see if we can keep the cache (no $rs changes)
 406   my $cache;
 407   my %safe = (alias => 1, cache => 1);
 408   if ( ! List::Util::first { !$safe{$_} } keys %$call_attrs and (
 409     ! defined $call_cond
 410       or
 411     ref $call_cond eq 'HASH' && ! keys %$call_cond
 412       or
 413     ref $call_cond eq 'ARRAY' && ! @$call_cond
 414   )) {
 415     $cache = $self->get_cache;
 416   }
 417
 418   my $old_attrs = { %{$self->{attrs}} };
 419   my ($old_having, $old_where) = delete @{$old_attrs}{qw(having where)};
 420
 421   my $new_attrs = { %$old_attrs };
 422
 423   # take care of call attrs (only if anything is changing)
 424   if ($call_attrs and keys %$call_attrs) {
 425
 426     # copy for _normalize_selection
 427     $call_attrs = { %$call_attrs };
 428
 429     my @selector_attrs = qw/select as columns cols +select +as +columns include_columns/;
 430
 431     # reset the current selector list if new selectors are supplied
 432     if (List::Util::first { exists $call_attrs->{$_} } qw/columns cols select as/) {
 433       delete @{$old_attrs}{(@selector_attrs, '_dark_selector')};
 434     }
 435
 436     # Normalize the new selector list (operates on the passed-in attr structure)
 437     # Need to do it on every chain instead of only once on _resolved_attrs, in
 438     # order to allow detection of empty vs partial 'as'
 439     $call_attrs->{_dark_selector} = $old_attrs->{_dark_selector}
 440       if $old_attrs->{_dark_selector};
 441     $self->_normalize_selection ($call_attrs);
 442
 443     # start with blind overwriting merge, exclude selector attrs
 444     $new_attrs = { %{$old_attrs}, %{$call_attrs} };
 445     delete @{$new_attrs}{@selector_attrs};
 446
 447     for (@selector_attrs) {
 448       $new_attrs->{$_} = $self->_merge_attr($old_attrs->{$_}, $call_attrs->{$_})
 449         if ( exists $old_attrs->{$_} or exists $call_attrs->{$_} );
 450     }
 451
 452     # older deprecated name, use only if {columns} is not there
 453     if (my $c = delete $new_attrs->{cols}) {
 454       carp_unique( "Resultset attribute 'cols' is deprecated, use 'columns' instead" );
 455       if ($new_attrs->{columns}) {
 456         carp "Resultset specifies both the 'columns' and the legacy 'cols' attributes - ignoring 'cols'";
 457       }
 458       else {
 459         $new_attrs->{columns} = $c;
 460       }
 461     }
 462
 463
 464     # join/prefetch use their own crazy merging heuristics
 465     foreach my $key (qw/join prefetch/) {
 466       $new_attrs->{$key} = $self->_merge_joinpref_attr($old_attrs->{$key}, $call_attrs->{$key})
 467         if exists $call_attrs->{$key};
 468     }
 469
 470     # stack binds together
 471     $new_attrs->{bind} = [ @{ $old_attrs->{bind} || [] }, @{ $call_attrs->{bind} || [] } ];
 472   }
 473
 474
 475   for ($old_where, $call_cond) {
 476     if (defined $_) {
 477       $new_attrs->{where} = $self->_stack_cond (
 478         $_, $new_attrs->{where}
 479       );
 480     }
 481   }
 482
 483   if (defined $old_having) {
 484     $new_attrs->{having} = $self->_stack_cond (
 485       $old_having, $new_attrs->{having}
 486     )
 487   }
 488
 489   my $rs = (ref $self)->new($rsrc, $new_attrs);
 490
 491   $rs->set_cache($cache) if ($cache);
 492
 493   return $rs;
 494 }
 495
 496 my $dark_sel_dumper;
 497 sub _normalize_selection {
 498   my ($self, $attrs) = @_;
 499
 500   # legacy syntax
 501   if ( exists $attrs->{include_columns} ) {
 502     carp_unique( "Resultset attribute 'include_columns' is deprecated, use '+columns' instead" );
 503     $attrs->{'+columns'} = $self->_merge_attr(
 504       $attrs->{'+columns'}, delete $attrs->{include_columns}
 505     );
 506   }
 507
 508   # columns are always placed first, however
 509
 510   # Keep the X vs +X separation until _resolved_attrs time - this allows to
 511   # delay the decision on whether to use a default select list ($rsrc->columns)
 512   # allowing stuff like the remove_columns helper to work
 513   #
 514   # select/as +select/+as pairs need special handling - the amount of select/as
 515   # elements in each pair does *not* have to be equal (think multicolumn
 516   # selectors like distinct(foo, bar) ). If the selector is bare (no 'as'
 517   # supplied at all) - try to infer the alias, either from the -as parameter
 518   # of the selector spec, or use the parameter whole if it looks like a column
 519   # name (ugly legacy heuristic). If all fails - leave the selector bare (which
 520   # is ok as well), but make sure no more additions to the 'as' chain take place
 521   for my $pref ('', '+') {
 522
 523     my ($sel, $as) = map {
 524       my $key = "${pref}${_}";
 525
 526       my $val = [ ref $attrs->{$key} eq 'ARRAY'
 527         ? @{$attrs->{$key}}
 528         : $attrs->{$key} || ()
 529       ];
 530       delete $attrs->{$key};
 531       $val;
 532     } qw/select as/;
 533
 534     if (! @$as and ! @$sel ) {
 535       next;
 536     }
 537     elsif (@$as and ! @$sel) {
 538       $self->throw_exception(
 539         "Unable to handle ${pref}as specification (@$as) without a corresponding ${pref}select"
 540       );
 541     }
 542     elsif( ! @$as ) {
 543       # no as part supplied at all - try to deduce (unless explicit end of named selection is declared)
 544       # if any @$as has been supplied we assume the user knows what (s)he is doing
 545       # and blindly keep stacking up pieces
 546       unless ($attrs->{_dark_selector}) {
 547         SELECTOR:
 548         for (@$sel) {
 549           if ( ref $_ eq 'HASH' and exists $_->{-as} ) {
 550             push @$as, $_->{-as};
 551           }
 552           # assume any plain no-space, no-parenthesis string to be a column spec
 553           # FIXME - this is retarded but is necessary to support shit like 'count(foo)'
 554           elsif ( ! ref $_ and $_ =~ /^ [^\s\(\)]+ $/x) {
 555             push @$as, $_;
 556           }
 557           # if all else fails - raise a flag that no more aliasing will be allowed
 558           else {
 559             $attrs->{_dark_selector} = {
 560               plus_stage => $pref,
 561               string => ($dark_sel_dumper ||= do {
 562                   require Data::Dumper::Concise;
 563                   Data::Dumper::Concise::DumperObject()->Indent(0);
 564                 })->Values([$_])->Dump
 565               ,
 566             };
 567             last SELECTOR;
 568           }
 569         }
 570       }
 571     }
 572     elsif (@$as < @$sel) {
 573       $self->throw_exception(
 574         "Unable to handle an ${pref}as specification (@$as) with less elements than the corresponding ${pref}select"
 575       );
 576     }
 577     elsif ($pref and $attrs->{_dark_selector}) {
 578       $self->throw_exception(
 579         "Unable to process named '+select', resultset contains an unnamed selector $attrs->{_dark_selector}{string}"
 580       );
 581     }
 582
 583
 584     # merge result
 585     $attrs->{"${pref}select"} = $self->_merge_attr($attrs->{"${pref}select"}, $sel);
 586     $attrs->{"${pref}as"} = $self->_merge_attr($attrs->{"${pref}as"}, $as);
 587   }
 588 }
 589
 590 sub _stack_cond {
 591   my ($self, $left, $right) = @_;
 592
 593   my $source = $self->result_source;
 594
 595   my $converter = $source->schema->storage->sql_maker->converter;
 596
 597   my @top = map $source->_extract_top_level_conditions(
 598     $converter->_expr_to_dq($_)
 599   ), grep defined, $left, $right;
 600
 601   return undef unless @top;
 602
 603   my %seen;
 604
 605   my @uniq = grep { !$seen{Data::Dumper::Concise::Dumper($_)}++ } @top;
 606
 607   return \$uniq[0] if @uniq == 1;
 608
 609   return \Operator({ 'SQL.Naive' => 'AND' }, \@uniq);
 610 }
 611
 612 =head2 search_literal
 613
 614 B<CAVEAT>: C<search_literal> is provided for Class::DBI compatibility and
 615 should only be used in that context. C<search_literal> is a convenience
 616 method. It is equivalent to calling C<< $schema->search(\[]) >>, but if you
 617 want to ensure columns are bound correctly, use L</search>.
 618
 619 See L<DBIx::Class::Manual::Cookbook/SEARCHING> and
 620 L<DBIx::Class::Manual::FAQ/Searching> for searching techniques that do not
 621 require C<search_literal>.
 622
 623 =over 4
 624
 625 =item Arguments: $sql_fragment, @standalone_bind_values
 626
 627 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
 628
 629 =back
 630
 631   my @cds   = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
 632   my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
 633
 634 Pass a literal chunk of SQL to be added to the conditional part of the
 635 resultset query.
 636
 637 Example of how to use C<search> instead of C<search_literal>
 638
 639   my @cds = $cd_rs->search_literal('cdid = ? AND (artist = ? OR artist = ?)', (2, 1, 2));
 640   my @cds = $cd_rs->search(\[ 'cdid = ? AND (artist = ? OR artist = ?)', [ 'cdid', 2 ], [ 'artist', 1 ], [ 'artist', 2 ] ]);
 641
 642 =cut
 643
 644 sub search_literal {
 645   my ($self, $sql, @bind) = @_;
 646   my $attr;
 647   if ( @bind && ref($bind[-1]) eq 'HASH' ) {
 648     $attr = pop @bind;
 649   }
 650   return $self->search(\[ $sql, map [ {} => $_ ], @bind ], ($attr || () ));
 651 }
 652
 653 =head2 find
 654
 655 =over 4
 656
 657 =item Arguments: \%columns_values | @pk_values, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
 658
 659 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
 660
 661 =back
 662
 663 Finds and returns a single row based on supplied criteria. Takes either a
 664 hashref with the same format as L</create> (including inference of foreign
 665 keys from related objects), or a list of primary key values in the same
 666 order as the L<primary columns|DBIx::Class::ResultSource/primary_columns>
 667 declaration on the L</result_source>.
 668
 669 In either case an attempt is made to combine conditions already existing on
 670 the resultset with the condition passed to this method.
 671
 672 To aid with preparing the correct query for the storage you may supply the
 673 C<key> attribute, which is the name of a
 674 L<unique constraint|DBIx::Class::ResultSource/add_unique_constraint> (the
 675 unique constraint corresponding to the
 676 L<primary columns|DBIx::Class::ResultSource/primary_columns> is always named
 677 C<primary>). If the C<key> attribute has been supplied, and DBIC is unable
 678 to construct a query that satisfies the named unique constraint fully (
 679 non-NULL values for each column member of the constraint) an exception is
 680 thrown.
 681
 682 If no C<key> is specified, the search is carried over all unique constraints
 683 which are fully defined by the available condition.
 684
 685 If no such constraint is found, C<find> currently defaults to a simple
 686 C<< search->(\%column_values) >> which may or may not do what you expect.
 687 Note that this fallback behavior may be deprecated in further versions. If
 688 you need to search with arbitrary conditions - use L</search>. If the query
 689 resulting from this fallback produces more than one row, a warning to the
 690 effect is issued, though only the first row is constructed and returned as
 691 C<$result_object>.
 692
 693 In addition to C<key>, L</find> recognizes and applies standard
 694 L<resultset attributes|/ATTRIBUTES> in the same way as L</search> does.
 695
 696 Note that if you have extra concerns about the correctness of the resulting
 697 query you need to specify the C<key> attribute and supply the entire condition
 698 as an argument to find (since it is not always possible to perform the
 699 combination of the resultset condition with the supplied one, especially if
 700 the resultset condition contains literal sql).
 701
 702 For example, to find a row by its primary key:
 703
 704   my $cd = $schema->resultset('CD')->find(5);
 705
 706 You can also find a row by a specific unique constraint:
 707
 708   my $cd = $schema->resultset('CD')->find(
 709     {
 710       artist => 'Massive Attack',
 711       title  => 'Mezzanine',
 712     },
 713     { key => 'cd_artist_title' }
 714   );
 715
 716 See also L</find_or_create> and L</update_or_create>.
 717
 718 =cut
 719
 720 sub find {
 721   my $self = shift;
 722   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
 723
 724   my $rsrc = $self->result_source;
 725
 726   my $constraint_name;
 727   if (exists $attrs->{key}) {
 728     $constraint_name = defined $attrs->{key}
 729       ? $attrs->{key}
 730       : $self->throw_exception("An undefined 'key' resultset attribute makes no sense")
 731     ;
 732   }
 733
 734   # Parse out the condition from input
 735   my $call_cond;
 736
 737   if (ref $_[0] eq 'HASH') {
 738     $call_cond = { %{$_[0]} };
 739   }
 740   else {
 741     # if only values are supplied we need to default to 'primary'
 742     $constraint_name = 'primary' unless defined $constraint_name;
 743
 744     my @c_cols = $rsrc->unique_constraint_columns($constraint_name);
 745
 746     $self->throw_exception(
 747       "No constraint columns, maybe a malformed '$constraint_name' constraint?"
 748     ) unless @c_cols;
 749
 750     $self->throw_exception (
 751       'find() expects either a column/value hashref, or a list of values '
 752     . "corresponding to the columns of the specified unique constraint '$constraint_name'"
 753     ) unless @c_cols == @_;
 754
 755     $call_cond = {};
 756     @{$call_cond}{@c_cols} = @_;
 757   }
 758
 759   my %related;
 760   for my $key (keys %$call_cond) {
 761     if (
 762       my $keyref = ref($call_cond->{$key})
 763         and
 764       my $relinfo = $rsrc->relationship_info($key)
 765     ) {
 766       my $val = delete $call_cond->{$key};
 767
 768       next if $keyref eq 'ARRAY'; # has_many for multi_create
 769
 770       my $rel_q = $rsrc->_resolve_condition(
 771         $relinfo->{cond}, $val, $key, $key
 772       );
 773       die "Can't handle complex relationship conditions in find" if ref($rel_q) ne 'HASH';
 774       @related{keys %$rel_q} = values %$rel_q;
 775     }
 776   }
 777
 778   # relationship conditions take precedence (?)
 779   @{$call_cond}{keys %related} = values %related;
 780
 781   my $alias = exists $attrs->{alias} ? $attrs->{alias} : $self->{attrs}{alias};
 782   my $final_cond;
 783   if (defined $constraint_name) {
 784     $final_cond = $self->_qualify_cond_columns (
 785
 786       $self->_build_unique_cond (
 787         $constraint_name,
 788         $call_cond,
 789       ),
 790
 791       $alias,
 792     );
 793   }
 794   elsif ($self->{attrs}{accessor} and $self->{attrs}{accessor} eq 'single') {
 795     # This means that we got here after a merger of relationship conditions
 796     # in ::Relationship::Base::search_related (the row method), and furthermore
 797     # the relationship is of the 'single' type. This means that the condition
 798     # provided by the relationship (already attached to $self) is sufficient,
 799     # as there can be only one row in the database that would satisfy the
 800     # relationship
 801   }
 802   else {
 803     # no key was specified - fall down to heuristics mode:
 804     # run through all unique queries registered on the resultset, and
 805     # 'OR' all qualifying queries together
 806     my (@unique_queries, %seen_column_combinations);
 807     for my $c_name ($rsrc->unique_constraint_names) {
 808       next if $seen_column_combinations{
 809         join "\x00", sort $rsrc->unique_constraint_columns($c_name)
 810       }++;
 811
 812       push @unique_queries, try {
 813         $self->_build_unique_cond ($c_name, $call_cond, 'croak_on_nulls')
 814       } || ();
 815     }
 816
 817     $final_cond = @unique_queries
 818       ? [ map { $self->_qualify_cond_columns($_, $alias) } @unique_queries ]
 819       : $self->_non_unique_find_fallback ($call_cond, $attrs)
 820     ;
 821   }
 822
 823   # Run the query, passing the result_class since it should propagate for find
 824   my $rs = $self->search ($final_cond, {result_class => $self->result_class, %$attrs});
 825   if ($rs->_resolved_attrs->{collapse}) {
 826     my $row = $rs->next;
 827     carp "Query returned more than one row" if $rs->next;
 828     return $row;
 829   }
 830   else {
 831     return $rs->single;
 832   }
 833 }
 834
 835 # This is a stop-gap method as agreed during the discussion on find() cleanup:
 836 # http://lists.scsys.co.uk/pipermail/dbix-class/2010-October/009535.html
 837 #
 838 # It is invoked when find() is called in legacy-mode with insufficiently-unique
 839 # condition. It is provided for overrides until a saner way forward is devised
 840 #
 841 # *NOTE* This is not a public method, and it's *GUARANTEED* to disappear down
 842 # the road. Please adjust your tests accordingly to catch this situation early
 843 # DBIx::Class::ResultSet->can('_non_unique_find_fallback') is reasonable
 844 #
 845 # The method will not be removed without an adequately complete replacement
 846 # for strict-mode enforcement
 847 sub _non_unique_find_fallback {
 848   my ($self, $cond, $attrs) = @_;
 849
 850   return $self->_qualify_cond_columns(
 851     $cond,
 852     exists $attrs->{alias}
 853       ? $attrs->{alias}
 854       : $self->{attrs}{alias}
 855   );
 856 }
 857
 858
 859 sub _qualify_cond_columns {
 860   my ($self, $cond, $alias) = @_;
 861
 862   my %aliased = %$cond;
 863   for (keys %aliased) {
 864     $aliased{"$alias.$_"} = delete $aliased{$_}
 865       if $_ !~ /\./;
 866   }
 867
 868   return \%aliased;
 869 }
 870
 871 sub _build_unique_cond {
 872   my ($self, $constraint_name, $extra_cond, $croak_on_null) = @_;
 873
 874   my @c_cols = $self->result_source->unique_constraint_columns($constraint_name);
 875
 876   # combination may fail if $self->{cond} is non-trivial
 877   my ($final_cond) = try {
 878     $self->_merge_with_rscond ($extra_cond)
 879   } catch {
 880     +{ %$extra_cond }
 881   };
 882
 883   # trim out everything not in $columns
 884   $final_cond = { map {
 885     exists $final_cond->{$_}
 886       ? ( $_ => $final_cond->{$_} )
 887       : ()
 888   } @c_cols };
 889
 890   if (my @missing = grep
 891     { ! ($croak_on_null ? defined $final_cond->{$_} : exists $final_cond->{$_}) }
 892     (@c_cols)
 893   ) {
 894     $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', no values for column(s): %s",
 895       $constraint_name,
 896       join (', ', map { "'$_'" } @missing),
 897     ) );
 898   }
 899
 900   if (
 901     !$croak_on_null
 902       and
 903     !$ENV{DBIC_NULLABLE_KEY_NOWARN}
 904       and
 905     my @undefs = sort grep { ! defined $final_cond->{$_} } (keys %$final_cond)
 906   ) {
 907     carp_unique ( sprintf (
 908       "NULL/undef values supplied for requested unique constraint '%s' (NULL "
 909     . 'values in column(s): %s). This is almost certainly not what you wanted, '
 910     . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.',
 911       $constraint_name,
 912       join (', ', map { "'$_'" } @undefs),
 913     ));
 914   }
 915
 916   return $final_cond;
 917 }
 918
 919 =head2 search_related
 920
 921 =over 4
 922
 923 =item Arguments: $rel_name, $cond?, L<\%attrs?|/ATTRIBUTES>
 924
 925 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
 926
 927 =back
 928
 929   $new_rs = $cd_rs->search_related('artist', {
 930     name => 'Emo-R-Us',
 931   });
 932
 933 Searches the specified relationship, optionally specifying a condition and
 934 attributes for matching records. See L</ATTRIBUTES> for more information.
 935
 936 In list context, C<< ->all() >> is called implicitly on the resultset, thus
 937 returning a list of result objects instead. To avoid that, use L</search_related_rs>.
 938
 939 See also L</search_related_rs>.
 940
 941 =cut
 942
 943 sub search_related {
 944   return shift->related_resultset(shift)->search(@_);
 945 }
 946
 947 =head2 search_related_rs
 948
 949 This method works exactly the same as search_related, except that
 950 it guarantees a resultset, even in list context.
 951
 952 =cut
 953
 954 sub search_related_rs {
 955   return shift->related_resultset(shift)->search_rs(@_);
 956 }
 957
 958 =head2 cursor
 959
 960 =over 4
 961
 962 =item Arguments: none
 963
 964 =item Return Value: L<$cursor|DBIx::Class::Cursor>
 965
 966 =back
 967
 968 Returns a storage-driven cursor to the given resultset. See
 969 L<DBIx::Class::Cursor> for more information.
 970
 971 =cut
 972
 973 sub cursor {
 974   my $self = shift;
 975
 976   return $self->{cursor} ||= do {
 977     my $attrs = $self->_resolved_attrs;
 978     $self->result_source->storage->select(
 979       $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
 980     );
 981   };
 982 }
 983
 984 =head2 single
 985
 986 =over 4
 987
 988 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
 989
 990 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
 991
 992 =back
 993
 994   my $cd = $schema->resultset('CD')->single({ year => 2001 });
 995
 996 Inflates the first result without creating a cursor if the resultset has
 997 any records in it; if not returns C<undef>. Used by L</find> as a lean version
 998 of L</search>.
 999
1000 While this method can take an optional search condition (just like L</search>)
1001 being a fast-code-path it does not recognize search attributes. If you need to
1002 add extra joins or similar, call L</search> and then chain-call L</single> on the
1003 L<DBIx::Class::ResultSet> returned.
1004
1005 =over
1006
1007 =item B<Note>
1008
1009 As of 0.08100, this method enforces the assumption that the preceding
1010 query returns only one row. If more than one row is returned, you will receive
1011 a warning:
1012
1013   Query returned more than one row
1014
1015 In this case, you should be using L</next> or L</find> instead, or if you really
1016 know what you are doing, use the L</rows> attribute to explicitly limit the size
1017 of the resultset.
1018
1019 This method will also throw an exception if it is called on a resultset prefetching
1020 has_many, as such a prefetch implies fetching multiple rows from the database in
1021 order to assemble the resulting object.
1022
1023 =back
1024
1025 =cut
1026
1027 sub single {
1028   my ($self, $where) = @_;
1029   if(@_ > 2) {
1030       $self->throw_exception('single() only takes search conditions, no attributes. You want ->search( $cond, $attrs )->single()');
1031   }
1032
1033   my $attrs = { %{$self->_resolved_attrs} };
1034
1035   $self->throw_exception(
1036     'single() can not be used on resultsets collapsing a has_many. Use find( \%cond ) or next() instead'
1037   ) if $attrs->{collapse};
1038
1039   if ($where) {
1040     if (defined $attrs->{where}) {
1041       $attrs->{where} = {
1042         '-and' =>
1043             [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
1044                $where, delete $attrs->{where} ]
1045       };
1046     } else {
1047       $attrs->{where} = $where;
1048     }
1049   }
1050
1051   my $data = [ $self->result_source->storage->select_single(
1052     $attrs->{from}, $attrs->{select},
1053     $attrs->{where}, $attrs
1054   )];
1055
1056   return undef unless @$data;
1057   $self->{_stashed_rows} = [ $data ];
1058   $self->_construct_results->[0];
1059 }
1060
1061
1062 # _collapse_query
1063 #
1064 # Recursively collapse the query, accumulating values for each column.
1065
1066 sub _collapse_query {
1067   my ($self, $query, $collapsed) = @_;
1068
1069   $collapsed ||= {};
1070
1071   if (ref $query eq 'ARRAY') {
1072     foreach my $subquery (@$query) {
1073       next unless ref $subquery;  # -or
1074       $collapsed = $self->_collapse_query($subquery, $collapsed);
1075     }
1076   }
1077   elsif (ref $query eq 'HASH') {
1078     if (keys %$query and (keys %$query)[0] eq '-and') {
1079       foreach my $subquery (@{$query->{-and}}) {
1080         $collapsed = $self->_collapse_query($subquery, $collapsed);
1081       }
1082     }
1083     else {
1084       foreach my $col (keys %$query) {
1085         my $value = $query->{$col};
1086         $collapsed->{$col}{$value}++;
1087       }
1088     }
1089   }
1090
1091   return $collapsed;
1092 }
1093
1094 =head2 get_column
1095
1096 =over 4
1097
1098 =item Arguments: L<$cond?|DBIx::Class::SQLMaker>
1099
1100 =item Return Value: L<$resultsetcolumn|DBIx::Class::ResultSetColumn>
1101
1102 =back
1103
1104   my $max_length = $rs->get_column('length')->max;
1105
1106 Returns a L<DBIx::Class::ResultSetColumn> instance for a column of the ResultSet.
1107
1108 =cut
1109
1110 sub get_column {
1111   my ($self, $column) = @_;
1112   my $new = DBIx::Class::ResultSetColumn->new($self, $column);
1113   return $new;
1114 }
1115
1116 =head2 search_like
1117
1118 =over 4
1119
1120 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1121
1122 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1123
1124 =back
1125
1126   # WHERE title LIKE '%blue%'
1127   $cd_rs = $rs->search_like({ title => '%blue%'});
1128
1129 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
1130 that this is simply a convenience method retained for ex Class::DBI users.
1131 You most likely want to use L</search> with specific operators.
1132
1133 For more information, see L<DBIx::Class::Manual::Cookbook>.
1134
1135 This method is deprecated and will be removed in 0.09. Use L</search()>
1136 instead. An example conversion is:
1137
1138   ->search_like({ foo => 'bar' });
1139
1140   # Becomes
1141
1142   ->search({ foo => { like => 'bar' } });
1143
1144 =cut
1145
1146 sub search_like {
1147   my $class = shift;
1148   carp_unique (
1149     'search_like() is deprecated and will be removed in DBIC version 0.09.'
1150    .' Instead use ->search({ x => { -like => "y%" } })'
1151    .' (note the outer pair of {}s - they are important!)'
1152   );
1153   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1154   my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
1155   $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
1156   return $class->search($query, { %$attrs });
1157 }
1158
1159 =head2 slice
1160
1161 =over 4
1162
1163 =item Arguments: $first, $last
1164
1165 =item Return Value: L<$resultset|/search> (scalar context) | L<@result_objs|DBIx::Class::Manual::ResultClass> (list context)
1166
1167 =back
1168
1169 Returns a resultset or object list representing a subset of elements from the
1170 resultset slice is called on. Indexes are from 0, i.e., to get the first
1171 three records, call:
1172
1173   my ($one, $two, $three) = $rs->slice(0, 2);
1174
1175 =cut
1176
1177 sub slice {
1178   my ($self, $min, $max) = @_;
1179   my $attrs = {}; # = { %{ $self->{attrs} || {} } };
1180   $attrs->{offset} = $self->{attrs}{offset} || 0;
1181   $attrs->{offset} += $min;
1182   $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
1183   return $self->search(undef, $attrs);
1184 }
1185
1186 =head2 next
1187
1188 =over 4
1189
1190 =item Arguments: none
1191
1192 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1193
1194 =back
1195
1196 Returns the next element in the resultset (C<undef> is there is none).
1197
1198 Can be used to efficiently iterate over records in the resultset:
1199
1200   my $rs = $schema->resultset('CD')->search;
1201   while (my $cd = $rs->next) {
1202     print $cd->title;
1203   }
1204
1205 Note that you need to store the resultset object, and call C<next> on it.
1206 Calling C<< resultset('Table')->next >> repeatedly will always return the
1207 first record from the resultset.
1208
1209 =cut
1210
1211 sub next {
1212   my ($self) = @_;
1213
1214   if (my $cache = $self->get_cache) {
1215     $self->{all_cache_position} ||= 0;
1216     return $cache->[$self->{all_cache_position}++];
1217   }
1218
1219   if ($self->{attrs}{cache}) {
1220     delete $self->{pager};
1221     $self->{all_cache_position} = 1;
1222     return ($self->all)[0];
1223   }
1224
1225   return shift(@{$self->{_stashed_results}}) if @{ $self->{_stashed_results}||[] };
1226
1227   $self->{_stashed_results} = $self->_construct_results
1228     or return undef;
1229
1230   return shift @{$self->{_stashed_results}};
1231 }
1232
1233 # Constructs as many results as it can in one pass while respecting
1234 # cursor laziness. Several modes of operation:
1235 #
1236 # * Always builds everything present in @{$self->{_stashed_rows}}
1237 # * If called with $fetch_all true - pulls everything off the cursor and
1238 #   builds all result structures (or objects) in one pass
1239 # * If $self->_resolved_attrs->{collapse} is true, checks the order_by
1240 #   and if the resultset is ordered properly by the left side:
1241 #   * Fetches stuff off the cursor until the "master object" changes,
1242 #     and saves the last extra row (if any) in @{$self->{_stashed_rows}}
1243 #   OR
1244 #   * Just fetches, and collapses/constructs everything as if $fetch_all
1245 #     was requested (there is no other way to collapse except for an
1246 #     eager cursor)
1247 # * If no collapse is requested - just get the next row, construct and
1248 #   return
1249 sub _construct_results {
1250   my ($self, $fetch_all) = @_;
1251
1252   my $rsrc = $self->result_source;
1253   my $attrs = $self->_resolved_attrs;
1254
1255   if (
1256     ! $fetch_all
1257       and
1258     ! $attrs->{order_by}
1259       and
1260     $attrs->{collapse}
1261       and
1262     my @pcols = $rsrc->primary_columns
1263   ) {
1264     # default order for collapsing unless the user asked for something
1265     $attrs->{order_by} = [ map { join '.', $attrs->{alias}, $_} @pcols ];
1266     $attrs->{_ordered_for_collapse} = 1;
1267     $attrs->{_order_is_artificial} = 1;
1268   }
1269
1270   # this will be used as both initial raw-row collector AND as a RV of
1271   # _construct_results. Not regrowing the array twice matters a lot...
1272   # a surprising amount actually
1273   my $rows = delete $self->{_stashed_rows};
1274
1275   my $cursor; # we may not need one at all
1276
1277   my $did_fetch_all = $fetch_all;
1278
1279   if ($fetch_all) {
1280     # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1281     $rows = [ ($rows ? @$rows : ()), $self->cursor->all ];
1282   }
1283   elsif( $attrs->{collapse} ) {
1284
1285     # a cursor will need to be closed over in case of collapse
1286     $cursor = $self->cursor;
1287
1288     $attrs->{_ordered_for_collapse} = (
1289       (
1290         $attrs->{order_by}
1291           and
1292         $rsrc->schema
1293               ->storage
1294                ->_main_source_order_by_portion_is_stable($rsrc, $attrs->{order_by}, $attrs->{where})
1295       ) ? 1 : 0
1296     ) unless defined $attrs->{_ordered_for_collapse};
1297
1298     if (! $attrs->{_ordered_for_collapse}) {
1299       $did_fetch_all = 1;
1300
1301       # instead of looping over ->next, use ->all in stealth mode
1302       # *without* calling a ->reset afterwards
1303       # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1304       if (! $cursor->{_done}) {
1305         $rows = [ ($rows ? @$rows : ()), $cursor->all ];
1306         $cursor->{_done} = 1;
1307       }
1308     }
1309   }
1310
1311   if (! $did_fetch_all and ! @{$rows||[]} ) {
1312     # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1313     $cursor ||= $self->cursor;
1314     if (scalar (my @r = $cursor->next) ) {
1315       $rows = [ \@r ];
1316     }
1317   }
1318
1319   return undef unless @{$rows||[]};
1320
1321   # sanity check - people are too clever for their own good
1322   if ($attrs->{collapse} and my $aliastypes = $attrs->{_sqlmaker_select_args}[3]{_aliastypes} ) {
1323
1324     my $multiplied_selectors;
1325     for my $sel_alias ( grep { $_ ne $attrs->{alias} } keys %{ $aliastypes->{selecting} } ) {
1326       if (
1327         $aliastypes->{multiplying}{$sel_alias}
1328           or
1329         $aliastypes->{premultiplied}{$sel_alias}
1330       ) {
1331         $multiplied_selectors->{$_} = 1 for values %{$aliastypes->{selecting}{$sel_alias}{-seen_columns}}
1332       }
1333     }
1334
1335     for my $i (0 .. $#{$attrs->{as}} ) {
1336       my $sel = $attrs->{select}[$i];
1337
1338       if (ref $sel eq 'SCALAR') {
1339         $sel = $$sel;
1340       }
1341       elsif( ref $sel eq 'REF' and ref $$sel eq 'ARRAY' ) {
1342         $sel = $$sel->[0];
1343       }
1344
1345       $self->throw_exception(
1346         'Result collapse not possible - selection from a has_many source redirected to the main object'
1347       ) if ($multiplied_selectors->{$sel} and $attrs->{as}[$i] !~ /\./);
1348     }
1349   }
1350
1351   # hotspot - skip the setter
1352   my $res_class = $self->_result_class;
1353
1354   my $inflator_cref = $self->{_result_inflator}{cref} ||= do {
1355     $res_class->can ('inflate_result')
1356       or $self->throw_exception("Inflator $res_class does not provide an inflate_result() method");
1357   };
1358
1359   my $infmap = $attrs->{as};
1360
1361   $self->{_result_inflator}{is_core_row} = ( (
1362     $inflator_cref
1363       ==
1364     ( \&DBIx::Class::Row::inflate_result || die "No ::Row::inflate_result() - can't happen" )
1365   ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_core_row};
1366
1367   $self->{_result_inflator}{is_hri} = ( (
1368     ! $self->{_result_inflator}{is_core_row}
1369       and
1370     $inflator_cref == (
1371       require DBIx::Class::ResultClass::HashRefInflator
1372         &&
1373       DBIx::Class::ResultClass::HashRefInflator->can('inflate_result')
1374     )
1375   ) ? 1 : 0 ) unless defined $self->{_result_inflator}{is_hri};
1376
1377
1378   if (! $attrs->{_related_results_construction}) {
1379     # construct a much simpler array->hash folder for the one-table cases right here
1380     if ($self->{_result_inflator}{is_hri}) {
1381       for my $r (@$rows) {
1382         $r = { map { $infmap->[$_] => $r->[$_] } 0..$#$infmap };
1383       }
1384     }
1385     # FIXME SUBOPTIMAL this is a very very very hot spot
1386     # while rather optimal we can *still* do much better, by
1387     # building a smarter Row::inflate_result(), and
1388     # switch to feeding it data via a much leaner interface
1389     #
1390     # crude unscientific benchmarking indicated the shortcut eval is not worth it for
1391     # this particular resultset size
1392     elsif (@$rows < 60) {
1393       for my $r (@$rows) {
1394         $r = $inflator_cref->($res_class, $rsrc, { map { $infmap->[$_] => $r->[$_] } (0..$#$infmap) } );
1395       }
1396     }
1397     else {
1398       eval sprintf (
1399         '$_ = $inflator_cref->($res_class, $rsrc, { %s }) for @$rows',
1400         join (', ', map { "\$infmap->[$_] => \$_->[$_]" } 0..$#$infmap )
1401       );
1402     }
1403   }
1404   else {
1405     my $parser_type =
1406         $self->{_result_inflator}{is_hri}       ? 'hri'
1407       : $self->{_result_inflator}{is_core_row}  ? 'classic_pruning'
1408       :                                           'classic_nonpruning'
1409     ;
1410
1411     # $args and $attrs to _mk_row_parser are separated to delineate what is
1412     # core collapser stuff and what is dbic $rs specific
1413     @{$self->{_row_parser}{$parser_type}}{qw(cref nullcheck)} = $rsrc->_mk_row_parser({
1414       eval => 1,
1415       inflate_map => $infmap,
1416       collapse => $attrs->{collapse},
1417       premultiplied => $attrs->{_main_source_premultiplied},
1418       hri_style => $self->{_result_inflator}{is_hri},
1419       prune_null_branches => $self->{_result_inflator}{is_hri} || $self->{_result_inflator}{is_core_row},
1420     }, $attrs) unless $self->{_row_parser}{$parser_type}{cref};
1421
1422     # column_info metadata historically hasn't been too reliable.
1423     # We need to start fixing this somehow (the collapse resolver
1424     # can't work without it). Add an explicit check for the *main*
1425     # result, hopefully this will gradually weed out such errors
1426     #
1427     # FIXME - this is a temporary kludge that reduces performance
1428     # It is however necessary for the time being
1429     my ($unrolled_non_null_cols_to_check, $err);
1430
1431     if (my $check_non_null_cols = $self->{_row_parser}{$parser_type}{nullcheck} ) {
1432
1433       $err =
1434         'Collapse aborted due to invalid ResultSource metadata - the following '
1435       . 'selections are declared non-nullable but NULLs were retrieved: '
1436       ;
1437
1438       my @violating_idx;
1439       COL: for my $i (@$check_non_null_cols) {
1440         ! defined $_->[$i] and push @violating_idx, $i and next COL for @$rows;
1441       }
1442
1443       $self->throw_exception( $err . join (', ', map { "'$infmap->[$_]'" } @violating_idx ) )
1444         if @violating_idx;
1445
1446       $unrolled_non_null_cols_to_check = join (',', @$check_non_null_cols);
1447     }
1448
1449     my $next_cref =
1450       ($did_fetch_all or ! $attrs->{collapse})  ? undef
1451     : defined $unrolled_non_null_cols_to_check  ? eval sprintf <<'EOS', $unrolled_non_null_cols_to_check
1452 sub {
1453   # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1454   my @r = $cursor->next or return;
1455   if (my @violating_idx = grep { ! defined $r[$_] } (%s) ) {
1456     $self->throw_exception( $err . join (', ', map { "'$infmap->[$_]'" } @violating_idx ) )
1457   }
1458   \@r
1459 }
1460 EOS
1461     : sub {
1462         # FIXME SUBOPTIMAL - we can do better, cursor->next/all (well diff. methods) should return a ref
1463         my @r = $cursor->next or return;
1464         \@r
1465       }
1466     ;
1467
1468     $self->{_row_parser}{$parser_type}{cref}->(
1469       $rows,
1470       $next_cref ? ( $next_cref, $self->{_stashed_rows} = [] ) : (),
1471     );
1472
1473     # Special-case multi-object HRI - there is no $inflator_cref pass
1474     unless ($self->{_result_inflator}{is_hri}) {
1475       $_ = $inflator_cref->($res_class, $rsrc, @$_) for @$rows
1476     }
1477   }
1478
1479   # The @$rows check seems odd at first - why wouldn't we want to warn
1480   # regardless? The issue is things like find() etc, where the user
1481   # *knows* only one result will come back. In these cases the ->all
1482   # is not a pessimization, but rather something we actually want
1483   carp_unique(
1484     'Unable to properly collapse has_many results in iterator mode due '
1485   . 'to order criteria - performed an eager cursor slurp underneath. '
1486   . 'Consider using ->all() instead'
1487   ) if ( ! $fetch_all and @$rows > 1 );
1488
1489   return $rows;
1490 }
1491
1492 =head2 result_source
1493
1494 =over 4
1495
1496 =item Arguments: L<$result_source?|DBIx::Class::ResultSource>
1497
1498 =item Return Value: L<$result_source|DBIx::Class::ResultSource>
1499
1500 =back
1501
1502 An accessor for the primary ResultSource object from which this ResultSet
1503 is derived.
1504
1505 =head2 result_class
1506
1507 =over 4
1508
1509 =item Arguments: $result_class?
1510
1511 =item Return Value: $result_class
1512
1513 =back
1514
1515 An accessor for the class to use when creating result objects. Defaults to
1516 C<< result_source->result_class >> - which in most cases is the name of the
1517 L<"table"|DBIx::Class::Manual::Glossary/"ResultSource"> class.
1518
1519 Note that changing the result_class will also remove any components
1520 that were originally loaded in the source class via
1521 L<DBIx::Class::ResultSource/load_components>. Any overloaded methods
1522 in the original source class will not run.
1523
1524 =cut
1525
1526 sub result_class {
1527   my ($self, $result_class) = @_;
1528   if ($result_class) {
1529
1530     # don't fire this for an object
1531     $self->ensure_class_loaded($result_class)
1532       unless ref($result_class);
1533
1534     if ($self->get_cache) {
1535       carp_unique('Changing the result_class of a ResultSet instance with cached results is a noop - the cache contents will not be altered');
1536     }
1537     # FIXME ENCAPSULATION - encapsulation breach, cursor method additions pending
1538     elsif ($self->{cursor} && $self->{cursor}{_pos}) {
1539       $self->throw_exception('Changing the result_class of a ResultSet instance with an active cursor is not supported');
1540     }
1541
1542     $self->_result_class($result_class);
1543
1544     delete $self->{_result_inflator};
1545   }
1546   $self->_result_class;
1547 }
1548
1549 =head2 count
1550
1551 =over 4
1552
1553 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1554
1555 =item Return Value: $count
1556
1557 =back
1558
1559 Performs an SQL C<COUNT> with the same query as the resultset was built
1560 with to find the number of elements. Passing arguments is equivalent to
1561 C<< $rs->search ($cond, \%attrs)->count >>
1562
1563 =cut
1564
1565 sub count {
1566   my $self = shift;
1567   return $self->search(@_)->count if @_ and defined $_[0];
1568   return scalar @{ $self->get_cache } if $self->get_cache;
1569
1570   my $attrs = { %{ $self->_resolved_attrs } };
1571
1572   # this is a little optimization - it is faster to do the limit
1573   # adjustments in software, instead of a subquery
1574   my ($rows, $offset) = delete @{$attrs}{qw/rows offset/};
1575
1576   my $crs;
1577   if ($self->_has_resolved_attr (qw/collapse group_by/)) {
1578     $crs = $self->_count_subq_rs ($attrs);
1579   }
1580   else {
1581     $crs = $self->_count_rs ($attrs);
1582   }
1583   my $count = $crs->next;
1584
1585   $count -= $offset if $offset;
1586   $count = $rows if $rows and $rows < $count;
1587   $count = 0 if ($count < 0);
1588
1589   return $count;
1590 }
1591
1592 =head2 count_rs
1593
1594 =over 4
1595
1596 =item Arguments: L<$cond|DBIx::Class::SQLMaker>, L<\%attrs?|/ATTRIBUTES>
1597
1598 =item Return Value: L<$count_rs|DBIx::Class::ResultSetColumn>
1599
1600 =back
1601
1602 Same as L</count> but returns a L<DBIx::Class::ResultSetColumn> object.
1603 This can be very handy for subqueries:
1604
1605   ->search( { amount => $some_rs->count_rs->as_query } )
1606
1607 As with regular resultsets the SQL query will be executed only after
1608 the resultset is accessed via L</next> or L</all>. That would return
1609 the same single value obtainable via L</count>.
1610
1611 =cut
1612
1613 sub count_rs {
1614   my $self = shift;
1615   return $self->search(@_)->count_rs if @_;
1616
1617   # this may look like a lack of abstraction (count() does about the same)
1618   # but in fact an _rs *must* use a subquery for the limits, as the
1619   # software based limiting can not be ported if this $rs is to be used
1620   # in a subquery itself (i.e. ->as_query)
1621   if ($self->_has_resolved_attr (qw/collapse group_by offset rows/)) {
1622     return $self->_count_subq_rs($self->{_attrs});
1623   }
1624   else {
1625     return $self->_count_rs($self->{_attrs});
1626   }
1627 }
1628
1629 #
1630 # returns a ResultSetColumn object tied to the count query
1631 #
1632 sub _count_rs {
1633   my ($self, $attrs) = @_;
1634
1635   my $rsrc = $self->result_source;
1636
1637   my $tmp_attrs = { %$attrs };
1638   # take off any limits, record_filter is cdbi, and no point of ordering nor locking a count
1639   delete @{$tmp_attrs}{qw/rows offset order_by record_filter for/};
1640
1641   # overwrite the selector (supplied by the storage)
1642   $rsrc->resultset_class->new($rsrc, {
1643     %$tmp_attrs,
1644     select => $rsrc->storage->_count_select ($rsrc, $attrs),
1645     as => 'count',
1646   })->get_column ('count');
1647 }
1648
1649 #
1650 # same as above but uses a subquery
1651 #
1652 sub _count_subq_rs {
1653   my ($self, $attrs) = @_;
1654
1655   my $rsrc = $self->result_source;
1656
1657   my $sub_attrs = { %$attrs };
1658   # extra selectors do not go in the subquery and there is no point of ordering it, nor locking it
1659   delete @{$sub_attrs}{qw/collapse columns as select order_by for/};
1660
1661   # if we multi-prefetch we group_by something unique, as this is what we would
1662   # get out of the rs via ->next/->all. We *DO WANT* to clobber old group_by regardless
1663   if ( $attrs->{collapse}  ) {
1664     $sub_attrs->{group_by} = [ map { "$attrs->{alias}.$_" } @{
1665       $rsrc->_identifying_column_set || $self->throw_exception(
1666         'Unable to construct a unique group_by criteria properly collapsing the '
1667       . 'has_many prefetch before count()'
1668       );
1669     } ]
1670   }
1671
1672   # Calculate subquery selector
1673   if (my $g = $sub_attrs->{group_by}) {
1674
1675     my $sql_maker = $rsrc->storage->sql_maker;
1676
1677     # necessary as the group_by may refer to aliased functions
1678     my $sel_index;
1679     for my $sel (@{$attrs->{select}}) {
1680       $sel_index->{$sel->{-as}} = $sel
1681         if (ref $sel eq 'HASH' and $sel->{-as});
1682     }
1683
1684     # anything from the original select mentioned on the group-by needs to make it to the inner selector
1685     # also look for named aggregates referred in the having clause
1686     # having often contains scalarrefs - thus parse it out entirely
1687     my @parts = @$g;
1688     if ($attrs->{having}) {
1689       local $sql_maker->{having_bind};
1690       local $sql_maker->{quote_char} = $sql_maker->{quote_char};
1691       local $sql_maker->{name_sep} = $sql_maker->{name_sep};
1692       unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
1693         $sql_maker->{quote_char} = [ "\x00", "\xFF" ];
1694         # if we don't unset it we screw up retarded but unfortunately working
1695         # 'MAX(foo.bar)' => { '>', 3 }
1696         $sql_maker->{name_sep} = '';
1697       }
1698
1699       # delete local is 5.12+
1700       local @{$sql_maker}{qw(renderer converter)};
1701       delete @{$sql_maker}{qw(renderer converter)};
1702
1703       my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
1704
1705       my $having_sql = $sql_maker->_render_sqla(where => $attrs->{having});
1706
1707       my %seen_having;
1708
1709       # search for both a proper quoted qualified string, for a naive unquoted scalarref
1710       # and if all fails for an utterly naive quoted scalar-with-function
1711       while ($having_sql =~ /
1712         (?: $rquote $sep)? $lquote (.+?) $rquote
1713           |
1714         [\s,] \w+ \. (\w+) [\s,]
1715           |
1716         [\s,] $lquote (.+?) $rquote [\s,]
1717       /gx) {
1718         my $part = $1 || $2 || $3;  # one of them matched if we got here
1719         unless ($seen_having{$part}++) {
1720           push @parts, $part;
1721         }
1722       }
1723     }
1724
1725     for (@parts) {
1726       my $colpiece = $sel_index->{$_} || $_;
1727
1728       # unqualify join-based group_by's. Arcane but possible query
1729       # also horrible horrible hack to alias a column (not a func.)
1730       # (probably need to introduce SQLA syntax)
1731       if ($colpiece =~ /\./ && $colpiece !~ /^$attrs->{alias}\./) {
1732         my $as = $colpiece;
1733         $as =~ s/\./__/;
1734         $colpiece = \ sprintf ('%s AS %s', map { $sql_maker->_quote ($_) } ($colpiece, $as) );
1735       }
1736       push @{$sub_attrs->{select}}, $colpiece;
1737     }
1738   }
1739   else {
1740     my @pcols = map { "$attrs->{alias}.$_" } ($rsrc->primary_columns);
1741     $sub_attrs->{select} = @pcols ? \@pcols : [ 1 ];
1742   }
1743
1744   return $rsrc->resultset_class
1745                ->new ($rsrc, $sub_attrs)
1746                 ->as_subselect_rs
1747                  ->search ({}, { columns => { count => $rsrc->storage->_count_select ($rsrc, $attrs) } })
1748                   ->get_column ('count');
1749 }
1750
1751
1752 =head2 count_literal
1753
1754 B<CAVEAT>: C<count_literal> is provided for Class::DBI compatibility and
1755 should only be used in that context. See L</search_literal> for further info.
1756
1757 =over 4
1758
1759 =item Arguments: $sql_fragment, @standalone_bind_values
1760
1761 =item Return Value: $count
1762
1763 =back
1764
1765 Counts the results in a literal query. Equivalent to calling L</search_literal>
1766 with the passed arguments, then L</count>.
1767
1768 =cut
1769
1770 sub count_literal { shift->search_literal(@_)->count; }
1771
1772 =head2 all
1773
1774 =over 4
1775
1776 =item Arguments: none
1777
1778 =item Return Value: L<@result_objs|DBIx::Class::Manual::ResultClass>
1779
1780 =back
1781
1782 Returns all elements in the resultset.
1783
1784 =cut
1785
1786 sub all {
1787   my $self = shift;
1788   if(@_) {
1789     $self->throw_exception("all() doesn't take any arguments, you probably wanted ->search(...)->all()");
1790   }
1791
1792   delete @{$self}{qw/_stashed_rows _stashed_results/};
1793
1794   if (my $c = $self->get_cache) {
1795     return @$c;
1796   }
1797
1798   $self->cursor->reset;
1799
1800   my $objs = $self->_construct_results('fetch_all') || [];
1801
1802   $self->set_cache($objs) if $self->{attrs}{cache};
1803
1804   return @$objs;
1805 }
1806
1807 =head2 reset
1808
1809 =over 4
1810
1811 =item Arguments: none
1812
1813 =item Return Value: $self
1814
1815 =back
1816
1817 Resets the resultset's cursor, so you can iterate through the elements again.
1818 Implicitly resets the storage cursor, so a subsequent L</next> will trigger
1819 another query.
1820
1821 =cut
1822
1823 sub reset {
1824   my ($self) = @_;
1825
1826   delete @{$self}{qw/_stashed_rows _stashed_results/};
1827   $self->{all_cache_position} = 0;
1828   $self->cursor->reset;
1829   return $self;
1830 }
1831
1832 =head2 first
1833
1834 =over 4
1835
1836 =item Arguments: none
1837
1838 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass> | undef
1839
1840 =back
1841
1842 L<Resets|/reset> the resultset (causing a fresh query to storage) and returns
1843 an object for the first result (or C<undef> if the resultset is empty).
1844
1845 =cut
1846
1847 sub first {
1848   return $_[0]->reset->next;
1849 }
1850
1851
1852 # _rs_update_delete
1853 #
1854 # Determines whether and what type of subquery is required for the $rs operation.
1855 # If grouping is necessary either supplies its own, or verifies the current one
1856 # After all is done delegates to the proper storage method.
1857
1858 sub _rs_update_delete {
1859   my ($self, $op, $values) = @_;
1860
1861   my $rsrc = $self->result_source;
1862   my $storage = $rsrc->schema->storage;
1863
1864   my $attrs = { %{$self->_resolved_attrs} };
1865
1866   my $join_classifications;
1867   my ($existing_group_by) = delete @{$attrs}{qw(group_by _grouped_by_distinct)};
1868
1869   # do we need a subquery for any reason?
1870   my $needs_subq = (
1871     defined $existing_group_by
1872       or
1873     # if {from} is unparseable wrap a subq
1874     ref($attrs->{from}) ne 'ARRAY'
1875       or
1876     # limits call for a subq
1877     $self->_has_resolved_attr(qw/rows offset/)
1878   );
1879
1880   # simplify the joinmap, so we can further decide if a subq is necessary
1881   if (!$needs_subq and @{$attrs->{from}} > 1) {
1882
1883     ($attrs->{from}, $join_classifications) =
1884       $storage->_prune_unused_joins ($attrs);
1885
1886     # any non-pruneable non-local restricting joins imply subq
1887     $needs_subq = defined List::Util::first { $_ ne $attrs->{alias} } keys %{ $join_classifications->{restricting} || {} };
1888   }
1889
1890   # check if the head is composite (by now all joins are thrown out unless $needs_subq)
1891   $needs_subq ||= (
1892     (ref $attrs->{from}[0]) ne 'HASH'
1893       or
1894     ref $attrs->{from}[0]{ $attrs->{from}[0]{-alias} }
1895   );
1896
1897   my ($cond, $guard);
1898   # do we need anything like a subquery?
1899   if (! $needs_subq) {
1900     # Most databases do not allow aliasing of tables in UPDATE/DELETE. Thus
1901     # a condition containing 'me' or other table prefixes will not work
1902     # at all - so we convert the WHERE to a dq tree now, dequalify all
1903     # identifiers found therein via a scan across the tree, and then use
1904     # \{} style to pass the result onwards for use in the final query
1905     if ($self->{cond}) {
1906       $cond = do {
1907         my $converter = $rsrc->storage->sql_maker->converter;
1908         scan_dq_nodes({
1909           DQ_IDENTIFIER ,=> sub { $_ = [ $_->[-1] ] for $_[0]->{elements} }
1910         }, my $where_dq = $converter->_where_to_dq($self->{cond}));
1911         \$where_dq;
1912       };
1913     }
1914   }
1915   else {
1916     # we got this far - means it is time to wrap a subquery
1917     my $idcols = $rsrc->_identifying_column_set || $self->throw_exception(
1918       sprintf(
1919         "Unable to perform complex resultset %s() without an identifying set of columns on source '%s'",
1920         $op,
1921         $rsrc->source_name,
1922       )
1923     );
1924
1925     # make a new $rs selecting only the PKs (that's all we really need for the subq)
1926     delete $attrs->{$_} for qw/select as collapse/;
1927     $attrs->{columns} = [ map { "$attrs->{alias}.$_" } @$idcols ];
1928
1929     # this will be consumed by the pruner waaaaay down the stack
1930     $attrs->{_force_prune_multiplying_joins} = 1;
1931
1932     my $subrs = (ref $self)->new($rsrc, $attrs);
1933
1934     if (@$idcols == 1) {
1935       $cond = { $idcols->[0] => { -in => \$subrs->_as_select_dq } };
1936     }
1937     elsif ($storage->_use_multicolumn_in) {
1938       # no syntax for calling this properly yet
1939       # !!! EXPERIMENTAL API !!! WILL CHANGE !!!
1940       my $left = $storage->sql_maker->_render_sqla(select_select => $idcols);
1941       $left =~ s/^SELECT //i;
1942       my $right = $storage->sql_maker
1943                           ->converter
1944                           ->_literal_to_dq(${$subrs->as_query});
1945       $cond = \Operator(
1946         { 'SQL.Naive' => 'in' },
1947         [ Literal(SQL => "( $left )"), $right ],
1948       ),
1949     }
1950     else {
1951       # if all else fails - get all primary keys and operate over a ORed set
1952       # wrap in a transaction for consistency
1953       # this is where the group_by/multiplication starts to matter
1954       if (
1955         $existing_group_by
1956           or
1957         # we do not need to check pre-multipliers, since if the premulti is there, its
1958         # parent (who is multi) will be there too
1959         keys %{ $join_classifications->{multiplying} || {} }
1960       ) {
1961         # make sure if there is a supplied group_by it matches the columns compiled above
1962         # perfectly. Anything else can not be sanely executed on most databases so croak
1963         # right then and there
1964         if ($existing_group_by) {
1965           my @current_group_by = map
1966             { $_ =~ /\./ ? $_ : "$attrs->{alias}.$_" }
1967             @$existing_group_by
1968           ;
1969
1970           if (
1971             join ("\x00", sort @current_group_by)
1972               ne
1973             join ("\x00", sort @{$attrs->{columns}} )
1974           ) {
1975             $self->throw_exception (
1976               "You have just attempted a $op operation on a resultset which does group_by"
1977               . ' on columns other than the primary keys, while DBIC internally needs to retrieve'
1978               . ' the primary keys in a subselect. All sane RDBMS engines do not support this'
1979               . ' kind of queries. Please retry the operation with a modified group_by or'
1980               . ' without using one at all.'
1981             );
1982           }
1983         }
1984
1985         $subrs = $subrs->search({}, { group_by => $attrs->{columns} });
1986       }
1987
1988       $guard = $storage->txn_scope_guard;
1989
1990       $cond = [];
1991       for my $row ($subrs->cursor->all) {
1992         push @$cond, { map
1993           { $idcols->[$_] => $row->[$_] }
1994           (0 .. $#$idcols)
1995         };
1996       }
1997     }
1998   }
1999
2000   my $res = $storage->$op (
2001     $rsrc,
2002     $op eq 'update' ? $values : (),
2003     $cond,
2004   );
2005
2006   $guard->commit if $guard;
2007
2008   return $res;
2009 }
2010
2011 =head2 update
2012
2013 =over 4
2014
2015 =item Arguments: \%values
2016
2017 =item Return Value: $underlying_storage_rv
2018
2019 =back
2020
2021 Sets the specified columns in the resultset to the supplied values in a
2022 single query. Note that this will not run any accessor/set_column/update
2023 triggers, nor will it update any result object instances derived from this
2024 resultset (this includes the contents of the L<resultset cache|/set_cache>
2025 if any). See L</update_all> if you need to execute any on-update
2026 triggers or cascades defined either by you or a
2027 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2028
2029 The return value is a pass through of what the underlying
2030 storage backend returned, and may vary. See L<DBI/execute> for the most
2031 common case.
2032
2033 =head3 CAVEAT
2034
2035 Note that L</update> does not process/deflate any of the values passed in.
2036 This is unlike the corresponding L<DBIx::Class::Row/update>. The user must
2037 ensure manually that any value passed to this method will stringify to
2038 something the RDBMS knows how to deal with. A notable example is the
2039 handling of L<DateTime> objects, for more info see:
2040 L<DBIx::Class::Manual::Cookbook/Formatting DateTime objects in queries>.
2041
2042 =cut
2043
2044 sub update {
2045   my ($self, $values) = @_;
2046   $self->throw_exception('Values for update must be a hash')
2047     unless ref $values eq 'HASH';
2048
2049   return $self->_rs_update_delete ('update', $values);
2050 }
2051
2052 =head2 update_all
2053
2054 =over 4
2055
2056 =item Arguments: \%values
2057
2058 =item Return Value: 1
2059
2060 =back
2061
2062 Fetches all objects and updates them one at a time via
2063 L<DBIx::Class::Row/update>. Note that C<update_all> will run DBIC defined
2064 triggers, while L</update> will not.
2065
2066 =cut
2067
2068 sub update_all {
2069   my ($self, $values) = @_;
2070   $self->throw_exception('Values for update_all must be a hash')
2071     unless ref $values eq 'HASH';
2072
2073   my $guard = $self->result_source->schema->txn_scope_guard;
2074   $_->update({%$values}) for $self->all;  # shallow copy - update will mangle it
2075   $guard->commit;
2076   return 1;
2077 }
2078
2079 =head2 delete
2080
2081 =over 4
2082
2083 =item Arguments: none
2084
2085 =item Return Value: $underlying_storage_rv
2086
2087 =back
2088
2089 Deletes the rows matching this resultset in a single query. Note that this
2090 will not run any delete triggers, nor will it alter the
2091 L<in_storage|DBIx::Class::Row/in_storage> status of any result object instances
2092 derived from this resultset (this includes the contents of the
2093 L<resultset cache|/set_cache> if any). See L</delete_all> if you need to
2094 execute any on-delete triggers or cascades defined either by you or a
2095 L<result component|DBIx::Class::Manual::Component/WHAT IS A COMPONENT>.
2096
2097 The return value is a pass through of what the underlying storage backend
2098 returned, and may vary. See L<DBI/execute> for the most common case.
2099
2100 =cut
2101
2102 sub delete {
2103   my $self = shift;
2104   $self->throw_exception('delete does not accept any arguments')
2105     if @_;
2106
2107   return $self->_rs_update_delete ('delete');
2108 }
2109
2110 =head2 delete_all
2111
2112 =over 4
2113
2114 =item Arguments: none
2115
2116 =item Return Value: 1
2117
2118 =back
2119
2120 Fetches all objects and deletes them one at a time via
2121 L<DBIx::Class::Row/delete>. Note that C<delete_all> will run DBIC defined
2122 triggers, while L</delete> will not.
2123
2124 =cut
2125
2126 sub delete_all {
2127   my $self = shift;
2128   $self->throw_exception('delete_all does not accept any arguments')
2129     if @_;
2130
2131   my $guard = $self->result_source->schema->txn_scope_guard;
2132   $_->delete for $self->all;
2133   $guard->commit;
2134   return 1;
2135 }
2136
2137 =head2 populate
2138
2139 =over 4
2140
2141 =item Arguments: [ \@column_list, \@row_values+ ] | [ \%col_data+ ]
2142
2143 =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context)
2144
2145 =back
2146
2147 Accepts either an arrayref of hashrefs or alternatively an arrayref of
2148 arrayrefs.
2149
2150 =over
2151
2152 =item NOTE
2153
2154 The context of this method call has an important effect on what is
2155 submitted to storage. In void context data is fed directly to fastpath
2156 insertion routines provided by the underlying storage (most often
2157 L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and
2158 L<insert|DBIx::Class::Row/insert> calls on the
2159 L<Result|DBIx::Class::Manual::ResultClass> class, including any
2160 augmentation of these methods provided by components. For example if you
2161 are using something like L<DBIx::Class::UUIDColumns> to create primary
2162 keys for you, you will find that your PKs are empty.  In this case you
2163 will have to explicitly force scalar or list context in order to create
2164 those values.
2165
2166 =back
2167
2168 In non-void (scalar or list) context, this method is simply a wrapper
2169 for L</create>. Depending on list or scalar context either a list of
2170 L<Result|DBIx::Class::Manual::ResultClass> objects or an arrayref
2171 containing these objects is returned.
2172
2173 When supplying data in "arrayref of arrayrefs" invocation style, the
2174 first element should be a list of column names and each subsequent
2175 element should be a data value in the earlier specified column order.
2176 For example:
2177
2178   $schema->resultset("Artist")->populate([
2179     [ qw( artistid name ) ],
2180     [ 100, 'A Formally Unknown Singer' ],
2181     [ 101, 'A singer that jumped the shark two albums ago' ],
2182     [ 102, 'An actually cool singer' ],
2183   ]);
2184
2185 For the arrayref of hashrefs style each hashref should be a structure
2186 suitable for passing to L</create>. Multi-create is also permitted with
2187 this syntax.
2188
2189   $schema->resultset("Artist")->populate([
2190      { artistid => 4, name => 'Manufactured Crap', cds => [
2191         { title => 'My First CD', year => 2006 },
2192         { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2193       ],
2194      },
2195      { artistid => 5, name => 'Angsty-Whiny Girl', cds => [
2196         { title => 'My parents sold me to a record company', year => 2005 },
2197         { title => 'Why Am I So Ugly?', year => 2006 },
2198         { title => 'I Got Surgery and am now Popular', year => 2007 }
2199       ],
2200      },
2201   ]);
2202
2203 If you attempt a void-context multi-create as in the example above (each
2204 Artist also has the related list of CDs), and B<do not> supply the
2205 necessary autoinc foreign key information, this method will proxy to the
2206 less efficient L</create>, and then throw the Result objects away. In this
2207 case there are obviously no benefits to using this method over L</create>.
2208
2209 =cut
2210
2211 sub populate {
2212   my $self = shift;
2213
2214   # cruft placed in standalone method
2215   my $data = $self->_normalize_populate_args(@_);
2216
2217   return unless @$data;
2218
2219   if(defined wantarray) {
2220     my @created = map { $self->create($_) } @$data;
2221     return wantarray ? @created : \@created;
2222   }
2223   else {
2224     my $first = $data->[0];
2225
2226     # if a column is a registered relationship, and is a non-blessed hash/array, consider
2227     # it relationship data
2228     my (@rels, @columns);
2229     my $rsrc = $self->result_source;
2230     my $rels = { map { $_ => $rsrc->relationship_info($_) } $rsrc->relationships };
2231     for (keys %$first) {
2232       my $ref = ref $first->{$_};
2233       $rels->{$_} && ($ref eq 'ARRAY' or $ref eq 'HASH')
2234         ? push @rels, $_
2235         : push @columns, $_
2236       ;
2237     }
2238
2239     my @pks = $rsrc->primary_columns;
2240
2241     ## do the belongs_to relationships
2242     foreach my $index (0..$#$data) {
2243
2244       # delegate to create() for any dataset without primary keys with specified relationships
2245       if (grep { !defined $data->[$index]->{$_} } @pks ) {
2246         for my $r (@rels) {
2247           if (grep { ref $data->[$index]{$r} eq $_ } qw/HASH ARRAY/) {  # a related set must be a HASH or AoH
2248             my @ret = $self->populate($data);
2249             return;
2250           }
2251         }
2252       }
2253
2254       foreach my $rel (@rels) {
2255         next unless ref $data->[$index]->{$rel} eq "HASH";
2256         my $result = $self->related_resultset($rel)->create($data->[$index]->{$rel});
2257         my ($reverse_relname, $reverse_relinfo) = %{$rsrc->reverse_relationship_info($rel)};
2258         my $related = $result->result_source->_resolve_condition(
2259           $reverse_relinfo->{cond},
2260           $self,
2261           $result,
2262           $rel,
2263         );
2264
2265         delete $data->[$index]->{$rel};
2266         $data->[$index] = {%{$data->[$index]}, %$related};
2267
2268         push @columns, keys %$related if $index == 0;
2269       }
2270     }
2271
2272     ## inherit the data locked in the conditions of the resultset
2273     my ($rs_data) = $self->_merge_with_rscond({});
2274     delete @{$rs_data}{@columns};
2275
2276     ## do bulk insert on current row
2277     $rsrc->storage->insert_bulk(
2278       $rsrc,
2279       [@columns, keys %$rs_data],
2280       [ map { [ @$_{@columns}, values %$rs_data ] } @$data ],
2281     );
2282
2283     ## do the has_many relationships
2284     foreach my $item (@$data) {
2285
2286       my $main_row;
2287
2288       foreach my $rel (@rels) {
2289         next unless ref $item->{$rel} eq "ARRAY" && @{ $item->{$rel} };
2290
2291         $main_row ||= $self->new_result({map { $_ => $item->{$_} } @pks});
2292
2293         my $child = $main_row->$rel;
2294
2295         my $related = $child->result_source->_resolve_condition(
2296           $rels->{$rel}{cond},
2297           $child,
2298           $main_row,
2299           $rel,
2300         );
2301
2302         if (ref($related) eq 'REF' and ref($$related) eq 'HASH') {
2303           $related = $self->result_source
2304                           ->_extract_fixed_values_for($$related, $rel);
2305         }
2306
2307         my @rows_to_add = ref $item->{$rel} eq 'ARRAY' ? @{$item->{$rel}} : ($item->{$rel});
2308         my @populate = map { {%$_, %$related} } @rows_to_add;
2309
2310         $child->populate( \@populate );
2311       }
2312     }
2313   }
2314 }
2315
2316 # populate() arguments went over several incarnations
2317 # What we ultimately support is AoH
2318 sub _normalize_populate_args {
2319   my ($self, $arg) = @_;
2320
2321   if (ref $arg eq 'ARRAY') {
2322     if (!@$arg) {
2323       return [];
2324     }
2325     elsif (ref $arg->[0] eq 'HASH') {
2326       return $arg;
2327     }
2328     elsif (ref $arg->[0] eq 'ARRAY') {
2329       my @ret;
2330       my @colnames = @{$arg->[0]};
2331       foreach my $values (@{$arg}[1 .. $#$arg]) {
2332         push @ret, { map { $colnames[$_] => $values->[$_] } (0 .. $#colnames) };
2333       }
2334       return \@ret;
2335     }
2336   }
2337
2338   $self->throw_exception('Populate expects an arrayref of hashrefs or arrayref of arrayrefs');
2339 }
2340
2341 =head2 pager
2342
2343 =over 4
2344
2345 =item Arguments: none
2346
2347 =item Return Value: L<$pager|Data::Page>
2348
2349 =back
2350
2351 Returns a L<Data::Page> object for the current resultset. Only makes
2352 sense for queries with a C<page> attribute.
2353
2354 To get the full count of entries for a paged resultset, call
2355 C<total_entries> on the L<Data::Page> object.
2356
2357 =cut
2358
2359 sub pager {
2360   my ($self) = @_;
2361
2362   return $self->{pager} if $self->{pager};
2363
2364   my $attrs = $self->{attrs};
2365   if (!defined $attrs->{page}) {
2366     $self->throw_exception("Can't create pager for non-paged rs");
2367   }
2368   elsif ($attrs->{page} <= 0) {
2369     $self->throw_exception('Invalid page number (page-numbers are 1-based)');
2370   }
2371   $attrs->{rows} ||= 10;
2372
2373   # throw away the paging flags and re-run the count (possibly
2374   # with a subselect) to get the real total count
2375   my $count_attrs = { %$attrs };
2376   delete @{$count_attrs}{qw/rows offset page pager/};
2377
2378   my $total_rs = (ref $self)->new($self->result_source, $count_attrs);
2379
2380   require DBIx::Class::ResultSet::Pager;
2381   return $self->{pager} = DBIx::Class::ResultSet::Pager->new(
2382     sub { $total_rs->count },  #lazy-get the total
2383     $attrs->{rows},
2384     $self->{attrs}{page},
2385   );
2386 }
2387
2388 =head2 page
2389
2390 =over 4
2391
2392 =item Arguments: $page_number
2393
2394 =item Return Value: L<$resultset|/search>
2395
2396 =back
2397
2398 Returns a resultset for the $page_number page of the resultset on which page
2399 is called, where each page contains a number of rows equal to the 'rows'
2400 attribute set on the resultset (10 by default).
2401
2402 =cut
2403
2404 sub page {
2405   my ($self, $page) = @_;
2406   return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
2407 }
2408
2409 =head2 new_result
2410
2411 =over 4
2412
2413 =item Arguments: \%col_data
2414
2415 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2416
2417 =back
2418
2419 Creates a new result object in the resultset's result class and returns
2420 it. The row is not inserted into the database at this point, call
2421 L<DBIx::Class::Row/insert> to do that. Calling L<DBIx::Class::Row/in_storage>
2422 will tell you whether the result object has been inserted or not.
2423
2424 Passes the hashref of input on to L<DBIx::Class::Row/new>.
2425
2426 =cut
2427
2428 sub new_result {
2429   my ($self, $values) = @_;
2430
2431   $self->throw_exception( "new_result takes only one argument - a hashref of values" )
2432     if @_ > 2;
2433
2434   $self->throw_exception( "new_result expects a hashref" )
2435     unless (ref $values eq 'HASH');
2436
2437   my ($merged_cond, $cols_from_relations) = $self->_merge_with_rscond($values);
2438
2439   my $new = $self->result_class->new({
2440     %$merged_cond,
2441     ( @$cols_from_relations
2442       ? (-cols_from_relations => $cols_from_relations)
2443       : ()
2444     ),
2445     -result_source => $self->result_source, # DO NOT REMOVE THIS, REQUIRED
2446   });
2447
2448   if (
2449     reftype($new) eq 'HASH'
2450       and
2451     ! keys %$new
2452       and
2453     blessed($new)
2454   ) {
2455     carp_unique (sprintf (
2456       "%s->new returned a blessed empty hashref - a strong indicator something is wrong with its inheritance chain",
2457       $self->result_class,
2458     ));
2459   }
2460
2461   $new;
2462 }
2463
2464 # _merge_with_rscond
2465 #
2466 # Takes a simple hash of K/V data and returns its copy merged with the
2467 # condition already present on the resultset. Additionally returns an
2468 # arrayref of value/condition names, which were inferred from related
2469 # objects (this is needed for in-memory related objects)
2470 sub _merge_with_rscond {
2471   my ($self, $data) = @_;
2472
2473   my (%new_data, @cols_from_relations);
2474
2475   my $alias = $self->{attrs}{alias};
2476
2477   if (! defined $self->{cond}) {
2478     # just massage $data below
2479   }
2480   elsif (ref $self->{cond} eq 'HASH') {
2481     # precedence must be given to passed values over values inherited from
2482     # the cond, so the order here is important.
2483     my $collapsed_cond = $self->_collapse_cond($self->{cond});
2484     my %implied = %{$self->_remove_alias($collapsed_cond, $alias)};
2485
2486     while ( my($col, $value) = each %implied ) {
2487       my $vref = ref $value;
2488       if (
2489         $vref eq 'HASH'
2490           and
2491         keys(%$value) == 1
2492           and
2493         (keys %$value)[0] eq '='
2494       ) {
2495         $new_data{$col} = $value->{'='};
2496       }
2497       elsif( !$vref or $vref eq 'SCALAR' or blessed($value) ) {
2498         $new_data{$col} = $value;
2499       }
2500     }
2501   }
2502   elsif (ref $self->{cond} eq 'REF' and ref ${$self->{cond}} eq 'HASH') {
2503     if ((${$self->{cond}})->{'DBIx::Class::ResultSource.UNRESOLVABLE'}) {
2504       %new_data = %{ $self->{attrs}{related_objects} || {} };  # nothing might have been inserted yet
2505       @cols_from_relations = keys %new_data;
2506     } else {
2507       %new_data = %{$self->_remove_alias(
2508         $self->result_source
2509              ->_extract_fixed_values_for(${$self->{cond}}),
2510         $alias
2511       )};
2512     }
2513   }
2514   else {
2515     $self->throw_exception(
2516       "Can't abstract implicit construct, resultset condition not a hash"
2517     );
2518   }
2519
2520   %new_data = (
2521     %new_data,
2522     %{ $self->_remove_alias($data, $alias) },
2523   );
2524
2525   return (\%new_data, \@cols_from_relations);
2526 }
2527
2528 # _has_resolved_attr
2529 #
2530 # determines if the resultset defines at least one
2531 # of the attributes supplied
2532 #
2533 # used to determine if a subquery is necessary
2534 #
2535 # supports some virtual attributes:
2536 #   -join
2537 #     This will scan for any joins being present on the resultset.
2538 #     It is not a mere key-search but a deep inspection of {from}
2539 #
2540
2541 sub _has_resolved_attr {
2542   my ($self, @attr_names) = @_;
2543
2544   my $attrs = $self->_resolved_attrs;
2545
2546   my %extra_checks;
2547
2548   for my $n (@attr_names) {
2549     if (grep { $n eq $_ } (qw/-join/) ) {
2550       $extra_checks{$n}++;
2551       next;
2552     }
2553
2554     my $attr =  $attrs->{$n};
2555
2556     next if not defined $attr;
2557
2558     if (ref $attr eq 'HASH') {
2559       return 1 if keys %$attr;
2560     }
2561     elsif (ref $attr eq 'ARRAY') {
2562       return 1 if @$attr;
2563     }
2564     else {
2565       return 1 if $attr;
2566     }
2567   }
2568
2569   # a resolved join is expressed as a multi-level from
2570   return 1 if (
2571     $extra_checks{-join}
2572       and
2573     ref $attrs->{from} eq 'ARRAY'
2574       and
2575     @{$attrs->{from}} > 1
2576   );
2577
2578   return 0;
2579 }
2580
2581 # _collapse_cond
2582 #
2583 # Recursively collapse the condition.
2584
2585 sub _collapse_cond {
2586   my ($self, $cond, $collapsed) = @_;
2587
2588   $collapsed ||= {};
2589
2590   if (ref $cond eq 'ARRAY') {
2591     foreach my $subcond (@$cond) {
2592       next unless ref $subcond;  # -or
2593       $collapsed = $self->_collapse_cond($subcond, $collapsed);
2594     }
2595   }
2596   elsif (ref $cond eq 'HASH') {
2597     if (keys %$cond and (keys %$cond)[0] eq '-and') {
2598       foreach my $subcond (@{$cond->{-and}}) {
2599         $collapsed = $self->_collapse_cond($subcond, $collapsed);
2600       }
2601     }
2602     else {
2603       foreach my $col (keys %$cond) {
2604         my $value = $cond->{$col};
2605         $collapsed->{$col} = $value;
2606       }
2607     }
2608   }
2609
2610   return $collapsed;
2611 }
2612
2613 # _remove_alias
2614 #
2615 # Remove the specified alias from the specified query hash. A copy is made so
2616 # the original query is not modified.
2617
2618 sub _remove_alias {
2619   my ($self, $query, $alias) = @_;
2620
2621   my %orig = %{ $query || {} };
2622   my %unaliased;
2623
2624   foreach my $key (keys %orig) {
2625     if ($key !~ /\./) {
2626       $unaliased{$key} = $orig{$key};
2627       next;
2628     }
2629     $unaliased{$1} = $orig{$key}
2630       if $key =~ m/^(?:\Q$alias\E\.)?([^.]+)$/;
2631   }
2632
2633   return \%unaliased;
2634 }
2635
2636 =head2 as_query
2637
2638 =over 4
2639
2640 =item Arguments: none
2641
2642 =item Return Value: \[ $sql, L<@bind_values|/DBIC BIND VALUES> ]
2643
2644 =back
2645
2646 Returns the SQL query and bind vars associated with the invocant.
2647
2648 This is generally used as the RHS for a subquery.
2649
2650 =cut
2651
2652 sub as_query {
2653   my $self = shift;
2654
2655   my $attrs = { %{ $self->_resolved_attrs } };
2656
2657   my $aq = $self->result_source->storage->_select_args_to_query (
2658     $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
2659   );
2660
2661   $self->{_attrs}{_sqlmaker_select_args} = $attrs->{_sqlmaker_select_args};
2662
2663   $aq;
2664 }
2665
2666 sub _as_select_dq {
2667   my $self = shift;
2668   my $attrs = { %{ $self->_resolved_attrs } };
2669   my $storage = $self->result_source->storage;
2670   my (undef, $ident, @args) = $storage->_select_args(
2671     $attrs->{from}, $attrs->{select}, $attrs->{where}, $attrs
2672   );
2673   $ident = $ident->from if blessed($ident);
2674   $storage->sql_maker->converter->_select_to_dq(
2675     $ident, @args
2676   );
2677 }
2678
2679 =head2 find_or_new
2680
2681 =over 4
2682
2683 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2684
2685 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2686
2687 =back
2688
2689   my $artist = $schema->resultset('Artist')->find_or_new(
2690     { artist => 'fred' }, { key => 'artists' });
2691
2692   $cd->cd_to_producer->find_or_new({ producer => $producer },
2693                                    { key => 'primary' });
2694
2695 Find an existing record from this resultset using L</find>. if none exists,
2696 instantiate a new result object and return it. The object will not be saved
2697 into your storage until you call L<DBIx::Class::Row/insert> on it.
2698
2699 You most likely want this method when looking for existing rows using a unique
2700 constraint that is not the primary key, or looking for related rows.
2701
2702 If you want objects to be saved immediately, use L</find_or_create> instead.
2703
2704 B<Note>: Make sure to read the documentation of L</find> and understand the
2705 significance of the C<key> attribute, as its lack may skew your search, and
2706 subsequently result in spurious new objects.
2707
2708 B<Note>: Take care when using C<find_or_new> with a table having
2709 columns with default values that you intend to be automatically
2710 supplied by the database (e.g. an auto_increment primary key column).
2711 In normal usage, the value of such columns should NOT be included at
2712 all in the call to C<find_or_new>, even when set to C<undef>.
2713
2714 =cut
2715
2716 sub find_or_new {
2717   my $self     = shift;
2718   my $attrs    = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2719   my $hash     = ref $_[0] eq 'HASH' ? shift : {@_};
2720   if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2721     return $row;
2722   }
2723   return $self->new_result($hash);
2724 }
2725
2726 =head2 create
2727
2728 =over 4
2729
2730 =item Arguments: \%col_data
2731
2732 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2733
2734 =back
2735
2736 Attempt to create a single new row or a row with multiple related rows
2737 in the table represented by the resultset (and related tables). This
2738 will not check for duplicate rows before inserting, use
2739 L</find_or_create> to do that.
2740
2741 To create one row for this resultset, pass a hashref of key/value
2742 pairs representing the columns of the table and the values you wish to
2743 store. If the appropriate relationships are set up, foreign key fields
2744 can also be passed an object representing the foreign row, and the
2745 value will be set to its primary key.
2746
2747 To create related objects, pass a hashref of related-object column values
2748 B<keyed on the relationship name>. If the relationship is of type C<multi>
2749 (L<DBIx::Class::Relationship/has_many>) - pass an arrayref of hashrefs.
2750 The process will correctly identify columns holding foreign keys, and will
2751 transparently populate them from the keys of the corresponding relation.
2752 This can be applied recursively, and will work correctly for a structure
2753 with an arbitrary depth and width, as long as the relationships actually
2754 exists and the correct column data has been supplied.
2755
2756 Instead of hashrefs of plain related data (key/value pairs), you may
2757 also pass new or inserted objects. New objects (not inserted yet, see
2758 L</new_result>), will be inserted into their appropriate tables.
2759
2760 Effectively a shortcut for C<< ->new_result(\%col_data)->insert >>.
2761
2762 Example of creating a new row.
2763
2764   $person_rs->create({
2765     name=>"Some Person",
2766     email=>"somebody@someplace.com"
2767   });
2768
2769 Example of creating a new row and also creating rows in a related C<has_many>
2770 or C<has_one> resultset.  Note Arrayref.
2771
2772   $artist_rs->create(
2773      { artistid => 4, name => 'Manufactured Crap', cds => [
2774         { title => 'My First CD', year => 2006 },
2775         { title => 'Yet More Tweeny-Pop crap', year => 2007 },
2776       ],
2777      },
2778   );
2779
2780 Example of creating a new row and also creating a row in a related
2781 C<belongs_to> resultset. Note Hashref.
2782
2783   $cd_rs->create({
2784     title=>"Music for Silly Walks",
2785     year=>2000,
2786     artist => {
2787       name=>"Silly Musician",
2788     }
2789   });
2790
2791 =over
2792
2793 =item WARNING
2794
2795 When subclassing ResultSet never attempt to override this method. Since
2796 it is a simple shortcut for C<< $self->new_result($attrs)->insert >>, a
2797 lot of the internals simply never call it, so your override will be
2798 bypassed more often than not. Override either L<DBIx::Class::Row/new>
2799 or L<DBIx::Class::Row/insert> depending on how early in the
2800 L</create> process you need to intervene. See also warning pertaining to
2801 L</new>.
2802
2803 =back
2804
2805 =cut
2806
2807 sub create {
2808   my ($self, $col_data) = @_;
2809   $self->throw_exception( "create needs a hashref" )
2810     unless ref $col_data eq 'HASH';
2811   return $self->new_result($col_data)->insert;
2812 }
2813
2814 =head2 find_or_create
2815
2816 =over 4
2817
2818 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2819
2820 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2821
2822 =back
2823
2824   $cd->cd_to_producer->find_or_create({ producer => $producer },
2825                                       { key => 'primary' });
2826
2827 Tries to find a record based on its primary key or unique constraints; if none
2828 is found, creates one and returns that instead.
2829
2830   my $cd = $schema->resultset('CD')->find_or_create({
2831     cdid   => 5,
2832     artist => 'Massive Attack',
2833     title  => 'Mezzanine',
2834     year   => 2005,
2835   });
2836
2837 Also takes an optional C<key> attribute, to search by a specific key or unique
2838 constraint. For example:
2839
2840   my $cd = $schema->resultset('CD')->find_or_create(
2841     {
2842       artist => 'Massive Attack',
2843       title  => 'Mezzanine',
2844     },
2845     { key => 'cd_artist_title' }
2846   );
2847
2848 B<Note>: Make sure to read the documentation of L</find> and understand the
2849 significance of the C<key> attribute, as its lack may skew your search, and
2850 subsequently result in spurious row creation.
2851
2852 B<Note>: Because find_or_create() reads from the database and then
2853 possibly inserts based on the result, this method is subject to a race
2854 condition. Another process could create a record in the table after
2855 the find has completed and before the create has started. To avoid
2856 this problem, use find_or_create() inside a transaction.
2857
2858 B<Note>: Take care when using C<find_or_create> 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_create>, even when set to C<undef>.
2863
2864 See also L</find> and L</update_or_create>. For information on how to declare
2865 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2866
2867 If you need to know if an existing row was found or a new one created use
2868 L</find_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2869 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2870 database!
2871
2872   my $cd = $schema->resultset('CD')->find_or_new({
2873     cdid   => 5,
2874     artist => 'Massive Attack',
2875     title  => 'Mezzanine',
2876     year   => 2005,
2877   });
2878
2879   if( !$cd->in_storage ) {
2880       # do some stuff
2881       $cd->insert;
2882   }
2883
2884 =cut
2885
2886 sub find_or_create {
2887   my $self     = shift;
2888   my $attrs    = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2889   my $hash     = ref $_[0] eq 'HASH' ? shift : {@_};
2890   if (keys %$hash and my $row = $self->find($hash, $attrs) ) {
2891     return $row;
2892   }
2893   return $self->create($hash);
2894 }
2895
2896 =head2 update_or_create
2897
2898 =over 4
2899
2900 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2901
2902 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2903
2904 =back
2905
2906   $resultset->update_or_create({ col => $val, ... });
2907
2908 Like L</find_or_create>, but if a row is found it is immediately updated via
2909 C<< $found_row->update (\%col_data) >>.
2910
2911
2912 Takes an optional C<key> attribute to search on a specific unique constraint.
2913 For example:
2914
2915   # In your application
2916   my $cd = $schema->resultset('CD')->update_or_create(
2917     {
2918       artist => 'Massive Attack',
2919       title  => 'Mezzanine',
2920       year   => 1998,
2921     },
2922     { key => 'cd_artist_title' }
2923   );
2924
2925   $cd->cd_to_producer->update_or_create({
2926     producer => $producer,
2927     name => 'harry',
2928   }, {
2929     key => 'primary',
2930   });
2931
2932 B<Note>: Make sure to read the documentation of L</find> and understand the
2933 significance of the C<key> attribute, as its lack may skew your search, and
2934 subsequently result in spurious row creation.
2935
2936 B<Note>: Take care when using C<update_or_create> with a table having
2937 columns with default values that you intend to be automatically
2938 supplied by the database (e.g. an auto_increment primary key column).
2939 In normal usage, the value of such columns should NOT be included at
2940 all in the call to C<update_or_create>, even when set to C<undef>.
2941
2942 See also L</find> and L</find_or_create>. For information on how to declare
2943 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
2944
2945 If you need to know if an existing row was updated or a new one created use
2946 L</update_or_new> and L<DBIx::Class::Row/in_storage> instead. Don't forget
2947 to call L<DBIx::Class::Row/insert> to save the newly created row to the
2948 database!
2949
2950 =cut
2951
2952 sub update_or_create {
2953   my $self = shift;
2954   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
2955   my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
2956
2957   my $row = $self->find($cond, $attrs);
2958   if (defined $row) {
2959     $row->update($cond);
2960     return $row;
2961   }
2962
2963   return $self->create($cond);
2964 }
2965
2966 =head2 update_or_new
2967
2968 =over 4
2969
2970 =item Arguments: \%col_data, { key => $unique_constraint, L<%attrs|/ATTRIBUTES> }?
2971
2972 =item Return Value: L<$result|DBIx::Class::Manual::ResultClass>
2973
2974 =back
2975
2976   $resultset->update_or_new({ col => $val, ... });
2977
2978 Like L</find_or_new> but if a row is found it is immediately updated via
2979 C<< $found_row->update (\%col_data) >>.
2980
2981 For example:
2982
2983   # In your application
2984   my $cd = $schema->resultset('CD')->update_or_new(
2985     {
2986       artist => 'Massive Attack',
2987       title  => 'Mezzanine',
2988       year   => 1998,
2989     },
2990     { key => 'cd_artist_title' }
2991   );
2992
2993   if ($cd->in_storage) {
2994       # the cd was updated
2995   }
2996   else {
2997       # the cd is not yet in the database, let's insert it
2998       $cd->insert;
2999   }
3000
3001 B<Note>: Make sure to read the documentation of L</find> and understand the
3002 significance of the C<key> attribute, as its lack may skew your search, and
3003 subsequently result in spurious new objects.
3004
3005 B<Note>: Take care when using C<update_or_new> with a table having
3006 columns with default values that you intend to be automatically
3007 supplied by the database (e.g. an auto_increment primary key column).
3008 In normal usage, the value of such columns should NOT be included at
3009 all in the call to C<update_or_new>, even when set to C<undef>.
3010
3011 See also L</find>, L</find_or_create> and L</find_or_new>.
3012
3013 =cut
3014
3015 sub update_or_new {
3016     my $self  = shift;
3017     my $attrs = ( @_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {} );
3018     my $cond  = ref $_[0] eq 'HASH' ? shift : {@_};
3019
3020     my $row = $self->find( $cond, $attrs );
3021     if ( defined $row ) {
3022         $row->update($cond);
3023         return $row;
3024     }
3025
3026     return $self->new_result($cond);
3027 }
3028
3029 =head2 get_cache
3030
3031 =over 4
3032
3033 =item Arguments: none
3034
3035 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass> | undef
3036
3037 =back
3038
3039 Gets the contents of the cache for the resultset, if the cache is set.
3040
3041 The cache is populated either by using the L</prefetch> attribute to
3042 L</search> or by calling L</set_cache>.
3043
3044 =cut
3045
3046 sub get_cache {
3047   shift->{all_cache};
3048 }
3049
3050 =head2 set_cache
3051
3052 =over 4
3053
3054 =item Arguments: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3055
3056 =item Return Value: L<\@result_objs|DBIx::Class::Manual::ResultClass>
3057
3058 =back
3059
3060 Sets the contents of the cache for the resultset. Expects an arrayref
3061 of objects of the same class as those produced by the resultset. Note that
3062 if the cache is set, the resultset will return the cached objects rather
3063 than re-querying the database even if the cache attr is not set.
3064
3065 The contents of the cache can also be populated by using the
3066 L</prefetch> attribute to L</search>.
3067
3068 =cut
3069
3070 sub set_cache {
3071   my ( $self, $data ) = @_;
3072   $self->throw_exception("set_cache requires an arrayref")
3073       if defined($data) && (ref $data ne 'ARRAY');
3074   $self->{all_cache} = $data;
3075 }
3076
3077 =head2 clear_cache
3078
3079 =over 4
3080
3081 =item Arguments: none
3082
3083 =item Return Value: undef
3084
3085 =back
3086
3087 Clears the cache for the resultset.
3088
3089 =cut
3090
3091 sub clear_cache {
3092   shift->set_cache(undef);
3093 }
3094
3095 =head2 is_paged
3096
3097 =over 4
3098
3099 =item Arguments: none
3100
3101 =item Return Value: true, if the resultset has been paginated
3102
3103 =back
3104
3105 =cut
3106
3107 sub is_paged {
3108   my ($self) = @_;
3109   return !!$self->{attrs}{page};
3110 }
3111
3112 =head2 is_ordered
3113
3114 =over 4
3115
3116 =item Arguments: none
3117
3118 =item Return Value: true, if the resultset has been ordered with C<order_by>.
3119
3120 =back
3121
3122 =cut
3123
3124 sub is_ordered {
3125   my ($self) = @_;
3126   return scalar $self->result_source->storage->_extract_order_criteria($self->{attrs}{order_by});
3127 }
3128
3129 =head2 related_resultset
3130
3131 =over 4
3132
3133 =item Arguments: $rel_name
3134
3135 =item Return Value: L<$resultset|/search>
3136
3137 =back
3138
3139 Returns a related resultset for the supplied relationship name.
3140
3141   $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
3142
3143 =cut
3144
3145 sub related_resultset {
3146   my ($self, $rel) = @_;
3147
3148   return $self->{related_resultsets}{$rel}
3149     if defined $self->{related_resultsets}{$rel};
3150
3151   return $self->{related_resultsets}{$rel} = do {
3152     my $rsrc = $self->result_source;
3153     my $rel_info = $rsrc->relationship_info($rel);
3154
3155     $self->throw_exception(
3156       "search_related: result source '" . $rsrc->source_name .
3157         "' has no such relationship $rel")
3158       unless $rel_info;
3159
3160     my $attrs = $self->_chain_relationship($rel);
3161
3162     my $join_count = $attrs->{seen_join}{$rel};
3163
3164     my $alias = $self->result_source->storage
3165         ->relname_to_table_alias($rel, $join_count);
3166
3167     # since this is search_related, and we already slid the select window inwards
3168     # (the select/as attrs were deleted in the beginning), we need to flip all
3169     # left joins to inner, so we get the expected results
3170     # read the comment on top of the actual function to see what this does
3171     $attrs->{from} = $rsrc->schema->storage->_inner_join_to_node ($attrs->{from}, $alias);
3172
3173
3174     #XXX - temp fix for result_class bug. There likely is a more elegant fix -groditi
3175     delete @{$attrs}{qw(result_class alias)};
3176
3177     my $rel_source = $rsrc->related_source($rel);
3178
3179     my $new = do {
3180
3181       # The reason we do this now instead of passing the alias to the
3182       # search_rs below is that if you wrap/overload resultset on the
3183       # source you need to know what alias it's -going- to have for things
3184       # to work sanely (e.g. RestrictWithObject wants to be able to add
3185       # extra query restrictions, and these may need to be $alias.)
3186
3187       my $rel_attrs = $rel_source->resultset_attributes;
3188       local $rel_attrs->{alias} = $alias;
3189
3190       $rel_source->resultset
3191                  ->search_rs(
3192                      undef, {
3193                        %$attrs,
3194                        where => $attrs->{where},
3195                    });
3196     };
3197
3198     if (my $cache = $self->get_cache) {
3199       my @related_cache = map
3200         { @{$_->related_resultset($rel)->get_cache||[]} }
3201         @$cache
3202       ;
3203
3204       $new->set_cache(\@related_cache) if @related_cache;
3205     }
3206
3207     $new;
3208   };
3209 }
3210
3211 =head2 current_source_alias
3212
3213 =over 4
3214
3215 =item Arguments: none
3216
3217 =item Return Value: $source_alias
3218
3219 =back
3220
3221 Returns the current table alias for the result source this resultset is built
3222 on, that will be used in the SQL query. Usually it is C<me>.
3223
3224 Currently the source alias that refers to the result set returned by a
3225 L</search>/L</find> family method depends on how you got to the resultset: it's
3226 C<me> by default, but eg. L</search_related> aliases it to the related result
3227 source name (and keeps C<me> referring to the original result set). The long
3228 term goal is to make L<DBIx::Class> always alias the current resultset as C<me>
3229 (and make this method unnecessary).
3230
3231 Thus it's currently necessary to use this method in predefined queries (see
3232 L<DBIx::Class::Manual::Cookbook/Predefined searches>) when referring to the
3233 source alias of the current result set:
3234
3235   # in a result set class
3236   sub modified_by {
3237     my ($self, $user) = @_;
3238
3239     my $me = $self->current_source_alias;
3240
3241     return $self->search({
3242       "$me.modified" => $user->id,
3243     });
3244   }
3245
3246 =cut
3247
3248 sub current_source_alias {
3249   return (shift->{attrs} || {})->{alias} || 'me';
3250 }
3251
3252 =head2 as_subselect_rs
3253
3254 =over 4
3255
3256 =item Arguments: none
3257
3258 =item Return Value: L<$resultset|/search>
3259
3260 =back
3261
3262 Act as a barrier to SQL symbols.  The resultset provided will be made into a
3263 "virtual view" by including it as a subquery within the from clause.  From this
3264 point on, any joined tables are inaccessible to ->search on the resultset (as if
3265 it were simply where-filtered without joins).  For example:
3266
3267  my $rs = $schema->resultset('Bar')->search({'x.name' => 'abc'},{ join => 'x' });
3268
3269  # 'x' now pollutes the query namespace
3270
3271  # So the following works as expected
3272  my $ok_rs = $rs->search({'x.other' => 1});
3273
3274  # But this doesn't: instead of finding a 'Bar' related to two x rows (abc and
3275  # def) we look for one row with contradictory terms and join in another table
3276  # (aliased 'x_2') which we never use
3277  my $broken_rs = $rs->search({'x.name' => 'def'});
3278
3279  my $rs2 = $rs->as_subselect_rs;
3280
3281  # doesn't work - 'x' is no longer accessible in $rs2, having been sealed away
3282  my $not_joined_rs = $rs2->search({'x.other' => 1});
3283
3284  # works as expected: finds a 'table' row related to two x rows (abc and def)
3285  my $correctly_joined_rs = $rs2->search({'x.name' => 'def'});
3286
3287 Another example of when one might use this would be to select a subset of
3288 columns in a group by clause:
3289
3290  my $rs = $schema->resultset('Bar')->search(undef, {
3291    group_by => [qw{ id foo_id baz_id }],
3292  })->as_subselect_rs->search(undef, {
3293    columns => [qw{ id foo_id }]
3294  });
3295
3296 In the above example normally columns would have to be equal to the group by,
3297 but because we isolated the group by into a subselect the above works.
3298
3299 =cut
3300
3301 sub as_subselect_rs {
3302   my $self = shift;
3303
3304   my $attrs = $self->_resolved_attrs;
3305
3306   my $fresh_rs = (ref $self)->new (
3307     $self->result_source
3308   );
3309
3310   # these pieces will be locked in the subquery
3311   delete $fresh_rs->{cond};
3312   delete @{$fresh_rs->{attrs}}{qw/where bind/};
3313
3314   return $fresh_rs->search( {}, {
3315     from => [{
3316       $attrs->{alias} => $self->as_query,
3317       -alias  => $attrs->{alias},
3318       -rsrc   => $self->result_source,
3319     }],
3320     alias => $attrs->{alias},
3321   });
3322 }
3323
3324 # This code is called by search_related, and makes sure there
3325 # is clear separation between the joins before, during, and
3326 # after the relationship. This information is needed later
3327 # in order to properly resolve prefetch aliases (any alias
3328 # with a relation_chain_depth less than the depth of the
3329 # current prefetch is not considered)
3330 #
3331 # The increments happen twice per join. An even number means a
3332 # relationship specified via a search_related, whereas an odd
3333 # number indicates a join/prefetch added via attributes
3334 #
3335 # Also this code will wrap the current resultset (the one we
3336 # chain to) in a subselect IFF it contains limiting attributes
3337 sub _chain_relationship {
3338   my ($self, $rel) = @_;
3339   my $source = $self->result_source;
3340   my $attrs = { %{$self->{attrs}||{}} };
3341
3342   # we need to take the prefetch the attrs into account before we
3343   # ->_resolve_join as otherwise they get lost - captainL
3344   my $join = $self->_merge_joinpref_attr( $attrs->{join}, $attrs->{prefetch} );
3345
3346   delete @{$attrs}{qw/join prefetch collapse group_by distinct _grouped_by_distinct select as columns +select +as +columns/};
3347
3348   my $seen = { %{ (delete $attrs->{seen_join}) || {} } };
3349
3350   my $from;
3351   my @force_subq_attrs = qw/offset rows group_by having/;
3352
3353   if (
3354     ($attrs->{from} && ref $attrs->{from} ne 'ARRAY')
3355       ||
3356     $self->_has_resolved_attr (@force_subq_attrs)
3357   ) {
3358     # Nuke the prefetch (if any) before the new $rs attrs
3359     # are resolved (prefetch is useless - we are wrapping
3360     # a subquery anyway).
3361     my $rs_copy = $self->search;
3362     $rs_copy->{attrs}{join} = $self->_merge_joinpref_attr (
3363       $rs_copy->{attrs}{join},
3364       delete $rs_copy->{attrs}{prefetch},
3365     );
3366
3367     $from = [{
3368       -rsrc   => $source,
3369       -alias  => $attrs->{alias},
3370       $attrs->{alias} => $rs_copy->as_query,
3371     }];
3372     delete @{$attrs}{@force_subq_attrs, qw/where bind/};
3373     $seen->{-relation_chain_depth} = 0;
3374   }
3375   elsif ($attrs->{from}) {  #shallow copy suffices
3376     $from = [ @{$attrs->{from}} ];
3377   }
3378   else {
3379     $from = [{
3380       -rsrc  => $source,
3381       -alias => $attrs->{alias},
3382       $attrs->{alias} => $source->from,
3383     }];
3384   }
3385
3386   my $jpath = ($seen->{-relation_chain_depth})
3387     ? $from->[-1][0]{-join_path}
3388     : [];
3389
3390   my @requested_joins = $source->_resolve_join(
3391     $join,
3392     $attrs->{alias},
3393     $seen,
3394     $jpath,
3395   );
3396
3397   push @$from, @requested_joins;
3398
3399   $seen->{-relation_chain_depth}++;
3400
3401   # if $self already had a join/prefetch specified on it, the requested
3402   # $rel might very well be already included. What we do in this case
3403   # is effectively a no-op (except that we bump up the chain_depth on
3404   # the join in question so we could tell it *is* the search_related)
3405   my $already_joined;
3406
3407   # we consider the last one thus reverse
3408   for my $j (reverse @requested_joins) {
3409     my ($last_j) = keys %{$j->[0]{-join_path}[-1]};
3410     if ($rel eq $last_j) {
3411       $j->[0]{-relation_chain_depth}++;
3412       $already_joined++;
3413       last;
3414     }
3415   }
3416
3417   unless ($already_joined) {
3418     push @$from, $source->_resolve_join(
3419       $rel,
3420       $attrs->{alias},
3421       $seen,
3422       $jpath,
3423     );
3424   }
3425
3426   $seen->{-relation_chain_depth}++;
3427
3428   return {%$attrs, from => $from, seen_join => $seen};
3429 }
3430
3431 sub _resolved_attrs {
3432   my $self = shift;
3433   return $self->{_attrs} if $self->{_attrs};
3434
3435   my $attrs  = { %{ $self->{attrs} || {} } };
3436   my $source = $self->result_source;
3437   my $alias  = $attrs->{alias};
3438
3439   $self->throw_exception("Specifying distinct => 1 in conjunction with collapse => 1 is unsupported")
3440     if $attrs->{collapse} and $attrs->{distinct};
3441
3442   # default selection list
3443   $attrs->{columns} = [ $source->columns ]
3444     unless List::Util::first { exists $attrs->{$_} } qw/columns cols select as/;
3445
3446   # merge selectors together
3447   for (qw/columns select as/) {
3448     $attrs->{$_} = $self->_merge_attr($attrs->{$_}, delete $attrs->{"+$_"})
3449       if $attrs->{$_} or $attrs->{"+$_"};
3450   }
3451
3452   # disassemble columns
3453   my (@sel, @as);
3454   if (my $cols = delete $attrs->{columns}) {
3455     for my $c (ref $cols eq 'ARRAY' ? @$cols : $cols) {
3456       if (ref $c eq 'HASH') {
3457         for my $as (sort keys %$c) {
3458           push @sel, $c->{$as};
3459           push @as, $as;
3460         }
3461       }
3462       else {
3463         push @sel, $c;
3464         push @as, $c;
3465       }
3466     }
3467   }
3468
3469   # when trying to weed off duplicates later do not go past this point -
3470   # everything added from here on is unbalanced "anyone's guess" stuff
3471   my $dedup_stop_idx = $#as;
3472
3473   push @as, @{ ref $attrs->{as} eq 'ARRAY' ? $attrs->{as} : [ $attrs->{as} ] }
3474     if $attrs->{as};
3475   push @sel, @{ ref $attrs->{select} eq 'ARRAY' ? $attrs->{select} : [ $attrs->{select} ] }
3476     if $attrs->{select};
3477
3478   # assume all unqualified selectors to apply to the current alias (legacy stuff)
3479   $_ = (ref $_ or $_ =~ /\./) ? $_ : "$alias.$_" for @sel;
3480
3481   # disqualify all $alias.col as-bits (inflate-map mandated)
3482   $_ = ($_ =~ /^\Q$alias.\E(.+)$/) ? $1 : $_ for @as;
3483
3484   # de-duplicate the result (remove *identical* select/as pairs)
3485   # and also die on duplicate {as} pointing to different {select}s
3486   # not using a c-style for as the condition is prone to shrinkage
3487   my $seen;
3488   my $i = 0;
3489   while ($i <= $dedup_stop_idx) {
3490     if ($seen->{"$sel[$i] \x00\x00 $as[$i]"}++) {
3491       splice @sel, $i, 1;
3492       splice @as, $i, 1;
3493       $dedup_stop_idx--;
3494     }
3495     elsif ($seen->{$as[$i]}++) {
3496       $self->throw_exception(
3497         "inflate_result() alias '$as[$i]' specified twice with different SQL-side {select}-ors"
3498       );
3499     }
3500     else {
3501       $i++;
3502     }
3503   }
3504
3505   $attrs->{select} = \@sel;
3506   $attrs->{as} = \@as;
3507
3508   $attrs->{from} ||= [{
3509     -rsrc   => $source,
3510     -alias  => $self->{attrs}{alias},
3511     $self->{attrs}{alias} => $source->from,
3512   }];
3513
3514   if ( $attrs->{join} || $attrs->{prefetch} ) {
3515
3516     $self->throw_exception ('join/prefetch can not be used with a custom {from}')
3517       if ref $attrs->{from} ne 'ARRAY';
3518
3519     my $join = (delete $attrs->{join}) || {};
3520
3521     if ( defined $attrs->{prefetch} ) {
3522       $join = $self->_merge_joinpref_attr( $join, $attrs->{prefetch} );
3523     }
3524
3525     $attrs->{from} =    # have to copy here to avoid corrupting the original
3526       [
3527         @{ $attrs->{from} },
3528         $source->_resolve_join(
3529           $join,
3530           $alias,
3531           ($attrs->{seen_join} = { %{ $attrs->{seen_join} || {} } }),
3532           ( $attrs->{seen_join} && keys %{$attrs->{seen_join}})
3533             ? $attrs->{from}[-1][0]{-join_path}
3534             : []
3535           ,
3536         )
3537       ];
3538   }
3539
3540   if ( defined $attrs->{order_by} ) {
3541     $attrs->{order_by} = (
3542       ref( $attrs->{order_by} ) eq 'ARRAY'
3543       ? [ @{ $attrs->{order_by} } ]
3544       : [ $attrs->{order_by} || () ]
3545     );
3546   }
3547
3548   if ($attrs->{group_by} and ref $attrs->{group_by} ne 'ARRAY') {
3549     $attrs->{group_by} = [ $attrs->{group_by} ];
3550   }
3551
3552
3553   # generate selections based on the prefetch helper
3554   my ($prefetch, @prefetch_select, @prefetch_as);
3555   $prefetch = $self->_merge_joinpref_attr( {}, delete $attrs->{prefetch} )
3556     if defined $attrs->{prefetch};
3557
3558   if ($prefetch) {
3559
3560     $self->throw_exception("Unable to prefetch, resultset contains an unnamed selector $attrs->{_dark_selector}{string}")
3561       if $attrs->{_dark_selector};
3562
3563     $self->throw_exception("Specifying prefetch in conjunction with an explicit collapse => 0 is unsupported")
3564       if defined $attrs->{collapse} and ! $attrs->{collapse};
3565
3566     $attrs->{collapse} = 1;
3567
3568     # this is a separate structure (we don't look in {from} directly)
3569     # as the resolver needs to shift things off the lists to work
3570     # properly (identical-prefetches on different branches)
3571     my $join_map = {};
3572     if (ref $attrs->{from} eq 'ARRAY') {
3573
3574       my $start_depth = $attrs->{seen_join}{-relation_chain_depth} || 0;
3575
3576       for my $j ( @{$attrs->{from}}[1 .. $#{$attrs->{from}} ] ) {
3577         next unless $j->[0]{-alias};
3578         next unless $j->[0]{-join_path};
3579         next if ($j->[0]{-relation_chain_depth} || 0) < $start_depth;
3580
3581         my @jpath = map { keys %$_ } @{$j->[0]{-join_path}};
3582
3583         my $p = $join_map;
3584         $p = $p->{$_} ||= {} for @jpath[ ($start_depth/2) .. $#jpath]; #only even depths are actual jpath boundaries
3585         push @{$p->{-join_aliases} }, $j->[0]{-alias};
3586       }
3587     }
3588
3589     my @prefetch = $source->_resolve_prefetch( $prefetch, $alias, $join_map );
3590
3591     # save these for after distinct resolution
3592     @prefetch_select = map { $_->[0] } @prefetch;
3593     @prefetch_as = map { $_->[1] } @prefetch;
3594   }
3595
3596   # run through the resulting joinstructure (starting from our current slot)
3597   # and unset collapse if proven unnecessary
3598   #
3599   # also while we are at it find out if the current root source has
3600   # been premultiplied by previous related_source chaining
3601   #
3602   # this allows to predict whether a root object with all other relation
3603   # data set to NULL is in fact unique
3604   if ($attrs->{collapse}) {
3605
3606     if (ref $attrs->{from} eq 'ARRAY') {
3607
3608       if (@{$attrs->{from}} == 1) {
3609         # no joins - no collapse
3610         $attrs->{collapse} = 0;
3611       }
3612       else {
3613         # find where our table-spec starts
3614         my @fromlist = @{$attrs->{from}};
3615         while (@fromlist) {
3616           my $t = shift @fromlist;
3617
3618           my $is_multi;
3619           # me vs join from-spec distinction - a ref means non-root
3620           if (ref $t eq 'ARRAY') {
3621             $t = $t->[0];
3622             $is_multi ||= ! $t->{-is_single};
3623           }
3624           last if ($t->{-alias} && $t->{-alias} eq $alias);
3625           $attrs->{_main_source_premultiplied} ||= $is_multi;
3626         }
3627
3628         # no non-singles remaining, nor any premultiplication - nothing to collapse
3629         if (
3630           ! $attrs->{_main_source_premultiplied}
3631             and
3632           ! List::Util::first { ! $_->[0]{-is_single} } @fromlist
3633         ) {
3634           $attrs->{collapse} = 0;
3635         }
3636       }
3637     }
3638
3639     else {
3640       # if we can not analyze the from - err on the side of safety
3641       $attrs->{_main_source_premultiplied} = 1;
3642     }
3643   }
3644
3645   # generate the distinct induced group_by before injecting the prefetched select/as parts
3646   if (delete $attrs->{distinct}) {
3647     if ($attrs->{group_by}) {
3648       carp_unique ("Useless use of distinct on a grouped resultset ('distinct' is ignored when a 'group_by' is present)");
3649     }
3650     else {
3651       $attrs->{_grouped_by_distinct} = 1;
3652       # distinct affects only the main selection part, not what prefetch may add below
3653       ($attrs->{group_by}, my $new_order) = $source->storage->_group_over_selection($attrs);
3654
3655       # FIXME possibly ignore a rewritten order_by (may turn out to be an issue)
3656       # The thinking is: if we are collapsing the subquerying prefetch engine will
3657       # rip stuff apart for us anyway, and we do not want to have a potentially
3658       # function-converted external order_by
3659       # ( there is an explicit if ( collapse && _grouped_by_distinct ) check in DBIHacks )
3660       $attrs->{order_by} = $new_order unless $attrs->{collapse};
3661     }
3662   }
3663
3664   # inject prefetch-bound selection (if any)
3665   push @{$attrs->{select}}, @prefetch_select;
3666   push @{$attrs->{as}}, @prefetch_as;
3667
3668   # whether we can get away with the dumbest (possibly DBI-internal) collapser
3669   if ( List::Util::first { $_ =~ /\./ } @{$attrs->{as}} ) {
3670     $attrs->{_related_results_construction} = 1;
3671   }
3672
3673   # if both page and offset are specified, produce a combined offset
3674   # even though it doesn't make much sense, this is what pre 081xx has
3675   # been doing
3676   if (my $page = delete $attrs->{page}) {
3677     $attrs->{offset} =
3678       ($attrs->{rows} * ($page - 1))
3679             +
3680       ($attrs->{offset} || 0)
3681     ;
3682   }
3683
3684   return $self->{_attrs} = $attrs;
3685 }
3686
3687 sub _rollout_attr {
3688   my ($self, $attr) = @_;
3689
3690   if (ref $attr eq 'HASH') {
3691     return $self->_rollout_hash($attr);
3692   } elsif (ref $attr eq 'ARRAY') {
3693     return $self->_rollout_array($attr);
3694   } else {
3695     return [$attr];
3696   }
3697 }
3698
3699 sub _rollout_array {
3700   my ($self, $attr) = @_;
3701
3702   my @rolled_array;
3703   foreach my $element (@{$attr}) {
3704     if (ref $element eq 'HASH') {
3705       push( @rolled_array, @{ $self->_rollout_hash( $element ) } );
3706     } elsif (ref $element eq 'ARRAY') {
3707       #  XXX - should probably recurse here
3708       push( @rolled_array, @{$self->_rollout_array($element)} );
3709     } else {
3710       push( @rolled_array, $element );
3711     }
3712   }
3713   return \@rolled_array;
3714 }
3715
3716 sub _rollout_hash {
3717   my ($self, $attr) = @_;
3718
3719   my @rolled_array;
3720   foreach my $key (keys %{$attr}) {
3721     push( @rolled_array, { $key => $attr->{$key} } );
3722   }
3723   return \@rolled_array;
3724 }
3725
3726 sub _calculate_score {
3727   my ($self, $a, $b) = @_;
3728
3729   if (defined $a xor defined $b) {
3730     return 0;
3731   }
3732   elsif (not defined $a) {
3733     return 1;
3734   }
3735
3736   if (ref $b eq 'HASH') {
3737     my ($b_key) = keys %{$b};
3738     if (ref $a eq 'HASH') {
3739       my ($a_key) = keys %{$a};
3740       if ($a_key eq $b_key) {
3741         return (1 + $self->_calculate_score( $a->{$a_key}, $b->{$b_key} ));
3742       } else {
3743         return 0;
3744       }
3745     } else {
3746       return ($a eq $b_key) ? 1 : 0;
3747     }
3748   } else {
3749     if (ref $a eq 'HASH') {
3750       my ($a_key) = keys %{$a};
3751       return ($b eq $a_key) ? 1 : 0;
3752     } else {
3753       return ($b eq $a) ? 1 : 0;
3754     }
3755   }
3756 }
3757
3758 sub _merge_joinpref_attr {
3759   my ($self, $orig, $import) = @_;
3760
3761   return $import unless defined($orig);
3762   return $orig unless defined($import);
3763
3764   $orig = $self->_rollout_attr($orig);
3765   $import = $self->_rollout_attr($import);
3766
3767   my $seen_keys;
3768   foreach my $import_element ( @{$import} ) {
3769     # find best candidate from $orig to merge $b_element into
3770     my $best_candidate = { position => undef, score => 0 }; my $position = 0;
3771     foreach my $orig_element ( @{$orig} ) {
3772       my $score = $self->_calculate_score( $orig_element, $import_element );
3773       if ($score > $best_candidate->{score}) {
3774         $best_candidate->{position} = $position;
3775         $best_candidate->{score} = $score;
3776       }
3777       $position++;
3778     }
3779     my ($import_key) = ( ref $import_element eq 'HASH' ) ? keys %{$import_element} : ($import_element);
3780     $import_key = '' if not defined $import_key;
3781
3782     if ($best_candidate->{score} == 0 || exists $seen_keys->{$import_key}) {
3783       push( @{$orig}, $import_element );
3784     } else {
3785       my $orig_best = $orig->[$best_candidate->{position}];
3786       # merge orig_best and b_element together and replace original with merged
3787       if (ref $orig_best ne 'HASH') {
3788         $orig->[$best_candidate->{position}] = $import_element;
3789       } elsif (ref $import_element eq 'HASH') {
3790         my ($key) = keys %{$orig_best};
3791         $orig->[$best_candidate->{position}] = { $key => $self->_merge_joinpref_attr($orig_best->{$key}, $import_element->{$key}) };
3792       }
3793     }
3794     $seen_keys->{$import_key} = 1; # don't merge the same key twice
3795   }
3796
3797   return @$orig ? $orig : ();
3798 }
3799
3800 {
3801   my $hm;
3802
3803   sub _merge_attr {
3804     $hm ||= do {
3805       require Hash::Merge;
3806       my $hm = Hash::Merge->new;
3807
3808       $hm->specify_behavior({
3809         SCALAR => {
3810           SCALAR => sub {
3811             my ($defl, $defr) = map { defined $_ } (@_[0,1]);
3812
3813             if ($defl xor $defr) {
3814               return [ $defl ? $_[0] : $_[1] ];
3815             }
3816             elsif (! $defl) {
3817               return [];
3818             }
3819             elsif (__HM_DEDUP and $_[0] eq $_[1]) {
3820               return [ $_[0] ];
3821             }
3822             else {
3823               return [$_[0], $_[1]];
3824             }
3825           },
3826           ARRAY => sub {
3827             return $_[1] if !defined $_[0];
3828             return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3829             return [$_[0], @{$_[1]}]
3830           },
3831           HASH  => sub {
3832             return [] if !defined $_[0] and !keys %{$_[1]};
3833             return [ $_[1] ] if !defined $_[0];
3834             return [ $_[0] ] if !keys %{$_[1]};
3835             return [$_[0], $_[1]]
3836           },
3837         },
3838         ARRAY => {
3839           SCALAR => sub {
3840             return $_[0] if !defined $_[1];
3841             return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3842             return [@{$_[0]}, $_[1]]
3843           },
3844           ARRAY => sub {
3845             my @ret = @{$_[0]} or return $_[1];
3846             return [ @ret, @{$_[1]} ] unless __HM_DEDUP;
3847             my %idx = map { $_ => 1 } @ret;
3848             push @ret, grep { ! defined $idx{$_} } (@{$_[1]});
3849             \@ret;
3850           },
3851           HASH => sub {
3852             return [ $_[1] ] if ! @{$_[0]};
3853             return $_[0] if !keys %{$_[1]};
3854             return $_[0] if __HM_DEDUP and List::Util::first { $_ eq $_[1] } @{$_[0]};
3855             return [ @{$_[0]}, $_[1] ];
3856           },
3857         },
3858         HASH => {
3859           SCALAR => sub {
3860             return [] if !keys %{$_[0]} and !defined $_[1];
3861             return [ $_[0] ] if !defined $_[1];
3862             return [ $_[1] ] if !keys %{$_[0]};
3863             return [$_[0], $_[1]]
3864           },
3865           ARRAY => sub {
3866             return [] if !keys %{$_[0]} and !@{$_[1]};
3867             return [ $_[0] ] if !@{$_[1]};
3868             return $_[1] if !keys %{$_[0]};
3869             return $_[1] if __HM_DEDUP and List::Util::first { $_ eq $_[0] } @{$_[1]};
3870             return [ $_[0], @{$_[1]} ];
3871           },
3872           HASH => sub {
3873             return [] if !keys %{$_[0]} and !keys %{$_[1]};
3874             return [ $_[0] ] if !keys %{$_[1]};
3875             return [ $_[1] ] if !keys %{$_[0]};
3876             return [ $_[0] ] if $_[0] eq $_[1];
3877             return [ $_[0], $_[1] ];
3878           },
3879         }
3880       } => 'DBIC_RS_ATTR_MERGER');
3881       $hm;
3882     };
3883
3884     return $hm->merge ($_[1], $_[2]);
3885   }
3886 }
3887
3888 sub STORABLE_freeze {
3889   my ($self, $cloning) = @_;
3890   my $to_serialize = { %$self };
3891
3892   # A cursor in progress can't be serialized (and would make little sense anyway)
3893   # the parser can be regenerated (and can't be serialized)
3894   delete @{$to_serialize}{qw/cursor _row_parser _result_inflator/};
3895
3896   # nor is it sensical to store a not-yet-fired-count pager
3897   if ($to_serialize->{pager} and ref $to_serialize->{pager}{total_entries} eq 'CODE') {
3898     delete $to_serialize->{pager};
3899   }
3900
3901   Storable::nfreeze($to_serialize);
3902 }
3903
3904 # need this hook for symmetry
3905 sub STORABLE_thaw {
3906   my ($self, $cloning, $serialized) = @_;
3907
3908   %$self = %{ Storable::thaw($serialized) };
3909
3910   $self;
3911 }
3912
3913
3914 =head2 throw_exception
3915
3916 See L<DBIx::Class::Schema/throw_exception> for details.
3917
3918 =cut
3919
3920 sub throw_exception {
3921   my $self=shift;
3922
3923   if (ref $self and my $rsrc = $self->result_source) {
3924     $rsrc->throw_exception(@_)
3925   }
3926   else {
3927     DBIx::Class::Exception->throw(@_);
3928   }
3929 }
3930
3931 1;
3932
3933 __END__
3934
3935 # XXX: FIXME: Attributes docs need clearing up
3936
3937 =head1 ATTRIBUTES
3938
3939 Attributes are used to refine a ResultSet in various ways when
3940 searching for data. They can be passed to any method which takes an
3941 C<\%attrs> argument. See L</search>, L</search_rs>, L</find>,
3942 L</count>.
3943
3944 Default attributes can be set on the result class using
3945 L<DBIx::Class::ResultSource/resultset_attributes>.  (Please read
3946 the CAVEATS on that feature before using it!)
3947
3948 These are in no particular order:
3949
3950 =head2 order_by
3951
3952 =over 4
3953
3954 =item Value: ( $order_by | \@order_by | \%order_by )
3955
3956 =back
3957
3958 Which column(s) to order the results by.
3959
3960 [The full list of suitable values is documented in
3961 L<SQL::Abstract/"ORDER BY CLAUSES">; the following is a summary of
3962 common options.]
3963
3964 If a single column name, or an arrayref of names is supplied, the
3965 argument is passed through directly to SQL. The hashref syntax allows
3966 for connection-agnostic specification of ordering direction:
3967
3968  For descending order:
3969
3970   order_by => { -desc => [qw/col1 col2 col3/] }
3971
3972  For explicit ascending order:
3973
3974   order_by => { -asc => 'col' }
3975
3976 The old scalarref syntax (i.e. order_by => \'year DESC') is still
3977 supported, although you are strongly encouraged to use the hashref
3978 syntax as outlined above.
3979
3980 =head2 columns
3981
3982 =over 4
3983
3984 =item Value: \@columns | \%columns | $column
3985
3986 =back
3987
3988 Shortcut to request a particular set of columns to be retrieved. Each
3989 column spec may be a string (a table column name), or a hash (in which
3990 case the key is the C<as> value, and the value is used as the C<select>
3991 expression). Adds C<me.> onto the start of any column without a C<.> in
3992 it and sets C<select> from that, then auto-populates C<as> from
3993 C<select> as normal. (You may also use the C<cols> attribute, as in
3994 earlier versions of DBIC, but this is deprecated.)
3995
3996 Essentially C<columns> does the same as L</select> and L</as>.
3997
3998     columns => [ 'foo', { bar => 'baz' } ]
3999
4000 is the same as
4001
4002     select => [qw/foo baz/],
4003     as => [qw/foo bar/]
4004
4005 =head2 +columns
4006
4007 =over 4
4008
4009 =item Value: \@columns
4010
4011 =back
4012
4013 Indicates additional columns to be selected from storage. Works the same as
4014 L</columns> but adds columns to the selection. (You may also use the
4015 C<include_columns> attribute, as in earlier versions of DBIC, but this is
4016 deprecated). For example:-
4017
4018   $schema->resultset('CD')->search(undef, {
4019     '+columns' => ['artist.name'],
4020     join => ['artist']
4021   });
4022
4023 would return all CDs and include a 'name' column to the information
4024 passed to object inflation. Note that the 'artist' is the name of the
4025 column (or relationship) accessor, and 'name' is the name of the column
4026 accessor in the related table.
4027
4028 B<NOTE:> You need to explicitly quote '+columns' when defining the attribute.
4029 Not doing so causes Perl to incorrectly interpret +columns as a bareword with a
4030 unary plus operator before it.
4031
4032 =head2 include_columns
4033
4034 =over 4
4035
4036 =item Value: \@columns
4037
4038 =back
4039
4040 Deprecated.  Acts as a synonym for L</+columns> for backward compatibility.
4041
4042 =head2 select
4043
4044 =over 4
4045
4046 =item Value: \@select_columns
4047
4048 =back
4049
4050 Indicates which columns should be selected from the storage. You can use
4051 column names, or in the case of RDBMS back ends, function or stored procedure
4052 names:
4053
4054   $rs = $schema->resultset('Employee')->search(undef, {
4055     select => [
4056       'name',
4057       { count => 'employeeid' },
4058       { max => { length => 'name' }, -as => 'longest_name' }
4059     ]
4060   });
4061
4062   # Equivalent SQL
4063   SELECT name, COUNT( employeeid ), MAX( LENGTH( name ) ) AS longest_name FROM employee
4064
4065 B<NOTE:> You will almost always need a corresponding L</as> attribute when you
4066 use L</select>, to instruct DBIx::Class how to store the result of the column.
4067 Also note that the L</as> attribute has nothing to do with the SQL-side 'AS'
4068 identifier aliasing. You can however alias a function, so you can use it in
4069 e.g. an C<ORDER BY> clause. This is done via the C<-as> B<select function
4070 attribute> supplied as shown in the example above.
4071
4072 B<NOTE:> You need to explicitly quote '+select'/'+as' when defining the attributes.
4073 Not doing so causes Perl to incorrectly interpret them as a bareword with a
4074 unary plus operator before it.
4075
4076 =head2 +select
4077
4078 =over 4
4079
4080 Indicates additional columns to be selected from storage.  Works the same as
4081 L</select> but adds columns to the default selection, instead of specifying
4082 an explicit list.
4083
4084 =back
4085
4086 =head2 as
4087
4088 =over 4
4089
4090 =item Value: \@inflation_names
4091
4092 =back
4093
4094 Indicates column names for object inflation. That is L</as> indicates the
4095 slot name in which the column value will be stored within the
4096 L<Row|DBIx::Class::Row> object. The value will then be accessible via this
4097 identifier by the C<get_column> method (or via the object accessor B<if one
4098 with the same name already exists>) as shown below. The L</as> attribute has
4099 B<nothing to do> with the SQL-side C<AS>. See L</select> for details.
4100
4101   $rs = $schema->resultset('Employee')->search(undef, {
4102     select => [
4103       'name',
4104       { count => 'employeeid' },
4105       { max => { length => 'name' }, -as => 'longest_name' }
4106     ],
4107     as => [qw/
4108       name
4109       employee_count
4110       max_name_length
4111     /],
4112   });
4113
4114 If the object against which the search is performed already has an accessor
4115 matching a column name specified in C<as>, the value can be retrieved using
4116 the accessor as normal:
4117
4118   my $name = $employee->name();
4119
4120 If on the other hand an accessor does not exist in the object, you need to
4121 use C<get_column> instead:
4122
4123   my $employee_count = $employee->get_column('employee_count');
4124
4125 You can create your own accessors if required - see
4126 L<DBIx::Class::Manual::Cookbook> for details.
4127
4128 =head2 +as
4129
4130 =over 4
4131
4132 Indicates additional column names for those added via L</+select>. See L</as>.
4133
4134 =back
4135
4136 =head2 join
4137
4138 =over 4
4139
4140 =item Value: ($rel_name | \@rel_names | \%rel_names)
4141
4142 =back
4143
4144 Contains a list of relationships that should be joined for this query.  For
4145 example:
4146
4147   # Get CDs by Nine Inch Nails
4148   my $rs = $schema->resultset('CD')->search(
4149     { 'artist.name' => 'Nine Inch Nails' },
4150     { join => 'artist' }
4151   );
4152
4153 Can also contain a hash reference to refer to the other relation's relations.
4154 For example:
4155
4156   package MyApp::Schema::Track;
4157   use base qw/DBIx::Class/;
4158   __PACKAGE__->table('track');
4159   __PACKAGE__->add_columns(qw/trackid cd position title/);
4160   __PACKAGE__->set_primary_key('trackid');
4161   __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
4162   1;
4163
4164   # In your application
4165   my $rs = $schema->resultset('Artist')->search(
4166     { 'track.title' => 'Teardrop' },
4167     {
4168       join     => { cd => 'track' },
4169       order_by => 'artist.name',
4170     }
4171   );
4172
4173 You need to use the relationship (not the table) name in  conditions,
4174 because they are aliased as such. The current table is aliased as "me", so
4175 you need to use me.column_name in order to avoid ambiguity. For example:
4176
4177   # Get CDs from 1984 with a 'Foo' track
4178   my $rs = $schema->resultset('CD')->search(
4179     {
4180       'me.year' => 1984,
4181       'tracks.name' => 'Foo'
4182     },
4183     { join => 'tracks' }
4184   );
4185
4186 If the same join is supplied twice, it will be aliased to <rel>_2 (and
4187 similarly for a third time). For e.g.
4188
4189   my $rs = $schema->resultset('Artist')->search({
4190     'cds.title'   => 'Down to Earth',
4191     'cds_2.title' => 'Popular',
4192   }, {
4193     join => [ qw/cds cds/ ],
4194   });
4195
4196 will return a set of all artists that have both a cd with title 'Down
4197 to Earth' and a cd with title 'Popular'.
4198
4199 If you want to fetch related objects from other tables as well, see L</prefetch>
4200 below.
4201
4202  NOTE: An internal join-chain pruner will discard certain joins while
4203  constructing the actual SQL query, as long as the joins in question do not
4204  affect the retrieved result. This for example includes 1:1 left joins
4205  that are not part of the restriction specification (WHERE/HAVING) nor are
4206  a part of the query selection.
4207
4208 For more help on using joins with search, see L<DBIx::Class::Manual::Joining>.
4209
4210 =head2 collapse
4211
4212 =over 4
4213
4214 =item Value: (0 | 1)
4215
4216 =back
4217
4218 When set to a true value, indicates that any rows fetched from joined has_many
4219 relationships are to be aggregated into the corresponding "parent" object. For
4220 example, the resultset:
4221
4222   my $rs = $schema->resultset('CD')->search({}, {
4223     '+columns' => [ qw/ tracks.title tracks.position / ],
4224     join => 'tracks',
4225     collapse => 1,
4226   });
4227
4228 While executing the following query:
4229
4230   SELECT me.*, tracks.title, tracks.position
4231     FROM cd me
4232     LEFT JOIN track tracks
4233       ON tracks.cdid = me.cdid
4234
4235 Will return only as many objects as there are rows in the CD source, even
4236 though the result of the query may span many rows. Each of these CD objects
4237 will in turn have multiple "Track" objects hidden behind the has_many
4238 generated accessor C<tracks>. Without C<< collapse => 1 >>, the return values
4239 of this resultset would be as many CD objects as there are tracks (a "Cartesian
4240 product"), with each CD object containing exactly one of all fetched Track data.
4241
4242 When a collapse is requested on a non-ordered resultset, an order by some
4243 unique part of the main source (the left-most table) is inserted automatically.
4244 This is done so that the resultset is allowed to be "lazy" - calling
4245 L<< $rs->next|/next >> will fetch only as many rows as it needs to build the next
4246 object with all of its related data.
4247
4248 If an L</order_by> is already declared, and orders the resultset in a way that
4249 makes collapsing as described above impossible (e.g. C<< ORDER BY
4250 has_many_rel.column >> or C<ORDER BY RANDOM()>), DBIC will automatically
4251 switch to "eager" mode and slurp the entire resultset before constructing the
4252 first object returned by L</next>.
4253
4254 Setting this attribute on a resultset that does not join any has_many
4255 relations is a no-op.
4256
4257 For a more in-depth discussion, see L</PREFETCHING>.
4258
4259 =head2 prefetch
4260
4261 =over 4
4262
4263 =item Value: ($rel_name | \@rel_names | \%rel_names)
4264
4265 =back
4266
4267 This attribute is a shorthand for specifying a L</join> spec, adding all
4268 columns from the joined related sources as L</+columns> and setting
4269 L</collapse> to a true value. For example, the following two queries are
4270 equivalent:
4271
4272   my $rs = $schema->resultset('Artist')->search({}, {
4273     prefetch => { cds => ['genre', 'tracks' ] },
4274   });
4275
4276 and
4277
4278   my $rs = $schema->resultset('Artist')->search({}, {
4279     join => { cds => ['genre', 'tracks' ] },
4280     collapse => 1,
4281     '+columns' => [
4282       (map
4283         { +{ "cds.$_" => "cds.$_" } }
4284         $schema->source('Artist')->related_source('cds')->columns
4285       ),
4286       (map
4287         { +{ "cds.genre.$_" => "genre.$_" } }
4288         $schema->source('Artist')->related_source('cds')->related_source('genre')->columns
4289       ),
4290       (map
4291         { +{ "cds.tracks.$_" => "tracks.$_" } }
4292         $schema->source('Artist')->related_source('cds')->related_source('tracks')->columns
4293       ),
4294     ],
4295   });
4296
4297 Both producing the following SQL:
4298
4299   SELECT  me.artistid, me.name, me.rank, me.charfield,
4300           cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track,
4301           genre.genreid, genre.name,
4302           tracks.trackid, tracks.cd, tracks.position, tracks.title, tracks.last_updated_on, tracks.last_updated_at
4303     FROM artist me
4304     LEFT JOIN cd cds
4305       ON cds.artist = me.artistid
4306     LEFT JOIN genre genre
4307       ON genre.genreid = cds.genreid
4308     LEFT JOIN track tracks
4309       ON tracks.cd = cds.cdid
4310   ORDER BY me.artistid
4311
4312 While L</prefetch> implies a L</join>, it is ok to mix the two together, as
4313 the arguments are properly merged and generally do the right thing. For
4314 example, you may want to do the following:
4315
4316   my $artists_and_cds_without_genre = $schema->resultset('Artist')->search(
4317     { 'genre.genreid' => undef },
4318     {
4319       join => { cds => 'genre' },
4320       prefetch => 'cds',
4321     }
4322   );
4323
4324 Which generates the following SQL:
4325
4326   SELECT  me.artistid, me.name, me.rank, me.charfield,
4327           cds.cdid, cds.artist, cds.title, cds.year, cds.genreid, cds.single_track
4328     FROM artist me
4329     LEFT JOIN cd cds
4330       ON cds.artist = me.artistid
4331     LEFT JOIN genre genre
4332       ON genre.genreid = cds.genreid
4333   WHERE genre.genreid IS NULL
4334   ORDER BY me.artistid
4335
4336 For a more in-depth discussion, see L</PREFETCHING>.
4337
4338 =head2 alias
4339
4340 =over 4
4341
4342 =item Value: $source_alias
4343
4344 =back
4345
4346 Sets the source alias for the query.  Normally, this defaults to C<me>, but
4347 nested search queries (sub-SELECTs) might need specific aliases set to
4348 reference inner queries.  For example:
4349
4350    my $q = $rs
4351       ->related_resultset('CDs')
4352       ->related_resultset('Tracks')
4353       ->search({
4354          'track.id' => { -ident => 'none_search.id' },
4355       })
4356       ->as_query;
4357
4358    my $ids = $self->search({
4359       -not_exists => $q,
4360    }, {
4361       alias    => 'none_search',
4362       group_by => 'none_search.id',
4363    })->get_column('id')->as_query;
4364
4365    $self->search({ id => { -in => $ids } })
4366
4367 This attribute is directly tied to L</current_source_alias>.
4368
4369 =head2 page
4370
4371 =over 4
4372
4373 =item Value: $page
4374
4375 =back
4376
4377 Makes the resultset paged and specifies the page to retrieve. Effectively
4378 identical to creating a non-pages resultset and then calling ->page($page)
4379 on it.
4380
4381 If L</rows> attribute is not specified it defaults to 10 rows per page.
4382
4383 When you have a paged resultset, L</count> will only return the number
4384 of rows in the page. To get the total, use the L</pager> and call
4385 C<total_entries> on it.
4386
4387 =head2 rows
4388
4389 =over 4
4390
4391 =item Value: $rows
4392
4393 =back
4394
4395 Specifies the maximum number of rows for direct retrieval or the number of
4396 rows per page if the page attribute or method is used.
4397
4398 =head2 offset
4399
4400 =over 4
4401
4402 =item Value: $offset
4403
4404 =back
4405
4406 Specifies the (zero-based) row number for the  first row to be returned, or the
4407 of the first row of the first page if paging is used.
4408
4409 =head2 software_limit
4410
4411 =over 4
4412
4413 =item Value: (0 | 1)
4414
4415 =back
4416
4417 When combined with L</rows> and/or L</offset> the generated SQL will not
4418 include any limit dialect stanzas. Instead the entire result will be selected
4419 as if no limits were specified, and DBIC will perform the limit locally, by
4420 artificially advancing and finishing the resulting L</cursor>.
4421
4422 This is the recommended way of performing resultset limiting when no sane RDBMS
4423 implementation is available (e.g.
4424 L<Sybase ASE|DBIx::Class::Storage::DBI::Sybase::ASE> using the
4425 L<Generic Sub Query|DBIx::Class::SQLMaker::LimitDialects/GenericSubQ> hack)
4426
4427 =head2 group_by
4428
4429 =over 4
4430
4431 =item Value: \@columns
4432
4433 =back
4434
4435 A arrayref of columns to group by. Can include columns of joined tables.
4436
4437   group_by => [qw/ column1 column2 ... /]
4438
4439 =head2 having
4440
4441 =over 4
4442
4443 =item Value: $condition
4444
4445 =back
4446
4447 HAVING is a select statement attribute that is applied between GROUP BY and
4448 ORDER BY. It is applied to the after the grouping calculations have been
4449 done.
4450
4451   having => { 'count_employee' => { '>=', 100 } }
4452
4453 or with an in-place function in which case literal SQL is required:
4454
4455   having => \[ 'count(employee) >= ?', [ count => 100 ] ]
4456
4457 =head2 distinct
4458
4459 =over 4
4460
4461 =item Value: (0 | 1)
4462
4463 =back
4464
4465 Set to 1 to automatically generate a L</group_by> clause based on the selection
4466 (including intelligent handling of L</order_by> contents). Note that the group
4467 criteria calculation takes place over the B<final> selection. This includes
4468 any L</+columns>, L</+select> or L</order_by> additions in subsequent
4469 L</search> calls, and standalone columns selected via
4470 L<DBIx::Class::ResultSetColumn> (L</get_column>). A notable exception are the
4471 extra selections specified via L</prefetch> - such selections are explicitly
4472 excluded from group criteria calculations.
4473
4474 If the final ResultSet also explicitly defines a L</group_by> attribute, this
4475 setting is ignored and an appropriate warning is issued.
4476
4477 =head2 where
4478
4479 =over 4
4480
4481 Adds to the WHERE clause.
4482
4483   # only return rows WHERE deleted IS NULL for all searches
4484   __PACKAGE__->resultset_attributes({ where => { deleted => undef } });
4485
4486 Can be overridden by passing C<< { where => undef } >> as an attribute
4487 to a resultset.
4488
4489 For more complicated where clauses see L<SQL::Abstract/WHERE CLAUSES>.
4490
4491 =back
4492
4493 =head2 cache
4494
4495 Set to 1 to cache search results. This prevents extra SQL queries if you
4496 revisit rows in your ResultSet:
4497
4498   my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
4499
4500   while( my $artist = $resultset->next ) {
4501     ... do stuff ...
4502   }
4503
4504   $rs->first; # without cache, this would issue a query
4505
4506 By default, searches are not cached.
4507
4508 For more examples of using these attributes, see
4509 L<DBIx::Class::Manual::Cookbook>.
4510
4511 =head2 for
4512
4513 =over 4
4514
4515 =item Value: ( 'update' | 'shared' | \$scalar )
4516
4517 =back
4518
4519 Set to 'update' for a SELECT ... FOR UPDATE or 'shared' for a SELECT
4520 ... FOR SHARED. If \$scalar is passed, this is taken directly and embedded in the
4521 query.
4522
4523 =head1 PREFETCHING
4524
4525 DBIx::Class supports arbitrary related data prefetching from multiple related
4526 sources. Any combination of relationship types and column sets are supported.
4527 If L<collapsing|/collapse> is requested, there is an additional requirement of
4528 selecting enough data to make every individual object uniquely identifiable.
4529
4530 Here are some more involved examples, based on the following relationship map:
4531
4532   # Assuming:
4533   My::Schema::CD->belongs_to( artist      => 'My::Schema::Artist'     );
4534   My::Schema::CD->might_have( liner_note  => 'My::Schema::LinerNotes' );
4535   My::Schema::CD->has_many(   tracks      => 'My::Schema::Track'      );
4536
4537   My::Schema::Artist->belongs_to( record_label => 'My::Schema::RecordLabel' );
4538
4539   My::Schema::Track->has_many( guests => 'My::Schema::Guest' );
4540
4541
4542
4543   my $rs = $schema->resultset('Tag')->search(
4544     undef,
4545     {
4546       prefetch => {
4547         cd => 'artist'
4548       }
4549     }
4550   );
4551
4552 The initial search results in SQL like the following:
4553
4554   SELECT tag.*, cd.*, artist.* FROM tag
4555   JOIN cd ON tag.cd = cd.cdid
4556   JOIN artist ON cd.artist = artist.artistid
4557
4558 L<DBIx::Class> has no need to go back to the database when we access the
4559 C<cd> or C<artist> relationships, which saves us two SQL statements in this
4560 case.
4561
4562 Simple prefetches will be joined automatically, so there is no need
4563 for a C<join> attribute in the above search.
4564
4565 The L</prefetch> attribute can be used with any of the relationship types
4566 and multiple prefetches can be specified together. Below is a more complex
4567 example that prefetches a CD's artist, its liner notes (if present),
4568 the cover image, the tracks on that CD, and the guests on those
4569 tracks.
4570
4571   my $rs = $schema->resultset('CD')->search(
4572     undef,
4573     {
4574       prefetch => [
4575         { artist => 'record_label'},  # belongs_to => belongs_to
4576         'liner_note',                 # might_have
4577         'cover_image',                # has_one
4578         { tracks => 'guests' },       # has_many => has_many
4579       ]
4580     }
4581   );
4582
4583 This will produce SQL like the following:
4584
4585   SELECT cd.*, artist.*, record_label.*, liner_note.*, cover_image.*,
4586          tracks.*, guests.*
4587     FROM cd me
4588     JOIN artist artist
4589       ON artist.artistid = me.artistid
4590     JOIN record_label record_label
4591       ON record_label.labelid = artist.labelid
4592     LEFT JOIN track tracks
4593       ON tracks.cdid = me.cdid
4594     LEFT JOIN guest guests
4595       ON guests.trackid = track.trackid
4596     LEFT JOIN liner_notes liner_note
4597       ON liner_note.cdid = me.cdid
4598     JOIN cd_artwork cover_image
4599       ON cover_image.cdid = me.cdid
4600   ORDER BY tracks.cd
4601
4602 Now the C<artist>, C<record_label>, C<liner_note>, C<cover_image>,
4603 C<tracks>, and C<guests> of the CD will all be available through the
4604 relationship accessors without the need for additional queries to the
4605 database.
4606
4607 =head3 CAVEATS
4608
4609 Prefetch does a lot of deep magic. As such, it may not behave exactly
4610 as you might expect.
4611
4612 =over 4
4613
4614 =item *
4615
4616 Prefetch uses the L</cache> to populate the prefetched relationships. This
4617 may or may not be what you want.
4618
4619 =item *
4620
4621 If you specify a condition on a prefetched relationship, ONLY those
4622 rows that match the prefetched condition will be fetched into that relationship.
4623 This means that adding prefetch to a search() B<may alter> what is returned by
4624 traversing a relationship. So, if you have C<< Artist->has_many(CDs) >> and you do
4625
4626   my $artist_rs = $schema->resultset('Artist')->search({
4627       'cds.year' => 2008,
4628   }, {
4629       join => 'cds',
4630   });
4631
4632   my $count = $artist_rs->first->cds->count;
4633
4634   my $artist_rs_prefetch = $artist_rs->search( {}, { prefetch => 'cds' } );
4635
4636   my $prefetch_count = $artist_rs_prefetch->first->cds->count;
4637
4638   cmp_ok( $count, '==', $prefetch_count, "Counts should be the same" );
4639
4640 That cmp_ok() may or may not pass depending on the datasets involved. In other
4641 words the C<WHERE> condition would apply to the entire dataset, just like
4642 it would in regular SQL. If you want to add a condition only to the "right side"
4643 of a C<LEFT JOIN> - consider declaring and using a L<relationship with a custom
4644 condition|DBIx::Class::Relationship::Base/condition>
4645
4646 =back
4647
4648 =head1 DBIC BIND VALUES
4649
4650 Because DBIC may need more information to bind values than just the column name
4651 and value itself, it uses a special format for both passing and receiving bind
4652 values.  Each bind value should be composed of an arrayref of
4653 C<< [ \%args => $val ] >>.  The format of C<< \%args >> is currently:
4654
4655 =over 4
4656
4657 =item dbd_attrs
4658
4659 If present (in any form), this is what is being passed directly to bind_param.
4660 Note that different DBD's expect different bind args.  (e.g. DBD::SQLite takes
4661 a single numerical type, while DBD::Pg takes a hashref if bind options.)
4662
4663 If this is specified, all other bind options described below are ignored.
4664
4665 =item sqlt_datatype
4666
4667 If present, this is used to infer the actual bind attribute by passing to
4668 C<< $resolved_storage->bind_attribute_by_data_type() >>.  Defaults to the
4669 "data_type" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>.
4670
4671 Note that the data type is somewhat freeform (hence the sqlt_ prefix);
4672 currently drivers are expected to "Do the Right Thing" when given a common
4673 datatype name.  (Not ideal, but that's what we got at this point.)
4674
4675 =item sqlt_size
4676
4677 Currently used to correctly allocate buffers for bind_param_inout().
4678 Defaults to "size" from the L<add_columns column info|DBIx::Class::ResultSource/add_columns>,
4679 or to a sensible value based on the "data_type".
4680
4681 =item dbic_colname
4682
4683 Used to fill in missing sqlt_datatype and sqlt_size attributes (if they are
4684 explicitly specified they are never overridden).  Also used by some weird DBDs,
4685 where the column name should be available at bind_param time (e.g. Oracle).
4686
4687 =back
4688
4689 For backwards compatibility and convenience, the following shortcuts are
4690 supported:
4691
4692   [ $name => $val ] === [ { dbic_colname => $name }, $val ]
4693   [ \$dt  => $val ] === [ { sqlt_datatype => $dt }, $val ]
4694   [ undef,   $val ] === [ {}, $val ]
4695   $val              === [ {}, $val ]
4696
4697 =head1 AUTHOR AND CONTRIBUTORS
4698
4699 See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
4700
4701 =head1 LICENSE
4702
4703 You may distribute this code under the same terms as Perl itself.
4704