MongoDB\Driver\Server::executeCommand
(mongodb >=1.0.0)
MongoDB\Driver\Server::executeCommand — Execute a database command on this server
説明
$db
, MongoDB\Driver\Command $command
[, MongoDB\Driver\ReadPreference $readPreference
] )
Executes command on this server.
注意:
The
readPreferenceparameter does not control the server to which the driver issues the command; the command will always be executed on this server object. Instead, it may be used when issuing the command to a secondary (from a replica set connection, not standalone) or mongos node to ensure that the driver sets the wire protocol accordingly or adds the read preference to the command document, respectively.
パラメータ
-
db(string) -
コマンドを実行するデータベースの名前。
-
command(MongoDB\Driver\Command) -
実行する MongoDB\Driver\Command。
-
readPreference(MongoDB\Driver\ReadPreference) -
オプションの MongoDB\Driver\ReadPreference で、この操作の対象となるサーバーを指定します。省略した場合は、MongoDB Connection URI で設定したデフォルトの優先読み込みを使います。
返り値
成功した場合に MongoDB\Driver\Cursor を返します。
エラー / 例外
- 引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。
- サーバーへの接続が認証以外の理由で失敗した場合に MongoDB\Driver\Exception\ConnectionException をスローします。
- 認証が必要な場面で認証に失敗した場合に MongoDB\Driver\Exception\AuthenticationException をスローします。
- Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command, issuing a write command to a secondary).
注意
注意:
This method does not take a MongoDB\Driver\WriteConcern parameter. For write commands (e.g. » findAndModify in MongoDB 3.2+), the write concern should be included in the
commanddocument itself.It is the caller's responsibility to ensure that the server is capable of executing the command. For example, executing a write operation on a secondary (excluding its "local" database) will fail.
参考
- MongoDB\Driver\Command
- MongoDB\Driver\Cursor
- MongoDB\Driver\ReadPreference
- MongoDB\Driver\Manager::executeCommand() - Execute a database command
忘却曲線を使ってこの知識を確実に記憶に残す
