Supabase Database의 타입을 생성하는법 with Supabase CLI

DL·2023년 11월 22일
1
post-thumbnail

서문

저는 기존에 Firebase를 사용하던 프로젝트의 코드를 Supabase를 사용하기 위한 코드로 마이그레이션 중입니다.
마이그레이션 도중 타입의 부재로 인한 불편함을 겪게 되어, Prisma Client처럼 자동으로 타입을 생성해 주고 싶었으나, 관련되어 정리된 글이 많지 않아 어려움을 겪게 되었습니다.
그래서 이 정리 글을 남기게 되었습니다.

Supabase CLI

supabase CLI는 로컬에서 supabase를 제어할 수 있는 도구입니다.
아래의 명령어로 설치해 주시면 됩니다.

// npm
npm i supabase --save-dev

// yarn
yarn add -D supabase

타입 생성

supabase login

CLI를 설치후에는 아래의 명령어로 login을 하면 됩니다.

// npx
npx supabase login

// yarn
yarn supabase login

그러면 액세스토큰을 요구하는데요, 아래의 경로로 들어가셔서 Generate new token 버튼을 눌러서 토큰을 생성하시면 됩니다.

https://supabase.com/dashboard/account/tokens

supabase gen types typescript

아래의 명령어로 타입을 생성하시면 됩니다.

// npx
yarn supabase gen types typescript --project-id <프로젝트 ID> --schema public > <경로>

// yarn
yarn supabase gen types typescript --project-id <프로젝트 ID> --schema public > <경로>

프로젝트 ID

프로젝트 화면에서 URL을 보면 https://supabase.com/dashboard/project/<프로젝트 ID>가 있습니다.

참고

Supabase Docs
썸네일

profile
어제보다 오늘, 오늘보다 내일 더 성장하는 프론트엔드 개발자

0개의 댓글