🚀지난번 Prisma를 설치하고 데이터베이스에 연결하는 것을 알아보았다. 오늘은 데이터베이스에 어떻게 접근하고 조작하는지 알아보려 한다.

Prisma Client

Prisma Client란 데이터베이스 스키마에 맞게 자동으로 생성되는 데이터베이스 클라이언트이다. 쉽게 말해 Prisma를 통해 생성한 데이터베이스 테이블에 쉽게 접근할 수 있게 해주는 도구라고 할 수 있다.

Prisma Client 설치

아래 명령어로 PrismaClient를 설치한다.

npm install @prisma/client

설치 후 아래 명령어로 Prisma Client를 생성해준다.

prisma generate

📢 Prisma Schema에 변경 사항이 있을 때마다 npx prisma generate를 실행해 Prisma Client를 업데이트해줘야 한다.

이제 데이터베이스 접근이 필요한 곳에서 PrismaClient를 인스턴스화 하여 사용하면 된다.

import { PrismaClient } from '@prisma/client';

const prisma = new PrismaClient();

or

const { PrismaClient } = require('@prisma/client');

const prisma = new PrismaClient();

💡 Next.js에서의 Prisma Client

Next.js의 경우 개발 환경에서 핫 리로딩(코드 변경시 변경된 코드 재실행. 파일을 저장할 때마다 자바스크립트 파일들이 재실행됨.)으로 인해 매번 새로운 PrismaClient 인스턴스가 초기화되고 데이터베이스에 대한 연결이 생성된다. 이에 따라 너무 많은 데이터베이스 연결이 생기면 데이터베이스 입출력이 매우 느려지거나 오류가 발생할 수 있다. 이를 방지하기 위해 PrismaClient를 인스턴스화하여 gloabalThis 개체에 저장해서 사용한다.

// lib/prisma.js

const { PrismaClient } = require("@prisma/client");

// PrismaClient가 global에 없는 경우에만 인스턴스화
const prisma = globalThis.prisma || new PrismaClient();

// 프로덕션 상태가 아닐 때 globalThis 개체에 저장
if (process.env.NODE_ENV !== "production") globalThis.prisma = prisma;

export default prisma;

Prisma Client 사용

데이터 접근이 필요한 곳에서 인스턴스화한 PrismaClient를 불러와 사용한다. Prisma Client API로 CRUD 작업을 수행할 수 있다.

Create

create 새로운 데이터 생성

const member = await prisma.member.create({
  data: {
    name: 'Kim',
    age: 20
  },
})

createMany 여러 데이터 생성

const createMembers = await prisma.member.createMany({
  data: [
    { name: 'Kim', age: 22 },
    { name: 'Lee', age: 23 },
    { name: 'Park', age: 23 },
  ],
})

Read

findUnique 특정 데이터 가져오기

// name이 Kim인 데이터 조회
const member = await prisma.member.findUnique({
  where: {
    name: 'Kim',
  },
})

findMany 여러 데이터 가져오기

// 모든 데이터 가져오기
const members = await prisma.member.findMany()

// 조건에 맞는 여러 데이터 가져오기
// age가 23인 모든 데이터 조회
const members = await prisma.member.findMany({
  where: {
    age: 23,
  },
})

Update

update where 안의 속성을 가진 데이터 업데이트

// name이 Park인 데이터의 age를 24로 업데이트
const updateMember = await prisma.member.update({
  where: {
    name: 'Park',
  },
  data: {
    age: 24,
  },
})

updateMany where 안의 속성을 가진 모든 데이터 업데이트

// age가 23 이상인 모든 데이터의 role을 ADMIN으로 업데이트
const updateMembers = await prisma.member.updateMany({
  where: {
    age: {
      gte: 23,
    },
  },
  data: {
    role: 'ADMIN',
  },
})

upsert where 안의 속성을 가진 데이터가 있다면 업데이트, 없다면 데이터 생성

// name이 Jo인 데이터가 있다면 age를 20으로 업데이트, 없다면 name이 Jo이고 age가 20데이터 생성
const upsertMember = await prisma.member.upsert({
  where: {
    name: 'Jo',
  },
  update: {
    age: 20,
  },
  create: {
    name: 'Jo',
    age: 20,
  },
})

Delete

delete where 안의 속성을 가진 데이터 삭제

// age가 22인 데이터 삭제하기
const deleteMember = await prisma.member.delete({
  where: {
    age: 22,
  },
})

deleteMany 여러 데이터 삭제

// 모든 데이터 삭제하기
const members = await prisma.member.deleteMany()

// 조건에 맞는 여러 데이터 삭제하기
// age가 23인 모든 데이터 삭제
const members = await prisma.member.deleteMany({
  where: {
    age: 23,
  },
})

정리

• Prisma Client: 데이터베이스 테이블에 쉽게 접근할 수 있게 해주는 도구
• Prisma Schema에 변경 사항이 있을 때마다 npx prisma generate를 실행하여 Prisma Client를 업데이트해야 한다.
• Next.js에서는 따로 prisma.js 파일을 만들어 Prisma Client를 인스턴스화하여 사용한다.

참고

https://www.prisma.io/docs/orm/prisma-client/setup-and-configuration/generating-prisma-client#why-is-prisma-client-generated-into-node_modulesprismaclient-by-default

https://www.prisma.io/docs/orm/more/help-and-troubleshooting/help-articles/nextjs-prisma-client-dev-practices

https://medium.com/@2018.itsuki/postgresql-with-next-js-and-prisma-44f66a05378a

https://www.prisma.io/docs/orm/prisma-client/queries/crud