MongoCursor::slaveOkay
(PECL mongo >=0.9.4)
MongoCursor::slaveOkay — Sets whether this query can be done on a secondary [deprecated]
説明
This method is deprecated since version 1.5.0. Instead, please use MongoCursor::setReadPreference() and 優先読み込み.
Calling this will make the driver route reads to secondaries if:
- You are using a replica set, and
-
You created a MongoClient instance using the option
"replicaSet" => "setName", and - There is a healthy secondary that can be reached by the driver.
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(), MongoDB::setSlaveOkay() and MongoCollection::setSlaveOkay().
パラメータ
-
okay -
If it is okay to query the secondary.
返り値
Returns this cursor.
エラー / 例外
Throws MongoCursorException if this cursor has started iterating.
例
例1 MongoCursor::slaveOkay() 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);
?>
参考
- 優先読み込み
- MongoCursor::setReadPreference() - このクエリの優先読み込みを設定する
- MongoCursor::getReadPreference() - このクエリの優先読み込みを取得する
変更履歴
| バージョン | 説明 |
|---|---|
| 1.5.0 | This method has been deprecated in favour of MongoCursor::setReadPreference() and 優先読み込み. |
add a note
