Node MySQL 2

PlanetScale

MySQL 2

MySQL HTTP proxy

According to the official website, mysql2 is a MySQL client for Node.js with focus on performance.

Drizzle ORM natively supports mysql2 with drizzle-orm/mysql2 package.

npm

yarn

pnpm

bun

npm i drizzle-orm mysql2
npm i -D drizzle-kit

yarn add drizzle-orm mysql2
yarn add -D drizzle-kit

pnpm add drizzle-orm mysql2
pnpm add -D drizzle-kit

bun add drizzle-orm mysql2
bun add -D drizzle-kit

There’re two ways you can connect to the MySQL with mysql2 driver, either single client connection or a pool.

Client connection

Pool connection

import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

const connection = await mysql.createConnection({
  host: "host",
  user: "user",
  database: "database",
  ...
});

const db = drizzle(connection);

import { drizzle } from "drizzle-orm/mysql2";
import mysql from "mysql2/promise";

const poolConnection = mysql.createPool({
  host: "host",
  user: "user",
  database: "database",
  ...
});

const db = drizzle(poolConnection);

⚙️

For the built in migrate function with DDL migrations we and drivers strongly encourage you to use single client connection.

For querying purposes feel free to use either client or pool based on your business demands.