MongoClient::getReadPreference
(PECL mongo >=1.3.0)
MongoClient::getReadPreference — この接続の優先読み込みを取得する
このメソッドを定義している拡張モジュールは非推奨です。 かわりに MongoDB 拡張モジュールを使うべきです。 このメソッドの代替は、新しい拡張モジュールには存在しません。
説明
public array MongoClient::getReadPreference
( void
)
パラメータ
この関数にはパラメータはありません。
返り値
この関数は、優先読み込みに関する配列を返します。配列に含まれる内容は、type (優先読み込みモードを表す文字列。MongoClient の定数に対応)、そして tagsets (すべてのタグセット条件のリスト) です。タグセットを指定しなかった場合は、tagsets は存在しません。
変更履歴
| バージョン | 説明 |
|---|---|
| 1.3.3 | 返り値が変わり、 MongoClient::setReadPreference() との整合性があるものになりました。 type の値は数字から文字列に変わり、 type_string は削除され、そして tagsets はコロン区切りの文字列ではなくキー/値のペアでタグを表すようになりました。 |
例
例1 MongoClient::getReadPreference() の返り値の例
<?php
$m = new MongoClient();
$m->setReadPreference(MongoClient::RP_SECONDARY, array(
array('dc' => 'east', 'use' => 'reporting'),
array('dc' => 'west'),
array(),
));
var_dump($m->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) {
}
}
}
参考
- 優先読み込みのドキュメント
- MongoClient::setReadPreference() - この接続の優先読み込みを設定する
忘却曲線を使ってこの知識を確実に記憶に残す
