Php/docs/class.mongocursorinterface
(PECL mongo >=1.5.0)
Introduction
Interface for cursors, which can be used to iterate through results of a database query or command. This interface is implemented by the MongoCursor and MongoCommandCursor classes.
Note:
Similar to Traversable, this interface cannot be implemented in PHP scripts.
Class synopsis
MongoCursorInterface extends Iterator {
abstract public batchSize
( int $batchSize
) : MongoCursorInterface
abstract public dead ( ) : bool
abstract public getReadPreference ( ) : array
abstract public info ( ) : array
abstract public setReadPreference
( string $read_preference
[, array $tags
] ) : MongoCursorInterface
abstract public timeout
( int $ms
) : MongoCursorInterface
/* Inherited methods */
abstract public Iterator::current ( ) : mixed
abstract public Iterator::key ( ) : scalar
abstract public Iterator::next ( ) : void
abstract public Iterator::rewind ( ) : void
abstract public Iterator::valid ( ) : bool
}
Table of Contents
- MongoCursorInterface::batchSize — Limits the number of elements returned in one batch
- MongoCursorInterface::dead — Checks if there are results that have not yet been sent from the database
- MongoCursorInterface::getReadPreference — Get the read preference for this query
- MongoCursorInterface::info — Gets information about the cursor's creation and iteration
- MongoCursorInterface::setReadPreference — Set the read preference for this query
- MongoCursorInterface::timeout — Sets a client-side timeout for this query
/* Methods */