feat: add support for whereNotInUnnest

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v8.3.0 (2024-09-02)
+
+- add support for `Query\Builder::whereNotInUnnest(...)` (#225)
+
 # v8.2.0 (2024-08-05)
 
 > [!NOTE]

src/Query/Builder.php

@@ -151,20 +151,31 @@ public function whereInArray(string $column, $value, string $boolean = 'and')
      * @param string $boolean
      * @return $this
      */
-    public function whereInUnnest(string $column, $values, string $boolean = 'and')
+    public function whereInUnnest(string $column, $values, string $boolean = 'and', bool $not = false)
     {
         $type = 'InUnnest';
 
         // prevent getBindings() from flattening the array by wrapping it in a class
         $values = ($values instanceof Nested) ? $values : new Nested($values);
 
-        $this->wheres[] = compact('type', 'column', 'values', 'boolean');
+        $this->wheres[] = compact('type', 'column', 'values', 'boolean', 'not');
 
         $this->addBinding($values);
 
         return $this;
     }
 
+    /**
+     * @param string $column
+     * @param array<array-key, mixed>|Arrayable<array-key, mixed>|Nested $values
+     * @param string $boolean
+     * @return $this
+     */
+    public function whereNotInUnnest(string $column, array|Arrayable|Nested $values, string $boolean = 'and'): static
+    {
+        return $this->whereInUnnest($column, $values, $boolean, true);
+    }
+
     /**
      * @param array<array-key, mixed> $values
      * @return array<int, mixed>

src/Query/Grammar.php

@@ -121,7 +121,7 @@ protected function whereInArray(Builder $query, $where)
 
     /**
      * @param Builder $query
-     * @param array $where
+     * @param array $where{ values: Nested, column: string, not: bool }
      * @return string
      */
     protected function whereInUnnest(Builder $query, $where)
@@ -132,9 +132,13 @@ protected function whereInUnnest(Builder $query, $where)
             throw new RuntimeException('Invalid Type:'.get_class($values).' given. '.Nested::class.' expected.');
         }
 
-        return (count($values) > 0)
-            ? $this->wrap($where['column']).' in unnest(?)'
-            : '0 = 1';
+        if (count($values) <= 0) {
+            return '0 = 1';
+        }
+
+        return $this->wrap($where['column'])
+            . ($where['not'] ? ' not' : '')
+            . ' in unnest(?)';
     }
 
     /**

tests/Query/BuilderTest.php

@@ -22,11 +22,8 @@
 use Colopl\Spanner\Schema\Blueprint;
 use Colopl\Spanner\Tests\TestCase;
 use Colopl\Spanner\TimestampBound\ExactStaleness;
-use Google\Cloud\Core\Exception\ConflictException;
-use Google\Cloud\Core\Exception\DeadlineExceededException;
 use Google\Cloud\Spanner\Bytes;
 use Google\Cloud\Spanner\Duration;
-use Illuminate\Database\Events\QueryExecuted;
 use Illuminate\Database\QueryException;
 use Illuminate\Support\Carbon;
 use LogicException;

tests/Query/UnnestTest.php

@@ -72,4 +72,30 @@ public function test_whereInUnnest__with_more_than_950_parameters(): void
         $expected = collect([$id1, $id2])->sort()->values()->all();
         $this->assertSame($expected, $given);
     }
+
+
+    public function test_whereNotInUnnest(): void
+    {
+        $conn = $this->getDefaultConnection();
+        $tableName = self::TABLE_NAME_TEST;
+
+        $testDataCount = 3;
+        $insertValues = [];
+        for ($i = 0; $i < $testDataCount; $i++) {
+            $insertValues[] = $this->generateTestRow();
+        }
+        $qb = $conn->table($tableName);
+        $qb->insert($insertValues);
+
+        $ids = $qb->pluck('testId')->sort()->values();
+
+        $qb = $qb->whereNotInUnnest('testId', [$ids->first()]);
+        $sql = $qb->toSql();
+        $results = $qb->get('testId')->pluck('testId')->sort()->values();
+
+        $this->assertSame('select * from `Test` where `testId` not in unnest(?)', $sql);
+        $this->assertCount(2, $results);
+        $this->assertSame($ids->skip(1)->values()->all(), $results->all());
+    }
+
 }