substring() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ substring() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  ff96e968_a4b7_505e_fd59_a2a30cf291bc["substring()"]
  cabc09a3_ec84_8c89_c79b_2f73bcd7c163["expressions.ts"]
  ff96e968_a4b7_505e_fd59_a2a30cf291bc -->|defined in| cabc09a3_ec84_8c89_c79b_2f73bcd7c163
  style ff96e968_a4b7_505e_fd59_a2a30cf291bc fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/pg-core/expressions.ts lines 12–25

export function substring(
	column: PgColumn | SQL.Aliased,
	{ from, for: _for }: { from?: number | Placeholder | SQLWrapper; for?: number | Placeholder | SQLWrapper },
): SQL {
	const chunks: SQLChunk[] = [sql`substring(`, column];
	if (from !== undefined) {
		chunks.push(sql` from `, bindIfParam(from, column));
	}
	if (_for !== undefined) {
		chunks.push(sql` for `, bindIfParam(_for, column));
	}
	chunks.push(sql`)`);
	return sql.join(chunks);
}