=head1 METHODS
-=head2 new
+=head2 new
=over 4
-=item Arguments: ($source, \%$attrs)
+=item Arguments: $source, \%$attrs
+
+=item Return Value: $rs
+
+=item
=back
my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
+IMPORTANT: If called on an object, proxies to new_result instead so
+
+ my $cd = $schema->resultset('CD')->new({ title => 'Spoon' });
+
+will return a CD object, not a ResultSet.
+
=cut
sub new {
=over 4
-=item Arguments: (\%cond?, \%attrs?)
+=item Arguments: $cond, \%attrs?
-=item Returns: $resultset (scalar context), @row_objs (list context)
+=item Return Value: $resultset (scalar context), @row_objs (list context)
=back
my @cds = $cd_rs->search({ year => 2001 }); # "... WHERE year = 2001"
my $new_rs = $cd_rs->search({ year => 2005 });
+ my $new_rs = $cd_rs->search([ { year => 2005 }, { year => 2004 } ]);
+ # year = 2005 OR year = 2004
+
If you need to pass in additional attributes but no additional condition,
call it as C<search(undef, \%attrs);>.
=over 4
-=item Arguments: ($literal_cond, @bind?)
+=item Arguments: $sql_fragment, @bind_values
-=item Returns: $resultset (scalar context), @row_objs (list context)
+=item Return Value: $resultset (scalar context), @row_objs (list context)
=back
=over 4
-=item Arguments: (@colvalues) | (\%cols, \%attrs?)
+=item Arguments: (@values | \%cols), \%attrs?
-=item Returns: $row_object
+=item Return Value: $row_object
=back
=over 4
-=item Arguments: (\%cond?, \%attrs?)
+=item Arguments: $cond, \%attrs?
-=item Returns: $new_resultset
+=item Return Value: $new_resultset
=back
=over 4
-=item Arguments: (none)
+=item Arguments: none
-=item Returns: $cursor
+=item Return Value: $cursor
=back
=over 4
-=item Arguments: (\%cond)
+=item Arguments: $cond?
-=item Returns: $row_object
+=item Return Value: $row_object?
=back
my $cd = $schema->resultset('CD')->single({ year => 2001 });
-Inflates the first result without creating a cursor.
+Inflates the first result without creating a cursor if the resultset has
+any records in it; if not returns nothing. Used by find() as an optimisation.
=cut
=over 4
-=item Arguments: (\%cond?, \%attrs?)
+=item Arguments: $cond, \%attrs?
-=item Returns: $resultset (scalar context), @row_objs (list context)
+=item Return Value: $resultset (scalar context), @row_objs (list context)
=back
=over 4
-=item Arguments: ($first, $last)
+=item Arguments: $first, $last
-=item Returns: $resultset (scalar context), @row_objs (list context)
+=item Return Value: $resultset (scalar context), @row_objs (list context)
=back
-Returns a subset of elements from the resultset.
+Returns a resultset or object list representing a subset of elements from the
+resultset slice is called on. Indexes are from 0 - i.e. to get the first
+three records, call
+
+ my ($one, $two, $three) = $rs->slice(0, 2);
=cut
=head2 next
+=over 4
+
+=item Arguments: none
+
+=item Return Value: $result?
+
+=back
+
Returns the next element in the resultset (C<undef> is there is none).
Can be used to efficiently iterate over records in the resultset:
=head2 result_source
-Returns a reference to the result source for this recordset.
+=over 4
+
+=item Arguments: $result_source?
+
+=item Return Value: $result_source
+
+=back
+
+An accessor for the primary ResultSource object from which this ResultSet
+is derived.
=cut
=head2 count
+=over 4
+
+=item Arguments: ($cond, \%attrs?)?
+
+=item Return Value: $count
+
+=back
+
Performs an SQL C<COUNT> with the same query as the resultset was built
with to find the number of elements. If passed arguments, does a search
on the resultset and counts the results of that.
=head2 count_literal
+=over 4
+
+=item Arguments: $sql_fragment, @bind_values
+
+=item Return Value: $count
+
+=back
+
Counts the results in a literal query. Equivalent to calling L</search_literal>
with the passed arguments, then L</count>.
=head2 all
+=over 4
+
+=item Arguments: none
+
+=item Return Value: @objects
+
+=back
+
Returns all elements in the resultset. Called implicitly if the resultset
is returned in list context.
=head2 reset
+=over 4
+
+=item Arguments: none
+
+=item Return Value: $self
+
+=back
+
Resets the resultset's cursor, so you can iterate through the elements again.
=cut
=head2 first
-Resets the resultset and returns the first element.
+=over 4
+
+=item Arguments: none
+
+=item Return Value: $object?
+
+=back
+
+Resets the resultset and returns an object for the first result (if the
+resultset contains anything).
=cut
=over 4
-=item Arguments: (\%values)
+=item Arguments: \%values
+
+=item Return Value: $storage_rv
=back
-Sets the specified columns in the resultset to the supplied values.
+Sets the specified columns in the resultset to the supplied values in a
+single query. Return value will be true if the update succeeded or false
+if no records were updated; exact type of success value is storage-dependent.
=cut
=over 4
-=item Arguments: (\%values)
+=item Arguments: \%values
+
+=item Return Value: 1
=back
=head2 delete
+=over 4
+
+=item Arguments: none
+
+=item Return Value: 1
+
+=back
+
Deletes the contents of the resultset from its result source. Note that this
will not run cascade triggers. See L</delete_all> if you need triggers to run.
=head2 delete_all
+=over 4
+
+=item Arguments: none
+
+=item Return Value: 1
+
+=back
+
Fetches all objects and deletes them one at a time. Note that C<delete_all>
will run cascade triggers while L</delete> will not.
=head2 pager
-Returns a L<Data::Page> object for the current resultset. Only makes
+=over 4
+
+=item Arguments: none
+
+=item Return Value: $pager
+
+=back
+
+Return Value a L<Data::Page> object for the current resultset. Only makes
sense for queries with a C<page> attribute.
=cut
=over 4
-=item Arguments: ($page_num)
+=item Arguments: $page_number
+
+=item Return Value: $rs
=back
-Returns a new resultset for the specified page.
+Returns a resultset for the $page_number page of the resultset on which page
+is called, where each page contains a number of rows equal to the 'rows'
+attribute set on the resultset, or 10 by default
=cut
=over 4
-=item Arguments: (\%vals)
+=item Arguments: \%vals
+
+=item Return Value: $object
=back
-Creates a result in the resultset's result class.
+Creates an object in the resultset's result class and returns it.
=cut
=over 4
-=item Arguments: (\%vals)
+=item Arguments: \%vals
+
+=item Return Value: $object
=back
-Inserts a record into the resultset and returns the object.
+Inserts a record into the resultset and returns the object representing it.
Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
=over 4
-=item Arguments: (\%vals, \%attrs?)
+=item Arguments: \%vals, \%attrs?
+
+=item Return Value: $object
=back
=head2 update_or_create
- $class->update_or_create({ key => $val, ... });
+=over 4
+
+=item Arguments: \%col_values, { key => $unique_constraint }?
+
+=item Return Value: $object
+
+=back
+
+ $class->update_or_create({ col => $val, ... });
First, search for an existing row matching one of the unique constraints
(including the primary key) on the source of this resultset. If a row is
=head2 get_cache
-Gets the contents of the cache for the resultset.
+=over 4
+
+=item Arguments: none
+
+=item Return Value: \@cache_objects?
+
+=back
+
+Gets the contents of the cache for the resultset if the cache is set
=cut
=head2 set_cache
+=over 4
+
+=item Arguments: \@cache_objects
+
+=item Return Value: \@cache_objects
+
+=back
+
Sets the contents of the cache for the resultset. Expects an arrayref
-of objects of the same class as those produced by the resultset.
+of objects of the same class as those produced by the resultset. Note that
+if the cache is set the resultset will return the cached objects rather
+than re-querying the database even if the cache attr is not set.
=cut
=head2 clear_cache
+=over 4
+
+=item Arguments: none
+
+=item Return Value: []
+
+=back
+
Clears the cache for the resultset.
=cut
=head2 related_resultset
+=over 4
+
+=item Arguments: $relationship_name
+
+=item Return Value: $resultset
+
+=back
+
Returns a related resultset for the supplied relationship name.
$artist_rs = $schema->resultset('CD')->related_resultset('Artist');
=cut
sub related_resultset {
- my ( $self, $rel, @rest ) = @_;
+ my ( $self, $rel ) = @_;
$self->{related_resultsets} ||= {};
return $self->{related_resultsets}{$rel} ||= do {
#warn "fetching related resultset for rel '$rel'";
alias => $alias,
select => undef,
as => undef }
- )->search(@rest);
+ );
};
}
=head2 throw_exception
-See Schema's throw_exception
+See L<DBIx::Class::Schema/throw_exception> for details.
=cut
$self->result_source->schema->throw_exception(@_);
}
-=head1 ATTRIBUTES
+# XXX: FIXME: Attributes docs need clearing up
-XXX: FIXME: Attributes docs need clearing up
+=head1 ATTRIBUTES
The resultset takes various attributes that modify its behavior. Here's an
overview of them:
=head2 order_by
+=over 4
+
+=item Value: ($order_by | \@order_by)
+
Which column(s) to order the results by. This is currently passed
through directly to SQL, so you can give e.g. C<year DESC> for a
descending order on the column `year'.
=over 4
-=item Arguments: (\@columns)
+=item Value: \@columns
=back
=over 4
-=item Arguments: (\@columns)
+=item Value: \@columns
=back
=over 4
-=item Arguments: (\@columns)
+=item Value: \@select_columns
=back
=over 4
-=item Arguments: (\@names)
+=item Value: \@inflation_names
=back
=head2 join
+=over 4
+
+=item Value: ($rel_name | \@rel_names | \%rel_names)
+
+=back
+
Contains a list of relationships that should be joined for this query. For
example:
=over 4
-=item Arguments: (\@relationships)
+=item Value: ($rel_name | \@rel_names | \%rel_names)
=back
=over 4
-=item Arguments: (\@array)
+=item Value: \@from_clause
=back
=over 4
-=item Arguments: ($page)
+=item Value: $page
=back
-For a paged resultset, specifies which page to retrieve. Leave unset
-for an unpaged resultset.
+Makes the resultset paged and specifies the page to retrieve. Effectively
+identical to creating a non-pages resultset and then calling ->page($page)
+on it.
=head2 rows
=over 4
-=item Arguments: ($rows)
+=item Value: $rows
=back
-For a paged resultset, specifies how many rows are in each page:
-
- rows => 10
-
-Can also be used to simulate an SQL C<LIMIT>.
+Specifes the maximum number of rows for direct retrieval or the number of
+rows per page if the page attribute or method is used.
=head2 group_by
=over 4
-=item Arguments: (\@columns)
+=item Value: \@columns
=back
=head2 distinct
+=over 4
+
+=item Value: (0 | 1)
+
+=back
+
Set to 1 to group by all columns.
=head2 cache
projects / dbsrgits/DBIx-Class.git / commitdiff