# PlanetScale (Prisma ORM v7) (/docs/v7/prisma-orm/add-to-existing-project/planetscale)

> For the complete Prisma documentation index, see [llms.txt](https://www.prisma.io/docs/llms.txt). A markdown version of any docs page is available by appending `.md` to its URL.

Add Prisma ORM to an existing TypeScript project with PlanetScale and learn database introspection and querying

Location: v7 > Prisma ORM > Add to Existing Project > PlanetScale

[PlanetScale](https://planetscale.com) is a serverless database platform. This guide covers both **PlanetScale MySQL** and **PlanetScale Postgres**. In this guide, you will learn how to add Prisma ORM to an existing TypeScript project, connect it to PlanetScale, introspect your existing database schema, and start querying with type-safe Prisma Client.

## Prerequisites [#prerequisites]

## 1. Set up Prisma ORM [#1-set-up-prisma-orm]

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

### MySQL [#mysql]

  

#### bun

```bash
bun add prisma@prev @types/node --dev
bun add @prisma/client@7 @prisma/adapter-planetscale undici dotenv
```

#### pnpm

```bash
pnpm add prisma@prev @types/node --save-dev
pnpm add @prisma/client@7 @prisma/adapter-planetscale undici dotenv
```

#### yarn

```bash
yarn add prisma@prev @types/node --dev
yarn add @prisma/client@7 @prisma/adapter-planetscale undici dotenv
```

#### npm

```bash
npm install prisma@prev @types/node --save-dev
npm install @prisma/client@7 @prisma/adapter-planetscale undici dotenv
```

### Postgres [#postgres]

  

#### bun

```bash
bun add prisma@prev @types/pg --dev
bun add @prisma/client@7 @prisma/adapter-pg pg dotenv
```

#### pnpm

```bash
pnpm add prisma@prev @types/pg --save-dev
pnpm add @prisma/client@7 @prisma/adapter-pg pg dotenv
```

#### yarn

```bash
yarn add prisma@prev @types/pg --dev
yarn add @prisma/client@7 @prisma/adapter-pg pg dotenv
```

#### npm

```bash
npm install prisma@prev @types/pg --save-dev
npm install @prisma/client@7 @prisma/adapter-pg pg dotenv
```

## 2. Initialize Prisma ORM [#2-initialize-prisma-orm]

Set up your Prisma ORM project by creating your [Prisma Schema](https://www.prisma.io/docs/orm/v7/prisma-schema/overview) file with the following command:

### MySQL [#mysql-1]

  

#### bun

```bash
bunx --bun prisma init --datasource-provider mysql --output ../generated/prisma
```

#### pnpm

```bash
pnpm prisma init --datasource-provider mysql --output ../generated/prisma
```

#### yarn

```bash
yarn prisma init --datasource-provider mysql --output ../generated/prisma
```

#### npm

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

### Postgres [#postgres-1]

  

#### bun

```bash
bunx --bun prisma init --datasource-provider postgresql --output ../generated/prisma
```

#### pnpm

```bash
pnpm prisma init --datasource-provider postgresql --output ../generated/prisma
```

#### yarn

```bash
yarn prisma init --datasource-provider postgresql --output ../generated/prisma
```

#### npm

```bash
npx prisma init --datasource-provider postgresql --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 `prisma7.config.ts` file for Prisma configuration

The generated `prisma7.config.ts` file looks like this:

```typescript title="prisma7.config.ts"
// This file was generated by Prisma, and assumes you have installed the following:
// npm install --save-dev prisma dotenv
import "dotenv/config";
import { defineConfig } from "prisma/config";

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

> [!NOTE]
> Prisma ORM 7.10 and later name this file `prisma7.config.ts` so that it does not clash with the Prisma 8 config format, which only accepts `prisma.config.ts`. The Prisma 7 CLI discovers either name, so a project that already has a `prisma.config.ts` keeps working.

The generated schema uses [the ESM-first `prisma-client` generator](https://www.prisma.io/docs/orm/v7/prisma-schema/overview/generators#prisma-client) with a custom output path:

  

#### MySQL

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

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

#### Postgres

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

datasource db {
  provider = "postgresql"
}
```

> [!NOTE]
> **PlanetScale MySQL** requires `relationMode = "prisma"` because it doesn't support foreign key constraints.

## 3. Connect your database [#3-connect-your-database]

Update the `.env` file with your PlanetScale connection URL:

  

#### MySQL

```text title=".env" 
DATABASE_URL="mysql://username:password@host.connect.psdb.cloud/mydb?sslaccept=strict"
```

#### Postgres

```text title=".env" 
DATABASE_URL="postgresql://{username}:{password}@{host}:6432/postgres?sslmode=verify-full"
```

You can find your connection string in the PlanetScale dashboard.

> [!NOTE]
> **PlanetScale Postgres connection types:**
> 
> | Type          | Port   | Use case                                                       |
> | ------------- | ------ | -------------------------------------------------------------- |
> | **Direct**    | `5432` | Prisma CLI commands (migrations, introspection), Prisma Studio |
> | **PgBouncer** | `6432` | Application connections, serverless environments               |
> 
> For production applications, we recommend using PgBouncer (port 6432) for application connections.

## 4. Introspect your database [#4-introspect-your-database]

Run the following command to introspect your existing database:

  

#### bun

```bash
bunx prisma db pull
```

#### pnpm

```bash
pnpm prisma db pull
```

#### yarn

```bash
yarn prisma db pull
```

#### npm

```bash
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.

![Introspect your database with Prisma ORM](https://www.prisma.io/img/getting-started/prisma-db-pull-generate-schema.png)

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

## 5. Generate Prisma ORM types [#5-generate-prisma-orm-types]

Generate Prisma Client based on your introspected schema:

  

#### bun

```bash
bunx prisma generate
```

#### pnpm

```bash
pnpm prisma generate
```

#### yarn

```bash
yarn prisma generate
```

#### npm

```bash
npx prisma generate
```

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

## 6. Instantiate Prisma Client [#6-instantiate-prisma-client]

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

  

#### MySQL

```typescript title="lib/prisma.ts" 
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 };
```

#### Postgres

```typescript title="lib/prisma.ts" 
import "dotenv/config";
import { PrismaPg } from "@prisma/adapter-pg";
import { PrismaClient } from "../generated/prisma/client";

const connectionString = `${process.env.DATABASE_URL}`;

const adapter = new PrismaPg({ connectionString });
const prisma = new PrismaClient({ adapter });

export { prisma };
```

## 7. Query your database [#7-query-your-database]

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

```typescript title="script.ts"
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:

  

#### bun

```bash
bunx tsx script.ts
```

#### pnpm

```bash
pnpm dlx tsx script.ts
```

#### yarn

```bash
yarn dlx tsx script.ts
```

#### npm

```bash
npx tsx script.ts
```

## 8. Evolve your schema [#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 [#81-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:

```prisma title="prisma/schema.prisma"
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: [#82-push-the-changes-to-your-development-branch]

  

#### bun

```bash
bunx prisma db push
```

#### pnpm

```bash
pnpm prisma db push
```

#### yarn

```bash
yarn prisma db push
```

#### npm

```bash
npx prisma db push
```

This command will:

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

> [!NOTE]
> For production deployments, use PlanetScale's [branching workflow](https://planetscale.com/docs/concepts/branching) to create deploy requests.

## 9. Explore your data with Prisma Studio [#9-explore-your-data-with-prisma-studio]

```shell
npx prisma studio
```

## Next steps [#next-steps]

Prisma ORM is set up. These are the pages you are most likely to need next:

* **Learn more about Prisma Client**: Explore the [Prisma Client API](https://www.prisma.io/docs/orm/v7/prisma-client/setup-and-configuration/introduction) for advanced querying, filtering, and relations
* **Database migrations**: Learn about [Prisma Migrate](https://www.prisma.io/docs/orm/v7/prisma-migrate) for evolving your database schema
* **Performance optimization**: Discover [query optimization techniques](https://www.prisma.io/docs/orm/v7/prisma-client/queries/advanced/query-optimization-performance)
* **Build a full application**: Check out our [framework guides](https://www.prisma.io/docs/guides/v7) to integrate Prisma ORM with Next.js, Express, and more
* **Join the community**: Connect with other developers on [Discord](https://pris.ly/discord)

## More info [#more-info]

* [PlanetScale database connector](https://www.prisma.io/docs/orm/v7/core-concepts/supported-databases/mysql#planetscale)
* [Prisma Config reference](https://www.prisma.io/docs/orm/v7/reference/prisma-config-reference)
* [Database introspection](https://www.prisma.io/docs/orm/v7/prisma-schema/introspection)
* [PlanetScale branching workflow](https://planetscale.com/docs/concepts/branching)

## Related pages

- [`CockroachDB`](https://www.prisma.io/docs/v7/prisma-orm/add-to-existing-project/cockroachdb): Add Prisma ORM to an existing TypeScript project with CockroachDB and learn database introspection, baselining, and querying
- [`MongoDB`](https://www.prisma.io/docs/v7/prisma-orm/add-to-existing-project/mongodb): Add Prisma ORM to an existing TypeScript project with MongoDB and learn database introspection and querying
- [`MySQL`](https://www.prisma.io/docs/v7/prisma-orm/add-to-existing-project/mysql): Add Prisma ORM to an existing TypeScript project with MySQL and learn database introspection, baselining, and querying
- [`PostgreSQL`](https://www.prisma.io/docs/v7/prisma-orm/add-to-existing-project/postgresql): Add Prisma ORM to an existing TypeScript project with PostgreSQL and learn database introspection, baselining, and querying
- [`Prisma Postgres`](https://www.prisma.io/docs/v7/prisma-orm/add-to-existing-project/prisma-postgres): Add Prisma ORM to an existing TypeScript project with Prisma Postgres and learn database introspection, baselining, and querying