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
  0fe7f590_ecb7_2a55_1488_832f74558f83["convert()"]
  64ac83a9_d9de_70fe_c7e7_7421b5de0987["PgAlterTableAlterColumnDropNotNullConvertor"]
  0fe7f590_ecb7_2a55_1488_832f74558f83 -->|defined in| 64ac83a9_d9de_70fe_c7e7_7421b5de0987
  style 0fe7f590_ecb7_2a55_1488_832f74558f83 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 3321–3329

	convert(statement: JsonAlterColumnDropNotNullStatement) {
		const { tableName, columnName } = statement;

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

		return `ALTER TABLE ${tableNameWithSchema} ALTER COLUMN "${columnName}" DROP NOT NULL;`;
	}