convert() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow

Entity Profile

DrizzleKit→ CLIWorkflow→ convert() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  80b8163e_28e7_170c_58f5_7d0e17abbf4c["convert()"]
  2d988a8e_405e_04a0_8ba3_aad1c94131e4["PgRenameTableConvertor"]
  80b8163e_28e7_170c_58f5_7d0e17abbf4c -->|defined in| 2d988a8e_405e_04a0_8ba3_aad1c94131e4
  style 80b8163e_28e7_170c_58f5_7d0e17abbf4c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1586–1593

	convert(statement: JsonRenameTableStatement) {
		const { tableNameFrom, tableNameTo, toSchema, fromSchema } = statement;
		const from = fromSchema
			? `"${fromSchema}"."${tableNameFrom}"`
			: `"${tableNameFrom}"`;
		const to = `"${tableNameTo}"`;
		return `ALTER TABLE ${from} RENAME TO ${to};`;
	}