prepareExportConfig() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow calls 4 called by 1

Entity Profile

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

Dependency Diagram

graph TD
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2["prepareExportConfig()"]
  09e5bcf1_0f03_3dbd_fbdb_762440f28855["utils.ts"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|defined in| 09e5bcf1_0f03_3dbd_fbdb_762440f28855
  8ac39f3a_57cf_0538_3bf2_ca46c4542dc3["exportRaw.transform()"]
  8ac39f3a_57cf_0538_3bf2_ca46c4542dc3 -->|calls| 9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2
  face3c40_88e9_a534_6538_9c662631c6f6["drizzleConfigFromFile()"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  b00190f0_9c7c_acbf_86f7_950ac8c79592["wrapParam()"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|calls| b00190f0_9c7c_acbf_86f7_950ac8c79592
  d2a6d85b_7d3b_7d17_794c_d2cd77de724c["prepareFilenames()"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|calls| d2a6d85b_7d3b_7d17_794c_d2cd77de724c
  style 9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/utils.ts lines 208–238

export const prepareExportConfig = async (
	options: {
		config?: string;
		schema?: string;
		dialect?: Dialect;
		sql: boolean;
	},
	from: 'config' | 'cli',
): Promise<ExportConfig> => {
	const config = from === 'config' ? await drizzleConfigFromFile(options.config, true) : options;

	const { schema, dialect, sql } = config;

	if (!schema || !dialect) {
		console.log(error('Please provide required params:'));
		console.log(wrapParam('schema', schema));
		console.log(wrapParam('dialect', dialect));
		process.exit(1);
	}

	const fileNames = prepareFilenames(schema);
	if (fileNames.length === 0) {
		render(`[${chalk.blue('i')}] No schema file in ${schema} was found`);
		process.exit(0);
	}
	return {
		dialect: dialect,
		schema: schema,
		sql: sql,
	};
};