Supabase Edge Functions와 Drizzle 사용하기

새로운 Supabase 프로젝트 초기화하기

이 튜토리얼은 Supabase Edge Functions와 Drizzle ORM을 함께 사용하는 방법을 보여줍니다.

npm i drizzle-orm
npm i -D drizzle-kit

yarn add drizzle-orm
yarn add -D drizzle-kit

pnpm add drizzle-orm
pnpm add -D drizzle-kit

bun add drizzle-orm
bun add -D drizzle-kit

로컬 머신에서 기본 Edge Function을 생성하고 배포하는 방법을 배우려면 Edge Functions 빠른 시작을 참고하세요.

supabase init

└── supabase
    └── config.toml

새로운 Edge Function 생성하기

새로운 Edge Function을 만들려면 supabase functions new [FUNCTION_NAME] 커맨드를 실행하세요:

supabase functions new drizzle-tutorial

이 명령어를 실행하면 supabase/functions 디렉토리에 함수 이름으로 된 새 폴더가 생성됩니다:

└── supabase
    └── functions
        └── drizzle-tutorial
            └── index.ts ## 여러분의 함수 코드가 위치할 파일

임포트 설정

supabase/functions 디렉토리에 import_map.json 파일을 생성하고 Drizzle ORM을 위한 임포트를 추가합니다:

{
  "imports": {
    "drizzle-orm": "npm:drizzle-orm@0.30.10",
    "drizzle-orm/": "npm:/drizzle-orm@0.30.10/"
  }
}

더 자세한 내용은 공식 문서에서 확인할 수 있습니다.

테이블 생성하기

supabase/functions/common 디렉토리에 schema.ts 파일을 생성하고 테이블 스키마를 선언합니다:

import { pgTable, serial, text, integer } from "drizzle-orm/pg-core";

export const usersTable = pgTable('users_table', {
  id: serial('id').primaryKey(),  // 기본 키로 설정된 id 컬럼
  name: text('name').notNull(),   // null이 허용되지 않는 name 컬럼
  age: integer('age').notNull(),  // null이 허용되지 않는 age 컬럼
  email: text('email').notNull().unique(),  // null이 허용되지 않고 고유한 email 컬럼
});

이 코드는 users_table이라는 테이블을 정의합니다. 테이블에는 id, name, age, email 네 개의 컬럼이 있으며, 각 컬럼은 특정 타입과 제약 조건을 가지고 있습니다.

Drizzle 설정 파일 설정하기

Drizzle config는 Drizzle Kit에서 사용하는 설정 파일로, 데이터베이스 연결 정보, 마이그레이션 폴더, 스키마 파일 등에 대한 모든 정보를 담고 있습니다.

프로젝트 루트에 drizzle.config.ts 파일을 생성하고 다음 내용을 추가하세요:

import { defineConfig } from "drizzle-kit";

export default defineConfig({
  schema: "./supabase/functions/common/schema.ts",
  out: "./supabase/migrations",
  dialect: "postgresql",
});

이 튜토리얼에서는 Drizzle Kit을 사용해 스키마에 대한 마이그레이션을 생성할 것입니다.

마이그레이션 생성하기

drizzle-kit generate 명령어를 실행하여 마이그레이션을 생성합니다:

npx drizzle-kit generate

이 명령어는 supabase/migrations 디렉토리에 새로운 마이그레이션 파일을 생성합니다.

마이그레이션 적용하기

Supabase 로컬 개발 스택을 시작하고 마이그레이션을 적용하려면 다음 명령어를 실행하세요:

supabase start

또는 지원되는 모든 드라이버에서 사용 가능한 migrate() 헬퍼를 사용해 마이그레이션을 적용할 수도 있습니다. 이 마이그레이션 과정에 대해 더 자세히 알아보려면 문서를 참고하세요.

Drizzle ORM을 데이터베이스에 연결하기

supabase/common 디렉토리에 db.ts 파일을 생성하고 데이터베이스 설정을 구성합니다:

import postgres from "npm:postgres";
import { drizzle } from "drizzle-orm/postgres-js";

const connectionString = Deno.env.get("SUPABASE_DB_URL")!;

// "Transaction" 풀 모드에서는 prefetch를 지원하지 않으므로 비활성화
const client = postgres(connectionString, { prepare: false });
export const db = drizzle({ client });

SUPABASE_DB_URL은 직접 데이터베이스 연결을 위한 기본 환경 변수입니다. Supabase Edge Functions에서 환경 변수를 관리하는 방법에 대해 더 알아보려면 문서를 참고하세요.

로컬에서 코드 테스트하기

import { db } from "../common/db.ts";
import { usersTable } from "../common/schema.ts";

Deno.serve(async (req) => {
  await db.insert(usersTable).values({
    name: "Alice",
    email: "email",
    age: 25
  });
  const data = await db.select().from(usersTable);

  return new Response(
    JSON.stringify(data),
    { headers: { "Content-Type": "application/json" } },
  );
});

로컬에서 함수를 테스트하려면 다음 커맨드를 실행하세요:

supabase functions serve --no-verify-jwt

브라우저에서 해당 라우트(예: /drizzle-tutorial)로 이동하면 다음과 같은 결과를 확인할 수 있습니다:

[
  {
    "id": 1,
    "name": "Alice",
    "age": 25,
    "email": "email"
  }
]

로컬 프로젝트를 호스팅된 Supabase 프로젝트에 연결하기

대시보드에서 새로운 Supabase 프로젝트를 생성하거나, 이 링크를 따라가면 됩니다.

Reference ID를 복사한 후, 아래 명령어를 실행하여 로컬 개발 프로젝트를 호스팅된 Supabase 프로젝트에 연결할 수 있습니다:

supabase link --project-ref <Reference ID>

스키마 변경 사항을 호스팅된 Supabase 프로젝트에 적용하려면 다음 명령어를 실행하세요:

supabase db push

환경 변수 설정하기

데이터베이스 설정 페이지로 이동한 후, Connection String 섹션에서 URI를 복사하세요. 데이터베이스에 연결할 때는 connection pooling과 Transaction 모드를 사용해야 합니다. 비밀번호 자리 표시자를 실제 데이터베이스 비밀번호로 바꾸는 것을 잊지 마세요.

Connection Pooler에 대해 더 알아보려면 문서를 참고하세요.

환경 변수를 설정하려면 다음 커맨드를 실행하세요:

supabase secrets set DATABASE_URL=

supabase/functions/common 디렉토리에 있는 db.ts 파일을 업데이트하여 DATABASE_URL 환경 변수를 사용하도록 수정하세요:

// imports

const connectionString = Deno.env.get("DATABASE_URL")!;

// code

Supabase Edge Functions에서 환경 변수를 관리하는 방법에 대해 더 알아보려면 문서를 참고하세요.

여러분의 함수 배포하기

아래 명령어를 실행하여 함수를 배포할 수 있습니다:

supabase functions deploy drizzle-tutorial --no-verify-jwt

배포가 완료되면, 배포된 프로젝트의 URL을 사용하여 생성한 라우트(예: /drizzle-tutorial)로 이동해 엣지 함수에 접근할 수 있습니다.