SupabaseとDrizzle ORMを利用する場合のDBスキーマの管理方法

こんにちは、電通総研の瀧川亮弘です。
本記事ではSupabaseとDrizzle ORMを利用する場合のDBスキーマの管理方法について記載します。

テーブル定義は、Drizzleのお作法に則り、TypeScriptで管理しています。
schema.ts

import {
  boolean, pgEnum, pgTable, primaryKey, timestamp, uuid,
} from "drizzle-orm/pg-core";

export const roleEnum = pgEnum("Role", ["admin", "general"]);

export const users = pgTable("users", {
  authUserId: uuid("auth_user_id").primaryKey(),
  createdAt: timestamp("created_at").notNull().defaultNow(),
  updatedAt: timestamp("updated_at").notNull().defaultNow(),
  role: roleEnum("role").notNull(),
  isDeleted: boolean("is_deleted").default(false),
});

// 省略

テーブル定義に変更があった場合、コマンドひとつnpm run gen-ddlで差分DDLをSupabaseのマイグレーションフォルダsupabase/migrationsに出力できるようにしています。
差分DDLを出力後、Supabase CLIのコマンドを実行することで、対象のSupabaseプロジェクトに差分DDLを実行できます。
このようにDrizzleとSupabaseのマイグレーション機能がスムーズに連携され便利です。

package.json

{
  "scripts": {
    "gen-ddl": "drizzle-kit generate:pg",
    "gen-ddl-custom": "drizzle-kit generate:pg --custom"
  },
  "devDependencies": {
    "drizzle-kit": "^0.20.14"
  }
}

drizzle.config.ts

import type { Config } from "drizzle-kit";
export default {
  schema: "./supabase/functions/_shared/schema.ts",
  out: "./supabase/migrations",
} satisfies Config;