sql() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  eb432528_5e12_9f5b_6ed4_4aeab03024d8["sql()"]
  99347ab2_b1a1_faf4_e37c_7643e4b2eb8a["sql.ts"]
  eb432528_5e12_9f5b_6ed4_4aeab03024d8 -->|defined in| 99347ab2_b1a1_faf4_e37c_7643e4b2eb8a
  style eb432528_5e12_9f5b_6ed4_4aeab03024d8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/sql/sql.ts lines 485–495

export function sql(strings: TemplateStringsArray, ...params: SQLChunk[]): SQL {
	const queryChunks: SQLChunk[] = [];
	if (params.length > 0 || (strings.length > 0 && strings[0] !== '')) {
		queryChunks.push(new StringChunk(strings[0]!));
	}
	for (const [paramIndex, param] of params.entries()) {
		queryChunks.push(param, new StringChunk(strings[paramIndex + 1]!));
	}

	return new SQL(queryChunks);
}