PlanetScale

Prisma and PlanetScale together provide a development arena that optimizes rapid, type-safe development of data access applications, using Prisma's ORM and PlanetScale's highly scalable MySQL-based platform.

This document discusses the concepts behind using Prisma ORM and PlanetScale, explains the commonalities and differences between PlanetScale and other database providers, and leads you through the process for configuring your application to integrate with PlanetScale.

What is PlanetScale?

PlanetScale uses the Vitess database clustering system to provide a MySQL-compatible database platform. Features include:

• Enterprise scalability. PlanetScale provides a highly available production database cluster that supports scaling across multiple database servers. This is particularly useful in a serverless context, as it avoids the problem of having to manage connection limits.
• Database branches. PlanetScale allows you to create branches of your database schema, so that you can test changes on a development branch before applying them to your production database.
• Support for non-blocking schema changes. PlanetScale provides a workflow that allows users to update database schemas without locking the database or causing downtime.

Commonalities with other database providers

Many aspects of using Prisma ORM with PlanetScale are just like using Prisma ORM with any other relational database. You can still:

• model your database with the Prisma Schema Language
• use Prisma ORM's existing mysql database connector in your schema, along with the connection string PlanetScale provides you
• use Introspection for existing projects if you already have a database schema in PlanetScale
• use db push to push changes in your schema to the database
• use Prisma Client in your application to talk to the database server at PlanetScale

Differences to consider

PlanetScale's branching model and design for scalability means that there are also a number of differences to consider. You should be aware of the following points when deciding to use PlanetScale with Prisma ORM:

• Branching and deploy requests. PlanetScale provides two types of database branches: development branches, which allow you to test out schema changes, and production branches, which are protected from direct schema changes. Instead, changes must be first created on a development branch and then deployed to production using a deploy request. Production branches are highly available and include automated daily backups. To learn more, see How to use branches and deploy requests.

• Referential actions and integrity. To support scaling across multiple database servers, PlanetScale by default does not use foreign key constraints, which are normally used in relational databases to enforce relationships between data in different tables, and asks users to handle this manually in their applications. However, you can explicitly enable them in the PlanetScale database settings. If you don't enable these explicitly, you can still maintain these relationships in your data and allow the use of referential actions by using Prisma ORM's ability to emulate relations in Prisma Client with the prisma relation mode. For more information, see How to emulate relations in Prisma Client.

• Creating indexes on foreign keys. When emulating relations in Prisma ORM (i.e. when not using foreign key constraints on the database-level), you will need to create dedicated indexes on foreign keys. In a standard MySQL database, if a table has a column with a foreign key constraint, an index is automatically created on that column. When PlanetScale is configured to not use foreign key constraints, these indexes are currently not created when Prisma Client emulates relations, which can lead to issues with queries not being well optimized. To avoid this, you can create indexes in Prisma ORM. For more information, see How to create indexes on foreign keys.

• Making schema changes with db push. When you merge a development branch into your production branch, PlanetScale will automatically compare the two schemas and generate its own schema diff. This means that Prisma ORM's prisma migrate workflow, which generates its own history of migration files, is not a natural fit when working with PlanetScale. These migration files may not reflect the actual schema changes run by PlanetScale when the branch is merged.

  warning

  We recommend not using prisma migrate when making schema changes with PlanetScale. Instead, we recommend that you use the prisma db push command.

  For an example of how this works, see How to make schema changes with db push

• Introspection. When you introspect on an existing database and you have not enabled foreign key constraints in your PlanetScale database, you will get a schema with no relations, as they are usually defined based on foreign keys that connect tables. In that case, you will need to add the missing relations in manually. For more information, see How to add in missing relations after Introspection.

How to use branches and deploy requests

When connecting to PlanetScale with Prisma ORM, you will need to use the correct connection string for your branch. The connection URL for a given database branch can be found from your PlanetScale account by going to the overview page for the branch and selecting the 'Connect' dropdown. In the 'Passwords' section, generate a new password and select 'Prisma' from the dropdown to get the Prisma format for the connection URL. See Prisma ORM's Getting Started guide for more details of how to connect to a PlanetScale database.

