Mango::Cursor - MongoDB cursor
use Mango::Cursor; my $cursor = Mango::Cursor->new(collection => $collection); my $docs = $cursor->all;
Mango::Cursor is a container for MongoDB cursors used by Mango::Collection.
Mango::Cursor implements the following attributes.
my $size = $cursor->batch_size; $cursor = $cursor->batch_size(10);
Number of documents to fetch in one batch, defaults to 0.
0
my $collection = $cursor->collection; $cursor = $cursor->collection(Mango::Collection->new);
Mango::Collection object this cursor belongs to.
my $fields = $cursor->fields; $cursor = $cursor->fields({foo => 1});
Select fields from documents.
my $hint = $cursor->hint; $cursor = $cursor->hint({foo => 1});
Force a specific index to be used.
my $id = $cursor->id; $cursor = $cursor->id(123456);
Cursor id.
my $limit = $cursor->limit; $cursor = $cursor->limit(10);
Limit the number of documents, defaults to 0.
my $max = $cursor->max_scan; $cursor = $cursor->max_scan(500);
Limit the number of documents to scan.
my $query = $cursor->query; $cursor = $cursor->query({foo => 'bar'});
Original query.
my $skip = $cursor->skip; $cursor = $cursor->skip(5);
Number of documents to skip, defaults to 0.
my $snapshot = $cursor->snapshot; $cursor = $cursor->snapshot(1);
Use snapshot mode.
my $sort = $cursor->sort; $cursor = $cursor->sort({foo => 1}); $cursor = $cursor->sort(bson_doc(foo => 1, bar => -1));
Sort documents, the order of keys matters.
my $tailable = $cursor->tailable; $cursor = $cursor->tailable(1);
Tailable cursor.
Mango::Cursor inherits all methods from Mojo::Base and implements the following new ones.
$cursor = $cursor->add_batch($docs);
Add batch of documents to cursor.
my $docs = $cursor->all;
Fetch all documents at once. You can also append a callback to perform operation non-blocking.
$cursor->all(sub { my ($cursor, $err, $docs) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $query = $cursor->build_query; my $query = $cursor->build_query($explain);
Generate final query with cursor attributes.
my $clone = $cursor->clone;
Clone cursor.
my $count = $cursor->count;
Count number of documents this cursor can return. You can also append a callback to perform operation non-blocking.
$cursor->count(sub { my ($cursor, $err, $count) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $values = $cursor->distinct('foo');
Get all distinct values for key. You can also append a callback to perform operation non-blocking.
$cursor->distinct(foo => sub { my ($cursor, $err, $values) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $doc = $cursor->explain;
Provide information on the query plan. You can also append a callback to perform operation non-blocking.
$cursor->explain(sub { my ($cursor, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $doc = $cursor->next;
Fetch next document. You can also append a callback to perform operation non-blocking.
$cursor->next(sub { my ($cursor, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
$cursor->rewind;
Rewind cursor and kill it on the server. You can also append a callback to perform operation non-blocking.
$cursor->rewind(sub { my ($cursor, $err) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
Mango, Mojolicious::Guides, http://mojolicio.us.
To install Mango, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mango
CPAN shell
perl -MCPAN -e shell install Mango
For more information on module installation, please visit the detailed CPAN module installation guide.