convert() — drizzle-orm Function Reference

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

Function typescript DrizzleKit Introspection calls 1

Entity Profile

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

Dependency Diagram

graph TD
  5d74f2d3_75ea_3b3e_58ff_04a35f70eafd["convert()"]
  13136106_a856_4f84_043e_c76843b1dc3f["CreateTypeEnumConvertor"]
  5d74f2d3_75ea_3b3e_58ff_04a35f70eafd -->|defined in| 13136106_a856_4f84_043e_c76843b1dc3f
  6a0cfd17_5e20_42bb_3596_ae02093b0fda["escapeSingleQuotes()"]
  5d74f2d3_75ea_3b3e_58ff_04a35f70eafd -->|calls| 6a0cfd17_5e20_42bb_3596_ae02093b0fda
  style 5d74f2d3_75ea_3b3e_58ff_04a35f70eafd fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1380–1401

	convert(st: JsonCreateEnumStatement) {
		const { name, values, schema } = st;

		const enumNameWithSchema = schema ? `"${schema}"."${name}"` : `"${name}"`;

		let valuesStatement = '(';
		valuesStatement += values.map((it) => `'${escapeSingleQuotes(it)}'`).join(', ');
		valuesStatement += ')';

		// TODO do we need this?
		// let statement = 'DO $$ BEGIN';
		// statement += '\n';
		let statement = `CREATE TYPE ${enumNameWithSchema} AS ENUM${valuesStatement};`;
		// statement += '\n';
		// statement += 'EXCEPTION';
		// statement += '\n';
		// statement += ' WHEN duplicate_object THEN null;';
		// statement += '\n';
		// statement += 'END $$;';
		// statement += '\n';
		return statement;
	}