arrayContains() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/sql/expressions/conditions.ts lines 632–645

export function arrayContains(
	column: SQLWrapper,
	values: (unknown | Placeholder)[] | SQLWrapper,
): SQL {
	if (Array.isArray(values)) {
		if (values.length === 0) {
			throw new Error('arrayContains requires at least one value');
		}
		const array = sql`${bindIfParam(values, column)}`;
		return sql`${column} @> ${array}`;
	}

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