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
  0143411a_4cc4_e876_aa0d_8204b7800742["convert()"]
  d685d918_bbb9_7678_d4d2_cdcc47853e03["PgAlterTableAlterColumnSetDefaultConvertor"]
  0143411a_4cc4_e876_aa0d_8204b7800742 -->|defined in| d685d918_bbb9_7678_d4d2_cdcc47853e03
  style 0143411a_4cc4_e876_aa0d_8204b7800742 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/sqlgenerator.ts lines 1974–1982

	convert(statement: JsonAlterColumnSetDefaultStatement) {
		const { tableName, columnName, schema } = statement;

		const tableNameWithSchema = schema
			? `"${schema}"."${tableName}"`
			: `"${tableName}"`;

		return `ALTER TABLE ${tableNameWithSchema} ALTER COLUMN "${columnName}" SET DEFAULT ${statement.newDefaultValue};`;
	}