Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/ -> BulkWriteResult.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]
(no description)
| File Size: | 188 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
BulkWriteResult:: (9 methods):
__construct()
getDeletedCount()
getInsertedCount()
getInsertedIds()
getMatchedCount()
getModifiedCount()
getUpsertedCount()
getUpsertedIds()
isAcknowledged()
Class: BulkWriteResult - X-Ref
Result class for a bulk write operation.| __construct(WriteResult $writeResult, array $insertedIds) X-Ref |
| No description |
| getDeletedCount() X-Ref |
| Return the number of documents that were deleted. This method should only be called if the write was acknowledged. return: integer|null |
| getInsertedCount() X-Ref |
| Return the number of documents that were inserted. This method should only be called if the write was acknowledged. return: integer|null |
| getInsertedIds() X-Ref |
| Return a map of the inserted documents' IDs. The index of each ID in the map corresponds to each document's position in the bulk operation. If a document had an ID prior to inserting (i.e. the driver did not generate an ID), the index will contain its "_id" field value. Any driver-generated ID will be a MongoDB\BSON\ObjectId instance. return: array |
| getMatchedCount() X-Ref |
| Return the number of documents that were matched by the filter. This method should only be called if the write was acknowledged. return: integer|null |
| getModifiedCount() X-Ref |
| Return the number of documents that were modified. This value is undefined (i.e. null) if the write executed as a legacy operation instead of command. This method should only be called if the write was acknowledged. return: integer|null |
| getUpsertedCount() X-Ref |
| Return the number of documents that were upserted. This method should only be called if the write was acknowledged. return: integer|null |
| getUpsertedIds() X-Ref |
| Return a map of the upserted documents' IDs. The index of each ID in the map corresponds to each document's position in bulk operation. If a document had an ID prior to upserting (i.e. the server did not need to generate an ID), this will contain its "_id". Any server-generated ID will be a MongoDB\BSON\ObjectId instance. This method should only be called if the write was acknowledged. return: array |
| isAcknowledged() X-Ref |
| Return whether this update was acknowledged by the server. If the update was not acknowledged, other fields from the WriteResult (e.g. matchedCount) will be undefined. return: boolean |
