MongoDB\Driver\Server::executeBulkWrite
(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-
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.
エラー / 例外
- Throws MongoDB\Driver\Exception\InvalidArgumentException if
bulkdoes not contain any write operations. - Throws MongoDB\Driver\Exception\InvalidArgumentException if
bulkhas already been executed. MongoDB\Driver\BulkWrite objects may not be executed multiple times. - 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\BulkWriteException on any write failure (e.g. write error, failure to apply a write concern)
- Throws MongoDB\Driver\Exception\RuntimeException on other errors.
変更履歴
| バージョン | 説明 |
|---|---|
| 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.
|
注意
注意: 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\BulkWrite
- MongoDB\Driver\WriteResult
- MongoDB\Driver\WriteConcern
- MongoDB\Driver\Manager::executeBulkWrite() - Execute one or more write operations
User Contributed Notes
