👉 미래의 본인을 위해 정리하는 prisma 👈

📢 prisma란

sequelize와 같은 ORM입니다.

• ORM: Object Relational Mapping으로 JavaScript의 객체를 Database의 테이블 혹은 스키마와 연결해서 SQL문 보다 쉽고 편하게 DB를 컨트롤할 수 있는 방식입니다.

JS의 class나 TS의 interface로 형태와 속성들을 정의해주면 그것에 맞게 자동적으로 SQL문을 생성해서 Database를 관리해주는 것으로 알고 있습니다.

ORM의 장점은 굳이 복잡한 SQL에 대해 자세하게 이해하지 않아도 되며(물론 어느정도는 알고 사용해야한다고 생각함), CRUD 그리고 JOIN같은 복잡한 연산을 간단하게 해결해주는 메서드를 미리 구현해놨기 때문에 쉽게 데이터를 관리할 수 있습니다.

🪄 설치

npm i -D prisma
npm i @prisma/client

⚙️ 초기 세팅

npx prisma init

/prisma/schema.prisma와 .env가 생성됩니다.

• 이외의 다른 DB들은 공식페이지에서 찾아보고 그대로 적용하면 됩니다.

mysql 기준 세팅 방법

• /prisma/schema

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

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

• .env

DATABASE_URL="mysql://testUser:test@localhost:3306/testDB"
DATABASE_URL="mysql://<유저명>:<비밀번호>@<호스트>:<port>/<DB명>

🔎 schema.prisma

prisma의 세팅을 입력하는 파일입니다.

• datasource

# prisma와 Database를 연결하는 방법을 설정하는 부분입니다.

datasource db {
  provider             = "mysql"
  url                  = env("DATABASE_URL")
  referentialIntegrity = "prisma"
}

• generator

# 

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["referentialIntegrity"]
}

• model

# Database의 테이블의 형태를 명시
# user와 post 관계 ( 1 : N )

model User {
  id        Int      @id @default(autoincrement())
  name      String
  phone     Int?     @unique
  email     String?  @unique
  avatar    String?
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  
  posts     Post[]
}

model Post {
  id        Int      @id @default(autoincrement())
  content   String
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  
  user      User @relation(fields: [userId], references: [id], onDelete: Cascade)
  userId    Int
}

🤝 관계

• @relation을 정의하는 모델에 foreign key가 생성됩니다.

1. 관계 정의 예시

• 1 : 1

# 1 : 1 관계이므로 User or Profile중에 foreign key를 생성할 위치는 선택할 수 있음 ( @relation 위치 )
model User {
  id      Int      @id @default(autoincrement())
  profile Profile?
}

model Profile {
  id     Int    @id @default(autoincrement())
  name   String
  user   User   @relation(fields: [userId], references: [id])
  userId Int    @unique
}

• 1 : N

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

  # vscode의 prisma플러그인을 설치했을 경우에
  # 아래 코드부터 입력하면 자동으로 Post에 관계설정 코드를 입력해준다.
  posts Post[]
}

model Post {
  id       Int    @id @default(autoincrement())
  contents String

  User   User? @relation(fields: [userId], references: [id])
  userId Int?
}

• N : M

# 묵시적 N : M
# @relation("MyTable")은 중간 테이블 이름 지정 ( _MyTable )
# 생략시 _PostToCategory와 같은 명칭의 중간 테이블이 생성됨
model Post {
  id        Int    @id @default(autoincrement())
  contents  String

  categories Category[] @relation("MyTable")
}
model Category {
  id       Int    @id @default(autoincrement())
  category String

  posts Post[] @relation("MyTable")
}


# 명시적 N : M
model Post {
  id    Int    @id @default(autoincrement())
  title String

  categories PostCategory[]
}
model Category {
  id       Int    @id @default(autoincrement())
  category String

  posts PostCategory[]
}
model PostCategory {
  Post       Post     @relation(fields: [postId], references: [id])
  postId     Int
  Category   Category @relation(fields: [categoryId], references: [id])
  categoryId Int

  @@id([postId, categoryId])
}

• 하나의 테이블이 동시에 두 가지 이상의 1 : N관계를 가질 때

# user와 message가 두 번 1 : N관계를 가지는 경우, "name"으로 구분
model User {
  id    Int     @id @default(autoincrement())
  email String
  name  String?

  sentMessage     Message[] @relation("sent")
  receivedMessage Message[] @relation("received")
}

model Message {
  id      Int    @id @default(autoincrement())
  message String

  sent       User? @relation(name: "sent", fields: [sentId], references: [id])
  sentId     Int?
  received   User? @relation(name: "received", fields: [receivedId], references: [id])
  receivedId Int?
}

2. 관계 사용

1. create: 연관된 테이블에 데이터 생성

await prisma.user.create({
  data: {
    name: "admin",
    email: "admin@naver.com",
    posts: {
      create: {
        contents: "첫 번째 게시글",
      },
    },
  },
});

2. connect: 이미 생성된 데이터 연결

// async 함수 내부의 코드라 가정
const createdPost = await prisma.post.create({
  data: {
    contents: "첫 번째 게시글",
  },
});

await prisma.user.create({
  data: {
    name: "admin",
    email: "admin@naver.com",
    posts: {
      connect: {
        id: createdPost.id,
      },
    },
  },
});

