pull.handler() — drizzle-orm Function Reference

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

Function typescript DrizzleKit Introspection calls 6

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

drizzle-kit/src/cli/schema.ts lines 509–630

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

		const {
			dialect,
			credentials,
			out,
			casing,
			breakpoints,
			tablesFilter,
			schemasFilter,
			prefix,
			entities,
		} = config;
		mkdirSync(out, { recursive: true });

		console.log(
			grey(
				`Pulling from [${
					schemasFilter
						.map((it) => `'${it}'`)
						.join(', ')
				}] list of schemas`,
			),
		);
		console.log();

		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 { introspectPostgres } = await import('./commands/introspect');
				await introspectPostgres(
					casing,
					out,
					breakpoints,
					credentials,
					tablesFilter,
					schemasFilter,
					prefix,
					entities,
				);
			} else if (dialect === 'mysql') {
				const { introspectMysql } = await import('./commands/introspect');
				await introspectMysql(
					casing,
					out,
					breakpoints,
					credentials,
					tablesFilter,
					prefix,
				);
			} else if (dialect === 'sqlite') {
				const { introspectSqlite } = await import('./commands/introspect');
				await introspectSqlite(
					casing,
					out,
					breakpoints,
					credentials,
					tablesFilter,
					prefix,