Docs Menu

Docs HomePHP Library Manual

MongoDB\BulkWriteResult::getInsertedIds()

On this page

  • Definition
  • Return Values
MongoDB\BulkWriteResult::getInsertedIds()

Return a map of IDs (i.e. _id field values) for documents that were inserted by all insert operations in the bulk write.

function getInsertedIds(): array

Since IDs are created by the driver, this method may be called irrespective of whether the write was acknowledged.

A map of IDs (i.e. _id field values) for documents that were inserted by all insert operations in the bulk write.

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.

←  MongoDB\BulkWriteResult::getInsertedCount()MongoDB\BulkWriteResult::getMatchedCount() →