MongoDB\Collection::insertMany()

On this page

Definition
Return Values
Errors/Exceptions
Behavior
Example
See Also

Definition

MongoDB\Collection::insertMany

Insert multiple documents.

function insertMany(array $documents, array $options = []): MongoDB\InsertManyResult

This method has the following parameters:

Parameter	Type	Description
`$documents`	array	The documents to insert into the collection.
`$options`	array	Optional. An array specifying the desired options.

The $options parameter supports the following options:

Option	Type	Description
`bypassDocumentValidation`	boolean	Optional. If `true`, allows the write operation to circumvent document level validation. Defaults to `false`. This option is available in MongoDB 3.2+ and is ignored for older server versions, which do not support document level validation.
`ordered`	boolean	Optional. If `true`: when a single write fails, the operation will stop without performing the remaining writes and throw an exception. If `false`: when a single write fails, the operation will continue with the remaining writes, if any, and throw an exception. The default is `true`.
`session`	MongoDB\Driver\Session	Optional. Client session to associate with the operation. Sessions are not supported for server versions prior to 3.6. New in version 1.3.
`writeConcern`	MongoDB\Driver\WriteConcern	Optional. Write concern to use for the operation. Defaults to the collection’s write concern. It is not possible to specify a write concern for individual operations as part of a transaction. Instead, set the `writeConcern` option when starting the transaction with startTransaction.

Return Values

A MongoDB\InsertManyResult object, which encapsulates a MongoDB\Driver\WriteResult object.

Errors/Exceptions

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\BulkWriteException for errors related to the write operation. Users should inspect the value returned by getWriteResult() to determine the nature of the error.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Behavior

If a MongoDB\Driver\Exception\BulkWriteException is thrown, users should call getWriteResult() and inspect the returned MongoDB\Driver\WriteResult object to determine the nature of the error.

For example, a write operation may have been successfully applied to the primary server but failed to satisfy the write concern (e.g. replication took too long). Alternatively, a write operation may have failed outright (e.g. unique key violation).

In the case of a bulk write, the result may indicate multiple successful write operations and/or errors. If the ordered option is true, some operations may have succeeded before the first error was encountered and the exception thrown. If the ordered option is false, multiple errors may have been encountered.

Example

The following operation inserts two documents into the users collection in the test database:

copy

<?php

$collection = (new MongoDB\Client)->test->users;

$insertManyResult = $collection->insertMany([
    [
        'username' => 'admin',
        'email' => 'admin@example.com',
        'name' => 'Admin User',
    ],
    [
        'username' => 'test',
        'email' => 'test@example.com',
        'name' => 'Test User',
    ],
]);

printf("Inserted %d document(s)\n", $insertManyResult->getInsertedCount());

var_dump($insertManyResult->getInsertedIds());

The output would then resemble:

Inserted 2 document(s)
array(2) {
  [0]=>
  object(MongoDB\BSON\ObjectId)#11 (1) {
    ["oid"]=>
    string(24) "579a25921f417dd1e5518141"
  }
  [1]=>
  object(MongoDB\BSON\ObjectId)#12 (1) {
    ["oid"]=>
    string(24) "579a25921f417dd1e5518142"
  }
}