.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Mango::Cursor 3pm"
.TH Mango::Cursor 3pm "2020-06-05" "perl v5.30.3" "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"
Mango::Cursor \- MongoDB cursor
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mango::Cursor;
\&
\&  my $cursor = Mango::Cursor\->new(collection => $collection);
\&  my $docs   = $cursor\->all;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mango::Cursor is a container for MongoDB cursors used by
Mango::Collection.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
Mango::Cursor implements the following attributes.
.SS "batch_size"
.IX Subsection "batch_size"
.Vb 2
\&  my $size = $cursor\->batch_size;
\&  $cursor  = $cursor\->batch_size(10);
.Ve
.PP
Number of documents to fetch in one batch, defaults to \f(CW0\fR.
.SS "collection"
.IX Subsection "collection"
.Vb 2
\&  my $collection = $cursor\->collection;
\&  $cursor        = $cursor\->collection(Mango::Collection\->new);
.Ve
.PP
Mango::Collection object this cursor belongs to.
.SS "id"
.IX Subsection "id"
.Vb 2
\&  my $id  = $cursor\->id;
\&  $cursor = $cursor\->id(123456);
.Ve
.PP
Cursor id.
.SS "limit"
.IX Subsection "limit"
.Vb 2
\&  my $limit = $cursor\->limit;
\&  $cursor   = $cursor\->limit(10);
.Ve
.PP
Limit the number of documents, defaults to \f(CW0\fR.
.SH "METHODS"
.IX Header "METHODS"
Mango::Cursor inherits all methods from Mojo::Base and implements the
following new ones.
.SS "add_batch"
.IX Subsection "add_batch"
.Vb 1
\&  $cursor = $cursor\->add_batch($docs);
.Ve
.PP
Add batch of documents to cursor.
.SS "all"
.IX Subsection "all"
.Vb 1
\&  my $docs = $cursor\->all;
.Ve
.PP
Fetch all documents at once. You can also append a callback to perform
operation non-blocking.
.PP
.Vb 5
\&  $cursor\->all(sub {
\&    my ($cursor, $err, $docs) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "next"
.IX Subsection "next"
.Vb 1
\&  my $doc = $cursor\->next;
.Ve
.PP
Fetch next document. You can also append a callback to perform operation
non-blocking.
.PP
.Vb 5
\&  $cursor\->next(sub {
\&    my ($cursor, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "rewind"
.IX Subsection "rewind"
.Vb 1
\&  $cursor\->rewind;
.Ve
.PP
Rewind cursor and kill it on the server. You can also append a callback to
perform operation non-blocking.
.PP
.Vb 5
\&  $cursor\->rewind(sub {
\&    my ($cursor, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "num_to_return"
.IX Subsection "num_to_return"
.Vb 1
\&  my $num = $cursor\->num_to_return;
.Ve
.PP
Number of results to return with next \f(CW\*(C`QUERY\*(C'\fR or \f(CW\*(C`GET_MORE\*(C'\fR operation based
on \*(L"batch_size\*(R" and \*(L"limit\*(R".
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mango, Mojolicious::Guides, <http://mojolicio.us>.