Tutorial: Integrate with Prisma

Verify the prerequisites

Before you begin this tutorial, ensure you have the following components prepared:

• A MongoDB Atlas account with a configured cluster. To view instructions, see the Get Started with Atlas guide.

• Node.js v16.20.1 or later.

Download the example application

Clone or download the example application from the Prisma examples repository.

This example is a simple blog content management platform that uses a SQLite database. The following steps modify the application to use MongoDB instead of SQLite.

Configure your Prisma schema

Navigate to the prisma/schema.prisma file in the example application directory. In the datasource db object of this file, set the provider field to "mongodb" and the url field to your Atlas connection URI.

In the User model in the same file, change the id field type from Int to String and set the default value to auto(). The id property must map to the MongoDB _id field. You must also instruct Prisma to set the data type for this property to ObjectId.

In the Post model, perform the same changes to the id field as you did in the User model. You must also change the authorId field type from Int to String and set the data type to ObjectId.

Your schema.prisma file should resemble the following:

generator client {
  provider = "prisma-client-js"
}
datasource db {
  provider = "mongodb"
  url      = "<your connection URI>"
}
model Post {
  id        String   @id @default(auto()) @map("_id") @db.ObjectId
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User     @relation(fields: [authorId], references: [id])
  authorId  String   @db.ObjectId
}
model User {
  id    String  @id @default(auto()) @map("_id") @db.ObjectId
  email String  @unique
  name  String?
  posts Post[]
}

This schema defines separate User and Post collections in your MongoDB database, where each Post contains a reference to a User.

Once you have made these changes, navigate to the project directory in your terminal and run the following commands to install the necessary dependencies and generate the schema:

npm install
npx prisma generate

Create and populate the MongoDB database

To populate the database with sample data, run the prisma/seed.ts file in the example project by running the following command:

npx prisma db seed

This creates the User and Post collections as defined by the schema.prisma file and populates them with sample data.

Make the example application compatible with MongoDB

Navigate to the src directory of the example project. In the pages/api/post/[id].ts and pages/api/publish/[id].ts files, replace all instances of Number(postId) with postId. This is necessary because the id fields in the schema are now of type String instead of Int.

Run the application

To start the application, run the following command from the project directory:

npm run dev

Navigate to http://localhost:3000 in your web browser to view and run the application. You can use the application to create, draft, publish, and delete blog posts. You can reference the API route definitions in the pages/api folder of the example project.