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
  8da4df4f_3974_eade_4ab6_db36117e8ab6["convert()"]
  b7ba37dd_1e2b_8816_6766_2f8d0db9a4ba["PgAlterTableAddCheckConstraintConvertor"]
  8da4df4f_3974_eade_4ab6_db36117e8ab6 -->|defined in| b7ba37dd_1e2b_8816_6766_2f8d0db9a4ba
  style 8da4df4f_3974_eade_4ab6_db36117e8ab6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1186–1194

	convert(statement: JsonCreateCheckConstraint): string {
		const unsquashed = PgSquasher.unsquashCheck(statement.data);

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

		return `ALTER TABLE ${tableNameWithSchema} ADD CONSTRAINT "${unsquashed.name}" CHECK (${unsquashed.value});`;
	}