Matt S Trout > DBIx-Class-0.08100 > DBIx::Class::Storage::DBI::Cursor

Download:
DBIx-Class-0.08100.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  11
Open  16
Stalled  11
View/Report Bugs
Source   Latest Release: DBIx-Class-0.082700_10

NAME ^

DBIx::Class::Storage::DBI::Cursor - Object representing a query cursor on a resultset.

SYNOPSIS ^

  my $cursor = $schema->resultset('CD')->cursor();
  my $first_cd = $cursor->next;

DESCRIPTION ^

A Cursor represents a query cursor on a DBIx::Class::ResultSet object. It allows for traversing the result set with "next", retrieving all results with "all" and resetting the cursor with "reset".

Usually, you would use the cursor methods built into DBIx::Class::ResultSet to traverse it. See "next" in DBIx::Class::ResultSet, "reset" in DBIx::Class::ResultSet and "all" in DBIx::Class::ResultSet for more information.

METHODS ^

new

Returns a new DBIx::Class::Storage::DBI::Cursor object.

as_query

Arguments: none
Return Value: \[ $sql, @bind ]

Returns the SQL statement and bind vars associated with the invocant.

next

Arguments: none
Return Value: \@row_columns

Advances the cursor to the next row and returns an array of column values (the result of "fetchrow_array" in DBI method).

all

Arguments: none
Return Value: \@row_columns+

Returns a list of arrayrefs of column values for all rows in the DBIx::Class::ResultSet.

reset

Resets the cursor to the beginning of the DBIx::Class::ResultSet.

syntax highlighting: