(mongodb >=1.0.0)
MongoDB\Driver\Server::executeBulkWrite — Execute one or more write operations on this server
$namespace
, MongoDB\Driver\BulkWrite $bulk
, array|MongoDB\Driver\WriteConcern|null $options
= null
): MongoDB\Driver\WriteResultExecutes one or more write operations on this server.
A MongoDB\Driver\BulkWrite can be constructed with one or more write operations of varying types (e.g. updates, deletes, and inserts). The driver will attempt to send operations of the same type to the server in as few requests as possible to optimize round trips.
The default value for the "writeConcern"
option will be
inferred from an active transaction (indicated by the
"session"
option), followed by the
connection URI.
namespace
(string)
A fully qualified namespace (e.g. "databaseName.collectionName"
).
bulk
(MongoDB\Driver\BulkWrite)The write(s) to execute.
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. |
Returns MongoDB\Driver\WriteResult on success.
bulk
does not contain any write operations.bulk
has already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times."session"
option is used in combination with an unacknowledged write concern.
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.
|
PECL mongodb 1.4.0 |
The third parameter is now an options array.
For backwards compatibility, this paramater will still accept a
MongoDB\Driver\WriteConcern object.
|
PECL mongodb 1.3.0 |
MongoDB\Driver\Exception\InvalidArgumentException
is now thrown if bulk does not contain any write
operations. Previously, a
MongoDB\Driver\Exception\BulkWriteException was
thrown.
|
Note: 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.