[플젝기록] PlanetScale branch 변경 및 deploy request (Prisma String의 default 값)

[플젝기록] Next.js + Prisma + PlanetScale 세팅하기 (Vercel 배포)

지난 세팅편에서 8번에 "promote 후에 main 브랜치는 production을 위한 브랜치가 되고 main 브랜치에 대해 직접적인 스키마 변경이 불가능하다. 이 글을 작성하기 전에 테스트 삼아 만들어 본 DB에서 이 브랜치에 대한 개념을 잘 모르고 promote한 상태에서 스키마를 변경하려고 해서 에러로 당황했던 적이 있다. " 라고 작성했었다. 그럼 이미 브랜치를 promote를 했는데 스키마를 변경해야하는 경우에는 어떻게 해야 하는가에 대한 이야기를 해보려고 한다. 발단에서는 이 글을 왜 작성하게 되었는지에 대한 이야기를 다루기 때문에 읽지 않아도 무방하다.

 

발단

지난 편에는 단순히 세팅을 위한 글이었기 때문에 간단한 샘플로 User 모델만 작성했었는데 사이드 프로젝트를 진행하면서 Article이라는 모델을 작성하였다. 아래에 일부 필드에 대해서 보여준다. 

title 필드를 varchar(255)로 제한을 두었다. Prisma가 익숙하지 않은 나는 content에 아무것도 적어주지 않으면 제한을 두지 않는다고 생각했다...😬 이 상태로 이미 promote를 해버렸고... 테스트 해보려고 Postman을 사용하여 POST 요청을 보내보니 content가 너무 길다는 것이었다. 왜일까... 구글링을 하다보니 아래의 페이지를 발견했다. (링크)

Prisma Connector별 String의 기본값

MySQL의 경우 String 타입에서 default는 varchar(191)이었고 그렇기 때문에 너무 길다는 에러가 뜬 것이었다. 그래서 아래와 같이 @db.Text로 수정했다. 

그리고 PlanetScale의 main 브랜치에서 `npx prisma db push` 를 실행하면 초반에 언급했던 에러가 아래와 같이 뜬다.  

 

해결

1. 브랜치 생성하기 (CLI 혹은 GUI 방식) 

위의 에러 메시지에서도 볼 수 있듯이 main 브랜치를 이미 promote했다면 main 브랜치에서는 더 이상 직접적으로 DDL 수정이 불가능하다. Git을 사용해보신 분들이라면 좀 더 익숙할 브랜치가 여기서도 등장한다. 스키마 변경 작업을 위한 브랜치를 새로 하나 생성해주어야 한다. CLI / GUI 방식 중 편한 방식 한 가지를 선택하여 진행하면된다. 참고로 브랜치를 생성하면 main 브랜치에 있는 데이터는 복사되지 않고 스키마만 복사된다.

CLI로 생성하는 방식은 아래와 같다. 

PlanetScale CLI로 생성하기

아래와 같이 PlanetScale 웹사이트에서 로그인 후 자신이 생성한 DB를 선택해 해당 대시보드에서도 New Branch 버튼을 클릭해 아래의 내용을 입력해주고 생성할 수 있다. 

PlanetScale Dashboard에서 생성하기

 

2. 새로 생성한 브랜치와 연결

--port 3309를 플래그로 지정해준 이유는 이전 초기 세팅관련 글에서도 3309으로 정해주었고 .env 파일에도 3309으로 DATABASE_URL로 저장해주었기 때문이다. --port 플래그를 붙이지 않으면 다른 포트로 연결이 이루어지고 .env 파일에서 해당 포트 번호로 변경해주면 된다. 연결이 잘 이루어졌다면 성공 메시지를 콘솔에서 확인할 수 있을 것이다. 

Prisma에서 제공하는 기능으로 새로운 브랜치에 데이터 쉽게 넣는 방법 확인하기👇

[플젝기록] Prisma Seeding 🌱

 

3. 새로운 브랜치에 변경된 schema push 하고 확인하기

main 브랜치에 push 하던 명령어와 동일하다. 

아래의 명령어를 입력하여 Prisma Studio에서 확인할 수 있는데 콘솔에 뜨는 주소에서 접속하여 구조가 변경되었는지 보고 직접 데이터를 넣어볼 수 도 있다. 

 

4. 새로운 브랜치의 변경 내용을 main 브랜치에 deploy하기

변경한 내용을 production에도 적용하려면 이미 promote된 main 브랜치에 deploy해야한다. Git에서도 내가 브랜치를 따서 작업하고 merge하기 위해 pull request를 보내듯 PlanetScale에서는 deploy request를 해야한다. (이것은 내가 이해한 부분으로 틀린 부분에 대해서는 댓글로 피드백 부탁한다.) 이 과정은 GUI를 사용하겠다. (CLI를 사용하는 방법은 공식 문서를 통해 확인 가능하다. )

PlanetScale의 대시보드에서 내가 생성한 DB를 클릭하고 들어가 Branches 탭을 누르면 아래와 같은 화면이 보일 것이다. 

작업을 위해 새로 생성한 브랜치를 클릭하고 들어가면 아래와 같이 deploy request를 할 수 있는 화면이 나오는데 comments는 선택사항이라고 하니 알아서 입력하거나 생략하고 Create deploy request를 클릭한다. 

아래와 같이 Deploy changes 버튼이 활성화되면 문제없이 main 브랜치로 deploy 될 수 있다는 것이다. ALTER TABLE을 클릭해보면 어떤 SQL이 실행되는지도 확인할 수 있다. 

아래와 같이 deploy가 완료된 후에는 브랜치를 삭제할 수 있다. 삭제하지 않고 개발 브랜치로 계속 사용할 수도 있다. 

혼자 진행하는 사이드 프로젝트로 팀 계정이 아니다보니 deploy request에서도 별도의 승인 절차가 없이 진행되는 것 같은데 팀일 경우 플로우가 다를 것 같다. 

혹시 나처럼 브랜치는 생성했는데 브랜치를 어떻게 바꾸는지, 어떻게 deploy하는 것인지 몰랐던 분/답답했던 분들에게 조금이나마 도움이 되었기를 바란다. 

참고로 이 유튜브 동영상도 참 도움이 많이 되었다.