convert() — drizzle-orm Function Reference

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

Function typescript DrizzleKit Introspection

Entity Profile

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

Dependency Diagram

graph TD
  81f5ebf0_2a2c_eebd_48eb_304be1169461["convert()"]
  918d5543_d0c5_332a_287b_5c5e1e95a771["PgAlterTableAlterColumnSetExpressionConvertor"]
  81f5ebf0_2a2c_eebd_48eb_304be1169461 -->|defined in| 918d5543_d0c5_332a_287b_5c5e1e95a771
  style 81f5ebf0_2a2c_eebd_48eb_304be1169461 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 2031–2068

	convert(statement: JsonAlterColumnSetGeneratedStatement) {
		const {
			tableName,
			columnName,
			schema,
			columnNotNull: notNull,
			columnDefault,
			columnOnUpdate,
			columnAutoIncrement,
			columnPk,
			columnGenerated,
		} = statement;

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

		const addColumnStatement = new PgAlterTableAddColumnConvertor().convert({
			schema,
			tableName,
			column: {
				name: columnName,
				type: statement.newDataType,
				notNull,
				default: columnDefault,
				onUpdate: columnOnUpdate,
				autoincrement: columnAutoIncrement,
				primaryKey: columnPk,
				generated: columnGenerated,
			},
			type: 'alter_table_add_column',
		});

		return [
			`ALTER TABLE ${tableNameWithSchema} drop column "${columnName}";`,
			addColumnStatement,
		];
	}