Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DBIx::Class::Storage::User:Contributed PerDBIx::Class::Storage::DBI::Cursor(3)

NAME
       DBIx::Class::Storage::DBI::Cursor - 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
       Returns a new DBIx::Class::Storage::DBI::Cursor object.

   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.

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.

perl v5.24.1			  2016-06-DBIx::Class::Storage::DBI::Cursor(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | FURTHER QUESTIONS? | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DBIx::Class::Storage::DBI::Cursor&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help