Prisma ORM setup in NextJS

Introduction

Prisma ORM helps you easily work with databases in your Next.js app. It turns database data into simple JavaScript objects you can use.

You want to save user data like names and emails in a database.

You need to read and show data from a database on your website.

You want to update or delete data safely without writing complex SQL.

You want to keep your database code clean and easy to understand.

Syntax

NextJS

npx prisma init

// Then edit prisma/schema.prisma to define your data models

// Generate Prisma client
npx prisma generate

// Use Prisma client in your Next.js code
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()

npx prisma init creates the basic setup files.

You define your database tables as models in schema.prisma.

Examples

This defines a User table with id, name, and unique email.

NextJS

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

This fetches all users from the database.

NextJS

const users = await prisma.user.findMany()

This adds a new user to the database.

NextJS

const newUser = await prisma.user.create({
  data: { name: 'Anna', email: '[e-mail]' }
})

Sample Program

This Next.js compatible code creates a user and then fetches all users from the database. It logs the results to the console.

NextJS

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

async function main() {
  // Create a new user
  const user = await prisma.user.create({
    data: {
      name: 'John Doe',
      email: '[e-mail]'
    }
  })

  // Fetch all users
  const allUsers = await prisma.user.findMany()

  console.log('Created user:', user)
  console.log('All users:', allUsers)
}

main()
  .catch(e => console.error(e))
  .finally(async () => {
    await prisma.$disconnect()
  })

Important Notes

Always run npx prisma generate after changing your schema.

Use environment variables to keep your database URL safe.

Disconnect Prisma client after use to avoid open connections.

Summary

Prisma ORM makes database work simple and safe in Next.js.

Define your data models in schema.prisma.

Use Prisma client to create, read, update, and delete data easily.

Practice

1. What is the primary purpose of the schema.prisma file in a Next.js project using Prisma ORM?

easy

A. To write API routes for Next.js

B. To define the database models and their relationships

C. To configure Next.js page routing

D. To style the application components

Solution

1. Step 1: Understand the role of schema.prisma

   This file is used to define the data models and how they relate to each other in the database.

2. Step 2: Differentiate from other files in Next.js

   API routes and page routing are handled by Next.js files, not schema.prisma. Styling is done with CSS or styling libraries.

3. Final Answer:

   To define the database models and their relationships -> Option B

4. Quick Check:

   schema.prisma = data models [OK]

Hint: Remember: schema.prisma defines your database structure [OK]

Common Mistakes:

• Confusing schema.prisma with API route files
• Thinking schema.prisma handles styling
• Assuming schema.prisma manages Next.js routing

2. Which of the following is the correct way to import and instantiate the Prisma Client in a Next.js API route?

easy

A. import { PrismaClient } from '@prisma/client'; const prisma = new PrismaClient();

B. const prisma = require('@prisma/client').PrismaClient();

C. import prisma from '@prisma/client'; const client = new prisma();

D. import Prisma from 'prisma'; const prisma = Prisma.Client();

Solution

1. Step 1: Check the correct import syntax for Prisma Client

   The official way is to import PrismaClient as a named import from '@prisma/client'.

2. Step 2: Instantiate PrismaClient correctly

   Use the new keyword to create an instance: new PrismaClient().

3. Final Answer:

   import { PrismaClient } from '@prisma/client'; const prisma = new PrismaClient(); -> Option A

4. Quick Check:

   Correct import and instantiation = import { PrismaClient } from '@prisma/client'; const prisma = new PrismaClient(); [OK]

Hint: Use named import and new keyword for PrismaClient [OK]

Common Mistakes:

• Using require() instead of import
• Calling PrismaClient as a function without new
• Incorrect import paths or default imports

3. Given the following Prisma model in schema.prisma:

model Post {
  id        Int      @id @default(autoincrement())
  title     String
  published Boolean  @default(false)
}

What will be the result of this Prisma Client query?

const posts = await prisma.post.findMany({ where: { published: true } });
console.log(posts);

medium

A. A single post object with published true

B. An array of all posts regardless of published status

C. An error because 'published' is not a valid field

D. An array of posts where published is true

Solution

1. Step 1: Understand the Prisma model and query

   The model has a Boolean field published. The query filters posts where published is true.

2. Step 2: Analyze the query result

   findMany returns an array of all matching posts, so it returns all posts with published: true.

3. Final Answer:

   An array of posts where published is true -> Option D

4. Quick Check:

   findMany with where filter = array filtered by condition [OK]

Hint: findMany returns arrays filtered by where conditions [OK]

Common Mistakes:

• Expecting a single object instead of an array
• Ignoring the where filter and expecting all posts
• Thinking 'published' field does not exist

4. You wrote this code in a Next.js API route:

import { PrismaClient } from '@prisma/client';
const prisma = new PrismaClient();

export default async function handler(req, res) {
  const user = await prisma.user.findUnique({ where: { id: req.query.id } });
  res.json(user);
}

But you get an error: TypeError: Cannot read property 'id' of undefined. What is the likely cause?

medium

A. PrismaClient is not instantiated correctly

B. The findUnique method does not exist

C. The req.query object is undefined or missing id

D. You forgot to import res from Next.js

Solution

1. Step 1: Identify the error cause

   The error says Cannot read property 'id' of undefined, meaning req.query is undefined or id is missing.

2. Step 2: Check the API route usage

   Ensure the request URL includes a query parameter ?id=someValue so req.query.id exists.

3. Final Answer:

   The req.query object is undefined or missing id -> Option C

4. Quick Check:

   Missing query param causes undefined error [OK]

Hint: Check if query parameters exist before accessing them [OK]

Common Mistakes:

• Assuming PrismaClient instantiation causes this error
• Thinking findUnique method is invalid
• Trying to import res object explicitly

5. You want to add a new model Comment related to Post in your Prisma schema, where each comment belongs to one post. Which of the following schema additions correctly sets up this relationship?

hard

A. model Comment {
id Int @id @default(autoincrement())
content String
postId Int
post Post @relation(fields: [postId], references: [id])
}

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

B. model Comment {
id Int @id @default(autoincrement())
content String
post Post
}

model Post {
id Int @id @default(autoincrement())
title String
}

C. model Comment {
id Int @id @default(autoincrement())
content String
postId Int
}

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

D. model Comment {
id Int @id @default(autoincrement())
content String
postId Int
post Post
}

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

Solution

1. Step 1: Understand Prisma relations syntax

   To relate Comment to Post, Comment needs a foreign key postId and a relation field post with @relation specifying fields and references.

2. Step 2: Check the Post model for back relation

   Post should have a comments field as an array of Comment to represent one-to-many relation.

3. Final Answer:

   Option A correctly defines the foreign key, relation, and back relation -> Option A

4. Quick Check:

   Relation fields with @relation and back array = model Comment { id Int @id @default(autoincrement()) content String postId Int post Post @relation(fields: [postId], references: [id]) } model Post { id Int @id @default(autoincrement()) title String comments Comment[] } [OK]

Hint: Use @relation with fields and references for foreign keys [OK]

Common Mistakes:

• Omitting @relation attribute causing errors
• Not defining back relation array in Post
• Missing foreign key field postId in Comment