MongoCursor
PHP Manual

MongoCursor::slaveOkay

(PECL mongo >=0.9.4)

MongoCursor::slaveOkayこのクエリをセカンダリ上で完了できるかどうかを設定する [非推奨]

説明

public MongoCursor MongoCursor::slaveOkay ([ bool $okay = true ] )
警告

このメソッドは、バージョン 1.5.0 以降で非推奨になりました。かわりに MongoCursor::setReadPreference()優先読み込み を使いましょう。

このメソッドをコールすると、以下の条件を満たす場合にドライバが読み込みをセカンダリに回すようになります。

どのサーバーがこのクエリを処理したのかを調べるには、クエリを実行した後に MongoCursor::info() をコールします。 server フィールドが、クエリの送信先のサーバーです。

セカンダリへの自動ルーティングを使っていない場合でも、この関数を使わなければならないことに注意しましょう。 レプリカセットのセカンダリに直接接続したとしても、この関数をコールすべきです。 そうすることで、古いデータであることを承知の上で取得しているのだということを データベースに伝えることができます。コールしなければ、クエリを実行すると "not master" エラーが発生します。

このメソッドは、静的クラス変数 MongoCursor::$slaveOkay を上書きします。 また、Mongo::setSlaveOkay()MongoDB::setSlaveOkay()MongoCollection::setSlaveOkay() も上書きします。

パラメータ

okay

セカンダリに問い合わせることが可能かどうか。

返り値

このカーソルを返します。

エラー / 例外

このカーソルの反復処理が始まっている場合に MongoCursorException をスローします。

例1 MongoCursor::slaveOkay() の例

<?php

MongoCursor
::$slaveOkay false;

// セカンダリには問い合わせられません
$cursor $collection->find();

// セカンダリに問い合わせることができます
$cursor $collection->find()->slaveOkay();

MongoCursor::$slaveOkay true;

// セカンダリに問い合わせることができます
$cursor $collection->find();

// セカンダリには問い合わせられません
$cursor $collection->find()->slaveOkay(false);

?>

参考

変更履歴

バージョン 説明
1.5.0 このメソッドは非推奨になりました。かわりに MongoCursor::setReadPreference()優先読み込み を使いましょう。


MongoCursor
PHP Manual