Php/docs/mongocursor.getreadpreference

• PHP Manual
• MongoCursor
• このクエリの優先読み込みを取得する

MongoCursor::getReadPreference

(PECL mongo >=1.3.3)

MongoCursor::getReadPreference — このクエリの優先読み込みを取得する

説明

public MongoCursor::getReadPreference ( ) : array

パラメータ

この関数にはパラメータはありません。

返り値

この関数は、優先読み込みに関する配列を返します。配列に含まれる内容は、type (優先読み込みモードを表す文字列。MongoClient の定数に対応)、そして tagsets (すべてのタグセット条件のリスト) です。タグセットを指定しなかった場合は、tagsets は存在しません。

例

例1 MongoCursor::getReadPreference() の返り値の例

<?php$m = new MongoClient();$cursor = $m->test->users->find();$cursor->setReadPreference(MongoClient::RP_SECONDARY, array(    array('dc' => 'east', 'use' => 'reporting'),    array('dc' => 'west'),    array(),));var_dump($cursor->getReadPreference());?>

上の例の出力は以下となります。

array(2) {
  ["type"]=>
  string(9) "secondary"
  ["tagsets"]=>
  array(3) {
    [0]=>
    array(2) {
      ["dc"]=>
      string(4) "east"
      ["use"]=>
      string(9) "reporting"
    }
    [1]=>
    array(1) {
      ["dc"]=>
      string(7) "west"
    }
    [2]=>
    array(0) {
    }
  }
}

参考

• 優先読み込みのドキュメント
• MongoCursor::setReadPreference() - このクエリの優先読み込みを設定する
• MongoCursorInterface::getReadPreference() - Get the read preference for this query