Php/docs/mongoclient.setreadpreference

提供:Dev Guides
< Php
移動先:案内検索

MongoClient::setReadPreference

(PECL mongo >=1.3.0)

MongoClient::setReadPreferenceこの接続の優先読み込みを設定する


このメソッドを定義している拡張モジュールは非推奨です。 かわりに MongoDB 拡張モジュールを使うべきです。 このメソッドの代替は、新しい拡張モジュールには存在しません。


説明

public MongoClient::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 MongoClient::setReadPreference() タグセット配列構文の例

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

参考