arrayContained() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects calls 1

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-orm/src/sql/expressions/conditions.ts lines 680–693

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

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