Scroll to navigation

DBIx::Class::Cursor(3pm) User Contributed Perl Documentation DBIx::Class::Cursor(3pm)

NAME

DBIx::Class::Cursor - Abstract object representing a query cursor on a resultset.

SYNOPSIS

  my $cursor = $schema->resultset('CD')->cursor();
  # 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;

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

Virtual method. Returns a new DBIx::Class::Cursor object.

next

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

reset

Virtual method. Resets the cursor to the beginning.

all

Virtual method. Returns all rows in the DBIx::Class::ResultSet.

FURTHER QUESTIONS?

Check the list of additional DBIC resources.

COPYRIGHT AND LICENSE

This module is free software copyright by the DBIx::Class (DBIC) authors. You can redistribute it and/or modify it under the same terms as the DBIx::Class library.

2022-05-21 perl v5.34.0