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