inArray() — drizzle-orm Function Reference

Architecture documentation for the inArray() function in conditions.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects calls 1

Entity Profile

DrizzleORM→ SQLDialects→ inArray() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  cdbb5661_a9fc_bb21_1c6f_1abe1b9fdd7c["inArray()"]
  57e6e1af_7162_5b6e_bfcf_9d9935f60d31["conditions.ts"]
  cdbb5661_a9fc_bb21_1c6f_1abe1b9fdd7c -->|defined in| 57e6e1af_7162_5b6e_bfcf_9d9935f60d31
  4c6d62d9_6b87_a37a_f778_9a0034345725["bindIfParam()"]
  cdbb5661_a9fc_bb21_1c6f_1abe1b9fdd7c -->|calls| 4c6d62d9_6b87_a37a_f778_9a0034345725
  style cdbb5661_a9fc_bb21_1c6f_1abe1b9fdd7c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sql/expressions/conditions.ts lines 281–293

export function inArray(
	column: SQLWrapper,
	values: ReadonlyArray<unknown | Placeholder> | SQLWrapper,
): SQL {
	if (Array.isArray(values)) {
		if (values.length === 0) {
			return sql`false`;
		}
		return sql`${column} in ${values.map((v) => bindIfParam(v, column))}`;
	}

	return sql`${column} in ${bindIfParam(values, column)}`;
}