MongoCollection::setReadPreference

(PECL mongo >=1.3.0)

MongoCollection::setReadPreferenceこのコレクションの優先読み込みを設定する

説明

public MongoCollection::setReadPreference ( string $read_preference [, array $tags ] ) : bool

パラメータ

read_preference

読み込みの優先モード。MongoClient::RP_PRIMARYMongoClient::RP_PRIMARY_PREFERREDMongoClient::RP_SECONDARYMongoClient::RP_SECONDARY_PREFERRED あるいは MongoClient::RP_NEAREST のいずれか。

tags

ゼロ個以上のタグセットの配列。各タグセット自体も配列で、レプリカセットのメンバーのタグにマッチさせる条件として使います。

返り値

成功した場合に TRUE、それ以外の場合に FALSE を返します。

エラー / 例外

パラメータが無効な場合、あるいは優先読み込みモードが MongoClient::RP_PRIMARY のときにタグセットを指定した場合に E_WARNING が発生します。

例1 MongoCollection::setReadPreference() タグセット配列構文の例

<?php

$m 
= new MongoClient();
$c $m->test->users;

// "east" データセンターの一番近いサーバーをレポート用に使うようにして、
// 代替として "west" データセンターのサーバーを設定します
$c->setReadPreference(MongoClient::RP_NEAREST, array(
    array(
'dc' => 'east''use' => 'reporting'),
    array(
'dc' => 'west'),
));
?>

参考