[TIL] Prisma, Planet scale 셋업 및 연결 방법

💡 TIL 20230822 - Prisma, Planet scale 셋업 및 연결 방법

---

1. Prisma, Planet Scale, Vitess

1) Prisma

Prisma는 데이터베이스를 다루기 위한 현대적이고 강력한 ORM (Object-Relational Mapping) 도구이다. Prisma를 사용하면 데이터베이스 스키마를 간편하게 정의할 수 있고, 데이터베이스 쿼리 역시 쉽게 작성하고 실행할 수 있다. Prisma는 다양한 데이터베이스 시스템과 통합할 수 있으며, TypeScript와 JavaScript를 지원하며, 데이터 모델과 데이터베이스 스키마를 동기화하여 개발자에게 강력한 개발 경험을 제공한다.

 

2) Planet Scale

MySQL과 호환되는 서버리스 데이터베이스로, 개발자 경험을 저하시키지 않으면서 확장성, 성능 및 안정성을 제공하는 서비스이다.

Vitess 개발 팀 인원들이 만든 서비스로, MySQL의 안정성과 오픈소스인 Vitess의 확장성을 갖추었다는 장점 때문에 2021년에 서비스를 런칭한 이후 매우 빠르게 입소문이 난(!?) 서비스라고 한다.

 

3) Vitess

Vitess는 Youtube 서비스의 너무 거대해진 데이터베이스를 스케일링하기 위해 Youtube에서 오픈 소스로 개발된 데이터베이스 셰이딩 및 클러스터링 시스템으로, 주로 대규모 데이터베이스 환경에서 사용된다. Vitess는 MySQL 데이터베이스에 대한 가상화 계층을 제공하며, 데이터베이스를 여러 노드로 분할하고 확장 가능한 아키텍처를 제공한다. 이를 통해 데이터베이스 확장성 및 가용성을 향상시키고, 높은 부하를 처리할 수 있게 해준다.

 

---

2. 기본 셋업

// PlanetScale auth
pscale auth login

// PlanetScale과 프로젝트(로컬) 연결
pscale connect project-name

// secure tunnel을 통해 PlanetScale과 연결되는 url 환경변수 설정
DATABASE_URL="mysql://000.0.0.0:0000/project-name"

// scheme.prisma에서 스키마 정의 후 push
npx prisma db push

// 프리즈마 스튜디오 실행 -> DB 관리자 패널
npx prisma studio

// 프리즈마 클라이언트 설치
yarn add @prisma/client

 

---

 

3. 프리즈마 클라이언트 설치 후 client.ts 파일 설정

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

export default new PrismaClient();

• 설정 후 npx prisma db push로 서버에 push

 

---

4. schema.prisma

프리즈마를 설정하고 데이터의 생김새를 정의하는 프리즈마의 심장과 같은 파일..!

// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema

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

datasource db {
  provider     = "mysql"
  url          = env("DATABASE_URL") // 환경변수에 설정해준 planet scale secure url
  // relationMode 설정: 데이터 간 관계를 관리할 때 prisma 설정대로 하겠다는 의미
  // 참조 무결성
  relationMode = "prisma"
}

// npx prisma db push
model User {
  id        Int      @id @default(autoincrement())
  phone     Int?     @unique
  email     String?  @unique
  name      String
  avartar   String?
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
}

 

참조 무결성

• ex. User DB : { id: 1, username: john }
  • Comments DB에 { id: 1, text: wow!, user: 5 }로 등록하려하면 에러가 발생하지 않음 (user: 5가 없음에도)
  • 일반적인 sql이나 postgresql 환경에서는 외래키 제약때문에 에러 발생함
  • comments DB에 user라는 외래키가 있으니 User 테이블에서 검색하기 때문
  • 하지만 이번에 사용하는 Vitess는 foreign key constranint를 지원하지 않음
  • 따라서 이러한 확인작업을 DB side에서 하는 것이 아니라 prisma를 통해서 할 것

 

---

참고 사이트

노마드 코더 - 당근마켓 클론코딩

PlanetScale을 Prisma로 더 잘 사용하기