prepareDropParams() — drizzle-orm Function Reference

Architecture documentation for the prepareDropParams() function in utils.ts from the drizzle-orm codebase.

Function typescript DrizzleKit CLIWorkflow calls 2 called by 1

Entity Profile

DrizzleKit→ CLIWorkflow→ prepareDropParams() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  c7328928_5db3_f48d_da99_9ac1d9dce97a["prepareDropParams()"]
  09e5bcf1_0f03_3dbd_fbdb_762440f28855["utils.ts"]
  c7328928_5db3_f48d_da99_9ac1d9dce97a -->|defined in| 09e5bcf1_0f03_3dbd_fbdb_762440f28855
  67a4966d_9164_7cb1_dcd5_8c205545c584["drop.transform()"]
  67a4966d_9164_7cb1_dcd5_8c205545c584 -->|calls| c7328928_5db3_f48d_da99_9ac1d9dce97a
  face3c40_88e9_a534_6538_9c662631c6f6["drizzleConfigFromFile()"]
  c7328928_5db3_f48d_da99_9ac1d9dce97a -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  c7328928_5db3_f48d_da99_9ac1d9dce97a -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  style c7328928_5db3_f48d_da99_9ac1d9dce97a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/utils.ts lines 114–137

export const prepareDropParams = async (
	options: {
		config?: string;
		out?: string;
		driver?: Driver;
		dialect?: Dialect;
	},
	from: 'cli' | 'config',
): Promise<{ out: string; bundle: boolean }> => {
	const config = from === 'config'
		? await drizzleConfigFromFile(options.config as string | undefined)
		: options;

	if (config.dialect === 'gel') {
		console.log(
			error(
				`You can't use 'drop' command with Gel dialect`,
			),
		);
		process.exit(1);
	}

	return { out: config.out || 'drizzle', bundle: config.driver === 'expo' };
};