lib/DBIx/Class/ResultSet.pm

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