/ 
MongoDB-0.31
River stage two • 48 direct dependents • 56 total dependents
/ MongoDB::Cursor

NAME

MongoDB::Cursor - A cursor/iterator for Mongo query results

SYNOPSIS

while (my $object = $cursor->next) {
    ...
}

my @objects = $cursor->all;

SEE ALSO

Core documentation on cursors: http://dochub.mongodb.org/core/cursors.

OPTIONS

The MongoDB::Cursor::Options subpackage defines the actual values for options that can be put on a cursor.

These are used internally by the driver.

tailable

If a cursor should be tailable.

slave_okay

If a query can be done on a slave database server.

immortal

Ordinarily, a cursor "dies" on the database server after a certain length of time, to prevent inactive cursors from hogging resources. This option sets that a cursor should never die.

STATIC ATTRIBUTES

slave_okay

$MongoDB::Cursor::slave_okay = 1;

Whether it is okay to run queries on the slave. Defaults to 0.

timeout

How many milliseconds to wait for a response from the server. Set to 30000 (30 seconds) by default. -1 waits forever (or until TCP times out, which is usually a long time).

ATTRIBUTES

started_iterating

If this cursor has queried the database yet. Methods mofifying the query will complain if they are called after the database is queried.

METHODS

fields (\%f)

$coll->insert({name => "Fred", age => 20});
my $cursor = $coll->query->fields({ name => 1 });
my $obj = $cursor->next;
$obj->{name}; "Fred"
$obj->{age}; # undef

Selects which fields are returned. The default is all fields. _id is always returned.

sort ($order)

# sort by name, descending
my $sort = {"name" => -1};
$cursor = $coll->query->sort($sort);

Adds a sort to the query. Argument is either a hash reference or a Tie::IxHash. Returns this cursor for chaining operations.

limit ($num)

$per_page = 20;
$cursor = $coll->query->limit($per_page);

Returns a maximum of N results. Returns this cursor for chaining operations.

skip ($num)

$page_num = 7;
$per_page = 100;
$cursor = $coll->query->limit($per_page)->skip($page_num * $per_page);

Skips the first N results. Returns this cursor for chaining operations.

See also core documentation on limit: http://dochub.mongodb.org/core/limit.

snapshot

my $cursor = $coll->query->snapshot;

Uses snapshot mode for the query. Snapshot mode assures no duplicates are returned, or objects missed, which were present at both the start and end of the query's execution (if an object is new during the query, or deleted during the query, it may or may not be returned, even with snapshot mode). Note that short query responses (less than 1MB) are always effectively snapshotted. Currently, snapshot mode may not be used with sorting or explicit hints.

hint

my $cursor = $coll->query->hint({'x' => 1});

Force Mongo to use a specific index for a query.

explain

my $explanation = $cursor->explain;

This will tell you the type of cursor used, the number of records the DB had to examine as part of this query, the number of records returned by the query, and the time in milliseconds the query took to execute. Requires boolean package.

See also core documentation on explain: http://dochub.mongodb.org/core/explain.

count($all?)

my $num = $cursor->count;
my $num = $cursor->skip(20)->count(1);

Returns the number of document this query will return. Optionally takes a boolean parameter, indicating that the cursor's limit and skip fields should be used in calculating the count.

reset

Resets the cursor. After being reset, pre-query methods can be called on the cursor (sort, limit, etc.) and subsequent calls to next, has_next, or all will re-query the database.

has_next

while ($cursor->has_next) {
    ...
}

Checks if there is another result to fetch.

next

while (my $object = $cursor->next) {
    ...
}

Returns the next object in the cursor. Will automatically fetch more data from the server if necessary. Returns undef if no more data is available.

all

my @objects = $cursor->all;

Returns a list of all objects in the result.

AUTHOR

Kristina Chodorow <kristina@mongodb.org>