ContextQMD
Back to Prisma

CockroachDB

apps/docs/content/docs.v6/(index)/prisma-orm/quickstart/cockroachdb.mdx

latest6.6 KB
Original Source

CockroachDB is a distributed SQL database built for cloud applications. In this guide, you will learn how to set up a new TypeScript project from scratch, connect it to CockroachDB using Prisma ORM, and generate a Prisma Client for easy, type-safe access to your database.

Prerequisites

You also need:

  • A CockroachDB database
  • Database connection string from CockroachDB

1. Create a new project

2. Install required dependencies

Install the packages needed for this quickstart:

npm
npm install prisma @types/node @types/pg --save-dev
npm
npm install @prisma/client @prisma/adapter-pg pg dotenv

Here's what each package does:

  • prisma - The Prisma CLI for running commands like prisma init, prisma migrate, and prisma generate
  • @prisma/client - The Prisma Client library for querying your database
  • @prisma/adapter-pg - The node-postgres driver adapter that connects Prisma Client to your database (CockroachDB is PostgreSQL-compatible)
  • pg - The node-postgres database driver
  • @types/pg - TypeScript type definitions for node-postgres
  • dotenv - Loads environment variables from your .env file

3. Configure ESM support

Update tsconfig.json for ESM compatibility:

json
{
  "compilerOptions": {
    "module": "ESNext",
    "moduleResolution": "node",
    "target": "ES2023",
    "strict": true,
    "esModuleInterop": true,
    "ignoreDeprecations": "6.0"
  }
}

Update package.json to enable ESM:

json
{
  "type": "module" // [!code ++]
}

4. Initialize Prisma ORM

You can now invoke the Prisma CLI by prefixing it with npx:

npm
npx prisma

Next, set up your Prisma ORM project by creating your Prisma Schema file with the following command:

npm
npx prisma init --datasource-provider cockroachdb --output ../generated/prisma

This command does a few things:

  • Creates a prisma/ directory with a schema.prisma file containing your database connection and schema models
  • 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:

typescript
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:

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

datasource db {
  provider = "cockroachdb"
}

Update your .env file with your CockroachDB connection string:

text
DATABASE_URL="postgresql://username:password@host:26257/mydb?sslmode=require"

Replace with your actual CockroachDB connection string from your cluster dashboard.

5. Define your data model

Open prisma/schema.prisma and add the following models:

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

datasource db {
  provider = "cockroachdb"
}

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

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

6. Create and apply your first migration

Create your first migration to set up the database tables:

npm
npx prisma migrate dev --name init

This command creates the database tables based on your schema.

Now run the following command to generate the Prisma Client:

npm
npx prisma generate

7. Instantiate Prisma Client

Now that you have all the dependencies installed, you can instantiate Prisma Client. You need to pass an instance of Prisma ORM's driver adapter to the PrismaClient constructor:

typescript
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 };

8. Write your first query

Create a script.ts file to test your setup:

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

async function main() {
  // Create a new user with a post
  const user = await prisma.user.create({
    data: {
      name: "Alice",
      email: "[email protected]",
      posts: {
        create: {
          title: "Hello World",
          content: "This is my first post!",
          published: true,
        },
      },
    },
    include: {
      posts: true,
    },
  });
  console.log("Created user:", user);

  // Fetch all users with their posts
  const allUsers = await prisma.user.findMany({
    include: {
      posts: true,
    },
  });
  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:

npm
npx tsx script.ts

You should see the created user and all users printed to the console!

9. Explore your data

Explore the options suggested by CockroachDB to view and manage your data.

Prisma Studio does not currently support CockroachDB. Support may be added in a future release. See Databases supported by Prisma Studio for more information.

Next steps

More info