convert() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow

Entity Profile

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

Dependency Diagram

graph TD
  3161dc08_43f0_9de5_9686_baa1103d15f1["convert()"]
  21ee15e6_12ec_de13_040e_179705fb14dc["CreatePgSequenceConvertor"]
  3161dc08_43f0_9de5_9686_baa1103d15f1 -->|defined in| 21ee15e6_12ec_de13_040e_179705fb14dc
  style 3161dc08_43f0_9de5_9686_baa1103d15f1 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1291–1301

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

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

		return `CREATE SEQUENCE ${sequenceWithSchema}${values.increment ? ` INCREMENT BY ${values.increment}` : ''}${
			values.minValue ? ` MINVALUE ${values.minValue}` : ''
		}${values.maxValue ? ` MAXVALUE ${values.maxValue}` : ''}${
			values.startWith ? ` START WITH ${values.startWith}` : ''
		}${values.cache ? ` CACHE ${values.cache}` : ''}${values.cycle ? ` CYCLE` : ''};`;
	}