--- /dev/null
+=head1 DBIx::Class Cookbook
+
+=over 4
+
+=item Input validation.
+
+=item Using joins
+
+=item Many-to-many relationships
+
+This is not as easy as it could be, but it's possible. Here's an example to
+illustrate:
+
+ package Base;
+
+ use base qw/DBIx::Class/;
+
+ __PACKAGE__->load_components(qw/Core DB/);
+ __PACKAGE__->connection(...);
+
+ package Left;
+
+ use base qw/Base/;
+
+ __PACKAGE__->table('left');
+ __PACKAGE__->add_columns(qw/id left_stuff/);
+ __PACKAGE__->set_primary_key(qw/id/);
+ __PACKAGE__->has_many('mid' => 'Mid');
+
+ sub right {
+ my ($self) = @_;
+ return Right->search(
+ { 'left.id' => $self->id },
+ { join => { 'mid' => 'left' }});
+ }
+
+ package Mid;
+
+ use base qw/Base/;
+
+ __PACKAGE__->table('mid');
+ __PACKAGE__->add_columns(qw/left right/);
+ __PACKAGE__->set_primary_key(qw/left right/);
+
+ __PACKAGE__->belongs_to('left' => 'Left');
+ __PACKAGE__->belongs_to('right' => 'Right');
+
+ package Right;
+
+ use base qw/Base/;
+
+ __PACKAGE__->table('right');
+ __PACKAGE__->add_columns(qw/id right_stuff/);
+ __PACKAGE__->set_primary_key(qw/id/);
+ __PACKAGE__->has_many('mid' => 'Mid');
+
+ sub left {
+ my ($self) = @_;
+ return Left->search(
+ { 'right.id' => $self->id },
+ { join => { 'mid' => 'right' });
+ }
+
+=item Advanced Exception handling
+
+=item Transactions
+
+=back
fallback => 1;
use Data::Page;
+=head1 NAME
+
+DBIX::Class::Recordset - Responsible for fetching and creating recordsets.
+
+=head1 SYNOPSIS;
+
+$rs=MyApp::DB::Class->search(registered=>1);
+
+=head1 DESCRIPTION
+
+The recordset is also know as an iterator.
+
+=head1 METHODS
+
+=over 4
+
+=item new <db_class> <attrs>
+
+The recordset constructor. Takes a db class and an
+attribute hash (see below for more info on attributes)
+
+=cut
+
sub new {
my ($it_class, $db_class, $attrs) = @_;
#use Data::Dumper; warn Dumper(@_);
return $new;
}
+=item cursor
+
+Return a storage driven cursor to the given record set.
+
+=cut
+
sub cursor {
my ($self) = @_;
my ($db_class, $attrs) = @{$self}{qw/class attrs/};
$attrs->{where},$attrs);
}
+=item slice <first> <last>
+
+return a number of elements from the given record set.
+
+=cut
+
sub slice {
my ($self, $min, $max) = @_;
my $attrs = { %{ $self->{attrs} || {} } };
return (wantarray ? $slice->all : $slice);
}
+=item next
+
+Returns the next element in this record set.
+
+=cut
+
sub next {
my ($self) = @_;
my @row = $self->cursor->next;
return $new;
}
+=item count
+
+Performs an SQL count with the same query as the resultset was built
+with to find the number of elements.
+
+=cut
+
+
sub count {
my ($self) = @_;
my $db_class = $self->{class};
: $self->{count};
}
+=item all
+
+Returns all elements in the recordset. Is called implictly if the search
+method is used in list context.
+
+=cut
+
sub all {
my ($self) = @_;
return map { $self->_construct_object(@$_); }
$self->cursor->all;
}
+=item reset
+
+Reset this recordset's cursor, so you can iterate through the elements again.
+
+=cut
+
sub reset {
my ($self) = @_;
$self->cursor->reset;
return $self;
}
+=item first
+
+resets the recordset and returns the first element.
+
+=cut
+
sub first {
return $_[0]->reset->next;
}
+=item delete
+
+Deletes all elements in the recordset.
+
+=cut
+
sub delete {
my ($self) = @_;
$_->delete for $self->all;
*delete_all = \&delete; # Yeah, yeah, yeah ...
+=item pager
+
+Returns a L<Data::Page> object for the current resultset. Only makes
+sense for queries with page turned on.
+
+=cut
+
sub pager {
my ($self) = @_;
my $attrs = $self->{attrs};
return $self->{pager};
}
+=item page <page>
+
+Returns a new recordset representing a given page.
+
+=cut
+
sub page {
my ($self, $page) = @_;
my $attrs = $self->{attrs};
return $self->new($self->{class}, $attrs);
}
-=head1 NAME
-
-DBIX::Class::Recordset - Responsible for fetching and creating recordsets.
-
-=head1 SYNOPSIS;
-
-$rs=MyApp::DB::Class->search(registered=>1);
-
+=back
=head1 Attributes
=item order_by
Which column to order the results by.
+
+=item cols
+
+Which cols should be retrieved on the first search.
+
+=item join
+
+Contains a list of relations that should be joined for this query. Can also
+contain a hash referece to refer to that relation's relations.
+
+=item from
+
+This attribute can contain a arrayref of elements. each element can be another
+arrayref, to nest joins, or it can be a hash which represents the two sides
+of the join.
+
+*NOTE* Use this on your own risk. This allows you to shoot your foot off!
+
=item page
Should the resultset be paged? This can also be enabled by using the
For paged resultsset, which page to start on.
+=item accesor
+
+Tells the recordset how to prefetch relations. Can either be 'single' or
+'filter'.
+
=back
1;
projects / dbsrgits/DBIx-Class.git / commitdiff