fixation
[dbsrgits/DBIx-Class.git] / 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'   => sub { 1; },
8         fallback => 1;
9 use Carp::Clan qw/^DBIx::Class/;
10 use Data::Page;
11 use Storable;
12 use DBIx::Class::ResultSetColumn;
13 use base qw/DBIx::Class/;
14
15 use Data::Dumper; $Data::Dumper::Indent = 1;
16
17 __PACKAGE__->load_components(qw/AccessorGroup/);
18 __PACKAGE__->mk_group_accessors('simple' => qw/result_source result_class/);
19
20 =head1 NAME
21
22 DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
23
24 =head1 SYNOPSIS
25
26   my $rs   = $schema->resultset('User')->search(registered => 1);
27   my @rows = $schema->resultset('CD')->search(year => 2005);
28
29 =head1 DESCRIPTION
30
31 The resultset is also known as an iterator. It is responsible for handling
32 queries that may return an arbitrary number of rows, e.g. via L</search>
33 or a C<has_many> relationship.
34
35 In the examples below, the following table classes are used:
36
37   package MyApp::Schema::Artist;
38   use base qw/DBIx::Class/;
39   __PACKAGE__->load_components(qw/Core/);
40   __PACKAGE__->table('artist');
41   __PACKAGE__->add_columns(qw/artistid name/);
42   __PACKAGE__->set_primary_key('artistid');
43   __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
44   1;
45
46   package MyApp::Schema::CD;
47   use base qw/DBIx::Class/;
48   __PACKAGE__->load_components(qw/Core/);
49   __PACKAGE__->table('cd');
50   __PACKAGE__->add_columns(qw/cdid artist title year/);
51   __PACKAGE__->set_primary_key('cdid');
52   __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
53   1;
54
55 =head1 METHODS
56
57 =head2 new
58
59 =over 4
60
61 =item Arguments: $source, \%$attrs
62
63 =item Return Value: $rs
64
65 =back
66
67 The resultset constructor. Takes a source object (usually a
68 L<DBIx::Class::ResultSourceProxy::Table>) and an attribute hash (see
69 L</ATTRIBUTES> below).  Does not perform any queries -- these are
70 executed as needed by the other methods.
71
72 Generally you won't need to construct a resultset manually.  You'll
73 automatically get one from e.g. a L</search> called in scalar context:
74
75   my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
76
77 IMPORTANT: If called on an object, proxies to new_result instead so
78
79   my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
80
81 will return a CD object, not a ResultSet.
82
83 =cut
84
85 sub new {
86   my $class = shift;
87   return $class->new_result(@_) if ref $class;
88
89   my ($source, $attrs) = @_;
90   #weaken $source;
91
92   if ($attrs->{page}) {
93     $attrs->{rows} ||= 10;
94     $attrs->{offset} ||= 0;
95     $attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
96   }
97
98   $attrs->{alias} ||= 'me';
99
100   bless {
101     result_source => $source,
102     result_class => $attrs->{result_class} || $source->result_class,
103     cond => $attrs->{where},
104 #    from => $attrs->{from},
105 #    collapse => $collapse,
106     count => undef,
107     pager => undef,
108     attrs => $attrs
109   }, $class;
110 }
111
112 =head2 search
113
114 =over 4
115
116 =item Arguments: $cond, \%attrs?
117
118 =item Return Value: $resultset (scalar context), @row_objs (list context)
119
120 =back
121
122   my @cds    = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
123   my $new_rs = $cd_rs->search({ year => 2005 });
124
125   my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
126                  # year = 2005 OR year = 2004
127
128 If you need to pass in additional attributes but no additional condition,
129 call it as C<search(undef, \%attrs)>.
130
131   # "SELECT name, artistid FROM $artist_table"
132   my @all_artists = $schema->resultset('Artist')->search(undef, {
133     columns => [qw/name artistid/],
134   });
135
136 =cut
137
138 sub search {
139   my $self = shift;
140   my $rs = $self->search_rs( @_ );
141   return (wantarray ? $rs->all : $rs);
142 }
143
144 =head2 search_rs
145
146 =over 4
147
148 =item Arguments: $cond, \%attrs?
149
150 =item Return Value: $resultset
151
152 =back
153
154 This method does the same exact thing as search() except it will
155 always return a resultset, even in list context.
156
157 =cut
158
159 sub search_rs {
160   my $self = shift;
161
162   my $rows;
163
164   unless (@_) {                 # no search, effectively just a clone
165     $rows = $self->get_cache;
166   }
167
168   my $attrs = {};
169   $attrs = pop(@_) if @_ > 1 and ref $_[$#_] eq 'HASH';
170   my $our_attrs = { %{$self->{attrs}} };
171   my $having = delete $our_attrs->{having};
172
173   # merge new attrs into inherited
174   foreach my $key (qw/join prefetch/) {
175     next unless exists $attrs->{$key};
176     $our_attrs->{$key} = $self->_merge_attr($our_attrs->{$key}, delete $attrs->{$key});
177   }
178   
179   my $new_attrs = { %{$our_attrs}, %{$attrs} };
180   my $where = (@_
181     ? (
182         (@_ == 1 || ref $_[0] eq "HASH")
183           ? shift
184           : (
185               (@_ % 2)
186                 ? $self->throw_exception("Odd number of arguments to search")
187                 : {@_}
188              )
189       )
190     : undef
191   );
192
193   if (defined $where) {
194     $new_attrs->{where} = (
195       defined $new_attrs->{where}
196         ? { '-and' => [
197               map {
198                 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
199               } $where, $new_attrs->{where}
200             ]
201           }
202         : $where);
203   }
204
205   if (defined $having) {
206     $new_attrs->{having} = (
207       defined $new_attrs->{having}
208         ? { '-and' => [
209               map {
210                 ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_
211               } $having, $new_attrs->{having}
212             ]
213           }
214         : $having);
215   }
216
217   my $rs = (ref $self)->new($self->result_source, $new_attrs);
218   if ($rows) {
219     $rs->set_cache($rows);
220   }
221   return $rs;
222 }
223
224 =head2 search_literal
225
226 =over 4
227
228 =item Arguments: $sql_fragment, @bind_values
229
230 =item Return Value: $resultset (scalar context), @row_objs (list context)
231
232 =back
233
234   my @cds   = $cd_rs->search_literal('year = ? AND title = ?', qw/2001 Reload/);
235   my $newrs = $artist_rs->search_literal('name = ?', 'Metallica');
236
237 Pass a literal chunk of SQL to be added to the conditional part of the
238 resultset query.
239
240 =cut
241
242 sub search_literal {
243   my ($self, $cond, @vals) = @_;
244   my $attrs = (ref $vals[$#vals] eq 'HASH' ? { %{ pop(@vals) } } : {});
245   $attrs->{bind} = [ @{$self->{attrs}{bind}||[]}, @vals ];
246   return $self->search(\$cond, $attrs);
247 }
248
249 =head2 find
250
251 =over 4
252
253 =item Arguments: @values | \%cols, \%attrs?
254
255 =item Return Value: $row_object
256
257 =back
258
259 Finds a row based on its primary key or unique constraint. For example, to find
260 a row by its primary key:
261
262   my $cd = $schema->resultset('CD')->find(5);
263
264 You can also find a row by a specific unique constraint using the C<key>
265 attribute. For example:
266
267   my $cd = $schema->resultset('CD')->find('Massive Attack', 'Mezzanine', {
268     key => 'cd_artist_title'
269   });
270
271 Additionally, you can specify the columns explicitly by name:
272
273   my $cd = $schema->resultset('CD')->find(
274     {
275       artist => 'Massive Attack',
276       title  => 'Mezzanine',
277     },
278     { key => 'cd_artist_title' }
279   );
280
281 If the C<key> is specified as C<primary>, it searches only on the primary key.
282
283 If no C<key> is specified, it searches on all unique constraints defined on the
284 source, including the primary key.
285
286 See also L</find_or_create> and L</update_or_create>. For information on how to
287 declare unique constraints, see
288 L<DBIx::Class::ResultSource/add_unique_constraint>.
289
290 =cut
291
292 sub find {
293   my $self = shift;
294   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
295
296   # Default to the primary key, but allow a specific key
297   my @cols = exists $attrs->{key}
298     ? $self->result_source->unique_constraint_columns($attrs->{key})
299     : $self->result_source->primary_columns;
300   $self->throw_exception(
301     "Can't find unless a primary key or unique constraint is defined"
302   ) unless @cols;
303
304   # Parse out a hashref from input
305   my $input_query;
306   if (ref $_[0] eq 'HASH') {
307     $input_query = { %{$_[0]} };
308   }
309   elsif (@_ == @cols) {
310     $input_query = {};
311     @{$input_query}{@cols} = @_;
312   }
313   else {
314     # Compatibility: Allow e.g. find(id => $value)
315     carp "Find by key => value deprecated; please use a hashref instead";
316     $input_query = {@_};
317   }
318
319   my @unique_queries = $self->_unique_queries($input_query, $attrs);
320
321   # Handle cases where the ResultSet defines the query, or where the user is
322   # abusing find
323   my $query = @unique_queries ? \@unique_queries : $input_query;
324
325   # Run the query
326   if (keys %$attrs) {
327     my $rs = $self->search($query, $attrs);
328     return keys %{$rs->_resolved_attrs->{collapse}} ? $rs->next : $rs->single;
329   }
330   else {
331     return keys %{$self->_resolved_attrs->{collapse}}
332       ? $self->search($query)->next
333       : $self->single($query);
334   }
335 }
336
337 # _unique_queries
338 #
339 # Build a list of queries which satisfy unique constraints.
340
341 sub _unique_queries {
342   my ($self, $query, $attrs) = @_;
343
344   my $alias = $self->{attrs}{alias};
345   my @constraint_names = exists $attrs->{key}
346     ? ($attrs->{key})
347     : $self->result_source->unique_constraint_names;
348
349   my @unique_queries;
350   foreach my $name (@constraint_names) {
351     my @unique_cols = $self->result_source->unique_constraint_columns($name);
352     my $unique_query = $self->_build_unique_query($query, \@unique_cols);
353
354     my $num_query = scalar keys %$unique_query;
355     next unless $num_query;
356
357     # Add the ResultSet's alias
358     foreach my $col (grep { ! m/\./ } keys %$unique_query) {
359       $unique_query->{"$alias.$col"} = delete $unique_query->{$col};
360     }
361
362     # XXX: Assuming quite a bit about $self->{attrs}{where}
363     my $num_cols = scalar @unique_cols;
364     my $num_where = exists $self->{attrs}{where}
365       ? scalar keys %{ $self->{attrs}{where} }
366       : 0;
367     push @unique_queries, $unique_query
368       if $num_query + $num_where == $num_cols;
369   }
370
371   return @unique_queries;
372 }
373
374 # _build_unique_query
375 #
376 # Constrain the specified query hash based on the specified column names.
377
378 sub _build_unique_query {
379   my ($self, $query, $unique_cols) = @_;
380
381   return {
382     map  { $_ => $query->{$_} }
383     grep { exists $query->{$_} }
384       @$unique_cols
385   };
386 }
387
388 =head2 search_related
389
390 =over 4
391
392 =item Arguments: $rel, $cond, \%attrs?
393
394 =item Return Value: $new_resultset
395
396 =back
397
398   $new_rs = $cd_rs->search_related('artist', {
399     name => 'Emo-R-Us',
400   });
401
402 Searches the specified relationship, optionally specifying a condition and
403 attributes for matching records. See L</ATTRIBUTES> for more information.
404
405 =cut
406
407 sub search_related {
408   return shift->related_resultset(shift)->search(@_);
409 }
410
411 =head2 cursor
412
413 =over 4
414
415 =item Arguments: none
416
417 =item Return Value: $cursor
418
419 =back
420
421 Returns a storage-driven cursor to the given resultset. See
422 L<DBIx::Class::Cursor> for more information.
423
424 =cut
425
426 sub cursor {
427   my ($self) = @_;
428
429   my $attrs = { %{$self->_resolved_attrs} };
430   return $self->{cursor}
431     ||= $self->result_source->storage->select($attrs->{from}, $attrs->{select},
432           $attrs->{where},$attrs);
433 }
434
435 =head2 single
436
437 =over 4
438
439 =item Arguments: $cond?
440
441 =item Return Value: $row_object?
442
443 =back
444
445   my $cd = $schema->resultset('CD')->single({ year => 2001 });
446
447 Inflates the first result without creating a cursor if the resultset has
448 any records in it; if not returns nothing. Used by L</find> as an optimisation.
449
450 Can optionally take an additional condition *only* - this is a fast-code-path
451 method; if you need to add extra joins or similar call ->search and then
452 ->single without a condition on the $rs returned from that.
453
454 =cut
455
456 sub single {
457   my ($self, $where) = @_;
458   my $attrs = { %{$self->_resolved_attrs} };
459   if ($where) {
460     if (defined $attrs->{where}) {
461       $attrs->{where} = {
462         '-and' =>
463             [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
464                $where, delete $attrs->{where} ]
465       };
466     } else {
467       $attrs->{where} = $where;
468     }
469   }
470
471   unless ($self->_is_unique_query($attrs->{where})) {
472     carp "Query not guaranteed to return a single row"
473       . "; please declare your unique constraints or use search instead";
474   }
475
476   my @data = $self->result_source->storage->select_single(
477     $attrs->{from}, $attrs->{select},
478     $attrs->{where}, $attrs
479   );
480
481   return (@data ? $self->_construct_object(@data) : ());
482 }
483
484 # _is_unique_query
485 #
486 # Try to determine if the specified query is guaranteed to be unique, based on
487 # the declared unique constraints.
488
489 sub _is_unique_query {
490   my ($self, $query) = @_;
491
492   my $collapsed = $self->_collapse_query($query);
493   my $alias = $self->{attrs}{alias};
494
495   foreach my $name ($self->result_source->unique_constraint_names) {
496     my @unique_cols = map {
497       "$alias.$_"
498     } $self->result_source->unique_constraint_columns($name);
499
500     # Count the values for each unique column
501     my %seen = map { $_ => 0 } @unique_cols;
502
503     foreach my $key (keys %$collapsed) {
504       my $aliased = $key =~ /\./ ? $key : "$alias.$key";
505       next unless exists $seen{$aliased};  # Additional constraints are okay
506       $seen{$aliased} = scalar keys %{ $collapsed->{$key} };
507     }
508
509     # If we get 0 or more than 1 value for a column, it's not necessarily unique
510     return 1 unless grep { $_ != 1 } values %seen;
511   }
512
513   return 0;
514 }
515
516 # _collapse_query
517 #
518 # Recursively collapse the query, accumulating values for each column.
519
520 sub _collapse_query {
521   my ($self, $query, $collapsed) = @_;
522
523   $collapsed ||= {};
524
525   if (ref $query eq 'ARRAY') {
526     foreach my $subquery (@$query) {
527       next unless ref $subquery;  # -or
528 #      warn "ARRAY: " . Dumper $subquery;
529       $collapsed = $self->_collapse_query($subquery, $collapsed);
530     }
531   }
532   elsif (ref $query eq 'HASH') {
533     if (keys %$query and (keys %$query)[0] eq '-and') {
534       foreach my $subquery (@{$query->{-and}}) {
535 #        warn "HASH: " . Dumper $subquery;
536         $collapsed = $self->_collapse_query($subquery, $collapsed);
537       }
538     }
539     else {
540 #      warn "LEAF: " . Dumper $query;
541       foreach my $col (keys %$query) {
542         my $value = $query->{$col};
543         $collapsed->{$col}{$value}++;
544       }
545     }
546   }
547
548   return $collapsed;
549 }
550
551 =head2 get_column
552
553 =over 4
554
555 =item Arguments: $cond?
556
557 =item Return Value: $resultsetcolumn
558
559 =back
560
561   my $max_length = $rs->get_column('length')->max;
562
563 Returns a ResultSetColumn instance for $column based on $self
564
565 =cut
566
567 sub get_column {
568   my ($self, $column) = @_;
569   my $new = DBIx::Class::ResultSetColumn->new($self, $column);
570   return $new;
571 }
572
573 =head2 search_like
574
575 =over 4
576
577 =item Arguments: $cond, \%attrs?
578
579 =item Return Value: $resultset (scalar context), @row_objs (list context)
580
581 =back
582
583   # WHERE title LIKE '%blue%'
584   $cd_rs = $rs->search_like({ title => '%blue%'});
585
586 Performs a search, but uses C<LIKE> instead of C<=> as the condition. Note
587 that this is simply a convenience method. You most likely want to use
588 L</search> with specific operators.
589
590 For more information, see L<DBIx::Class::Manual::Cookbook>.
591
592 =cut
593
594 sub search_like {
595   my $class = shift;
596   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
597   my $query = ref $_[0] eq 'HASH' ? { %{shift()} }: {@_};
598   $query->{$_} = { 'like' => $query->{$_} } for keys %$query;
599   return $class->search($query, { %$attrs });
600 }
601
602 =head2 slice
603
604 =over 4
605
606 =item Arguments: $first, $last
607
608 =item Return Value: $resultset (scalar context), @row_objs (list context)
609
610 =back
611
612 Returns a resultset or object list representing a subset of elements from the
613 resultset slice is called on. Indexes are from 0, i.e., to get the first
614 three records, call:
615
616   my ($one, $two, $three) = $rs->slice(0, 2);
617
618 =cut
619
620 sub slice {
621   my ($self, $min, $max) = @_;
622   my $attrs = {}; # = { %{ $self->{attrs} || {} } };
623   $attrs->{offset} = $self->{attrs}{offset} || 0;
624   $attrs->{offset} += $min;
625   $attrs->{rows} = ($max ? ($max - $min + 1) : 1);
626   return $self->search(undef(), $attrs);
627   #my $slice = (ref $self)->new($self->result_source, $attrs);
628   #return (wantarray ? $slice->all : $slice);
629 }
630
631 =head2 next
632
633 =over 4
634
635 =item Arguments: none
636
637 =item Return Value: $result?
638
639 =back
640
641 Returns the next element in the resultset (C<undef> is there is none).
642
643 Can be used to efficiently iterate over records in the resultset:
644
645   my $rs = $schema->resultset('CD')->search;
646   while (my $cd = $rs->next) {
647     print $cd->title;
648   }
649
650 Note that you need to store the resultset object, and call C<next> on it.
651 Calling C<< resultset('Table')->next >> repeatedly will always return the
652 first record from the resultset.
653
654 =cut
655
656 sub next {
657   my ($self) = @_;
658   if (my $cache = $self->get_cache) {
659     $self->{all_cache_position} ||= 0;
660     return $cache->[$self->{all_cache_position}++];
661   }
662   if ($self->{attrs}{cache}) {
663     $self->{all_cache_position} = 1;
664     return ($self->all)[0];
665   }
666   my @row = (
667     exists $self->{stashed_row}
668       ? @{delete $self->{stashed_row}}
669       : $self->cursor->next
670   );
671   return unless (@row);
672   return $self->_construct_object(@row);
673 }
674
675 sub _construct_object {
676   my ($self, @row) = @_;
677   my $info = $self->_collapse_result($self->{_attrs}{as}, \@row);
678   my $new = $self->result_class->inflate_result($self->result_source, @$info);
679   $new = $self->{_attrs}{record_filter}->($new)
680     if exists $self->{_attrs}{record_filter};
681   return $new;
682 }
683
684 sub _collapse_result {
685   my ($self, $as, $row, $prefix) = @_;
686
687   my %const;
688   my @copy = @$row;
689   
690   foreach my $this_as (@$as) {
691     my $val = shift @copy;
692     if (defined $prefix) {
693       if ($this_as =~ m/^\Q${prefix}.\E(.+)$/) {
694         my $remain = $1;
695         $remain =~ /^(?:(.*)\.)?([^.]+)$/;
696         $const{$1||''}{$2} = $val;
697       }
698     } else {
699       $this_as =~ /^(?:(.*)\.)?([^.]+)$/;
700       $const{$1||''}{$2} = $val;
701     }
702   }
703
704   my $alias = $self->{attrs}{alias};
705   my $info = [ {}, {} ];
706   foreach my $key (keys %const) {
707     if (length $key && $key ne $alias) {
708       my $target = $info;
709       my @parts = split(/\./, $key);
710       foreach my $p (@parts) {
711         $target = $target->[1]->{$p} ||= [];
712       }
713       $target->[0] = $const{$key};
714     } else {
715       $info->[0] = $const{$key};
716     }
717   }
718   
719   my @collapse;
720   if (defined $prefix) {
721     @collapse = map {
722         m/^\Q${prefix}.\E(.+)$/ ? ($1) : ()
723     } keys %{$self->{_attrs}{collapse}}
724   } else {
725     @collapse = keys %{$self->{_attrs}{collapse}};
726   };
727
728   if (@collapse) {
729     my ($c) = sort { length $a <=> length $b } @collapse;
730     my $target = $info;
731     foreach my $p (split(/\./, $c)) {
732       $target = $target->[1]->{$p} ||= [];
733     }
734     my $c_prefix = (defined($prefix) ? "${prefix}.${c}" : $c);
735     my @co_key = @{$self->{_attrs}{collapse}{$c_prefix}};
736     my $tree = $self->_collapse_result($as, $row, $c_prefix);
737     my %co_check = map { ($_, $tree->[0]->{$_}); } @co_key;
738     my (@final, @raw);
739
740     while (
741       !(
742         grep {
743           !defined($tree->[0]->{$_}) || $co_check{$_} ne $tree->[0]->{$_}
744         } @co_key
745         )
746     ) {
747       push(@final, $tree);
748       last unless (@raw = $self->cursor->next);
749       $row = $self->{stashed_row} = \@raw;
750       $tree = $self->_collapse_result($as, $row, $c_prefix);
751     }
752     @$target = (@final ? @final : [ {}, {} ]);
753       # single empty result to indicate an empty prefetched has_many
754   }
755
756   #print "final info: " . Dumper($info);
757   return $info;
758 }
759
760 =head2 result_source
761
762 =over 4
763
764 =item Arguments: $result_source?
765
766 =item Return Value: $result_source
767
768 =back
769
770 An accessor for the primary ResultSource object from which this ResultSet
771 is derived.
772
773 =cut
774
775
776 =head2 count
777
778 =over 4
779
780 =item Arguments: $cond, \%attrs??
781
782 =item Return Value: $count
783
784 =back
785
786 Performs an SQL C<COUNT> with the same query as the resultset was built
787 with to find the number of elements. If passed arguments, does a search
788 on the resultset and counts the results of that.
789
790 Note: When using C<count> with C<group_by>, L<DBIX::Class> emulates C<GROUP BY>
791 using C<COUNT( DISTINCT( columns ) )>. Some databases (notably SQLite) do
792 not support C<DISTINCT> with multiple columns. If you are using such a
793 database, you should only use columns from the main table in your C<group_by>
794 clause.
795
796 =cut
797
798 sub count {
799   my $self = shift;
800   return $self->search(@_)->count if @_ and defined $_[0];
801   return scalar @{ $self->get_cache } if $self->get_cache;
802   my $count = $self->_count;
803   return 0 unless $count;
804
805   $count -= $self->{attrs}{offset} if $self->{attrs}{offset};
806   $count = $self->{attrs}{rows} if
807     $self->{attrs}{rows} and $self->{attrs}{rows} < $count;
808   return $count;
809 }
810
811 sub _count { # Separated out so pager can get the full count
812   my $self = shift;
813   my $select = { count => '*' };
814
815   my $attrs = { %{$self->_resolved_attrs} };
816   if (my $group_by = delete $attrs->{group_by}) {
817     delete $attrs->{having};
818     my @distinct = (ref $group_by ?  @$group_by : ($group_by));
819     # todo: try CONCAT for multi-column pk
820     my @pk = $self->result_source->primary_columns;
821     if (@pk == 1) {
822       my $alias = $attrs->{alias};
823       foreach my $column (@distinct) {
824         if ($column =~ qr/^(?:\Q${alias}.\E)?$pk[0]$/) {
825           @distinct = ($column);
826           last;
827         }
828       }
829     }
830
831     $select = { count => { distinct => \@distinct } };
832   }
833
834   $attrs->{select} = $select;
835   $attrs->{as} = [qw/count/];
836
837   # offset, order by and page are not needed to count. record_filter is cdbi
838   delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
839
840   my $tmp_rs = (ref $self)->new($self->result_source, $attrs);
841   my ($count) = $tmp_rs->cursor->next;
842   return $count;
843 }
844
845 =head2 count_literal
846
847 =over 4
848
849 =item Arguments: $sql_fragment, @bind_values
850
851 =item Return Value: $count
852
853 =back
854
855 Counts the results in a literal query. Equivalent to calling L</search_literal>
856 with the passed arguments, then L</count>.
857
858 =cut
859
860 sub count_literal { shift->search_literal(@_)->count; }
861
862 =head2 all
863
864 =over 4
865
866 =item Arguments: none
867
868 =item Return Value: @objects
869
870 =back
871
872 Returns all elements in the resultset. Called implicitly if the resultset
873 is returned in list context.
874
875 =cut
876
877 sub all {
878   my ($self) = @_;
879   return @{ $self->get_cache } if $self->get_cache;
880
881   my @obj;
882
883   # TODO: don't call resolve here
884   if (keys %{$self->_resolved_attrs->{collapse}}) {
885 #  if ($self->{attrs}{prefetch}) {
886       # Using $self->cursor->all is really just an optimisation.
887       # If we're collapsing has_many prefetches it probably makes
888       # very little difference, and this is cleaner than hacking
889       # _construct_object to survive the approach
890     my @row = $self->cursor->next;
891     while (@row) {
892       push(@obj, $self->_construct_object(@row));
893       @row = (exists $self->{stashed_row}
894                ? @{delete $self->{stashed_row}}
895                : $self->cursor->next);
896     }
897   } else {
898     @obj = map { $self->_construct_object(@$_) } $self->cursor->all;
899   }
900
901   $self->set_cache(\@obj) if $self->{attrs}{cache};
902   return @obj;
903 }
904
905 =head2 reset
906
907 =over 4
908
909 =item Arguments: none
910
911 =item Return Value: $self
912
913 =back
914
915 Resets the resultset's cursor, so you can iterate through the elements again.
916
917 =cut
918
919 sub reset {
920   my ($self) = @_;
921   delete $self->{_attrs} if exists $self->{_attrs};
922   $self->{all_cache_position} = 0;
923   $self->cursor->reset;
924   return $self;
925 }
926
927 =head2 first
928
929 =over 4
930
931 =item Arguments: none
932
933 =item Return Value: $object?
934
935 =back
936
937 Resets the resultset and returns an object for the first result (if the
938 resultset returns anything).
939
940 =cut
941
942 sub first {
943   return $_[0]->reset->next;
944 }
945
946 # _cond_for_update_delete
947 #
948 # update/delete require the condition to be modified to handle
949 # the differing SQL syntax available.  This transforms the $self->{cond}
950 # appropriately, returning the new condition.
951
952 sub _cond_for_update_delete {
953   my ($self) = @_;
954   my $cond = {};
955
956   # No-op. No condition, we're updating/deleting everything
957   return $cond unless ref $self->{cond};
958
959   if (ref $self->{cond} eq 'ARRAY') {
960     $cond = [
961       map {
962         my %hash;
963         foreach my $key (keys %{$_}) {
964           $key =~ /([^.]+)$/;
965           $hash{$1} = $_->{$key};
966         }
967         \%hash;
968       } @{$self->{cond}}
969     ];
970   }
971   elsif (ref $self->{cond} eq 'HASH') {
972     if ((keys %{$self->{cond}})[0] eq '-and') {
973       $cond->{-and} = [];
974
975       my @cond = @{$self->{cond}{-and}};
976       for (my $i = 0; $i < @cond; $i++) {
977         my $entry = $cond[$i];
978
979         my %hash;
980         if (ref $entry eq 'HASH') {
981           foreach my $key (keys %{$entry}) {
982             $key =~ /([^.]+)$/;
983             $hash{$1} = $entry->{$key};
984           }
985         }
986         else {
987           $entry =~ /([^.]+)$/;
988           $hash{$1} = $cond[++$i];
989         }
990
991         push @{$cond->{-and}}, \%hash;
992       }
993     }
994     else {
995       foreach my $key (keys %{$self->{cond}}) {
996         $key =~ /([^.]+)$/;
997         $cond->{$1} = $self->{cond}{$key};
998       }
999     }
1000   }
1001   else {
1002     $self->throw_exception(
1003       "Can't update/delete on resultset with condition unless hash or array"
1004     );
1005   }
1006
1007   return $cond;
1008 }
1009
1010
1011 =head2 update
1012
1013 =over 4
1014
1015 =item Arguments: \%values
1016
1017 =item Return Value: $storage_rv
1018
1019 =back
1020
1021 Sets the specified columns in the resultset to the supplied values in a
1022 single query. Return value will be true if the update succeeded or false
1023 if no records were updated; exact type of success value is storage-dependent.
1024
1025 =cut
1026
1027 sub update {
1028   my ($self, $values) = @_;
1029   $self->throw_exception("Values for update must be a hash")
1030     unless ref $values eq 'HASH';
1031
1032   my $cond = $self->_cond_for_update_delete;
1033
1034   return $self->result_source->storage->update(
1035     $self->result_source->from, $values, $cond
1036   );
1037 }
1038
1039 =head2 update_all
1040
1041 =over 4
1042
1043 =item Arguments: \%values
1044
1045 =item Return Value: 1
1046
1047 =back
1048
1049 Fetches all objects and updates them one at a time. Note that C<update_all>
1050 will run DBIC cascade triggers, while L</update> will not.
1051
1052 =cut
1053
1054 sub update_all {
1055   my ($self, $values) = @_;
1056   $self->throw_exception("Values for update must be a hash")
1057     unless ref $values eq 'HASH';
1058   foreach my $obj ($self->all) {
1059     $obj->set_columns($values)->update;
1060   }
1061   return 1;
1062 }
1063
1064 =head2 delete
1065
1066 =over 4
1067
1068 =item Arguments: none
1069
1070 =item Return Value: 1
1071
1072 =back
1073
1074 Deletes the contents of the resultset from its result source. Note that this
1075 will not run DBIC cascade triggers. See L</delete_all> if you need triggers
1076 to run.
1077
1078 =cut
1079
1080 sub delete {
1081   my ($self) = @_;
1082
1083   my $cond = $self->_cond_for_update_delete;
1084
1085   $self->result_source->storage->delete($self->result_source->from, $cond);
1086   return 1;
1087 }
1088
1089 =head2 delete_all
1090
1091 =over 4
1092
1093 =item Arguments: none
1094
1095 =item Return Value: 1
1096
1097 =back
1098
1099 Fetches all objects and deletes them one at a time. Note that C<delete_all>
1100 will run DBIC cascade triggers, while L</delete> will not.
1101
1102 =cut
1103
1104 sub delete_all {
1105   my ($self) = @_;
1106   $_->delete for $self->all;
1107   return 1;
1108 }
1109
1110 =head2 pager
1111
1112 =over 4
1113
1114 =item Arguments: none
1115
1116 =item Return Value: $pager
1117
1118 =back
1119
1120 Return Value a L<Data::Page> object for the current resultset. Only makes
1121 sense for queries with a C<page> attribute.
1122
1123 =cut
1124
1125 sub pager {
1126   my ($self) = @_;
1127   my $attrs = $self->{attrs};
1128   $self->throw_exception("Can't create pager for non-paged rs")
1129     unless $self->{attrs}{page};
1130   $attrs->{rows} ||= 10;
1131   return $self->{pager} ||= Data::Page->new(
1132     $self->_count, $attrs->{rows}, $self->{attrs}{page});
1133 }
1134
1135 =head2 page
1136
1137 =over 4
1138
1139 =item Arguments: $page_number
1140
1141 =item Return Value: $rs
1142
1143 =back
1144
1145 Returns a resultset for the $page_number page of the resultset on which page
1146 is called, where each page contains a number of rows equal to the 'rows'
1147 attribute set on the resultset (10 by default).
1148
1149 =cut
1150
1151 sub page {
1152   my ($self, $page) = @_;
1153   return (ref $self)->new($self->result_source, { %{$self->{attrs}}, page => $page });
1154 }
1155
1156 =head2 new_result
1157
1158 =over 4
1159
1160 =item Arguments: \%vals
1161
1162 =item Return Value: $object
1163
1164 =back
1165
1166 Creates an object in the resultset's result class and returns it.
1167
1168 =cut
1169
1170 sub new_result {
1171   my ($self, $values) = @_;
1172   $self->throw_exception( "new_result needs a hash" )
1173     unless (ref $values eq 'HASH');
1174   $self->throw_exception(
1175     "Can't abstract implicit construct, condition not a hash"
1176   ) if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
1177   my %new = %$values;
1178   my $alias = $self->{attrs}{alias};
1179   foreach my $key (keys %{$self->{cond}||{}}) {
1180     $new{$1} = $self->{cond}{$key} if ($key =~ m/^(?:\Q${alias}.\E)?([^.]+)$/);
1181   }
1182   my $obj = $self->result_class->new(\%new);
1183   $obj->result_source($self->result_source) if $obj->can('result_source');
1184   return $obj;
1185 }
1186
1187 =head2 find_or_new
1188
1189 =over 4
1190
1191 =item Arguments: \%vals, \%attrs?
1192
1193 =item Return Value: $object
1194
1195 =back
1196
1197 Find an existing record from this resultset. If none exists, instantiate a new
1198 result object and return it. The object will not be saved into your storage
1199 until you call L<DBIx::Class::Row/insert> on it.
1200
1201 If you want objects to be saved immediately, use L</find_or_create> instead.
1202
1203 =cut
1204
1205 sub find_or_new {
1206   my $self     = shift;
1207   my $attrs    = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1208   my $hash     = ref $_[0] eq 'HASH' ? shift : {@_};
1209   my $exists   = $self->find($hash, $attrs);
1210   return defined $exists ? $exists : $self->new_result($hash);
1211 }
1212
1213 =head2 create
1214
1215 =over 4
1216
1217 =item Arguments: \%vals
1218
1219 =item Return Value: $object
1220
1221 =back
1222
1223 Inserts a record into the resultset and returns the object representing it.
1224
1225 Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
1226
1227 =cut
1228
1229 sub create {
1230   my ($self, $attrs) = @_;
1231   $self->throw_exception( "create needs a hashref" )
1232     unless ref $attrs eq 'HASH';
1233   return $self->new_result($attrs)->insert;
1234 }
1235
1236 =head2 find_or_create
1237
1238 =over 4
1239
1240 =item Arguments: \%vals, \%attrs?
1241
1242 =item Return Value: $object
1243
1244 =back
1245
1246   $class->find_or_create({ key => $val, ... });
1247
1248 Tries to find a record based on its primary key or unique constraint; if none
1249 is found, creates one and returns that instead.
1250
1251   my $cd = $schema->resultset('CD')->find_or_create({
1252     cdid   => 5,
1253     artist => 'Massive Attack',
1254     title  => 'Mezzanine',
1255     year   => 2005,
1256   });
1257
1258 Also takes an optional C<key> attribute, to search by a specific key or unique
1259 constraint. For example:
1260
1261   my $cd = $schema->resultset('CD')->find_or_create(
1262     {
1263       artist => 'Massive Attack',
1264       title  => 'Mezzanine',
1265     },
1266     { key => 'cd_artist_title' }
1267   );
1268
1269 See also L</find> and L</update_or_create>. For information on how to declare
1270 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1271
1272 =cut
1273
1274 sub find_or_create {
1275   my $self     = shift;
1276   my $attrs    = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1277   my $hash     = ref $_[0] eq 'HASH' ? shift : {@_};
1278   my $exists   = $self->find($hash, $attrs);
1279   return defined $exists ? $exists : $self->create($hash);
1280 }
1281
1282 =head2 update_or_create
1283
1284 =over 4
1285
1286 =item Arguments: \%col_values, { key => $unique_constraint }?
1287
1288 =item Return Value: $object
1289
1290 =back
1291
1292   $class->update_or_create({ col => $val, ... });
1293
1294 First, searches for an existing row matching one of the unique constraints
1295 (including the primary key) on the source of this resultset. If a row is
1296 found, updates it with the other given column values. Otherwise, creates a new
1297 row.
1298
1299 Takes an optional C<key> attribute to search on a specific unique constraint.
1300 For example:
1301
1302   # In your application
1303   my $cd = $schema->resultset('CD')->update_or_create(
1304     {
1305       artist => 'Massive Attack',
1306       title  => 'Mezzanine',
1307       year   => 1998,
1308     },
1309     { key => 'cd_artist_title' }
1310   );
1311
1312 If no C<key> is specified, it searches on all unique constraints defined on the
1313 source, including the primary key.
1314
1315 If the C<key> is specified as C<primary>, it searches only on the primary key.
1316
1317 See also L</find> and L</find_or_create>. For information on how to declare
1318 unique constraints, see L<DBIx::Class::ResultSource/add_unique_constraint>.
1319
1320 =cut
1321
1322 sub update_or_create {
1323   my $self = shift;
1324   my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
1325   my $cond = ref $_[0] eq 'HASH' ? shift : {@_};
1326
1327   my $row = $self->find($cond);
1328   if (defined $row) {
1329     $row->update($cond);
1330     return $row;
1331   }
1332
1333   return $self->create($cond);
1334 }
1335
1336 =head2 get_cache
1337
1338 =over 4
1339
1340 =item Arguments: none
1341
1342 =item Return Value: \@cache_objects?
1343
1344 =back
1345
1346 Gets the contents of the cache for the resultset, if the cache is set.
1347
1348 =cut
1349
1350 sub get_cache {
1351   shift->{all_cache};
1352 }
1353
1354 =head2 set_cache
1355
1356 =over 4
1357
1358 =item Arguments: \@cache_objects
1359
1360 =item Return Value: \@cache_objects
1361
1362 =back
1363
1364 Sets the contents of the cache for the resultset. Expects an arrayref
1365 of objects of the same class as those produced by the resultset. Note that
1366 if the cache is set the resultset will return the cached objects rather
1367 than re-querying the database even if the cache attr is not set.
1368
1369 =cut
1370
1371 sub set_cache {
1372   my ( $self, $data ) = @_;
1373   $self->throw_exception("set_cache requires an arrayref")
1374       if defined($data) && (ref $data ne 'ARRAY');
1375   $self->{all_cache} = $data;
1376 }
1377
1378 =head2 clear_cache
1379
1380 =over 4
1381
1382 =item Arguments: none
1383
1384 =item Return Value: []
1385
1386 =back
1387
1388 Clears the cache for the resultset.
1389
1390 =cut
1391
1392 sub clear_cache {
1393   shift->set_cache(undef);
1394 }
1395
1396 =head2 related_resultset
1397
1398 =over 4
1399
1400 =item Arguments: $relationship_name
1401
1402 =item Return Value: $resultset
1403
1404 =back
1405
1406 Returns a related resultset for the supplied relationship name.
1407
1408   $artist_rs = $schema->resultset('CD')->related_resultset('Artist');
1409
1410 =cut
1411
1412 sub related_resultset {
1413   my ($self, $rel) = @_;
1414
1415   $self->{related_resultsets} ||= {};
1416   return $self->{related_resultsets}{$rel} ||= do {
1417     my $rel_obj = $self->result_source->relationship_info($rel);
1418
1419     $self->throw_exception(
1420       "search_related: result source '" . $self->result_source->name .
1421         "' has no such relationship $rel")
1422       unless $rel_obj;
1423     
1424     my $rs = $self->search(undef, { join => $rel });
1425     my ($from,$seen) = $rs->_resolve_from;
1426
1427     my $join_count = $self->{attrs}{seen_join}{$rel};
1428     my $alias = $join_count ? join('_', $rel, $join_count+1) : $rel;
1429
1430     $self->result_source->schema->resultset($rel_obj->{class})->search_rs(
1431       undef, {
1432         select => undef,
1433         as => undef,
1434         alias => $alias,
1435         where => $self->{cond},
1436         _parent_from => $from,
1437         seen_join => $seen,
1438     });
1439   };
1440 }
1441
1442 sub _resolve_from {
1443   my ($self) = @_;
1444   my $source = $self->result_source;
1445   my $attrs = $self->{attrs};
1446   
1447   my $from = $attrs->{_parent_from}
1448     || [ { $attrs->{alias} => $source->from } ];
1449 #    ? [ @{$attrs->{_parent_from}} ]
1450 #    : undef;
1451     
1452   my $seen = { %{$attrs->{seen_join}||{}} };
1453
1454   if ($attrs->{join}) {
1455     push(@{$from}, 
1456       $source->resolve_join($attrs->{join}, $attrs->{alias}, $seen)
1457     );
1458   }
1459
1460   return ($from,$seen);
1461 }
1462
1463 sub _resolved_attrs {
1464   my $self = shift;
1465   return $self->{_attrs} if $self->{_attrs};
1466
1467   my $attrs = { %{$self->{attrs}||{}} };
1468   my $source = $self->{result_source};
1469   my $alias = $attrs->{alias};
1470
1471   # XXX - lose storable dclone
1472   my $record_filter = delete $attrs->{record_filter};
1473   #$attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } };
1474
1475   $attrs->{record_filter} = $record_filter if $record_filter;
1476
1477   $attrs->{columns} ||= delete $attrs->{cols} if exists $attrs->{cols};
1478   if ($attrs->{columns}) {
1479     delete $attrs->{as};
1480   } elsif (!$attrs->{select}) {
1481     $attrs->{columns} = [ $self->{result_source}->columns ];
1482   }
1483   
1484   $attrs->{select} ||= [
1485     map { m/\./ ? $_ : "${alias}.$_" } @{delete $attrs->{columns}}
1486   ];
1487   $attrs->{as} ||= [
1488     map { m/^\Q${alias}.\E(.+)$/ ? $1 : $_ } @{$attrs->{select}}
1489   ];
1490   
1491   my $adds;
1492   if ($adds = delete $attrs->{include_columns}) {
1493     $adds = [$adds] unless ref $adds eq 'ARRAY';
1494     push(@{$attrs->{select}}, @$adds);
1495     push(@{$attrs->{as}}, map { m/([^.]+)$/; $1 } @$adds);
1496   }
1497   if ($adds = delete $attrs->{'+select'}) {
1498     $adds = [$adds] unless ref $adds eq 'ARRAY';
1499     push(@{$attrs->{select}}, map { /\./ || ref $_ ? $_ : "${alias}.$_" } @$adds);
1500   }
1501   if (my $adds = delete $attrs->{'+as'}) {
1502     $adds = [$adds] unless ref $adds eq 'ARRAY';
1503     push(@{$attrs->{as}}, @$adds);
1504   }
1505
1506   $attrs->{from} ||= delete $attrs->{_parent_from}
1507     || [ { 'me' => $source->from } ];
1508
1509   if (exists $attrs->{join} || exists $attrs->{prefetch}) {
1510
1511     my $join = delete $attrs->{join} || {};
1512
1513     if (defined $attrs->{prefetch}) {
1514       $join = $self->_merge_attr(
1515         $join, $attrs->{prefetch}
1516       );
1517     }
1518
1519     push(@{$attrs->{from}},
1520       $source->resolve_join($join, $alias, { %{$attrs->{seen_join}||{}} })
1521     );
1522   }
1523
1524   $attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
1525   if ($attrs->{order_by}) {
1526     $attrs->{order_by} = [ $attrs->{order_by} ] unless ref $attrs->{order_by};    
1527   } else {
1528     $attrs->{order_by} ||= [];    
1529   }
1530
1531   my $collapse = $attrs->{collapse} || {};
1532   if (my $prefetch = delete $attrs->{prefetch}) {
1533     my @pre_order;
1534     foreach my $p (ref $prefetch eq 'ARRAY' ? @$prefetch : ($prefetch)) {
1535       # bring joins back to level of current class
1536       my @prefetch = $source->resolve_prefetch(
1537         $p, $alias, { %{$attrs->{seen_join}||{}} }, \@pre_order, $collapse
1538       );
1539       push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
1540       push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
1541     }
1542     push(@{$attrs->{order_by}}, @pre_order);
1543   }
1544   $attrs->{collapse} = $collapse;
1545
1546   return $self->{_attrs} = $attrs;
1547 }
1548
1549 sub _merge_attr {
1550   my ($self, $a, $b) = @_;
1551   return $b unless $a;
1552   
1553   if (ref $b eq 'HASH' && ref $a eq 'HASH') {
1554     foreach my $key (keys %{$b}) {
1555       if (exists $a->{$key}) {
1556         $a->{$key} = $self->_merge_attr($a->{$key}, $b->{$key});
1557       } else {
1558         $a->{$key} = $b->{$key};
1559       }
1560     }
1561     return $a;
1562   } else {
1563     $a = [$a] unless ref $a eq 'ARRAY';
1564     $b = [$b] unless ref $b eq 'ARRAY';
1565
1566     my $hash = {};
1567     my @array;
1568     foreach my $x ($a, $b) {
1569       foreach my $element (@{$x}) {
1570         if (ref $element eq 'HASH') {
1571           $hash = $self->_merge_attr($hash, $element);
1572         } elsif (ref $element eq 'ARRAY') {
1573           push(@array, @{$element});
1574         } else {
1575           push(@array, $element) unless $b == $x
1576             && grep { $_ eq $element } @array;
1577         }
1578       }
1579     }
1580     
1581     @array = grep { !exists $hash->{$_} } @array;
1582
1583     return keys %{$hash}
1584       ? ( scalar(@array)
1585             ? [$hash, @array]
1586             : $hash
1587         )
1588       : \@array;
1589   }
1590 }
1591
1592 =head2 throw_exception
1593
1594 See L<DBIx::Class::Schema/throw_exception> for details.
1595
1596 =cut
1597
1598 sub throw_exception {
1599   my $self=shift;
1600   $self->result_source->schema->throw_exception(@_);
1601 }
1602
1603 # XXX: FIXME: Attributes docs need clearing up
1604
1605 =head1 ATTRIBUTES
1606
1607 The resultset takes various attributes that modify its behavior. Here's an
1608 overview of them:
1609
1610 =head2 order_by
1611
1612 =over 4
1613
1614 =item Value: ($order_by | \@order_by)
1615
1616 =back
1617
1618 Which column(s) to order the results by. This is currently passed
1619 through directly to SQL, so you can give e.g. C<year DESC> for a
1620 descending order on the column `year'.
1621
1622 Please note that if you have quoting enabled (see
1623 L<DBIx::Class::Storage/quote_char>) you will need to do C<\'year DESC' > to
1624 specify an order. (The scalar ref causes it to be passed as raw sql to the DB,
1625 so you will need to manually quote things as appropriate.)
1626
1627 =head2 columns
1628
1629 =over 4
1630
1631 =item Value: \@columns
1632
1633 =back
1634
1635 Shortcut to request a particular set of columns to be retrieved.  Adds
1636 C<me.> onto the start of any column without a C<.> in it and sets C<select>
1637 from that, then auto-populates C<as> from C<select> as normal. (You may also
1638 use the C<cols> attribute, as in earlier versions of DBIC.)
1639
1640 =head2 include_columns
1641
1642 =over 4
1643
1644 =item Value: \@columns
1645
1646 =back
1647
1648 Shortcut to include additional columns in the returned results - for example
1649
1650   $schema->resultset('CD')->search(undef, {
1651     include_columns => ['artist.name'],
1652     join => ['artist']
1653   });
1654
1655 would return all CDs and include a 'name' column to the information
1656 passed to object inflation
1657
1658 =head2 select
1659
1660 =over 4
1661
1662 =item Value: \@select_columns
1663
1664 =back
1665
1666 Indicates which columns should be selected from the storage. You can use
1667 column names, or in the case of RDBMS back ends, function or stored procedure
1668 names:
1669
1670   $rs = $schema->resultset('Employee')->search(undef, {
1671     select => [
1672       'name',
1673       { count => 'employeeid' },
1674       { sum => 'salary' }
1675     ]
1676   });
1677
1678 When you use function/stored procedure names and do not supply an C<as>
1679 attribute, the column names returned are storage-dependent. E.g. MySQL would
1680 return a column named C<count(employeeid)> in the above example.
1681
1682 =head2 +select
1683
1684 =over 4
1685
1686 Indicates additional columns to be selected from storage.  Works the same as
1687 L<select> but adds columns to the selection.
1688
1689 =back
1690
1691 =head2 +as
1692
1693 =over 4
1694
1695 Indicates additional column names for those added via L<+select>.
1696
1697 =back
1698
1699 =head2 as
1700
1701 =over 4
1702
1703 =item Value: \@inflation_names
1704
1705 =back
1706
1707 Indicates column names for object inflation. This is used in conjunction with
1708 C<select>, usually when C<select> contains one or more function or stored
1709 procedure names:
1710
1711   $rs = $schema->resultset('Employee')->search(undef, {
1712     select => [
1713       'name',
1714       { count => 'employeeid' }
1715     ],
1716     as => ['name', 'employee_count'],
1717   });
1718
1719   my $employee = $rs->first(); # get the first Employee
1720
1721 If the object against which the search is performed already has an accessor
1722 matching a column name specified in C<as>, the value can be retrieved using
1723 the accessor as normal:
1724
1725   my $name = $employee->name();
1726
1727 If on the other hand an accessor does not exist in the object, you need to
1728 use C<get_column> instead:
1729
1730   my $employee_count = $employee->get_column('employee_count');
1731
1732 You can create your own accessors if required - see
1733 L<DBIx::Class::Manual::Cookbook> for details.
1734
1735 Please note: This will NOT insert an C<AS employee_count> into the SQL statement
1736 produced, it is used for internal access only. Thus attempting to use the accessor
1737 in an C<order_by> clause or similar will fail misrably.
1738
1739 =head2 join
1740
1741 =over 4
1742
1743 =item Value: ($rel_name | \@rel_names | \%rel_names)
1744
1745 =back
1746
1747 Contains a list of relationships that should be joined for this query.  For
1748 example:
1749
1750   # Get CDs by Nine Inch Nails
1751   my $rs = $schema->resultset('CD')->search(
1752     { 'artist.name' => 'Nine Inch Nails' },
1753     { join => 'artist' }
1754   );
1755
1756 Can also contain a hash reference to refer to the other relation's relations.
1757 For example:
1758
1759   package MyApp::Schema::Track;
1760   use base qw/DBIx::Class/;
1761   __PACKAGE__->table('track');
1762   __PACKAGE__->add_columns(qw/trackid cd position title/);
1763   __PACKAGE__->set_primary_key('trackid');
1764   __PACKAGE__->belongs_to(cd => 'MyApp::Schema::CD');
1765   1;
1766
1767   # In your application
1768   my $rs = $schema->resultset('Artist')->search(
1769     { 'track.title' => 'Teardrop' },
1770     {
1771       join     => { cd => 'track' },
1772       order_by => 'artist.name',
1773     }
1774   );
1775
1776 If the same join is supplied twice, it will be aliased to <rel>_2 (and
1777 similarly for a third time). For e.g.
1778
1779   my $rs = $schema->resultset('Artist')->search({
1780     'cds.title'   => 'Down to Earth',
1781     'cds_2.title' => 'Popular',
1782   }, {
1783     join => [ qw/cds cds/ ],
1784   });
1785
1786 will return a set of all artists that have both a cd with title 'Down
1787 to Earth' and a cd with title 'Popular'.
1788
1789 If you want to fetch related objects from other tables as well, see C<prefetch>
1790 below.
1791
1792 =head2 prefetch
1793
1794 =over 4
1795
1796 =item Value: ($rel_name | \@rel_names | \%rel_names)
1797
1798 =back
1799
1800 Contains one or more relationships that should be fetched along with the main
1801 query (when they are accessed afterwards they will have already been
1802 "prefetched").  This is useful for when you know you will need the related
1803 objects, because it saves at least one query:
1804
1805   my $rs = $schema->resultset('Tag')->search(
1806     undef,
1807     {
1808       prefetch => {
1809         cd => 'artist'
1810       }
1811     }
1812   );
1813
1814 The initial search results in SQL like the following:
1815
1816   SELECT tag.*, cd.*, artist.* FROM tag
1817   JOIN cd ON tag.cd = cd.cdid
1818   JOIN artist ON cd.artist = artist.artistid
1819
1820 L<DBIx::Class> has no need to go back to the database when we access the
1821 C<cd> or C<artist> relationships, which saves us two SQL statements in this
1822 case.
1823
1824 Simple prefetches will be joined automatically, so there is no need
1825 for a C<join> attribute in the above search. If you're prefetching to
1826 depth (e.g. { cd => { artist => 'label' } or similar), you'll need to
1827 specify the join as well.
1828
1829 C<prefetch> can be used with the following relationship types: C<belongs_to>,
1830 C<has_one> (or if you're using C<add_relationship>, any relationship declared
1831 with an accessor type of 'single' or 'filter').
1832
1833 =head2 page
1834
1835 =over 4
1836
1837 =item Value: $page
1838
1839 =back
1840
1841 Makes the resultset paged and specifies the page to retrieve. Effectively
1842 identical to creating a non-pages resultset and then calling ->page($page)
1843 on it.
1844
1845 If L<rows> attribute is not specified it defualts to 10 rows per page.
1846
1847 =head2 rows
1848
1849 =over 4
1850
1851 =item Value: $rows
1852
1853 =back
1854
1855 Specifes the maximum number of rows for direct retrieval or the number of
1856 rows per page if the page attribute or method is used.
1857
1858 =head2 offset
1859
1860 =over 4
1861
1862 =item Value: $offset
1863
1864 =back
1865
1866 Specifies the (zero-based) row number for the  first row to be returned, or the
1867 of the first row of the first page if paging is used.
1868
1869 =head2 group_by
1870
1871 =over 4
1872
1873 =item Value: \@columns
1874
1875 =back
1876
1877 A arrayref of columns to group by. Can include columns of joined tables.
1878
1879   group_by => [qw/ column1 column2 ... /]
1880
1881 =head2 having
1882
1883 =over 4
1884
1885 =item Value: $condition
1886
1887 =back
1888
1889 HAVING is a select statement attribute that is applied between GROUP BY and
1890 ORDER BY. It is applied to the after the grouping calculations have been
1891 done.
1892
1893   having => { 'count(employee)' => { '>=', 100 } }
1894
1895 =head2 distinct
1896
1897 =over 4
1898
1899 =item Value: (0 | 1)
1900
1901 =back
1902
1903 Set to 1 to group by all columns.
1904
1905 =head2 where
1906
1907 =over 4
1908
1909 Adds to the WHERE clause.
1910
1911   # only return rows WHERE deleted IS NULL for all searches
1912   __PACKAGE__->resultset_attributes({ where => { deleted => undef } }); )
1913
1914 Can be overridden by passing C<{ where => undef }> as an attribute
1915 to a resulset.
1916
1917 =back
1918
1919 =head2 cache
1920
1921 Set to 1 to cache search results. This prevents extra SQL queries if you
1922 revisit rows in your ResultSet:
1923
1924   my $resultset = $schema->resultset('Artist')->search( undef, { cache => 1 } );
1925
1926   while( my $artist = $resultset->next ) {
1927     ... do stuff ...
1928   }
1929
1930   $rs->first; # without cache, this would issue a query
1931
1932 By default, searches are not cached.
1933
1934 For more examples of using these attributes, see
1935 L<DBIx::Class::Manual::Cookbook>.
1936
1937 =head2 from
1938
1939 =over 4
1940
1941 =item Value: \@from_clause
1942
1943 =back
1944
1945 The C<from> attribute gives you manual control over the C<FROM> clause of SQL
1946 statements generated by L<DBIx::Class>, allowing you to express custom C<JOIN>
1947 clauses.
1948
1949 NOTE: Use this on your own risk.  This allows you to shoot off your foot!
1950
1951 C<join> will usually do what you need and it is strongly recommended that you
1952 avoid using C<from> unless you cannot achieve the desired result using C<join>.
1953 And we really do mean "cannot", not just tried and failed. Attempting to use
1954 this because you're having problems with C<join> is like trying to use x86
1955 ASM because you've got a syntax error in your C. Trust us on this.
1956
1957 Now, if you're still really, really sure you need to use this (and if you're
1958 not 100% sure, ask the mailing list first), here's an explanation of how this
1959 works.
1960
1961 The syntax is as follows -
1962
1963   [
1964     { <alias1> => <table1> },
1965     [
1966       { <alias2> => <table2>, -join_type => 'inner|left|right' },
1967       [], # nested JOIN (optional)
1968       { <table1.column1> => <table2.column2>, ... (more conditions) },
1969     ],
1970     # More of the above [ ] may follow for additional joins
1971   ]
1972
1973   <table1> <alias1>
1974   JOIN
1975     <table2> <alias2>
1976     [JOIN ...]
1977   ON <table1.column1> = <table2.column2>
1978   <more joins may follow>
1979
1980 An easy way to follow the examples below is to remember the following:
1981
1982     Anything inside "[]" is a JOIN
1983     Anything inside "{}" is a condition for the enclosing JOIN
1984
1985 The following examples utilize a "person" table in a family tree application.
1986 In order to express parent->child relationships, this table is self-joined:
1987
1988     # Person->belongs_to('father' => 'Person');
1989     # Person->belongs_to('mother' => 'Person');
1990
1991 C<from> can be used to nest joins. Here we return all children with a father,
1992 then search against all mothers of those children:
1993
1994   $rs = $schema->resultset('Person')->search(
1995       undef,
1996       {
1997           alias => 'mother', # alias columns in accordance with "from"
1998           from => [
1999               { mother => 'person' },
2000               [
2001                   [
2002                       { child => 'person' },
2003                       [
2004                           { father => 'person' },
2005                           { 'father.person_id' => 'child.father_id' }
2006                       ]
2007                   ],
2008                   { 'mother.person_id' => 'child.mother_id' }
2009               ],
2010           ]
2011       },
2012   );
2013
2014   # Equivalent SQL:
2015   # SELECT mother.* FROM person mother
2016   # JOIN (
2017   #   person child
2018   #   JOIN person father
2019   #   ON ( father.person_id = child.father_id )
2020   # )
2021   # ON ( mother.person_id = child.mother_id )
2022
2023 The type of any join can be controlled manually. To search against only people
2024 with a father in the person table, we could explicitly use C<INNER JOIN>:
2025
2026     $rs = $schema->resultset('Person')->search(
2027         undef,
2028         {
2029             alias => 'child', # alias columns in accordance with "from"
2030             from => [
2031                 { child => 'person' },
2032                 [
2033                     { father => 'person', -join_type => 'inner' },
2034                     { 'father.id' => 'child.father_id' }
2035                 ],
2036             ]
2037         },
2038     );
2039
2040     # Equivalent SQL:
2041     # SELECT child.* FROM person child
2042     # INNER JOIN person father ON child.father_id = father.id
2043
2044 =cut
2045
2046 1;