Every PlanetScale database is created with a branch called main, which is initially a development branch that you can use to test schema changes on. Once you are happy with the changes you make there, you can promote it to become a production branch. Note that you can only push new changes to a development branch, so further changes will need to be created on a separate development branch and then later deployed to production using a deploy request.

If you try to push to a production branch, you will get the error message Direct execution of DDL (Data Definition Language) SQL statements is disabled on this database.

How to use relations (and enable referential integrity) with PlanetScale

Option 1: Emulate relations in Prisma Client

1. Set relationMode = "prisma"

PlanetScale does not use foreign key constraints in its database schema by default. However, Prisma ORM relies on foreign key constraints in the underlying database to enforce referential integrity between models in your Prisma schema.

In Prisma ORM versions 3.1.1 and later, you can emulate relations in Prisma Client with the prisma relation mode, which avoids the need for foreign key constraints in the database.

To enable emulation of relations in Prisma Client, set the relationMode field to "prisma" in the datasource block:

schema.prisma

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL")
  relationMode = "prisma"
}

info

The ability to set the relation mode was introduced as part of the referentialIntegrity preview feature in Prisma ORM version 3.1.1, and is generally available in Prisma ORM versions 4.8.0 and later.

The relationMode field was renamed in Prisma ORM version 4.5.0, and was previously named referentialIntegrity.

If you use relations in your Prisma schema with the default "foreignKeys" option for the relationMode field, PlanetScale will error and Prisma ORM output the P3021 error message when it tries to create foreign keys. (In versions before 2.27.0 it will output a raw database error.)

2. Create indexes on foreign keys

When you emulate relations in Prisma Client, you need to create your own indexes. As an example of a situation where you would want to add an index, take this schema for a blog with posts and comments:

schema.prisma

model Post {
  id       Int       @id @default(autoincrement())
  title    String
  content  String
  likes    Int       @default(0)
  comments Comment[]
}

model Comment {
  id      Int    @id @default(autoincrement())
  comment String
  postId  Int
  post    Post   @relation(fields: [postId], references: [id], onDelete: Cascade)
}

The postId field in the Comment model refers to the corresponding id field in the Post model. However this is not implemented as a foreign key in PlanetScale, so the column doesn't have an automatic index. This means that some queries may not be well optimized. For example, if you query for all comments with a certain post id, PlanetScale may have to do a full table lookup. This could be slow, and also expensive because PlanetScale's billing model charges for the number of rows read.

To avoid this, you can define an index on the postId field using Prisma ORM's @@index argument:

schema.prisma

model Post {
  id       Int       @id @default(autoincrement())
  title    String
  content  String
  likes    Int       @default(0)
  comments Comment[]
}

model Comment {
  id      Int    @id @default(autoincrement())
  comment String
  postId  Int
  post    Post   @relation(fields: [postId], references: [id], onDelete: Cascade)

  @@index([postId])
}

You can then add this change to your schema using db push.

In versions 4.7.0 and later, Prisma ORM warns you if you have a relation with no index on the relation scalar field. For more information, see Index validation.

warning

One issue to be aware of is that implicit many-to-many relations cannot have an index added in this way. If query speed or cost is an issue, you may instead want to use an explicit many-to-many relation in this case.

Option 2: Enable foreign key constraints in the PlanetScale database settings

Support for foreign key constraints in PlanetScale databases has been Generally Available since February 2024. Follow the instructions in the PlanetScale documentation to enable them in your database.

You can then use Prisma ORM and define relations in your Prisma schema without the need for extra configuration.

In that case, you can define a relation as with other database that supports foreign key constraints, for example:

schema.prisma

model Post {
  id       Int       @id @default(autoincrement())
  title    String
  content  String
  likes    Int       @default(0)
  comments Comment[]
}

model Comment {
  id      Int    @id @default(autoincrement())
  comment String
  postId  Int
  post    Post   @relation(fields: [postId], references: [id], onDelete: Cascade)
}

With this approach, it is not necessary to:

• set relationMode = "prisma" in your Prisma schema
• define additional indexes on foreign keys