3. include: 포함해서 가져오기

// 기본 형태 ( post의 모든 row들을 가져옴 )
const usersWithPosts = await prisma.user.findMany({
  include: {
    posts: true,
  },
});

// select이외의 다른 조건들도 사용할 수 있음 ( post의 id, name만 가져옴 )
const usersWithPosts = await prisma.user.findMany({
  include: {
    posts: {
      select: {
        id: true,
        name: true,
      },
    },
  },
});

🎰 데이터 타입

npx prisma db push로 테이블 생성 시 자동적으로 타입을 만들어줍니다.
만들자마자 import하려면 VSCode에서 인식을 못하는데 그때는 직접 파일에 들어갔다가 나오면 VSCode에서 타입을 인식합니다.

• 모델

model User {
  id    Int    @id @default(autoincrement())
  name  String @db.VarChar(20)
  email String

  posts Post[]
}
model Post {
  id Int @id @default(autoincrement())

  User   User? @relation(fields: [userId], references: [id])
  userId Int?
}

• 생성된 타입

// node_modules/.prisma/client/index.d.ts
export type User = {
  id: number
  name: string
  email: string | null
}
export type Post = {
  id: number
  userId: number
}

// import { Product } from "@prisma/client";

• <DB명>CreateInput 사용 예시

let user: Prisma.UserCreateInput = {
  name: "",
  email: "aa",
};

const exUser = await prisma.user.create({
  data: user,
});

🛠️ 데이터 CRUD

모두 user와 post라는 테이블이 있다고 가정하고 작성하겠습니다.

1. Create

• prisma.user.create()

const createdUser = await prisma.user.create({
  data: {
    name: "john",
    email: "j@naver.com"
  },
});

• prisma.user.createMany()

const count = await prisma.user.createMany({
  data: [
    { name: "apple", email: "a@naver.com" },
    { name: "blue", email: "b@naver.com" },
    { name: "color", email: "c@naver.com" },
    // ...
  ],
});

console.log(count.count);	// 3

2. Read

• prisma.user.findUnique()

const exUser = await prisma.user.findUnique({
  // 유니크한 값만 검색조건으로 사용할 수 있습니다. ( type이 자동으로 만들어져 있어서 검색할 수 있는 row를 보여줌 )
  where: {
    id: 1,
  },
});

// 만약 @@unique([email, name])같은 형식으로 만들었다면 아래와 같이 사용해야합니다.
// 혹시 @@unique([email, name], name: "yourName")처럼 만들었다면 "email_name"대신 "yourName"을 사용하면 됩니다.
const exUser = await prisma.user.findUnique({
  where: {
    email_name: {
      email: "a@naver.com",
      name: "a",
    },
  },
});

• prisma.user.findMany()

// 모든 데이터 가져오기
const allUser = await prisma.user.findMany();

// 특정 데이터 모두 가져오기
const allUser = await prisma.user.findMany({
  where: {
    // ...
  },
});

• prisma.user.findFirst()

// 조건에 만족하는 첫 번째 데이터만 가져오기
const allUser = await prisma.user.findFirst({
  where: {
    // ...
  },
});

3. Update

• prisma.user.updateMany()

const updateUsers = await prisma.user.updateMany({
  where: {
    // ...
  },
  data: {
    // ...
  },
})

• prisma.user.upsert()

// 없으면 생성, 있으면 업데이트
const upsertUser = await prisma.user.upsert({
  where: {
	// ...
  },
  update: {
    // ...
  },
  create: {
    // ...
  },
})

4. Delete

• prisma.user.delete()

const deleteUser = await prisma.user.delete({
  where: {
    email: 'bert@prisma.io',
  },
});

• prisma.user.delete()

// 조건에 만족하는 일부분 삭제
const deleteUsers = await prisma.user.deleteMany({
  where: {
    email: {
      contains: 'prisma.io',
    },
  },
});

// 전체 삭제
const deleteUsers = await prisma.user.deleteMany({});

이후에 정리

🕊️

• select: 특정 필드 선택 or 관계된 테이블 및 테이블의 특정 필드 선택
• include: 관계된 테이블 선택
• orderBy: 정렬
• contains: 포함된것 찾기
• disconnect: 특정 레코드 관계 끊기
• set: 모든 레코드 관계 끊기
• deleteMany: 모든 or 특정 레코드 삭제
• update: 특정 레코드 수정
• upsert: 특정 레코드 생성 or 수정

🐲

• @@map("posts"): 실제 테이블명은 바뀌지만 prisma에서 사용하는 명칭을 바뀌지 않음
• @id, @default(), @default(autoincrement()), @unique
• @@id([id, email]): id와 email을 합쳐서 primary key로 지정
• @@unique([email, name]): email과 name 합쳐서 unique key로 설정
• @@index([email, name]): email과 name 합쳐서 index로 설정

@@id, @@unique의 배열 내부에 한번에 적을 경우 각각이 아니라 두 가지를 합쳐서 인덱스로 지정합니다.

• now(): 현재 시간
• uuid(): UUID 사양를 기반으로 고유한 식별자 생성
• autoincrement()
• @relation()
• fields: []
• references: []
• onDelete: Cascade
• onUpdate: Cascade