<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the read preference for this database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getprofilinglevel.html">MongoDB::getProfilingLevel</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getslaveokay.html">MongoDB::getSlaveOkay</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb.getreadpreference" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB::getReadPreference</h1>
<p class="verinfo">(PECL mongo >=1.3.0)</p><p class="refpurpose"><span class="refname">MongoDB::getReadPreference</span> — <span class="dc-title">Get the read preference for this database</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb.getreadpreference-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>MongoDB::getReadPreference</strong></span>
( <span class="methodparam">void</span>
)</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb.getreadpreference-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb.getreadpreference-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">This function returns an array describing the read preference. The array contains the values <em>type</em> for the string read preference mode (corresponding to the <a href="class.mongoclient.html" class="classname">MongoClient</a> constants), and <em>tagsets</em> containing a list of all tag set criteria. If no tag sets were specified, <em>tagsets</em> will not be present in the array.</p>
</div>
<div class="refsect1 changelog" id="refsect1-mongodb.getreadpreference-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.3.3</td>
<td>
The return value has changed to be consistent with
<span class="methodname"><a href="mongodb.setreadpreference.html" class="methodname">MongoDB::setReadPreference()</a></span>. The
<em>type</em> value was changed from a number to a string,
<em>type_string</em> was removed, and
<em>tagsets</em> now expresses tags as key/value pairs instead
of colon-delimited strings.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongodb.getreadpreference-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1425">
<p><strong>Example #1 <span class="methodname"><strong>MongoDB::getReadPreference()</strong></span> return value example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">test</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">setReadPreference</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">::</span><span style="color: #0000BB">RP_SECONDARY</span><span style="color: #007700">, array(<br /> array(</span><span style="color: #DD0000">'dc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'east'</span><span style="color: #007700">, </span><span style="color: #DD0000">'use' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'reporting'</span><span style="color: #007700">),<br /> array(</span><span style="color: #DD0000">'dc' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'west'</span><span style="color: #007700">),<br /> array(),<br />));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">getReadPreference</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
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) {
}
}
}
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb.getreadpreference-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">The <a href="mongo.readpreferences.html" class="link">read preferences</a> documentation.</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb.getprofilinglevel.html">MongoDB::getProfilingLevel</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb.getslaveokay.html">MongoDB::getSlaveOkay</a></div>
<div class="up"><a href="class.mongodb.html">MongoDB</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
