migrate.handler() — drizzle-orm Function Reference

Architecture documentation for the migrate.handler() function in schema.ts from the drizzle-orm codebase.

Function typescript DrizzleKit Introspection calls 5

Entity Profile

DrizzleKit→ Introspection→ migrate.handler() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8["migrate.handler()"]
  5bf76609_579e_d312_b33b_ab5b8b683111["schema.ts"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|defined in| 5bf76609_579e_d312_b33b_ab5b8b683111
  f2f9c6b8_d549_9373_9f11_ab0b6ee7eea1["assertOrmCoreVersion()"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|calls| f2f9c6b8_d549_9373_9f11_ab0b6ee7eea1
  773f4a96_2112_a02f_6216_ecef4a99527a["assertPackages()"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|calls| 773f4a96_2112_a02f_6216_ecef4a99527a
  bc2114db_3ee1_5e98_347a_e99ec7dcab98["ormVersionGt()"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|calls| bc2114db_3ee1_5e98_347a_e99ec7dcab98
  071bfc71_ad06_c0c4_cba2_360298dd4b47["assertUnreachable()"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|calls| 071bfc71_ad06_c0c4_cba2_360298dd4b47
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  style cf3ca1b1_f0b7_fe02_ec48_9a8e753b8fb8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/schema.ts lines 123–220

	handler: async (opts) => {
		await assertOrmCoreVersion();
		await assertPackages('drizzle-orm');

		const { dialect, schema, table, out, credentials } = opts;
		try {
			if (dialect === 'postgresql') {
				if ('driver' in credentials) {
					const { driver } = credentials;
					if (driver === 'aws-data-api') {
						if (!(await ormVersionGt('0.30.10'))) {
							console.log(
								"To use 'aws-data-api' driver - please update drizzle-orm to the latest version",
							);
							process.exit(1);
						}
					} else if (driver === 'pglite') {
						if (!(await ormVersionGt('0.30.6'))) {
							console.log(
								"To use 'pglite' driver - please update drizzle-orm to the latest version",
							);
							process.exit(1);
						}
					} else {
						assertUnreachable(driver);
					}
				}
				const { preparePostgresDB } = await import('./connections');
				const { migrate } = await preparePostgresDB(credentials);
				await renderWithTask(
					new MigrateProgress(),
					migrate({
						migrationsFolder: out,
						migrationsTable: table,
						migrationsSchema: schema,
					}),
				);
			} else if (dialect === 'mysql') {
				const { connectToMySQL } = await import('./connections');
				const { migrate } = await connectToMySQL(credentials);
				await renderWithTask(
					new MigrateProgress(),
					migrate({
						migrationsFolder: out,
						migrationsTable: table,
						migrationsSchema: schema,
					}),
				);
			} else if (dialect === 'singlestore') {
				const { connectToSingleStore } = await import('./connections');
				const { migrate } = await connectToSingleStore(credentials);
				await renderWithTask(
					new MigrateProgress(),
					migrate({
						migrationsFolder: out,
						migrationsTable: table,
						migrationsSchema: schema,
					}),
				);
			} else if (dialect === 'sqlite') {
				const { connectToSQLite } = await import('./connections');
				const { migrate } = await connectToSQLite(credentials);
				await renderWithTask(
					new MigrateProgress(),
					migrate({
						migrationsFolder: opts.out,
						migrationsTable: table,
						migrationsSchema: schema,
					}),
				);
			} else if (dialect === 'turso') {
				const { connectToLibSQL } = await import('./connections');
				const { migrate } = await connectToLibSQL(credentials);
				await renderWithTask(
					new MigrateProgress(),
					migrate({
						migrationsFolder: opts.out,
						migrationsTable: table,
						migrationsSchema: schema,
					}),
				);