convert() — drizzle-orm Function Reference

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

Function typescript DrizzleKit SchemaDiffer

Entity Profile

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

Dependency Diagram

graph TD
  bcb1152e_243d_290f_855c_76cda53a90d5["convert()"]
  dc286b0f_b5e0_8394_5162_40dff9a5bc85["PgAlterTableRenameColumnConvertor"]
  bcb1152e_243d_290f_855c_76cda53a90d5 -->|defined in| dc286b0f_b5e0_8394_5162_40dff9a5bc85
  style bcb1152e_243d_290f_855c_76cda53a90d5 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1636–1644

	convert(statement: JsonRenameColumnStatement) {
		const { tableName, oldColumnName, newColumnName, schema } = statement;

		const tableNameWithSchema = schema
			? `"${schema}"."${tableName}"`
			: `"${tableName}"`;

		return `ALTER TABLE ${tableNameWithSchema} RENAME COLUMN "${oldColumnName}" TO "${newColumnName}";`;
	}