MongoDB\Driver\Manager::executeWriteCommand
(mongodb >=1.4.0)
MongoDB\Driver\Manager::executeWriteCommand — Execute a database command that writes
Description
$db
, MongoDB\Driver\Command $command
, array $options
= array()): MongoDB\Driver\CursorExecutes the command on the primary 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.
Note: This method is not intended to be used to execute » insert, » update, or » delete commands. Users are encouraged to use MongoDB\Driver\Manager::executeBulkWrite() for those commands.
Parameters
-
db
(string) -
The name of the database on which to execute the command.
-
command
(MongoDB\Driver\Command) -
The command to execute.
-
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.
WarningIf 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().
Return Values
Returns MongoDB\Driver\Cursor on success.
Errors/Exceptions
- 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. - 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 on other errors (e.g. invalid command).
Changelog
Version | Description |
---|---|
PECL mongodb 1.4.4 |
MongoDB\Driver\Exception\InvalidArgumentException
will be thrown if the "session" option is used in
combination with an unacknowledged write concern.
|
See Also
- MongoDB\Driver\Command
- MongoDB\Driver\Cursor
- MongoDB\Driver\Manager::executeCommand() - Execute a database command
- MongoDB\Driver\Manager::executeReadCommand() - Execute a database command that reads
- MongoDB\Driver\Manager::executeReadWriteCommand() - Execute a database command that reads and writes
- MongoDB\Driver\Server::executeWriteCommand() - Execute a database command that writes on this server