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
  3aefef9b_1fa9_d83e_3cff_40d86d486921["convert()"]
  175e030c_37c7_1395_86a6_b3a732d0ed52["SqliteAlterTableAlterColumnDropGeneratedConvertor"]
  3aefef9b_1fa9_d83e_3cff_40d86d486921 -->|defined in| 175e030c_37c7_1395_86a6_b3a732d0ed52
  style 3aefef9b_1fa9_d83e_3cff_40d86d486921 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 2128–2166

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

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

		const dropColumnStatement = new SQLiteAlterTableDropColumnConvertor().convert({
			tableName,
			columnName,
			schema,
			type: 'alter_table_drop_column',
		});

		return [dropColumnStatement, addColumnStatement];
	}