[플젝기록] Prisma Seeding 🌱

요즘 Prisma를 사용해서 사이드 프로젝트를 진행중인데 처음 사용하다보니 새로 배우는 것들이 많다.
Seeding도 그 중 한 가지인데 튜토리얼 동영상과 글들을 보다보니 seeding, seed라는 단어가 자주 나왔다. 당장 필요해보이지는 않아서 나중에 필요할 때에 봐야지 하고 지나쳤는데 필요한 순간이 왔다. (위에서 언급했다시피 Prisma를 처음 사용하다보니 Prisma, Prisma seeding에 대한 나의 이해가 제한적일 수 있고 이 글이 공식 문서에 기초해 있긴하지만 더 정확한 내용은 공식 문서를 참고하기 바란다.)

Prisma의 공식 문서를 보고 싶다면 이 링크를 확인하라.

Seeding your database

 

Seeding은 무엇이고 언제 필요한가?

Seeding이 무엇인지부터 간단히 살펴보면 공식 문서에는 이렇게 한 문장으로 설명한다. 

Seeding allows you to consistently re-create the same data in your database
Seeding은 당신의 데이터베이스에 같은 데이터를 일관성있게 재생성하도록 해줍니다.

데이터베이스라는 토양에 데이터라는 씨를 미리 심어놓는 것을 의미하는 것 같기도 하다. 아무튼 공식 문서에서는 계속해서 seeding이 사용될 수 있는 부분에 대해 이렇게 설명한다. 

- Populate your database with data that is required for your application to start - for example, a default language or a default currency.
- Provide basic data for validating and using your application in a development environment. This is particularly useful if you are using Prisma Migrate, which sometimes requires resetting your development database.

- 당신의 애플리케이션을 시작하기 위해 필요한 데이터를 당신의 데이터베이스에 추가해준다. 예를 들면 기본 언어나 기본 통화. 
- 개발 환경에서 애플리케이션을 검증하고 사용하기 위한 기본 데이터를 제공한다. 이것은 당신의 개발 데이터베이스를 재설정해야 하는 Prisma Migrate를 사용하는 경우 특히 유용하다.

Prisma Migrate에 대해서는 다루지 않는다. 전 글에 PlanetScale에서 브랜치를 생성하고 deploy request하는 방법을 올렸었는데 개발하는 과정에 여러 브랜치를 생성하는 경우 seeding 기능을 활용하면 편리하고 빠르게 데이터를 추가해줄 수 있겠다는 생각이 들었다. PlanetScale에서 브랜치를 새로 생성하면 schema만 복사가 되고 데이터는 같이 복사되는 것이 아니기 때문에 새로운 브랜치를 생성할 때마다 새로운 테스트 데이터를 추가해주어야 할 것이다. 추가해주어야 하는 데이터가 적다면 Seed 스크립트를 작성하는 시간이 더 오래 걸릴지 모르지만 데이터가 적더라도 계속 반복하여 추가해 주어야 하는 것이라면 시간을 조금 더 들여 스크립트를 작성하는 것이 더 효율적일지도 모른다. 

 

Seeding은 어떻게 하는 것인가? (JavaScript 기준)

1. seed.js 파일 추가하기

프로젝트에서 prisma를 사용하고 있다면 /prisma라는 디렉토리가 있을 것이다. 해당 디렉토리 안에 seed.js 파일을 생성해준다. 

 

2. seed.js 에 스크립트 작성하기 

아래의 코드는 공식 문서에 나와있는 샘플 스크립트이다.
alice, bob이라는 user를 추가하고 있고 모두 upsert를 사용하고 있는데 where에 대해 존재하는 경우는 update를 그렇지 않으면 새로 생성하는 쿼리로 자세한 사용법은 여기서 확인해보자(링크). 이 스크립트는 자신의 스키마와 필요한 데이터에 맞춰서 작성해주면 된다. 

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

async function main() {
  const alice = await prisma.user.upsert({
    where: { email: 'alice@prisma.io' },
    update: {},
    create: {
      email: 'alice@prisma.io',
      name: 'Alice',
      posts: {
        create: {
          title: 'Check out Prisma with Next.js',
          content: 'https://www.prisma.io/nextjs',
          published: true,
        },
      },
    },
  })

  const bob = await prisma.user.upsert({
    where: { email: 'bob@prisma.io' },
    update: {},
    create: {
      email: 'bob@prisma.io',
      name: 'Bob',
      posts: {
        create: [
          {
            title: 'Follow Prisma on Twitter',
            content: 'https://twitter.com/prisma',
            published: true,
          },
          {
            title: 'Follow Nexus on Twitter',
            content: 'https://twitter.com/nexusgql',
            published: true,
          },
        ],
      },
    },
  })
  console.log({ alice, bob })
}

main()
  .catch((e) => {
    console.error(e)
    process.exit(1)
  })
  .finally(async () => {
    await prisma.$disconnect()
  })

아래는 내가 작성한 seed.js의 일부이다. 

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

async function main() {
  const category = await prisma.category.upsert({
    where: { id: 1 },
    update: {},
    create: {
      name: "Side project",
    },
  });

  const test = await prisma.user.upsert({
    where: { id: 1 },
    update: {},
    create: {
      email: "test@test.com",
      name: "test",
      Article: {
        create: {
          categoryId: 1,
          title: "[플젝계획] 새로운 사이드 프로젝트를 시작해보자",
          content:
            '새로운 사이드 프로젝트를 시작할 시간이다. 무엇이든 직접해봐야 느끼는 것도 많고 배우는 것도 많은 것 같다...',
          ... // 생략
        },
      },
    },
  });

  console.log({ category, test });
}

main()
  .catch((e) => {
    console.error(e);
    process.exit(1);
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

 

3. seed.js 파일에 대해 package.json에 추가하기

 

4. Seeding 하기

위의 커맨드를 실행하면 seeding이 진행되고 성공시 아래와 같이 확인할 수 있다.