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