seed() — drizzle-orm Function Reference

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

Function typescript DrizzleSeed SeedOrchestration

Entity Profile

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

Dependency Diagram

graph TD
  ee61d65c_3a91_eebf_195c_778a484baf2b["seed()"]
  0fabdd81_61c9_bb7c_7ddf_dde7a6071abc["index.ts"]
  ee61d65c_3a91_eebf_195c_778a484baf2b -->|defined in| 0fabdd81_61c9_bb7c_7ddf_dde7a6071abc
  style ee61d65c_3a91_eebf_195c_778a484baf2b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-seed/src/index.ts lines 346–364

export function seed<
	DB extends
		| PgDatabase<any, any>
		| MySqlDatabase<any, any, any, any>
		| BaseSQLiteDatabase<any, any>,
	SCHEMA extends {
		[key: string]:
			| PgTable
			| PgSchema
			| MySqlTable
			| MySqlSchema
			| SQLiteTable
			| Relations
			| any;
	},
	VERSION extends '2' | '1' | undefined,
>(db: DB, schema: SCHEMA, options?: { count?: number; seed?: number; version?: VERSION }) {
	return new SeedPromise<typeof db, typeof schema, VERSION>(db, schema, options);
}