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

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 3904–3950

	convert(statement: JsonRecreateSingleStoreTableStatement): string[] {
		const { tableName, columns, compositePKs, uniqueConstraints } = statement;

		const columnNames = columns.map((it) => `\`${it.name}\``).join(', ');
		const newTableName = `__new_${tableName}`;

		const sqlStatements: string[] = [];

		// create new table
		sqlStatements.push(
			new SingleStoreCreateTableConvertor().convert({
				type: 'create_table',
				tableName: newTableName,
				columns,
				compositePKs,
				uniqueConstraints,
				schema: '',
			}),
		);

		// migrate data
		sqlStatements.push(
			`INSERT INTO \`${newTableName}\`(${columnNames}) SELECT ${columnNames} FROM \`${tableName}\`;`,
		);

		// drop table
		sqlStatements.push(
			new SingleStoreDropTableConvertor().convert({
				type: 'drop_table',
				tableName: tableName,
				schema: '',
			}),
		);

		// rename table
		sqlStatements.push(
			new SingleStoreRenameTableConvertor().convert({
				fromSchema: '',
				tableNameFrom: newTableName,
				tableNameTo: tableName,
				toSchema: '',
				type: 'rename_table',
			}),
		);

		return sqlStatements;
	}