Prisma ORM이란?

Prisma ORM이란 무엇인가?

Prisma ORM은 차세대 오픈소스 ORM이다. 다음과 같은 부분으로 구성되어 있다:

• Prisma 클라이언트 : Node.js 및 TypeScript를 위한 자동 생성 및 타입 안전 쿼리 빌더
• Prisma 마이그레이션 : 마이그레이션 시스템
• Prisma 스튜디오 : 데이터베이스의 데이터를 보고 편집할 수 있는 GUI.

Prisma 클라이언트는 모든 Node.js(지원되는 버전) 또는 TypeScript 백엔드 애플리케이션(서버리스 애플리케이션 및 마이크로서비스 포함)에서 사용할 수 있다. 여기에는 REST API, GraphQL API, gRPC API 또는 데이터베이스가 필요한 모든 것이 포함된다.

Prisma ORM의 작동 방식

Prisma 스키마

Prisma ORM 도구를 사용하는 모든 프로젝트는 Prisma 스키마 파일에서 시작한다. Prisma 스키마를 통해 개발자는 직관적인 데이터 모델링 언어로 애플리케이션 모델을 정의할 수 있다. 또한 데이터베이스에 대한 연결이 포함되어 있으며 생성기(generator)를 정의한다:

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

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

model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

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

스키마에서는, 다음이 세 가지를 구성할 수 있다.

• 데이터 소스: 데이터베이스 연결을 지정한다(환경 변수를 통해).
• 생성기: Prisma 클라이언트를 생성할지 여부를 나타낸다.
• 데이터 모델: 애플리케이션 모델을 정의한다.

Prisma 스키마 데이터 모델

이 페이지에서는 데이터 모델에 초점을 맞추고 있다. 데이터 소스와 생성기에 대한 자세한 내용은 각각의 문서 페이지에서 확인할 수 있다.

Prisma 스키마 데이터 모델의 기능

데이터 모델은 모델들의 집합이다. 모델은 두 가지 주요 기능이 있다:

• 관계형 데이터베이스의 테이블 또는 MongoDB의 컬렉션을 나타낸다.
• Prisma 클라이언트 API의 쿼리를 위한 기초를 제공한다.

데이터 모델 가져오기

데이터 모델을 Prisma 스키마에 "가져오기" 위한 두 가지 주요 워크플로우는 다음과 같다:

• 데이터 모델을 수동으로 작성하고 Prisma 마이그레이션으로 데이터베이스에 매핑
• 데이터베이스 인트로스펙션을 통해 데이터 모델 생성

데이터 모델이 정의되면, 정의된 모델에 대한 CRUD 및 추가 쿼리를 노출하는 Prisma 클라이언트를 생성할 수 있다. 타입스크립트를 사용한다면 모든 쿼리에 대해 완전한 타입 안전성을 얻게 된다.

Prisma 클라이언트로 데이터베이스에 접근하기

Prisma 클라이언트 생성하기

Prisma 클라이언트를 사용할 때 첫 번째 단계는 @prisma/client npm 패키지를 설치하는 것이다:

npm install @prisma/client

@prisma/client 패키지를 설치하면 prisma generate 명령이 호출되어, Prisma 스키마를 읽고 Prisma 클라이언트 코드를 생성 한다. 기본적으로 코드는 node_modules/.prisma/client 폴더에 생성된다.

데이터 모델을 변경하면 node_modules/.prisma/client 내부의 코드가 업데이트되도록 Prisma 클라이언트를 수동으로 다시 생성해야 한다.

prisma generate

Prisma 클라이언트를 사용하여 데이터베이스에 쿼리 보내기

Prisma 클라이언트가 생성되면 코드에 임포트하여 데이터베이스로 쿼리를 보낼 수 있다. 설정 코드는 다음과 같다:

Prisma 클라이언트 임포트 및 인스턴스화 하기

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

const prisma = new PrismaClient();

이제 생성된 Prisma 클라이언트 API를 통해 쿼리를 보낼 수 있다. 다음은 몇 가지 샘플 쿼리다. 모든 Prisma 클라이언트 쿼리는 일반 자바스크립트 객체 를 반환한다는 점에 유의한다.

더 자세한 내용은 Prisma 클라이언트 API 참조 문서를 이용한다.

데이터베이스에서 모든 User 레코드 가져오기

const allUsers = await prisma.user.findMany();

반환된 각 User 객체에 posts 포함시키기

const allUsers = await prisma.user.findMany({
  include: { posts: true },
});

"Prisma" 문자열을 포함하는 Post 레코드 필터링하기

const filteredPosts = await prisma.post.findMany({
  where: {
    OR: [
      { title: { contains: 'prisma' } },
      { content: { contains: 'prisma' } },
    ],
  },
});

하나의 쿼리로 User 와 Post 레코드 생성하기

const user = await prisma.user.create({
  data: {
    name: 'Alice',
    email: 'alice@prisma.io',
    posts: {
      create: { title: 'Join us for Prisma Day 2020' },
    },
  },
});

기존 Post 레코드 업데이트하기

const post = await prisma.post.update({
  where: { id: 42 },
  data: { published: true },
});

타입스크립트와 함께 사용하기

타입스크립트를 사용할 경우 이 쿼리의 결과는 정적으로 타입화되므로 실수로 존재하지 않는 프로퍼티에 액세스하는 것을 방지할 수 있다(오타가 컴파일 타임에 감지됨).

Prisma ORM의 일반적인 워크플로우

위에서 언급했듯이 데이터 모델을 Prisma 스키마로 '가져오기'하는 방법에는 두 가지가 있다. 어떤 접근 방식을 선택하느냐에 따라 기본 Prisma ORM 워크플로가 달라진다.

Prisma 마이그레이션

Prisma ORM의 통합 데이터베이스 마이그레이션 도구인 Prisma 마이그레이션을 사용하면 다음과 같은 워크플로우를 사용할 수 있다:

1. Prisma 스키마 데이터 모델을 수동으로 작성한다.
2. prisma migrate dev CLI 명령을 사용하여 개발 데이터베이스를 마이그레이션한다.
3. 애플리케이션 코드에서 Prisma 클라이언트를 사용하여 데이터베이스 액세스한다.

SQL 마이그레이션과 인트로스펙션

어떤 이유로 Prisma 마이그레이션을 사용할 수 없거나 원하지 않는 경우에도 인트로스펙션을 사용하여 데이터베이스 스키마에서 Prisma 스키마를 업데이트할 수 있다. SQL 마이그레이션과 인트로스펙션을 사용할 때의 일반적인 워크플로우는 약간 다르다:

1. SQL 또는 타사 마이그레이션 도구를 사용하여 데이터베이스 스키마를 수동으로 작성한다.
2. 데이터베이스 (리)인트로스펙트
3. 선택적으로 Prisma 클라이언트 API (재)구성
4. 프리즈마 클라이언트 (재)생성
5. 애플리케이션 코드에서 Prisma 클라이언트를 사용하여 데이터베이스에 액세스한다.