createDockerDB() — drizzle-orm Function Reference

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

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

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

Dependency Diagram

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

Relationship Graph

Source Code

integration-tests/tests/pg/pg-common.ts lines 367–392

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

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

	pgContainer = await docker.createContainer({
		Image: image,
		Env: ['POSTGRES_PASSWORD=postgres', 'POSTGRES_USER=postgres', 'POSTGRES_DB=postgres'],
		name: `drizzle-integration-tests-${uuidV4()}`,
		HostConfig: {
			AutoRemove: true,
			PortBindings: {
				'5432/tcp': [{ HostPort: `${port}` }],
			},
		},
	});

	await pgContainer.start();

	return { connectionString: `postgres://postgres:postgres@localhost:${port}/postgres`, container: pgContainer };
}