Implement Query\Builder::insertOrIgnore()

Author: GromNaN

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 * New aggregation pipeline builder by @GromNaN in [#2738](https://github.com/mongodb/laravel-mongodb/pull/2738)
 * Drop support for Composer 1.x by @GromNaN in [#2784](https://github.com/mongodb/laravel-mongodb/pull/2784)
 * Fix `artisan query:retry` command by @GromNaN in [#2838](https://github.com/mongodb/laravel-mongodb/pull/2838)
+* Implement `MongoDB\Laravel\Query\Builder::insertOrIgnore()` to ignore duplicate values
 
 ## [4.2.0] - 2024-03-14
 

src/Query/Builder.php

@@ -23,6 +23,7 @@
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Builder\Stage\FluentFactoryTrait;
 use MongoDB\Driver\Cursor;
+use MongoDB\Driver\Exception\BulkWriteException;
 use Override;
 use RuntimeException;
 
@@ -659,6 +660,26 @@ public function whereBetween($column, iterable $values, $boolean = 'and', $not =
 
     /** @inheritdoc */
     public function insert(array $values)
+    {
+        return $this->performInsert($values);
+    }
+
+    /** @inheritdoc */
+    public function insertOrIgnore(array $values)
+    {
+        try {
+            return $this->performInsert($values, ['ordered' => false]);
+        } catch (BulkWriteException $exception) {
+            // Ignore "duplicate key error"
+            if ($exception->getCode() !== 11000) {
+                throw $exception;
+            }
+
+            return $exception->getWriteResult()->isAcknowledged();
+        }
+    }
+
+    private function performInsert(array $values, array $options = [])
     {
         // Allow empty insert batch for consistency with Eloquent SQL
         if ($values === []) {
@@ -682,7 +703,7 @@ public function insert(array $values)
             $values = [$values];
         }
 
-        $options = $this->inheritConnectionOptions();
+        $options += $this->inheritConnectionOptions();
 
         $result = $this->collection->insertMany($values, $options);
 

tests/QueryBuilderTest.php

@@ -142,6 +142,17 @@ public function testBatchInsert()
         $this->assertIsArray($users[0]['tags']);
     }
 
+    public function testInsertOrIgnoreMethod()
+    {
+        $builder = DB::collection('users');
+        // Expect "duplicate key error" on _id field to be ignored
+        $id = new ObjectId();
+        $this->assertTrue($builder->insertOrIgnore(['_id' => $id]));
+        $this->assertTrue($builder->insertOrIgnore(['_id' => $id]));
+        $this->assertTrue($builder->insertOrIgnore([['_id' => $id], ['foo' => 'bar']]));
+        $this->assertSame(2, $builder->count());
+    }
+
     public function testFind()
     {
         $id = DB::collection('users')->insertGetId(['name' => 'John Doe']);