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

prepareCheckParams() — drizzle-orm Function Reference

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

Function typescript DrizzleKit CLIWorkflow calls 3 called by 2

Entity Profile

Dependency Diagram

graph TD
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191["prepareCheckParams()"]
  09e5bcf1_0f03_3dbd_fbdb_762440f28855["utils.ts"]
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 -->|defined in| 09e5bcf1_0f03_3dbd_fbdb_762440f28855
  c4d15e30_a008_294f_9290_2c4fed1237ff["check.transform()"]
  c4d15e30_a008_294f_9290_2c4fed1237ff -->|calls| dc87ddd4_ebb6_e27f_9461_c39a0a9ca191
  f1f8beda_fd6a_e8c0_4640_ab8f8114dd5f["up.transform()"]
  f1f8beda_fd6a_e8c0_4640_ab8f8114dd5f -->|calls| dc87ddd4_ebb6_e27f_9461_c39a0a9ca191
  face3c40_88e9_a534_6538_9c662631c6f6["drizzleConfigFromFile()"]
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 -->|calls| face3c40_88e9_a534_6538_9c662631c6f6
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  b00190f0_9c7c_acbf_86f7_950ac8c79592["wrapParam()"]
  dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 -->|calls| b00190f0_9c7c_acbf_86f7_950ac8c79592
  style dc87ddd4_ebb6_e27f_9461_c39a0a9ca191 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/commands/utils.ts lines 92–112

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

	if (!config.out || !config.dialect) {
		let text = `Please provide required params for AWS Data API driver:\n`;
		console.log(error(text));
		console.log(wrapParam('database', config.out));
		console.log(wrapParam('secretArn', config.dialect));
		process.exit(1);
	}
	return { out: config.out, dialect: config.dialect };
};

Domain

Subdomains

Defined In

Calls

Called By

Source

Frequently Asked Questions

What does prepareCheckParams() do?
prepareCheckParams() is a function in the drizzle-orm codebase, defined in drizzle-kit/src/cli/commands/utils.ts.
Where is prepareCheckParams() defined?
prepareCheckParams() is defined in drizzle-kit/src/cli/commands/utils.ts at line 92.
What does prepareCheckParams() call?
prepareCheckParams() calls 3 function(s): drizzleConfigFromFile, error, wrapParam.
What calls prepareCheckParams()?
prepareCheckParams() is called by 2 function(s): check.transform, up.transform.

Analyze Your Own Codebase

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

Try Supermodel Free