这些安装的包仅用于在 创建表、设置 Drizzle 配置文件 和 将更改应用于数据库 步骤中在数据库中创建表。这些包不会影响在 Netlify Edge 函数内部运行的代码。我们将使用 import_map.json 导入 Edge 函数所需的包。
使用 Netlify Edge 函数和 Supabase 数据库的 Drizzle
本教程演示了如何使用 Drizzle ORM 与 Netlify Edge 函数 和 Supabase 数据库 数据库。
This guide assumes familiarity with:
- 你应该安装最新版本的 Netlify CLI。
- 你应该已经安装了 Drizzle ORM 和 Drizzle kit。你可以通过运行以下命令来完成这一步：
npm
yarn
pnpm
bun
npm i drizzle-orm
npm i -D drizzle-kit- 你应该已经安装了用于管理环境变量的
dotenv包。如果你使用的是 Node.jsv20.6.0或更高版本，则不需要安装它，因为 Node.js 原生支持.env文件。有关更多信息，请阅读 这里。
npm
yarn
pnpm
bun
npm i dotenv- 可选地，你可以安装
@netlify/edge-functions包，以导入稍后将使用的Context对象的类型。
npm
yarn
pnpm
bun
npm i @netlify/edge-functionsIMPORTANT
创建一个新的 Supabase 项目
你可以在 仪表板 中创建新的 Supabase 项目，也可以通过此 链接 进行创建。
设置连接字符串变量
你可以通过点击仪表板顶部的 连接 以查找 项目连接详细信息，并从 交易池 部分复制 URI。记得用你的实际数据库密码替换密码占位符。
将 DATABASE_URL 变量添加到你的 .env 文件中。
DATABASE_URL=<YOUR_DATABASE_URL>有关连接 Supabase 数据库的更多信息，请查看 文档。
设置 Netlify Edge 函数
在你的项目根目录中创建 netlify/edge-functions 目录。这是你将存储 Edge 函数的地方。
在 netlify/edge-functions 目录中创建一个函数 user.ts。
import type { Context } from "@netlify/edge-functions";
export default async (request: Request, context: Context) => {
return new Response("用户数据");
};IMPORTANT
Request 和 Response 对象的类型在全局范围内。
设置导入
在你的项目根目录中创建一个 import_map.json 文件，并添加以下内容：
{
"imports": {
"drizzle-orm/": "https://esm.sh/drizzle-orm/",
"postgres": "https://esm.sh/postgres"
}
}有关 import_map.json 的更多信息，请查看 Netlify Edge 函数的 文档。
创建 Netlify 配置文件
在你的项目根目录中创建一个 netlify.toml 文件，并添加以下内容：
[functions]
deno_import_map = "./import_map.json"
[[edge_functions]]
path = "/user"
function = "user"此配置告诉 Netlify 使用 import_map.json 文件进行 Deno 导入，并将对 /user 路径的请求路由到 user.ts 函数。
有关 netlify.toml 的更多信息，请查看 文档。
创建一个表
在 netlify/edge-functions/common 目录中创建一个 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(),
email: text('email').notNull().unique(),
})设置 Drizzle 配置文件
Drizzle 配置 - 一个被 Drizzle Kit 使用的配置文件，包含关于数据库连接、迁移文件夹和模式文件的所有信息。
在你的项目根目录中创建一个 drizzle.config.ts 文件，并添加以下内容：
import 'dotenv/config'; // 如果你使用 Node.js v20.6.0 或更高版本，请移除此行
import type { Config } from "drizzle-kit";
export default {
schema: './netlify/edge-functions/common/schema.ts',
out: './drizzle',
dialect: 'postgresql',
dbCredentials: {
url: process.env.DATABASE_URL!,
},
} satisfies Config;在本教程中，我们将使用 Drizzle kit 将更改推送到 Neon 数据库。
将更改应用于数据库
npx drizzle-kit pushIMPORTANT
推送命令适合于需要快速测试新模式设计或在本地开发环境中进行快速迭代的情况，无需管理迁移文件的开销。
另外，你可以使用迁移工作流。有关更多信息，请阅读 迁移文档。
将 Drizzle ORM 连接到你的数据库
更新你的 netlify/edge-functions/user.ts 文件并设置数据库配置：
import type { Context } from "@netlify/edge-functions";
import { usersTable } from "./common/schema.ts";
import { drizzle } from 'drizzle-orm/postgres-js';
import postgres from 'postgres';
export default async (request: Request, context: Context) => {
const queryClient = postgres(Netlify.env.get("DATABASE_URL")!);
const db = drizzle({ client: queryClient });
const users = await db.select().from(usersTable);
return new Response(JSON.stringify(users));
};IMPORTANT
如果你在使用 VS Code，你可能会看到导入部分下面有红色下划线。Edge 函数仍然会执行。要消除红色下划线，可以在下一步中配置 VS Code 使用 Edge 函数。
在本地测试你的代码
运行以下命令以启动 Netlify 开发服务器：
netlify dev首次运行该命令时，它会建议你配置 VS Code 以使用 Edge 函数。点击 是 进行配置。一个 settings.json 文件将会在 .vscode 目录中创建。
如果你仍然看到红色下划线，可以重新启动 Deno 语言服务器。
打开你的浏览器并导航到路由 /user。你应该能从 Neon 数据库中看到返回的用户数据：
[]如果你没有向 users_table 表中添加任何数据，它可能是一个空数组。
初始化一个新的 Netlify 项目
运行以下命令以初始化一个新的 Netlify 项目：
netlify init在 CLI 中回答问题以创建一个新的 Netlify 项目。在本教程中，我们将选择 是，手动创建和部署站点 -> <YOUR_TEAM> -> <SITE_NAME>。
设置 Netlify 环境变量
运行以下命令将你的环境变量导入到 Netlify：
netlify env:import .env有关 Netlify 环境变量的更多信息，请查看 文档。
部署你的项目
运行以下命令以部署你的项目：
netlify deploy按照 CLI 中的说明将你的项目部署到 Netlify。在本教程中，我们的发布目录为 '.'。
默认情况下，这是一个 草稿部署。 要进行生产部署，请运行以下命令：
netlify deploy --prod最后，你可以使用部署网站的 URL，导航到你创建的路由 (例如 /user) 以访问你的 Edge 函数。