.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DBIx::Class::Cursor 3pm"
.TH DBIx::Class::Cursor 3pm "2022-05-21" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
DBIx::Class::Cursor \- Abstract object representing a query cursor on a
resultset.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $cursor = $schema\->resultset(\*(AqCD\*(Aq)\->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;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Cursor represents a query cursor on a DBIx::Class::ResultSet object. It
allows for traversing the result set with \*(L"next\*(R", retrieving all results with
\&\*(L"all\*(R" and resetting the cursor with \*(L"reset\*(R".
.PP
Usually, you would use the cursor methods built into DBIx::Class::ResultSet
to traverse it. See \*(L"next\*(R" in DBIx::Class::ResultSet,
\&\*(L"reset\*(R" in DBIx::Class::ResultSet and \*(L"all\*(R" in DBIx::Class::ResultSet for more
information.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Virtual method. Returns a new DBIx::Class::Cursor object.
.SS "next"
.IX Subsection "next"
Virtual method. Advances the cursor to the next row. Returns an array of
column values (the result of \*(L"fetchrow_array\*(R" in \s-1DBI\s0 method).
.SS "reset"
.IX Subsection "reset"
Virtual method. Resets the cursor to the beginning.
.SS "all"
.IX Subsection "all"
Virtual method. Returns all rows in the DBIx::Class::ResultSet.
.SH "FURTHER QUESTIONS?"
.IX Header "FURTHER QUESTIONS?"
Check the list of additional \s-1DBIC\s0 resources.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This module is free software copyright
by the DBIx::Class (\s-1DBIC\s0) authors. You can
redistribute it and/or modify it under the same terms as the
DBIx::Class library.