MongoDB\Driver\Server::executeWriteCommand
(mongodb >=1.4.0)
MongoDB\Driver\Server::executeWriteCommand — Execute a database command that writes on this server
説明
final public MongoDB\Driver\Server::executeWriteCommand
( string $db
, MongoDB\Driver\Command $command
[, array $options = array()
] ) : MongoDB\Driver\Cursor
Executes the command on this server.
This method will apply logic that is specific to commands that write (e.g.
» drop) and
take the MongoDB server version into account. The
"writeConcern" option will default to the corresponding
value from the MongoDB
Connection URI.
注意:
This method is not intended to be used to execute » insert, » update, or » delete commands. Users are encouraged to use MongoDB\Driver\Server::executeBulkWrite() for those commands.
パラメータ
db(string)コマンドを実行するデータベースの名前。
command(MongoDB\Driver\Command)実行するコマンド。
options- {|
|+ options
! Option
! Type
! Description
|-
| session
| MongoDB\Driver\Session
|
A session to associate with the operation.
|- | writeConcern | MongoDB\Driver\WriteConcern
|A write concern to apply to the operation.
|}
警告
If you are using a
"session"which has a transaction in progress, you cannot specify a"readConcern"or"writeConcern"option. This will result in an MongoDB\Driver\Exception\InvalidArgumentException being thrown. Instead, you should set these two options when you create the transaction with MongoDB\Driver\Session::startTransaction().
エラー / 例外
- Throws MongoDB\Driver\Exception\InvalidArgumentException if the
"session"option is used with an associated transaction in combination with a"readConcern"or"writeConcern"option. - Throws MongoDB\Driver\Exception\InvalidArgumentException if the
"session"option is used in combination with an unacknowledged write concern. - 引数のパースに失敗した場合に MongoDB\Driver\Exception\InvalidArgumentException をスローします。
- サーバーへの接続が認証以外の理由で失敗した場合に MongoDB\Driver\Exception\ConnectionException をスローします。
- 認証が必要な場面で認証に失敗した場合に MongoDB\Driver\Exception\AuthenticationException をスローします。
- Throws MongoDB\Driver\Exception\RuntimeException on other errors (e.g. invalid command).
変更履歴
| バージョン | 説明 |
|---|---|
| PECL mongodb 1.4.4 | MongoDB\Driver\Exception\InvalidArgumentException
will be thrown if the |
注意
注意:
It is the caller's responsibility to ensure that the server is capable of executing the write operation. For example, executing a write operation on a secondary (excluding its "local" database) will fail.
参考
- MongoDB\Driver\Command
- MongoDB\Driver\Cursor
- MongoDB\Driver\Server::executeCommand() - Execute a database command on this server
- MongoDB\Driver\Server::executeReadCommand() - Execute a database command that reads on this server
- MongoDB\Driver\Server::executeReadWriteCommand() - Execute a database command that reads and writes on this server
- MongoDB\Driver\Manager::executeWriteCommand() - Execute a database command that writes
