getCustomDefaults() — drizzle-orm Function Reference

Architecture documentation for the getCustomDefaults() function in studio.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer calls 1 called by 5

Entity Profile

DrizzleKit→ SnapshotSerializer→ getCustomDefaults() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  d7ecc303_7005_43ee_f3ad_fa9fa658b409["getCustomDefaults()"]
  82de12f8_a8ca_9d38_8da8_9ac945d81e01["studio.ts"]
  d7ecc303_7005_43ee_f3ad_fa9fa658b409 -->|defined in| 82de12f8_a8ca_9d38_8da8_9ac945d81e01
  f115fdf8_009e_f0a5_2e08_c650dffd2496["drizzleForPostgres()"]
  f115fdf8_009e_f0a5_2e08_c650dffd2496 -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  faf342d9_5e62_6e76_b201_9e470cfbdaa4["drizzleForMySQL()"]
  faf342d9_5e62_6e76_b201_9e470cfbdaa4 -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  1a968317_891c_454b_77a6_20e6f61521b5["drizzleForSQLite()"]
  1a968317_891c_454b_77a6_20e6f61521b5 -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  5f41c0fa_3d50_95fc_cac3_007d8078aa47["drizzleForLibSQL()"]
  5f41c0fa_3d50_95fc_cac3_007d8078aa47 -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  0a6b395c_68c4_22b0_ad06_305965a4dc5a["drizzleForSingleStore()"]
  0a6b395c_68c4_22b0_ad06_305965a4dc5a -->|calls| d7ecc303_7005_43ee_f3ad_fa9fa658b409
  0f6bcec9_496e_3388_a2d6_2f3af1e12d53["getColumnCasing()"]
  d7ecc303_7005_43ee_f3ad_fa9fa658b409 -->|calls| 0f6bcec9_496e_3388_a2d6_2f3af1e12d53
  style d7ecc303_7005_43ee_f3ad_fa9fa658b409 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/serializer/studio.ts lines 240–276

const getCustomDefaults = <T extends AnyTable<{}>>(
	schema: Record<string, Record<string, T>>,
	casing?: CasingType,
): CustomDefault[] => {
	const customDefaults: CustomDefault[] = [];

	Object.entries(schema).map(([schema, tables]) => {
		Object.entries(tables).map(([, table]) => {
			let tableConfig: {
				name: string;
				columns: AnyColumn[];
			};
			if (is(table, PgTable)) {
				tableConfig = pgTableConfig(table);
			} else if (is(table, MySqlTable)) {
				tableConfig = mysqlTableConfig(table);
			} else if (is(table, SQLiteTable)) {
				tableConfig = sqliteTableConfig(table);
			} else {
				tableConfig = singlestoreTableConfig(table as SingleStoreTable);
			}

			tableConfig.columns.map((column) => {
				if (column.defaultFn) {
					customDefaults.push({
						schema,
						table: tableConfig.name,
						column: getColumnCasing(column, casing),
						func: column.defaultFn,
					});
				}
			});
		});
	});

	return customDefaults;
};