drizzle-orm Architecture Docs
Home / Function/ drizzleConfigFromFile() — drizzle-orm Function Reference

drizzleConfigFromFile() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow calls 3 called by 8

Entity Profile

Dependency Diagram

graph TD
  face3c40_88e9_a534_6538_9c662631c6f6["drizzleConfigFromFile()"]
  09e5bcf1_0f03_3dbd_fbdb_762440f28855["utils.ts"]
  face3c40_88e9_a534_6538_9c662631c6f6 -->|defined in| 09e5bcf1_0f03_3dbd_fbdb_762440f28855
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191["prepareCheckParams()"]
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  c7328928_5db3_f48d_da99_9ac1d9dce97a["prepareDropParams()"]
  c7328928_5db3_f48d_da99_9ac1d9dce97a -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  d8e81f13_ca82_f43e_b1af_dd7ca01cbee1["prepareGenerateConfig()"]
  d8e81f13_ca82_f43e_b1af_dd7ca01cbee1 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2["prepareExportConfig()"]
  9a3b19e2_a7d5_5e85_8b45_0f77ed2556a2 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  a1933878_8b6f_3410_d1a4_4a23055ce7d6["preparePushConfig()"]
  a1933878_8b6f_3410_d1a4_4a23055ce7d6 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  f2b425f7_cbc7_24b4_bcbe_192d9e3373b7["preparePullConfig()"]
  f2b425f7_cbc7_24b4_bcbe_192d9e3373b7 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  c0073ae8_c7f4_3872_09e0_5c7266fa8ffe["prepareStudioConfig()"]
  c0073ae8_c7f4_3872_09e0_5c7266fa8ffe -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  8c86936c_ce1b_9826_3df0_d5ccb901cc8e["prepareMigrateConfig()"]
  8c86936c_ce1b_9826_3df0_d5ccb901cc8e -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  9dfdf37a_ee36_44bf_591c_6c4ea46549dc["grey()"]
  face3c40_88e9_a534_6538_9c662631c6f6 -->|calls| 9dfdf37a_ee36_44bf_591c_6c4ea46549dc
  54221957_c725_0bfe_4345_4f3837d39296["safeRegister()"]
  face3c40_88e9_a534_6538_9c662631c6f6 -->|calls| 54221957_c725_0bfe_4345_4f3837d39296
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  face3c40_88e9_a534_6538_9c662631c6f6 -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  style face3c40_88e9_a534_6538_9c662631c6f6 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/utils.ts lines 876–927

export const drizzleConfigFromFile = async (
	configPath?: string,
	isExport?: boolean,
): Promise<CliConfig> => {
	const prefix = process.env.TEST_CONFIG_PATH_PREFIX || '';

	const defaultTsConfigExists = existsSync(resolve(join(prefix, 'drizzle.config.ts')));
	const defaultJsConfigExists = existsSync(resolve(join(prefix, 'drizzle.config.js')));
	const defaultJsonConfigExists = existsSync(
		join(resolve('drizzle.config.json')),
	);

	const defaultConfigPath = defaultTsConfigExists
		? 'drizzle.config.ts'
		: defaultJsConfigExists
		? 'drizzle.config.js'
		: 'drizzle.config.json';

	if (!configPath && !isExport) {
		console.log(
			chalk.gray(
				`No config path provided, using default '${defaultConfigPath}'`,
			),
		);
	}

	const path: string = resolve(join(prefix, configPath ?? defaultConfigPath));

	if (!existsSync(path)) {
		console.log(`${path} file does not exist`);
		process.exit(1);
	}

	if (!isExport) console.log(chalk.grey(`Reading config file '${path}'`));

	const { unregister } = await safeRegister();
	const required = require(`${path}`);
	const content = required.default ?? required;
	unregister();

	// --- get response and then check by each dialect independently
	const res = configCommonSchema.safeParse(content);
	if (!res.success) {
		console.log(res.error);
		if (!('dialect' in content)) {
			console.log(error("Please specify 'dialect' param in config file"));
		}
		process.exit(1);
	}

	return res.data;
};

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does drizzleConfigFromFile() do?
drizzleConfigFromFile() is a function in the drizzle-orm codebase, defined in drizzle-kit/src/cli/commands/utils.ts.
Where is drizzleConfigFromFile() defined?
drizzleConfigFromFile() is defined in drizzle-kit/src/cli/commands/utils.ts at line 876.
What does drizzleConfigFromFile() call?
drizzleConfigFromFile() calls 3 function(s): error, grey, safeRegister.
What calls drizzleConfigFromFile()?
drizzleConfigFromFile() is called by 8 function(s): prepareCheckParams, prepareDropParams, prepareExportConfig, prepareGenerateConfig, prepareMigrateConfig, preparePullConfig, preparePushConfig, prepareStudioConfig.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free