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