lib/DBIx/Class/ResultSet.pm

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