_prepareSqliteAddColumns() — drizzle-orm Function Reference

Architecture documentation for the _prepareSqliteAddColumns() function in jsonStatements.ts from the drizzle-orm codebase.

Function typescript DrizzleKit Introspection calls 1 called by 2

Entity Profile

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

Dependency Diagram

graph TD
  43392e0f_0d9a_fa67_3a01_ef88318d18a3["_prepareSqliteAddColumns()"]
  6139f734_8ada_c641_9fec_9a55cfdf376f["jsonStatements.ts"]
  43392e0f_0d9a_fa67_3a01_ef88318d18a3 -->|defined in| 6139f734_8ada_c641_9fec_9a55cfdf376f
  d9097b7e_1e27_d29f_7732_f2fa1447f2b8["applySqliteSnapshotsDiff()"]
  d9097b7e_1e27_d29f_7732_f2fa1447f2b8 -->|calls| 43392e0f_0d9a_fa67_3a01_ef88318d18a3
  55569cde_7638_9cfc_9dcd_34636d975ec3["applyLibSQLSnapshotsDiff()"]
  55569cde_7638_9cfc_9dcd_34636d975ec3 -->|calls| 43392e0f_0d9a_fa67_3a01_ef88318d18a3
  5fbcc7ce_945a_7e2d_e12d_559fa5000971["warning()"]
  43392e0f_0d9a_fa67_3a01_ef88318d18a3 -->|calls| 5fbcc7ce_945a_7e2d_e12d_559fa5000971
  style 43392e0f_0d9a_fa67_3a01_ef88318d18a3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/jsonStatements.ts lines 1332–1360

export const _prepareSqliteAddColumns = (
	tableName: string,
	columns: Column[],
	referenceData: string[],
): JsonSqliteAddColumnStatement[] => {
	const unsquashed = referenceData.map((addedFkValue) => SQLiteSquasher.unsquashFK(addedFkValue));

	return columns
		.map((it) => {
			const columnsWithReference = unsquashed.find((t) => t.columnsFrom.includes(it.name));

			if (it.generated?.type === 'stored') {
				warning(
					`As SQLite docs mention: "It is not possible to ALTER TABLE ADD COLUMN a STORED column. One can add a VIRTUAL column, however", source: "https://www.sqlite.org/gencol.html"`,
				);
				return undefined;
			}

			return {
				type: 'sqlite_alter_table_add_column',
				tableName: tableName,
				column: it,
				referenceData: columnsWithReference
					? SQLiteSquasher.squashFK(columnsWithReference)
					: undefined,
			};
		})
		.filter(Boolean) as JsonSqliteAddColumnStatement[];
};