<!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>Select a server matching a read preference</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.getwriteconcern.html">MongoDB\Driver\Manager::getWriteConcern</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.startsession.html">MongoDB\Driver\Manager::startSession</a></div> <div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-driver-manager.selectserver" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\Driver\Manager::selectServer</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::selectServer</span> — <span class="dc-title">Select a server matching a read preference</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-driver-manager.selectserver-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type"><span class="type MongoDB\Driver\Server">MongoDB\Driver\Server</span></span> <span class="methodname"><strong>MongoDB\Driver\Manager::selectServer</strong></span> ( <span class="methodparam"><span class="type"><span class="type MongoDB\Driver\ReadPreference">MongoDB\Driver\ReadPreference</span></span> <code class="parameter">$readPreference</code></span> )</div> <p class="para rdfs-comment"> Selects a <a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a> matching <code class="parameter">readPreference</code>. This may be used to preselect a server in order to perform version checking before executing an operation. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> Unlike <span class="function"><a href="mongodb-driver-manager.getservers.html" class="function">MongoDB\Driver\Manager::getServers()</a></span>, this method will initialize database connections and perform server discovery if necessary. See the <a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst#single-threaded-server-selection" class="link external">» Server Selection Specification</a> for additional information. </span> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.selectserver-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">readPreference</code> (<a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a>)</dt> <dd> <p class="para"> The read preference to use for selecting a server. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-manager.selectserver-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a <a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a> matching the read preference. </p> </div> <div class="refsect1 errors" id="refsect1-mongodb-driver-manager.selectserver-errors"> <h3 class="title">Errors/Exceptions</h3> <ul class="simplelist"> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li><li class="member">Throws <a href="class.mongodb-driver-exception-connectionexception.html" class="classname">MongoDB\Driver\Exception\ConnectionException</a> if connection to the server fails (for reasons other than authentication).</li><li class="member">Throws <a href="class.mongodb-driver-exception-authenticationexception.html" class="classname">MongoDB\Driver\Exception\AuthenticationException</a> if authentication is needed and fails.</li> <li class="member">Throws <a href="class.mongodb-driver-exception-runtimeexception.html" class="classname">MongoDB\Driver\Exception\RuntimeException</a> if a server matching the read preference could not be found.</li> </ul> </div> <div class="refsect1 seealso" id="refsect1-mongodb-driver-manager.selectserver-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><a href="class.mongodb-driver-server.html" class="classname">MongoDB\Driver\Server</a></li> <li class="member"><span class="function"><a href="mongodb-driver-manager.getservers.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::getServers()</a> - Return the servers to which this manager is connected</span></li> <li class="member"><a href="https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst" class="link external">» Server Selection Specification</a></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.getwriteconcern.html">MongoDB\Driver\Manager::getWriteConcern</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.startsession.html">MongoDB\Driver\Manager::startSession</a></div> <div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>