inArray and notInArray methods

Make inArray and notInArray methods accept an empty list as their second parameter
drizzle-team · Jul 22, 2024 · 8f97370 · 8f97370
1 parent d01cd7f
commit 8f97370
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 3 deletions.
diff --git a/drizzle-orm/src/sql/expressions/conditions.ts b/drizzle-orm/src/sql/expressions/conditions.ts
@@ -289,7 +289,7 @@ export function inArray(
 ): SQL {
 	if (Array.isArray(values)) {
 		if (values.length === 0) {
-			throw new Error('inArray requires at least one value');
+			return sql`false`;
 		}
 		return sql`${column} in ${values.map((v) => bindIfParam(v, column))}`;
 	}
@@ -335,7 +335,7 @@ export function notInArray(
 ): SQL {
 	if (Array.isArray(values)) {
 		if (values.length === 0) {
-			throw new Error('notInArray requires at least one value');
+			return sql`true`;
 		}
 		return sql`${column} not in ${values.map((v) => bindIfParam(v, column))}`;
 	}

diff --git a/integration-tests/tests/mysql/mysql-common.ts b/integration-tests/tests/mysql/mysql-common.ts
@@ -14,6 +14,7 @@ import {
 	gt,
 	gte,
 	inArray,
+	notInArray,
 	lt,
 	max,
 	min,
@@ -534,6 +535,34 @@ export function tests(driver?: string) {
 			expect(users).toEqual([{ name: 'JOHN' }]);
 		});
 
+		test('select with empty array in inArray', async (t) => {
+			const { db } = ctx.mysql;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(inArray(usersTable.id, []));
+
+			expect(result).toEqual([]);
+		});
+
+		test('select with empty array in notInArray', async (t) => {
+			const { db } = ctx.mysql;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(notInArray(usersTable.id, []));
+
+			expect(result).toEqual([{ name: 'JOHN' }, { name: 'JANE' }, { name: 'JANE' }]);
+		});
+
 		test('select distinct', async (ctx) => {
 			const { db } = ctx.mysql;
 

diff --git a/integration-tests/tests/pg/awsdatapi.test.ts b/integration-tests/tests/pg/awsdatapi.test.ts
@@ -2,7 +2,7 @@ import 'dotenv/config';
 
 import { RDSDataClient } from '@aws-sdk/client-rds-data';
 import * as dotenv from 'dotenv';
-import { asc, eq, sql, TransactionRollbackError } from 'drizzle-orm';
+import {asc, eq, inArray, notInArray, sql, TransactionRollbackError} from 'drizzle-orm';
 import type { AwsDataApiPgDatabase } from 'drizzle-orm/aws-data-api/pg';
 import { drizzle } from 'drizzle-orm/aws-data-api/pg';
 import { migrate } from 'drizzle-orm/aws-data-api/pg/migrator';
@@ -105,6 +105,24 @@ test('select sql', async () => {
 	expect(users).toEqual([{ name: 'JOHN' }]);
 });
 
+test('select with empty array in inArray', async () => {
+	await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+	const users = await db.select({
+		name: sql`upper(${usersTable.name})`,
+	}).from(usersTable).where(inArray(usersTable.id, []));
+
+	expect(users).toEqual([]);
+});
+
+test('select with empty array in notInArray', async () => {
+	await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+	const result = await db.select({
+		name: sql`upper(${usersTable.name})`,
+	}).from(usersTable).where(notInArray(usersTable.id, []));
+
+	expect(result).toEqual([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+});
+
 test('select typed sql', async () => {
 	await db.insert(usersTable).values({ name: 'John' });
 	const users = await db.select({

diff --git a/integration-tests/tests/pg/pg-common.ts b/integration-tests/tests/pg/pg-common.ts
@@ -18,6 +18,7 @@ import {
 	gte,
 	ilike,
 	inArray,
+	notInArray,
 	lt,
 	max,
 	min,
@@ -539,6 +540,34 @@ export function tests() {
 			expect(users).toEqual([{ name: 'JOHN' }]);
 		});
 
+		test('select with empty array in inArray', async (t) => {
+			const { db } = ctx.pg;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(inArray(usersTable.id, []));
+
+			expect(result).toEqual([]);
+		});
+
+		test('select with empty array in notInArray', async (t) => {
+			const { db } = ctx.pg;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(notInArray(usersTable.id, []));
+
+			expect(result).toEqual([{ name: 'JOHN' }, { name: 'JANE' }, { name: 'JANE' }]);
+		});
+
 		test('$default function', async (ctx) => {
 			const { db } = ctx.pg;
 

diff --git a/integration-tests/tests/sqlite/sqlite-common.ts b/integration-tests/tests/sqlite/sqlite-common.ts
@@ -11,6 +11,7 @@ import {
 	gt,
 	gte,
 	inArray,
+	notInArray,
 	lt,
 	max,
 	min,
@@ -371,6 +372,34 @@ export function tests() {
 			expect(users).toEqual([{ name: 'JOHN' }]);
 		});
 
+		test('select with empty array in inArray', async (t) => {
+			const { db } = ctx.sqlite;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(inArray(usersTable.id, []));
+
+			expect(result).toEqual([]);
+		});
+
+		test('select with empty array in notInArray', async (t) => {
+			const { db } = ctx.sqlite;
+
+			await db.insert(usersTable).values([{ name: 'John' }, { name: 'Jane' }, { name: 'Jane' }]);
+			const result = await db
+				.select({
+					name: sql`upper(${usersTable.name})`,
+				})
+				.from(usersTable)
+				.where(notInArray(usersTable.id, []));
+
+			expect(result).toEqual([{ name: 'JOHN' }, { name: 'JANE' }, { name: 'JANE' }]);
+		});
+
 		test('select distinct', async (ctx) => {
 			const { db } = ctx.sqlite;