Home/ Manual/ driver / manager/ MongoDB\Driver\Manager::selectServer

MongoDB\Driver\Manager::selectServer

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Select a server matching a read preference

Description

MongoDB\Driver\Manager::selectServer(MongoDB\Driver\ReadPreference|null $readPreference = null): MongoDB\Driver\Server

Selects a MongoDB\Driver\Server matching readPreference. If readPreference is null or omitted, the primary server will be selected by default. 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. If null or omitted, the primary server will be selected by default.

Return Values

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

Errors/Exceptions

Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found.

Changelog

Version	Description
PECL mongodb 1.11.0	The `readPreference` is now optional. If null or omitted, the primary server will be selected by default.