MONGOCURSOR.SLAVEOKAY(3) 1 MONGOCURSOR.SLAVEOKAY(3)
MongoCursor::slaveOkay - Sets whether this query can be done on a secondary [deprecated]
SYNOPSIS
public MongoCursor MongoCursor::slaveOkay ([bool $okay = true])
DESCRIPTION
Warning
This method is deprecated since version 1.5.0. Instead, please use MongoCursor::setReadPreference and "Read Preferences".
Calling this will make the driver route reads to secondaries if:
o You are using a replica set, and
o You created a MongoClient instance using the option
"replicaSet" => "setName", and
o There is a healthy secondary that can be reached by the driver.
You can check which server was used for this query by calling MongoCursor.info(3) after running the query. It's server field will show
which server the query was sent to.
Note that you should use this function even if you do not use the automatic routing to secondaries. If you connect directly to a secondary
in a replica set, you still need to call this function, which basically tells the database that you are aware that you might be getting
older data and you're okay with that. If you do not call this, you'll get "not master" errors when you try to query.
This method will override the static class variable $MongoCursor::$slaveOkay. It will also override Mongo.setSlaveOkay(3), MongoDB.set-
SlaveOkay(3) and MongoCollection.setSlaveOkay(3).
PARAMETERS
o $okay
- If it is okay to query the secondary.
RETURN VALUES
Returns this cursor.
ERRORS
/EXCEPTIONS
Throws MongoCursorException if this cursor has started iterating.
EXAMPLES
Example #1
MongoCursor.slaveOkay(3) example
<?php
MongoCursor::$slaveOkay = false;
// cannot query secondary
$cursor = $collection->find();
// can query secondary
$cursor = $collection->find()->slaveOkay();
MongoCursor::$slaveOkay = true;
// can query secondary
$cursor = $collection->find();
// cannot query secondary
$cursor = $collection->find()->slaveOkay(false);
?>
SEE ALSO";Read Preferences ,
MongoCursor::setReadPreference, MongoCursor::getReadPreference.
CHANGELOG
+--------+---------------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+---------------------------------------------------+
| 1.5.0 | |
| | |
| | This method has been deprecated in favour of |
| | MongoCursor::setReadPreference and "Read Prefer- |
| | ences". |
| | |
+--------+---------------------------------------------------+
PHP Documentation Group MONGOCURSOR.SLAVEOKAY(3)