MongoCollection::getReadPreference
(PECL mongo >=1.3.0)
MongoCollection::getReadPreference — Get the read preference for this collection
Description
public MongoCollection::getReadPreference
( void
) : array
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
MongoCollection::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 MongoCollection::getReadPreference() return value example
<?php
$m = new MongoClient();
$c = $m->test->users;
$c->setReadPreference(MongoClient::RP_SECONDARY, array(
array('dc' => 'east', 'use' => 'reporting'),
array('dc' => 'west'),
array(),
));
var_dump($c->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.
- MongoCollection::setReadPreference() - Set the read preference for this collection
add a note
User Contributed Notes
There are no user contributed notes for this page.
