substring() — drizzle-orm Function Reference

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

Function typescript DrizzleORM RelationalQuery

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

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

export function substring(
	column: GelColumn | 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);
}