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
  eed92d66_035e_1f10_3279_b5079cee95eb["convert()"]
  1b121685_2750_0618_c906_df4ce68e5484["MySqlCreateForeignKeyConvertor"]
  eed92d66_035e_1f10_3279_b5079cee95eb -->|defined in| 1b121685_2750_0618_c906_df4ce68e5484
  style eed92d66_035e_1f10_3279_b5079cee95eb fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 3407–3423

	convert(statement: JsonCreateReferenceStatement): string {
		const {
			name,
			tableFrom,
			tableTo,
			columnsFrom,
			columnsTo,
			onDelete,
			onUpdate,
		} = MySqlSquasher.unsquashFK(statement.data);
		const onDeleteStatement = onDelete ? ` ON DELETE ${onDelete}` : '';
		const onUpdateStatement = onUpdate ? ` ON UPDATE ${onUpdate}` : '';
		const fromColumnsString = columnsFrom.map((it) => `\`${it}\``).join(',');
		const toColumnsString = columnsTo.map((it) => `\`${it}\``).join(',');

		return `ALTER TABLE \`${tableFrom}\` ADD CONSTRAINT \`${name}\` FOREIGN KEY (${fromColumnsString}) REFERENCES \`${tableTo}\`(${toColumnsString})${onDeleteStatement}${onUpdateStatement};`;
	}