printConfigConnectionIssues() — drizzle-orm Function Reference

Architecture documentation for the printConfigConnectionIssues() function in sqlite.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
  d70ffae9_1857_cf96_bada_67408412252e["printConfigConnectionIssues()"]
  340acff6_8c1f_b0b5_9358_222e8b76d050["sqlite.ts"]
  d70ffae9_1857_cf96_bada_67408412252e -->|defined in| 340acff6_8c1f_b0b5_9358_222e8b76d050
  b0ef3d06_896b_eefc_c410_dfb419673d70["error()"]
  d70ffae9_1857_cf96_bada_67408412252e -->|calls| b0ef3d06_896b_eefc_c410_dfb419673d70
  b00190f0_9c7c_acbf_86f7_950ac8c79592["wrapParam()"]
  d70ffae9_1857_cf96_bada_67408412252e -->|calls| b00190f0_9c7c_acbf_86f7_950ac8c79592
  style d70ffae9_1857_cf96_bada_67408412252e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/cli/validations/sqlite.ts lines 40–104

export const printConfigConnectionIssues = (
	options: Record<string, unknown>,
	command: 'generate' | 'migrate' | 'push' | 'pull' | 'studio',
) => {
	const parsedDriver = sqliteDriver.safeParse(options.driver);
	const driver = parsedDriver.success ? parsedDriver.data : ('' as never);

	if (driver === 'expo') {
		if (command === 'migrate') {
			console.log(
				error(
					`You can't use 'migrate' command with Expo SQLite, please follow migration instructions in our docs - https://orm.drizzle.team/docs/get-started-sqlite#expo-sqlite`,
				),
			);
		} else if (command === 'studio') {
			console.log(
				error(
					`You can't use 'studio' command with Expo SQLite, please use Expo Plugin https://www.npmjs.com/package/expo-drizzle-studio-plugin`,
				),
			);
		} else if (command === 'pull') {
			console.log(error("You can't use 'pull' command with Expo SQLite"));
		} else if (command === 'push') {
			console.log(error("You can't use 'push' command with Expo SQLite"));
		} else {
			console.log(error('Unexpected error with expo driver 🤔'));
		}
		process.exit(1);
	} else if (driver === 'd1-http') {
		let text = `Please provide required params for D1 HTTP driver:\n`;
		console.log(error(text));
		console.log(wrapParam('accountId', options.accountId));
		console.log(wrapParam('databaseId', options.databaseId));
		console.log(wrapParam('token', options.token, false, 'secret'));
		process.exit(1);
	} else if (driver === 'durable-sqlite') {
		if (command === 'migrate') {
			console.log(
				error(
					`You can't use 'migrate' command with SQLite Durable Objects`,
				),
			);
		} else if (command === 'studio') {
			console.log(
				error(
					`You can't use 'studio' command with SQLite Durable Objects`,
				),
			);
		} else if (command === 'pull') {
			console.log(error("You can't use 'pull' command with SQLite Durable Objects"));
		} else if (command === 'push') {
			console.log(error("You can't use 'push' command with SQLite Durable Objects"));
		} else {
			console.log(error('Unexpected error with SQLite Durable Object driver 🤔'));
		}
		process.exit(1);
	} else {
		softAssertUnreachable(driver);
	}

	let text = `Please provide required params:\n`;
	console.log(error(text));
	console.log(wrapParam('url', options.url));
	process.exit(1);
};