MongoClient::setReadPreference
(PECL mongo >=1.3.0)
MongoClient::setReadPreference — Set the read preference for this connection
Description
$read_preference
[, array $tags
] )Parameters
-
read_preference
-
The read preference mode:
MongoClient::RP_PRIMARY
,MongoClient::RP_PRIMARY_PREFERRED
,MongoClient::RP_SECONDARY
,MongoClient::RP_SECONDARY_PREFERRED
, orMongoClient::RP_NEAREST
. -
tags
-
An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.
Return Values
Returns TRUE
on success, or FALSE
otherwise.
Errors/Exceptions
Emits E_WARNING
if either parameter is invalid, or if one or more tag sets are provided with the MongoClient::RP_PRIMARY
read preference mode.
Examples
Example #1 MongoClient::setReadPreference() tag set array syntax example
<?php
$m = new MongoClient();
// Prefer the nearest server in the "east" data center also used for reporting,
// but fall back to a server in the "west" data center
$m->setReadPreference(MongoClient::RP_NEAREST, array(
array('dc' => 'east', 'use' => 'reporting'),
array('dc' => 'west'),
));
?>
See Also
- The read preferences documentation.
- MongoClient::getReadPreference() - Get the read preference for this connection
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с базами данных
- Расширения для работы с базами данных отдельных производителей
- MongoDB
- Базовые классы
- Функция MongoClient::close() - Closes this connection
- Функция MongoClient::connect() - Connects to a database server
- Функция MongoClient::__construct() - Creates a new database connection object
- Функция MongoClient::dropDB() - Drops a database [deprecated]
- Функция MongoClient::__get() - Gets a database
- Функция MongoClient::getConnections() - Return info about all open connections
- Функция MongoClient::getHosts() - Updates status for all associated hosts
- Функция MongoClient::getReadPreference() - Get the read preference for this connection
- Функция MongoClient::getWriteConcern() - Get the write concern for this connection
- Функция MongoClient::killCursor() - Kills a specific cursor on the server
- Функция MongoClient::listDBs() - Lists all of the databases available.
- Функция MongoClient::selectCollection() - Gets a database collection
- Функция MongoClient::selectDB() - Gets a database
- Функция MongoClient::setReadPreference() - Set the read preference for this connection
- Функция MongoClient::setWriteConcern() - Set the write concern for this connection
- Функция MongoClient::__toString() - String representation of this connection
Коментарии
404 Not Found