MongoDB\Driver\Manager
PHP マニュアル

MongoDB\Driver\Manager::selectServer

Select a server matching a read preference

説明

final public MongoDB\Driver\Server MongoDB\Driver\Manager::selectServer(MongoDB\Driver\ReadPreferencenull $readPreference = null)

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.

注意: 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.

パラメータ

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.

戻り値

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

エラー / 例外

  • 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.

変更履歴

バージョン 説明
PECL mongodb 1.11.0 The readPreference is now optional. If null or omitted, the primary server will be selected by default.

参考