substring() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

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

export function substring(
	column: SQLiteColumn | SQL.Aliased,
	{ from, for: _for }: { from?: number | SQLWrapper; for?: number | 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);
}