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