createDockerDB() — drizzle-orm Function Reference

Architecture documentation for the createDockerDB() function in mysql-common.ts from the drizzle-orm codebase.

Function typescript DrizzleORM SQLDialects

Entity Profile

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

Dependency Diagram

graph TD
  64e47068_0d10_97d9_a217_b4a7be9ca005["createDockerDB()"]
  bcd266b2_f6a8_0abb_2a24_40a68c6f8cc5["mysql-common.ts"]
  64e47068_0d10_97d9_a217_b4a7be9ca005 -->|defined in| bcd266b2_f6a8_0abb_2a24_40a68c6f8cc5
  style 64e47068_0d10_97d9_a217_b4a7be9ca005 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

integration-tests/tests/mysql/mysql-common.ts lines 256–282

export async function createDockerDB(): Promise<{ connectionString: string; container: Docker.Container }> {
	const docker = new Docker();
	const port = await getPort({ port: 3306 });
	const image = 'mysql:8';

	const pullStream = await docker.pull(image);
	await new Promise((resolve, reject) =>
		docker.modem.followProgress(pullStream, (err) => (err ? reject(err) : resolve(err)))
	);

	mysqlContainer = await docker.createContainer({
		Image: image,
		Env: ['MYSQL_ROOT_PASSWORD=mysql', 'MYSQL_DATABASE=drizzle'],
		name: `drizzle-integration-tests-${uuid()}`,
		HostConfig: {
			AutoRemove: true,
			PortBindings: {
				'3306/tcp': [{ HostPort: `${port}` }],
			},
		},
	});

	await mysqlContainer.start();
	await new Promise((resolve) => setTimeout(resolve, 4000));

	return { connectionString: `mysql://root:mysql@127.0.0.1:${port}/drizzle`, container: mysqlContainer };
}