seedFunc() — drizzle-orm Function Reference

Architecture documentation for the seedFunc() function in index.ts from the drizzle-orm codebase.

Function typescript DrizzleSeed SeedOrchestration calls 3 called by 2

Entity Profile

DrizzleSeed→ SeedOrchestration→ seedFunc() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  50fb8705_0f33_e815_ab1a_b20077e692f8["seedFunc()"]
  0fabdd81_61c9_bb7c_7ddf_dde7a6071abc["index.ts"]
  50fb8705_0f33_e815_ab1a_b20077e692f8 -->|defined in| 0fabdd81_61c9_bb7c_7ddf_dde7a6071abc
  aeeb2367_a282_b6b2_4971_15a31b04f9fe["then()"]
  aeeb2367_a282_b6b2_4971_15a31b04f9fe -->|calls| 50fb8705_0f33_e815_ab1a_b20077e692f8
  0922125a_3416_ba42_60a1_e3254e166402["refine()"]
  0922125a_3416_ba42_60a1_e3254e166402 -->|calls| 50fb8705_0f33_e815_ab1a_b20077e692f8
  04837fc4_7ade_b181_1078_adb2a83fd135["seedPostgres()"]
  50fb8705_0f33_e815_ab1a_b20077e692f8 -->|calls| 04837fc4_7ade_b181_1078_adb2a83fd135
  91804a24_fdec_050d_343d_3b5365a9b5ca["seedMySql()"]
  50fb8705_0f33_e815_ab1a_b20077e692f8 -->|calls| 91804a24_fdec_050d_343d_3b5365a9b5ca
  098c3fad_5eaa_f8ac_60ed_8791f3fd9e74["seedSqlite()"]
  50fb8705_0f33_e815_ab1a_b20077e692f8 -->|calls| 098c3fad_5eaa_f8ac_60ed_8791f3fd9e74
  style 50fb8705_0f33_e815_ab1a_b20077e692f8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-seed/src/index.ts lines 366–399

const seedFunc = async (
	db: PgDatabase<any, any> | MySqlDatabase<any, any> | BaseSQLiteDatabase<any, any>,
	schema: {
		[key: string]:
			| PgTable
			| PgSchema
			| MySqlTable
			| MySqlSchema
			| SQLiteTable
			| Relations
			| any;
	},
	options: { count?: number; seed?: number; version?: string } = {},
	refinements?: RefinementsType,
) => {
	let version: number | undefined;
	if (options?.version !== undefined) {
		version = Number(options?.version);
	}

	if (is(db, PgDatabase<any, any>)) {
		await seedPostgres(db, schema, { ...options, version }, refinements);
	} else if (is(db, MySqlDatabase<any, any>)) {
		await seedMySql(db, schema, { ...options, version }, refinements);
	} else if (is(db, BaseSQLiteDatabase<any, any>)) {
		await seedSqlite(db, schema, { ...options, version }, refinements);
	} else {
		throw new Error(
			'The drizzle-seed package currently supports only PostgreSQL, MySQL, and SQLite databases. Please ensure your database is one of these supported types',
		);
	}

	return;
};