MongoCursor
PHP Manual

MongoCursor::getReadPreference

(PECL mongo >=1.4.0)

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

説明

public array MongoCursor::getReadPreference ( void )

パラメータ

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

返り値

この関数は、優先読み込みに関する配列を返します。 配列に含まれる内容は、type (優先読み込みモードを表す数値)、 type_string (優先読み込みモードの名前)、そして 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(3) {
  ["type"]=>
  int(2)
  ["type_string"]=>
  string(9) "secondary"
  ["tagsets"]=>
  array(3) {
    [0]=>
    array(2) {
      [0]=>
      string(7) "dc:east"
      [1]=>
      string(13) "use:reporting"
    }
    [1]=>
    array(1) {
      [0]=>
      string(7) "dc:west"
    }
    [2]=>
    array(0) {
    }
  }
}

参考

MongoCursor
PHP Manual