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