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
  65f043f1_0514_27ac_9803_baa63e6974cf["convert()"]
  3d49d42b_42f9_478d_3246_9680ec18d808["PgAlterTableCreateCompositePrimaryKeyConvertor"]
  65f043f1_0514_27ac_9803_baa63e6974cf -->|defined in| 3d49d42b_42f9_478d_3246_9680ec18d808
  style 65f043f1_0514_27ac_9803_baa63e6974cf fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 3078–3088

	convert(statement: JsonCreateCompositePK) {
		const { name, columns } = PgSquasher.unsquashPK(statement.data);

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

		return `ALTER TABLE ${tableNameWithSchema} ADD CONSTRAINT "${statement.constraintName}" PRIMARY KEY("${
			columns.join('","')
		}");`;
	}