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
  85408706_5160_9850_2b44_222ba3ff501c["convert()"]
  aedf7812_108a_f1ca_1873_9b82887d998e["PgAlterTableAlterCompositePrimaryKeyConvertor"]
  85408706_5160_9850_2b44_222ba3ff501c -->|defined in| aedf7812_108a_f1ca_1873_9b82887d998e
  style 85408706_5160_9850_2b44_222ba3ff501c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 3111–3124

	convert(statement: JsonAlterCompositePK) {
		const { name, columns } = PgSquasher.unsquashPK(statement.old);
		const { name: newName, columns: newColumns } = PgSquasher.unsquashPK(
			statement.new,
		);

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

		return `ALTER TABLE ${tableNameWithSchema} DROP CONSTRAINT "${statement.oldConstraintName}";\n${BREAKPOINT}ALTER TABLE ${tableNameWithSchema} ADD CONSTRAINT "${statement.newConstraintName}" PRIMARY KEY("${
			newColumns.join('","')
		}");`;
	}