Drizzle <> PlanetScale

This guide assumes familiarity with:

Database connection basics with Drizzle
PlanetScale database - website
PlanetScale http driver - GitHub
Drizzle MySQL drivers - docs

According to the official website, PlanetScale is the world’s most advanced serverless MySQL platform.

With Drizzle ORM you can access PlanetScale over http through their official database-js driver from serverless and serverfull environments with our drizzle-orm/planetscale-serverless package.

You can also access PlanetScale through TCP with mysql2 driver — see here.

Step 1 - Install packages

npm

yarn

pnpm

bun

npm i drizzle-orm @planetscale/database
npm i -D drizzle-kit

yarn add drizzle-orm @planetscale/database
yarn add -D drizzle-kit

pnpm add drizzle-orm @planetscale/database
pnpm add -D drizzle-kit

bun add drizzle-orm @planetscale/database
bun add -D drizzle-kit

Step 2 - Initialize the driver and make a query

import { drizzle } from "drizzle-orm/planetscale-serverless";

const db = drizzle({ connection: {
  host: process.env["DATABASE_HOST"],
  username: process.env["DATABASE_USERNAME"],
  password: process.env["DATABASE_PASSWORD"],
}});

const response = await db.select().from(...)

If you need to provide your existing driver

import { drizzle } from "drizzle-orm/planetscale-serverless";
import { Client } from "@planetscale/database";

const client = new Client({
  host: process.env["DATABASE_HOST"],
  username: process.env["DATABASE_USERNAME"],
  password: process.env["DATABASE_PASSWORD"],
});

const db = drizzle({ client });

Make sure to checkout the PlanetScale official MySQL courses, we think they’re outstanding 🙌

What’s next?

Manage schema

Drizzle Schema PostgreSQL data types Indexes and Constraints Database Views Database Schemas Sequences Extensions

Query data

Relational Queries Select Insert Update Delete Filters Joins sql`` operator