Php/docs/mongodb-driver-manager.selectserver

• PHP Manual
• MongoDB\Driver\Manager
• Select a server matching a read preference

MongoDB\Driver\Manager::selectServer

(mongodb >=1.0.0)

MongoDB\Driver\Manager::selectServer — Select a server matching a read preference

Description

final public MongoDB\Driver\Manager::selectServer ( MongoDB\Driver\ReadPreference $readPreference ) : MongoDB\Driver\Server

Selects a MongoDB\Driver\Server matching readPreference. This may be used to preselect a server in order to perform version checking before executing an operation.

Note:

Unlike MongoDB\Driver\Manager::getServers(), this method will initialize database connections and perform server discovery if necessary. See the » Server Selection Specification for additional information.

Parameters

readPreference (MongoDB\Driver\ReadPreference)

The read preference to use for selecting a server.

Return Values

Returns a MongoDB\Driver\Server matching the read preference.

Errors/Exceptions

• Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
• Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).
• Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.
• Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found.

See Also

• MongoDB\Driver\Server
• MongoDB\Driver\Manager::getServers() - Return the servers to which this manager is connected
• » Server Selection Specification