PlanetScale

PlanetScale is a serverless database platform. This guide covers PlanetScale MySQL, which is built on Vitess and offers database branching, non-blocking schema changes, and automatic backups. In this guide, you will learn how to add Prisma ORM to an existing TypeScript project, connect it to PlanetScale MySQL, introspect your existing database schema, and start querying with type-safe Prisma Client.

:::note

PlanetScale also offers PostgreSQL databases. If you're using PlanetScale PostgreSQL, follow the Add to existing PostgreSQL project guide instead.

:::

Prerequisites

1. Set up Prisma ORM

Navigate to your existing project directory and install the required dependencies:

npm install prisma @types/node --save-dev

npm install @prisma/client @prisma/adapter-planetscale undici dotenv

Here's what each package does:

• prisma - The Prisma CLI for running commands like prisma init, prisma db pull, and prisma generate
• @prisma/client - The Prisma Client library for querying your database
• @prisma/adapter-planetscale - The PlanetScale driver adapter that connects Prisma Client to your database
• undici - A fast HTTP/1.1 client required by the PlanetScale adapter
• dotenv - Loads environment variables from your .env file

2. Initialize Prisma ORM

Set up your Prisma ORM project by creating your Prisma Schema file with the following command:

npx prisma init --datasource-provider mysql --output ../generated/prisma

This command does a few things:

• Creates a prisma/ directory with a schema.prisma file containing your database connection configuration
• Creates a .env file in the root directory for environment variables
• Creates a prisma.config.ts file for Prisma configuration

The generated prisma.config.ts file looks like this:

import "dotenv/config";
import { defineConfig, env } from "prisma/config";

export default defineConfig({
  schema: "prisma/schema.prisma",
  migrations: {
    path: "prisma/migrations",
  },
  datasource: {
    url: env("DATABASE_URL"),
  },
});

The generated schema uses the ESM-first prisma-client generator with a custom output path:

generator client {
  provider = "prisma-client"
  output   = "../generated/prisma"
}

datasource db {
  provider     = "mysql"
  relationMode = "prisma"
}

:::info

PlanetScale requires relationMode = "prisma" because it doesn't support foreign key constraints.

:::

3. Connect your database

Update the .env file with your PlanetScale connection URL:

DATABASE_URL="mysql://username:[email protected]/mydb?sslaccept=strict"

You can find your connection string in the PlanetScale dashboard.

4. Introspect your database

Run the following command to introspect your existing database:

npx prisma db pull

This command reads the DATABASE_URL environment variable, connects to your database, and introspects the database schema. It then translates the database schema from SQL into a data model in your Prisma schema.

After introspection, your Prisma schema will contain models that represent your existing database tables.

5. Generate Prisma ORM types

Generate Prisma Client based on your introspected schema:

npx prisma generate

This creates a type-safe Prisma Client tailored to your database schema in the generated/prisma directory.

6. Instantiate Prisma Client

Create a utility file to instantiate Prisma Client. You need to pass an instance of Prisma ORM's driver adapter to the PrismaClient constructor:

import "dotenv/config";
import { PrismaPlanetScale } from "@prisma/adapter-planetscale";
import { PrismaClient } from "../generated/prisma/client";
import { fetch as undiciFetch } from "undici";

const adapter = new PrismaPlanetScale({ url: process.env.DATABASE_URL, fetch: undiciFetch });
const prisma = new PrismaClient({ adapter });

export { prisma };

7. Query your database

Now you can use Prisma Client to query your database. Create a script.ts file:

import { prisma } from "./lib/prisma";

async function main() {
  // Example: Fetch all records from a table
  // Replace 'user' with your actual model name
  const allUsers = await prisma.user.findMany();
  console.log("All users:", JSON.stringify(allUsers, null, 2));
}

main()
  .then(async () => {
    await prisma.$disconnect();
  })
  .catch(async (e) => {
    console.error(e);
    await prisma.$disconnect();
    process.exit(1);
  });

Run the script:

npx tsx script.ts

8. Evolve your schema

PlanetScale uses a branching workflow instead of traditional migrations. To make changes to your database schema:

8.1. Update your Prisma schema file

Update your Prisma schema file to reflect the changes you want to make to your database schema. For example, add a new model:

model Post { // [!code ++]
  id        Int      @id @default(autoincrement()) // [!code ++]
  title     String // [!code ++]
  content   String? // [!code ++]
  published Boolean  @default(false) // [!code ++]
  authorId  Int // [!code ++]
  author    User     @relation(fields: [authorId], references: [id]) // [!code ++]
} // [!code ++]

model User { // [!code ++]
  id    Int    @id @default(autoincrement()) // [!code ++]
  email String @unique // [!code ++]
  name  String? // [!code ++]
  posts Post[] // [!code ++]
} // [!code ++]

8.2. Push the changes to your development branch:

npx prisma db push

This command will:

• Apply the schema changes to your PlanetScale database
• Regenerate Prisma Client

:::info

For production deployments, use PlanetScale's branching workflow to create deploy requests.

:::

9. Explore your data with Prisma Studio

Next steps

More info

• PlanetScale database connector
• Prisma Config reference
• Database introspection
• PlanetScale branching workflow