MongoDB\BulkWriteCommandResult Class
Definition
MongoDB\BulkWriteCommandResult
This class contains information about a completed client bulk write operation. It is returned from
MongoDB\Client::bulkWrite()
.
Methods
Method | Description |
---|---|
| Returns the total number of documents inserted by all
insert operations in the bulk write command. |
| Returns the total number of documents matched by all
update and replace operations in the bulk write command. |
| Returns the total number of documents modified by all update
and replace operations in the bulk write command. |
| Returns the total number of documents upserted by all update
and replace operations in the bulk write command. |
| Return the total number of documents deleted by all delete
operations in the bulk write command. |
| Returns a map of results of each successful insert operation. Each
operation is represented by an integer key, which contains a
document with information corresponding to the operation such
as the inserted _id value. |
| Returns a map of results of each successful update operation. Each
operation is represented by an integer key, which contains a
document with information corresponding to the operation. |
| Returns a map of results of each successful delete operation.
Each operation is represented by an integer key, which contains
a document with information corresponding to the operation. |
| Returns a boolean indicating whether the server acknowledged
the bulk operation. |
To learn more about the information returned from the server when you
perform a client bulk write operation, see the Output section of the
Mongo.bulkWrite
shell method reference.
See Also
Client Bulk Write section of the Bulk Write Operations guide