drizzle() — drizzle-orm Function Reference

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

Function typescript DrizzleORM SQLDialects

Entity Profile

DrizzleORM→ SQLDialects→ drizzle() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  47745d76_9bee_6b0e_e577_09a8aa433f4f["drizzle()"]
  a4f01161_60cf_cee3_f86f_bc51f0eacf31["driver.ts"]
  47745d76_9bee_6b0e_e577_09a8aa433f4f -->|defined in| a4f01161_60cf_cee3_f86f_bc51f0eacf31
  style 47745d76_9bee_6b0e_e577_09a8aa433f4f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-orm/src/mysql-proxy/driver.ts lines 26–53

export function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(
	callback: RemoteCallback,
	config: DrizzleConfig<TSchema> = {},
): MySqlRemoteDatabase<TSchema> {
	const dialect = new MySqlDialect({ casing: config.casing });
	let logger;
	if (config.logger === true) {
		logger = new DefaultLogger();
	} else if (config.logger !== false) {
		logger = config.logger;
	}

	let schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined;
	if (config.schema) {
		const tablesConfig = extractTablesRelationalConfig(
			config.schema,
			createTableRelationsHelpers,
		);
		schema = {
			fullSchema: config.schema,
			schema: tablesConfig.tables,
			tableNamesMap: tablesConfig.tableNamesMap,
		};
	}

	const session = new MySqlRemoteSession(callback, dialect, schema, { logger });
	return new MySqlRemoteDatabase(dialect, session, schema as any, 'default') as MySqlRemoteDatabase<TSchema>;
}