Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

📒  Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

---

NestJS로 개발할 때 주로 prisma와 postgresql을 사용하는 추세입니다.

왜 어떠한 특장점이 있는지, 그리고 초기 설치 방법에 대해 설명하겠습니다.

 

📌 prisma와 PostgreSQL의 장점

🔎 prisma

Prisma는 TypeScript와 JavaScript 애플리케이션에서 ORM(Object-Relational Mapping) 역할을 수행하는 도구로, 데이터베이스와의 상호작용을 간편하고 효율적으로 만들어 줍니다.

Prisma는 데이터베이스 모델링, 쿼리 작성, 마이그레이션 관리 등 다양한 기능을 제공하며, 특히 TypeScript와의 강력한 호환성을 바탕으로 코드 자동 완성, 타입 검사 등을 통해 생산성과 안정성을 크게 향상합니다.

 

🔎 PostgreSQL

PostgreSQL은 오픈 소스 관계형 데이터베이스 시스템으로, 안정성, 확장성, 데이터 무결성을 중시하며 여러 고급 기능을 제공합니다. SQL 표준 준수 외에도 JSON 데이터 타입, 고급 쿼리 최적화, 트랜잭션 관리 등을 포함해 비관계형 데이터베이스 기능까지 폭넓게 지원하여 RDBMS와 NoSQL의 장점을 함께 제공합니다.

 

대표적 데이터베이스인 MySQL과 비교하면 다음과 같은 차이가 있습니다.

항목	PostgreSQL	MySQL
쿼리 최적화 및 성능	복잡한 쿼리 최적화 지원, 고급 트랜잭션 기능(윈도우 함수, CTE 등)	단순 쿼리에 대해 뛰어난 읽기 성능, 복잡한 트랜잭션 최적화는 제한적
아키텍처	객체 관계형 데이터베이스로 ACID 트랜잭션 준수, 데이터 일관성과 복잡한 관계 표현 가능	관계형 데이터베이스로 높은 성능과 가용성 제공, 웹 애플리케이션에서 많이 사용됨
데이터 타입	JSON, JSONB, 배열, 범위 등 고급 데이터 타입 지원	JSON 데이터 타입을 지원하지만 기능은 PostgreSQL보다 제한적
확장성	사용자 정의 함수, 자료형 확장 가능, 다양한 언어로 트리거와 기능 구현 가능	간편한 스케일링 지원, 다양한 스토리지 엔진 선택 가능(InnoDB, MyISAM 등)
복제 및 고가용성	스트리밍 및 논리적 복제로 고가용성 지원, 고급 복제 기능 제공	마스터-슬레이브 복제 지원, 다중 리더 설정 가능, 비동기 복제 성능이 뛰어남

 

📌 docker로 PostgreSQL 설치하기

🔎 이미지 pull

$ docker pull postgres:17

pull 명령어로 이미지를 받아줍니다.

가장 최신버전이 17이라 버전을 직접 명시해 주었습니다.

 

🔎 컨테이너 올리기

$ docker run -d --restart=always \
  --name postgres-db \
  -e POSTGRES_PASSWORD=your_password \
  -e POSTGRES_DB=your_db_name \
  -p 5432:5432 \
  -v /path/to/local/data:/var/lib/postgresql/data \
  postgres

주요 옵션에 대한 설명은 다음과 같습니다.

• -d: 백그라운드 실행 
• --restart=always: 컨테이너 자동으로 재시작
• --name: 컨테이너 이름 지정 
• -e POSTGRES_PASSWORD: PostgreSQL 루트 비밀번호 설정 
• -e POSTGRES_DB: 초기 데이터베이스 이름 설정 
• -p 5432:5432: 호스트와 컨테이너의 포트 매핑 
• -v: 컨테이너가 날아갔을 때 데이터를 지키기 위한 볼륨 설정

개인 서버에 올리고 데이터베이스 클라이언트로 연결해 보니 정상적으로 작동하네요.

 

📌 prisma 설치 및 PostgreSQL 연동

🔎 설치

$ npm i @prisma/client
$ npm i -D prisma

개발 의존성으로 프로젝트에 prisma 클라이언트를 설치해 줍니다.

 

🔎 초기화

$ npx prisma init

이 명령을 실행하면 프로젝트 루트에 prisma 폴더가 생성되고, 그 안에 schema.prisma 파일이 만들어집니다.

schema.prisma 파일은 Prisma의 기본 설정과 데이터베이스 스키마를 정의하는 파일입니다.

 

더 편하게 파일을 확인 및 작성하고 자동완성 기능을 사용하려면 다음 Extension을 설치해 주세요.

 

🔎 env 파일에 DB 정보 입력

# .env 파일

DATABASE_URL="postgresql://[username]:[password]@[서버_주소]:5432/[DB_name]"

 

자신이 생성한 대로 잘 입력해 주도록 합니다.

유저는 root를 사용하기보단 새로 하나 만드는 것을 추천합니다.

 

🔎 테이블 생성하기

prisma/schema.prisma에서 데이터베이스 스키마를 정의할 수 있습니다.

저는 정말 간단하게 테이블을 정의해 봤습니다.

 

그다음 명령어로 정의한 테이블을 데이터베이스와 동기화할 수 있습니다.

 

$ npx prisma migrate dev

 

prisma migrate 명령어는 Prisma에서 데이터베이스 스키마 변경을 관리하는 데 사용됩니다.

이 명령어는 데이터베이스 마이그레이션을 생성하고 적용하여 Prisma 스키마와 실제 데이터베이스 간의 동기화를 도와줍니다.

기본적으로 데이터베이스의 상태를 정의하고, 이를 기반으로 변경 사항을 추적 및 적용할 수 있게 합니다.

 

성공한다면 migration 파일이 생성되고 DB에도 잘 적용된 것을 확인할 수 있습니다.

 

📌 NestJS 다른 글

[NestJS] - NestJS 프로젝트 시작과 구조의 이해

NestJS 프로젝트 시작과 구조의 이해

 

NestJS와 prisma로 편리하게 CRUD 구현하기

NestJS와 prisma로 편리하게 CRUD 구현하기