printConfigConnectionIssues() — drizzle-orm Function Reference

Architecture documentation for the printConfigConnectionIssues() function in postgres.ts from the drizzle-orm codebase.

Function typescript DrizzleKit CLIWorkflow calls 2

Entity Profile

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

Dependency Diagram

graph TD
  ad6b53b6_e24e_ec86_a66a_3309f79f837f["printConfigConnectionIssues()"]
  aa34baa9_cce1_f1d8_4227_98c889d76b37["postgres.ts"]
  ad6b53b6_e24e_ec86_a66a_3309f79f837f -->|defined in| aa34baa9_cce1_f1d8_4227_98c889d76b37
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  ad6b53b6_e24e_ec86_a66a_3309f79f837f -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  b00190f0_9c7c_acbf_86f7_950ac8c79592["wrapParam()"]
  ad6b53b6_e24e_ec86_a66a_3309f79f837f -->|calls| b00190f0_9c7c_acbf_86f7_950ac8c79592
  style ad6b53b6_e24e_ec86_a66a_3309f79f837f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/validations/postgres.ts lines 46–83

export const printConfigConnectionIssues = (
	options: Record<string, unknown>,
) => {
	if (options.driver === 'aws-data-api') {
		let text = `Please provide required params for AWS Data API driver:\n`;
		console.log(error(text));
		console.log(wrapParam('database', options.database));
		console.log(wrapParam('secretArn', options.secretArn, false, 'secret'));
		console.log(wrapParam('resourceArn', options.resourceArn, false, 'secret'));
		process.exit(1);
	}

	if ('url' in options) {
		let text = `Please provide required params for Postgres driver:\n`;
		console.log(error(text));
		console.log(wrapParam('url', options.url, false, 'url'));
		process.exit(1);
	}

	if ('host' in options || 'database' in options) {
		let text = `Please provide required params for Postgres driver:\n`;
		console.log(error(text));
		console.log(wrapParam('host', options.host));
		console.log(wrapParam('port', options.port, true));
		console.log(wrapParam('user', options.user, true));
		console.log(wrapParam('password', options.password, true, 'secret'));
		console.log(wrapParam('database', options.database));
		console.log(wrapParam('ssl', options.ssl, true));
		process.exit(1);
	}

	console.log(
		error(
			`Either connection "url" or "host", "database" are required for PostgreSQL database connection`,
		),
	);
	process.exit(1);
};