MongoClient::getReadPreference
(PECL mongo >=1.3.0)
MongoClient::getReadPreference — Get the read preference for this connection
Description
public array MongoClient::getReadPreference
( void
)
Parameters
This function has no parameters.
Return Values
This function returns an array describing the read preference. The array contains the values type for the string read preference mode (corresponding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array.
Changelog
| Version | Description |
|---|---|
| 1.3.3 | The return value has changed to be consistent with MongoClient::setReadPreference(). The type value was changed from a number to a string, type_string was removed, and tagsets now expresses tags as key/value pairs instead of colon-delimited strings. |
Examples
Example #1 MongoClient::getReadPreference() return value example
<?php
$m = new MongoClient();
$m->setReadPreference(MongoClient::RP_SECONDARY, array(
array('dc' => 'east', 'use' => 'reporting'),
array('dc' => 'west'),
array(),
));
var_dump($m->getReadPreference());
?>
The above example will output:
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) {
}
}
}
See Also
- The read preferences documentation.
- MongoClient::setReadPreference() - Set 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