MongoCursorInterface::setReadPreference
(PECL mongo >=1.6.0)
MongoCursorInterface::setReadPreference — Set the read preference for this query
Description
abstract public MongoCursorInterface::setReadPreference
( string
$read_preference
[, array $tags
] ) : MongoCursorInterfaceParameters
-
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 this cursor.
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.
See Also
- The read preferences documentation.
- MongoCursorInterface::getReadPreference() - Get the read preference for this query
add a note
User Contributed Notes
There are no user contributed notes for this page.