Also, introspection will automatically create relation fields in your Prisma schema because it can detect the foreign key constraints in the database.

How to make schema changes with db push

To use db push with PlanetScale, you will first need to enable emulation of relations in Prisma Client. Pushing to your branch without referential emulation enabled will give the error message Foreign keys cannot be created on this database.

As an example, let's say you decide to decide to add a new excerpt field to the blog post schema above. You will first need to create a new development branch and connect to it.

Next, add the following to your schema.prisma file:

schema.prisma

model Post {
  id       Int       @id @default(autoincrement())
  title    String
  content  String
  excerpt  String?
  likes    Int       @default(0)
  comments Comment[]
}

model Comment {
  id      Int    @id @default(autoincrement())
  comment String
  postId  Int
  post    Post   @relation(fields: [postId], references: [id], onDelete: Cascade)

  @@index([postId])
}

To push these changes, navigate to your project directory in your terminal and run

npx prisma db push

Once you are happy with your changes on your development branch, you can open a deploy request to deploy these to your production branch.

For more examples, see PlanetScale's tutorial on automatic migrations with Prisma ORM using db push.

How to add in missing relations after Introspection

Note: This section is only relevant if you use relationMode = "prisma" to emulate foreign key constraints with Prisma ORM. If you enabled foreign key constraints in your PlanetScale database, you can ignore this section.

After introspecting with npx prisma db pull, the schema you get may be missing some relations. For example, the following schema is missing a relation between the User and Post models:

schema.prisma

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  title     String   @db.VarChar(255)
  content   String?
  authorId  Int

  @@index([authorId])
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

In this case you need to add the relation in manually:

schema.prisma

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  title     String   @db.VarChar(255)
  content   String?
  author    User     @relation(fields: [authorId], references: [id])
  authorId  Int

  @@index([authorId])
}

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

For a more detailed example, see the Getting Started guide for PlanetScale.

How to use the PlanetScale serverless driver with Prisma ORM (Preview)

The PlanetScale serverless driver provides a way of communicating with your database and executing queries over HTTP.

You can use Prisma ORM along with the PlanetScale serverless driver using the @prisma/adapter-planetscale driver adapter. The driver adapter allows you to communicate with your database over HTTP.

info

This feature is available in Preview from Prisma ORM versions 5.4.2 and later.

To get started, enable the driverAdapters Preview feature flag:

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["driverAdapters"]
}

Generate Prisma Client:

npx prisma generate

info

Ensure you update the host value in your connection string to aws.connect.psdb.cloud. You can learn more about this here.

DATABASE_URL='mysql://johndoe:[email protected]/clear_nightsky?sslaccept=strict'

Install the Prisma ORM adapter for PlanetScale, PlanetScale serverless driver and undici packages:

npm install @prisma/adapter-planetscale @planetscale/database undici

info

When using a Node.js version below 18, you must provide a custom fetch function implementation. We recommend the undici package on which Node's built-in fetch is based. Node.js versions 18 and later include a built-in global fetch function, so you don't have to install an extra package.

Update your Prisma Client instance to use the PlanetScale serverless driver:

import { Client } from '@planetscale/database'
import { PrismaPlanetScale } from '@prisma/adapter-planetscale'
import { PrismaClient } from '@prisma/client'
import dotenv from 'dotenv'
import { fetch as undiciFetch } from 'undici'

dotenv.config()
const connectionString = `${process.env.DATABASE_URL}`

const client = new Client({ url: connectionString, fetch: undiciFetch })
const adapter = new PrismaPlanetScale(client)
const prisma = new PrismaClient({ adapter })

You can then use Prisma Client as you normally would with full type-safety. Prisma Migrate, introspection, and Prisma Studio will continue working as before using the connection string defined in the Prisma schema.

More on using PlanetScale with Prisma ORM

The fastest way to start using PlanetScale with Prisma ORM is to refer to our Getting Started documentation:

• Start from scratch
• Add to existing project

These tutorials will take you through the process of connecting to PlanetScale, pushing schema changes, and using Prisma Client.

For further tips on best practices when using Prisma ORM and PlanetScale together, watch our video: