Restore ability to handle underdefined root (t/prefetch/incomplete.t)
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Cursor.pm
index 065e195..2031ac4 100644 (file)
@@ -3,6 +3,8 @@ package DBIx::Class::Cursor;
 use strict;
 use warnings;
 
+use base qw/DBIx::Class/;
+
 =head1 NAME
 
 DBIx::Class::Cursor - Abstract object representing a query cursor on a
@@ -11,7 +13,12 @@ resultset.
 =head1 SYNOPSIS
 
   my $cursor = $schema->resultset('CD')->cursor();
-  my $first_cd = $cursor->next;
+
+  # raw values off the database handle in resultset columns/select order
+  my @next_cd_column_values = $cursor->next;
+
+  # list of all raw values as arrayrefs
+  my @all_cds_column_values = $cursor->all;
 
 =head1 DESCRIPTION
 
@@ -28,8 +35,6 @@ information.
 
 =head2 new
 
-=back
-
 Virtual method. Returns a new L<DBIx::Class::Cursor> object.
 
 =cut
@@ -40,9 +45,8 @@ sub new {
 
 =head2 next
 
-=back
-
-Virtual method. Advances the cursor to the next row.
+Virtual method. Advances the cursor to the next row. Returns an array of
+column values (the result of L<DBI/fetchrow_array> method).
 
 =cut
 
@@ -52,8 +56,6 @@ sub next {
 
 =head2 reset
 
-=back
-
 Virtual method. Resets the cursor to the beginning.
 
 =cut
@@ -64,8 +66,6 @@ sub reset {
 
 =head2 all
 
-=back
-
 Virtual method. Returns all rows in the L<DBIx::Class::ResultSet>.
 
 =cut