MongoDB\Driver\Manager::selectServer
(mongodb >=1.0.0)
MongoDB\Driver\Manager::selectServer — Select a server matching a read preference
説明
final public MongoDB\Driver\Server MongoDB\Driver\Manager::selectServer
( MongoDB\Driver\ReadPreference
$readPreference
)
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.
注意:
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) -
オプションの MongoDB\Driver\ReadPreference で、この操作の対象となるサーバーを指定します。省略した場合は、MongoDB Connection URI で設定したデフォルトの優先読み込みを使います。
返り値
Returns an MongoDB\Driver\Server matching the read preference.
エラー / 例外
- 引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。
- サーバーへの接続が認証以外の理由で失敗した場合に MongoDB\Driver\Exception\ConnectionException をスローします。
- 認証が必要な場面で認証に失敗した場合に MongoDB\Driver\Exception\AuthenticationException をスローします。
- Throws MongoDB\Driver\Exception\RuntimeException if a server matching the read preference could not be found.
参考
- MongoDB\Driver\Server
- MongoDB\Driver\Manager::getServers() - Return the servers to which this manager is connected
- » Server Selection Specification
忘却曲線を使ってこの知識を確実に記憶に残す
