Drizzle 与 Supabase Edge Functions

本教程演示了如何将 Drizzle ORM 与 Supabase Edge Functions 结合使用。

本指南假定您熟悉

您应该安装了最新版本的 Supabase CLI。
您应该已经安装了 Drizzle ORM 和 Drizzle kit。您可以通过运行以下命令进行安装

npm

yarn

pnpm

bun

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

您应该已经安装了 Docker Desktop。它是本地开发的先决条件。请按照官方文档进行安装。

要了解如何在本地机器上创建并部署一个基本的 Edge Function，请参阅 Edge Functions 快速入门。

创建表

在您的 src 目录中创建一个 schema.ts 文件并声明一个表模式

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

export const usersTable = pgTable('users_table', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
  age: integer('age').notNull()
})

此文件将用于为您的数据库生成迁移。

设置 Drizzle 配置文件

Drizzle 配置 - 一个由 Drizzle Kit 使用的配置文件，包含您的数据库连接、迁移文件夹和模式文件的所有信息。

在项目的根目录中创建 drizzle.config.ts 文件并添加以下内容

import { defineConfig } from "drizzle-kit";

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

在本教程中，我们将使用 Drizzle kit 为我们的模式生成迁移。

初始化新的 Supabase 项目

在您本地机器上的一个文件夹中创建一个新的 Supabase 项目

supabase init

它将创建一个包含 config.toml 文件的 supabase 文件夹

└── supabase
    └── config.toml

如果您正在使用 Visual Studio Code，请按照 Supabase 文档设置 Deno 的配置。

生成迁移

运行 drizzle-kit generate 命令生成迁移文件

npx drizzle-kit generate

它将在 supabase/migrations 目录中创建一个新的迁移文件

应用迁移

要启动 Supabase 本地开发堆栈，请运行以下命令

supabase start

要应用迁移，请运行以下命令

supabase migration up

您可以在文档中了解更多关于 Supabase 迁移的信息。

重要提示

别忘了运行 Docker

或者，您可以使用 drizzle-kit migrate 命令应用迁移。在文档中了解更多关于此迁移过程的信息。

创建新的 Edge Function

运行 supabase functions new [FUNCTION_NAME] 命令创建一个新的 Edge Function

supabase functions new drizzle-tutorial

它将在 supabase/functions 目录中创建一个以函数名称命名的新文件夹

└── supabase
    └── functions
    │   └── drizzle-tutorial
    │   │   ├── .npmrc ## Function-specific npm configuration (if needed)
    │   │   ├── deno.json ## Function-specific Deno configuration
    │   │   └── index.ts ## Your function code

当您创建一个新的 Edge Function 时，它默认会使用 TypeScript。但是，也可以用 JavaScript 编写 Edge Function。在文档中了解更多信息。

设置导入

将以下导入添加到 supabase/functions/drizzle-tutorial 目录中的 deno.json 文件

{
  "imports": {
    "drizzle-orm/": "npm:/drizzle-orm/",
    "postgres": "npm:postgres"
  }
}

您可以在此处阅读更多关于管理依赖项的信息。

将您的模式复制到函数目录

将 src/schema.ts 文件中将在您的 Edge Function 中使用的代码复制到 supabase/functions/drizzle-tutorial/index.ts 文件

// Setup type definitions for built-in Supabase Runtime APIs
import "jsr:@supabase/functions-js/edge-runtime.d.ts"
import { pgTable, serial, text, integer } from "drizzle-orm/pg-core";

const usersTable = pgTable('users_table', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
  age: integer('age').notNull()
})

Deno.serve(async (req) => {
  const { name } = await req.json()
  const data = {
    message: `Hello ${name}!`,
  }

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

重要提示

在 Deno 生态系统中，每个函数都应被视为一个独立的具有其自身依赖项和配置的项目。因此，Supabase 建议在每个函数的目录中维护单独的配置文件（deno.json、.npmrc 或 import_map.json），即使这意味着某些配置会重复。在此处阅读更多信息：管理依赖项。

将 Drizzle ORM 连接到您的数据库

使用您的数据库配置更新 Edge Function 代码

// Setup type definitions for built-in Supabase Runtime APIs
import { integer, pgTable, serial, text } from "drizzle-orm/pg-core";
import { drizzle } from "drizzle-orm/postgres-js";
import "jsr:@supabase/functions-js/edge-runtime.d.ts";
import postgres from "postgres";

const usersTable = pgTable('users_table', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
  age: integer('age').notNull()
})

Deno.serve(async () => {
  const connectionString = Deno.env.get("SUPABASE_DB_URL")!;

  // Disable prefetch as it is not supported for "Transaction" pool mode
  const client = postgres(connectionString, { prepare: false });
  const db = drizzle({ client });

  await db.insert(usersTable).values({
    name: "Alice",
    age: 25
  })
  const data = await db.select().from(usersTable);

  return new Response(
    JSON.stringify(data)
  )
})

SUPABASE_DB_URL 是直接数据库连接的默认环境变量。在文档中了解更多关于在 Supabase Edge Functions 中管理环境变量的信息。

在本地测试您的代码

运行以下命令在本地测试您的函数

supabase functions serve --no-verify-jwt

在浏览器中导航到该路由（例如 /drizzle-tutorial）

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

将您的本地项目链接到托管的 Supabase 项目

您可以在仪表板中创建新的 Supabase 项目，或通过此链接创建。

从项目设置中复制 Reference ID，并使用它来通过运行以下命令将您的本地开发项目链接到托管的 Supabase 项目

supabase link --project-ref=<REFERENCE_ID>

通过运行以下命令将您的模式更改推送到托管的 Supabase 项目

supabase db push

设置环境变量

您可以通过点击仪表板顶部栏的连接找到 项目连接详情，并从 事务连接池 部分复制 URI。请记住用您的实际数据库密码替换密码占位符。

在文档中阅读更多关于连接池的信息。

更新您的 Edge Function 代码，使用 DATABASE_URL 环境变量代替 SUPABASE_DB_URL

// imports

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

// code

运行以下命令设置环境变量

supabase secrets set DATABASE_URL=<CONNECTION_STRING>

在文档中了解更多关于在 Supabase Edge Functions 中管理环境变量的信息。

部署您的函数

通过运行以下命令部署您的函数

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

最后，您可以使用已部署项目的 URL 并导航到您创建的路由（例如 /drizzle-tutorial）来访问您的 Edge Function。