部署到 Vercel Edge Functions & Middleware
本页涵盖了你需要了解的所有内容,以便将使用 Prisma Client 连接数据库的应用程序部署到 Vercel Edge Middleware 或部署到 Vercel Function 的 Vercel Edge Runtime。
要将 Vercel Function 部署到 Vercel Edge Runtime,你可以在 Vercel Function 的请求处理程序外部设置 export const runtime = 'edge'
。
部署到 Vercel Edge Functions & Edge Middleware 时的常规注意事项
使用 Prisma Postgres
你可以在 Vercel 的边缘运行时中使用 Prisma Postgres。请按照本指南,获取关于使用 Prisma Postgres 将应用程序部署到 Vercel 的端到端教程。
使用边缘兼容的驱动
Vercel 的 Edge Runtime 目前仅支持有限的数据库驱动
- Neon Serverless 使用 HTTP 访问数据库(也兼容 Vercel Postgres)
- PlanetScale Serverless 使用 HTTP 访问数据库
@libsql/client
用于访问 Turso 数据库
请注意,node-postgres
(pg
) 目前在 Vercel Edge Functions 上**不**支持。
部署使用 Prisma ORM 的 Vercel Edge Function 时,你需要使用这些边缘兼容驱动之一及其相应的 Prisma ORM 驱动适配器。
如果你的应用程序使用 PostgreSQL,我们建议使用Prisma Postgres。它在边缘运行时中得到全面支持,并且不需要专门的边缘兼容驱动。对于其他数据库,Prisma Accelerate 扩展了边缘兼容性,因此你可以从**任何**边缘函数提供程序连接到**任何**数据库。
将数据库连接 URL 设置为环境变量
首先,确保在你的 Prisma schema 中,datasource
的 url
已设置为 DATABASE_URL
datasource db {
provider = "postgresql" // this might also be `mysql` or another value depending on your database
url = env("DATABASE_URL")
}
开发
在**开发**阶段,你可以通过 DATABASE_URL
环境变量(例如使用 .env
文件)配置数据库连接。
生产
将 Edge Function 部署到**生产环境**时,你需要使用 vercel
CLI 设置数据库连接
npx vercel env add DATABASE_URL
此命令是交互式的,它将要求你选择环境并在后续步骤中提供 DATABASE_URL
的值。
或者,你可以在 Vercel Dashboard 中通过项目的用户界面 配置环境变量。
在 postinstall
钩子中生成 Prisma Client
在你的 package.json
中,你应该添加如下的 "postinstall"
部分
{
// ...,
"postinstall": "prisma generate"
}
免费账户的尺寸限制
Vercel 对免费账户有 1MB 的尺寸限制。如果你的应用程序包(包含 Prisma ORM)超过此大小,我们建议升级到付费账户或使用 Prisma Accelerate 部署你的应用程序。
数据库特定注意事项 & 示例
本节提供了使用 Prisma ORM 部署 Vercel Edge Functions 的数据库特定说明。
先决条件
作为下一节的先决条件,你需要有一个在本地运行的 Vercel Edge Function(通常是 Next.js API 路由的形式),并且安装了 Prisma 和 Vercel CLI。
如果你还没有,可以运行这些命令从头开始设置 Next.js 应用程序(按照Vercel Functions Quickstart 的说明)
npm install -g vercel
npx create-next-app@latest
npm install prisma --save-dev && npm install @prisma/client
npx prisma init --output ../app/generated/prisma
我们将使用下面的示例的默认 User
模型
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
}
Vercel Postgres
如果你正在使用 Vercel Postgres,你需要
- 使用
@prisma/adapter-neon
数据库适配器(通过driverAdapters
预览功能),因为 Vercel Postgres 在底层使用了 Neon - 请注意,Vercel 默认将数据库连接字符串的环境变量命名为
POSTGRES_PRISMA_URL
,而 Prisma 文档中通常使用的默认名称是DATABASE_URL
;使用 Vercel 的命名方式,你需要在datasource
块中设置以下字段datasource db {
provider = "postgresql"
url = env("POSTGRES_PRISMA_URL") // uses connection pooling
directUrl = env("POSTGRES_URL_NON_POOLING") // uses a direct connection
}
1. 配置 Prisma schema & 数据库连接
如果你没有要部署的项目,请按照先决条件中的说明,使用 Prisma ORM 引导一个基本的 Next.js 应用程序。
首先,确保数据库连接已正确配置。在你的 Prisma schema 中,将 datasource
块的 url
设置为 POSTGRES_PRISMA_URL
,并将 directUrl
设置为 POSTGRES_URL_NON_POOLING
环境变量。你还需要启用 driverAdapters
功能标志
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}
datasource db {
provider = "postgresql"
url = env("POSTGRES_PRISMA_URL") // uses connection pooling
directUrl = env("POSTGRES_URL_NON_POOLING") // uses a direct connection
}
接下来,你需要将 POSTGRES_PRISMA_URL
和 POSTGRES_URL_NON_POOLING
环境变量设置为你的数据库连接值。
如果你运行了 npx prisma init
,你可以使用该命令创建的 .env
文件来设置这些变量
POSTGRES_PRISMA_URL="postgres://user:password@host-pooler.region.postgres.vercel-storage.com:5432/name?pgbouncer=true&connect_timeout=15"
POSTGRES_URL_NON_POOLING="postgres://user:password@host.region.postgres.vercel-storage.com:5432/name"
2. 安装依赖
接下来,安装所需的包
npm install @prisma/adapter-neon
3. 配置 postinstall
钩子
接下来,在你的 package.json
的 scripts
部分添加一个新键
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}
4. 迁移你的数据库 schema(如果适用)
如果你在上面运行了 npx prisma init
,你需要迁移你的数据库 schema 以创建在 Prisma schema 中定义的 User
表(如果你的数据库中已经有所有需要的表,可以跳过此步骤)
npx prisma migrate dev --name init
5. 在你的 Vercel Edge Function 中使用 Prisma Client 向数据库发送查询
如果你从头创建了项目,可以按如下方式创建一个新的边缘函数。
首先,创建一个新的 API 路由,例如使用这些命令
mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts
这是一个示例代码片段,你可以在刚刚创建的 app/api/edge/route.ts
文件中使用它来实例化 PrismaClient
并向数据库发送查询
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaNeon } from '@prisma/adapter-neon'
export const runtime = 'edge'
export async function GET(request: Request) {
const adapter = new PrismaNeon({ connectionString: process.env.POSTGRES_PRISMA_URL })
const prisma = new PrismaClient({ adapter })
const users = await prisma.user.findMany()
return NextResponse.json(users, { status: 200 })
}
6. 在本地运行 Edge Function
使用以下命令运行应用程序
npm run dev
你现在可以通过此 URL 访问 Edge Function:http://localhost:3000/api/edge
。
7. 设置 POSTGRES_PRISMA_URL
环境变量并部署 Edge Function
运行以下命令以使用 Vercel 部署你的项目
npx vercel deploy
请注意,一旦项目在 Vercel 上创建,你需要设置 POSTGRES_PRISMA_URL
环境变量(如果这是你第一次部署,很可能失败了)。你可以通过 Vercel UI 或运行以下命令来完成此操作
npx vercel env add POSTGRES_PRISMA_URL
此时,你可以从 Vercel Dashboard 获取已部署应用程序的 URL,并通过 /api/edge
路由访问边缘函数。
PlanetScale
如果你正在使用 PlanetScale 数据库,你需要
- 使用
@prisma/adapter-planetscale
数据库适配器(通过driverAdapters
预览功能)
1. 配置 Prisma schema & 数据库连接
如果你没有要部署的项目,请按照先决条件中的说明,使用 Prisma ORM 引导一个基本的 Next.js 应用程序。
首先,确保数据库连接已正确配置。在你的 Prisma schema 中,将 datasource
块的 url
设置为 DATABASE_URL
环境变量。你还需要启用 driverAdapters
功能标志
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
relationMode = "prisma" // required for PlanetScale (as by default foreign keys are disabled)
}
接下来,你需要在 .env
文件中设置 DATABASE_URL
环境变量,Prisma 和 Next.js 都使用它来读取你的环境变量
DATABASE_URL="mysql://32qxa2r7hfl3102wrccj:password@us-east.connect.psdb.cloud/demo-cf-worker-ps?sslaccept=strict"
2. 安装依赖
接下来,安装所需的包
npm install @prisma/adapter-planetscale
3. 配置 postinstall
钩子
接下来,在你的 package.json
的 scripts
部分添加一个新键
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}
4. 迁移你的数据库 schema(如果适用)
如果你在上面运行了 npx prisma init
,你需要迁移你的数据库 schema 以创建在 Prisma schema 中定义的 User
表(如果你的数据库中已经有所有需要的表,可以跳过此步骤)
npx prisma db push
5. 在 Edge Function 中使用 Prisma Client 向数据库发送查询
如果你从头创建了项目,可以按如下方式创建一个新的边缘函数。
首先,创建一个新的 API 路由,例如使用这些命令
mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts
这是一个示例代码片段,你可以在刚刚创建的 app/api/edge/route.ts
文件中使用它来实例化 PrismaClient
并向数据库发送查询
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaPlanetScale } from '@prisma/adapter-planetscale'
export const runtime = 'edge'
export async function GET(request: Request) {
const adapter = new PrismaPlanetScale({ url: process.env.DATABASE_URL })
const prisma = new PrismaClient({ adapter })
const users = await prisma.user.findMany()
return NextResponse.json(users, { status: 200 })
}
6. 在本地运行 Edge Function
使用以下命令运行应用程序
npm run dev
你现在可以通过此 URL 访问 Edge Function:http://localhost:3000/api/edge
。
7. 设置 DATABASE_URL
环境变量并部署 Edge Function
运行以下命令以使用 Vercel 部署你的项目
npx vercel deploy
请注意,一旦项目在 Vercel 上创建,你需要设置 DATABASE_URL
环境变量(如果这是你第一次部署,很可能失败了)。你可以通过 Vercel UI 或运行以下命令来完成此操作
npx vercel env add DATABASE_URL
此时,你可以从 Vercel Dashboard 获取已部署应用程序的 URL,并通过 /api/edge
路由访问边缘函数。
Neon
如果你正在使用 Neon 数据库,你需要
- 使用
@prisma/adapter-neon
数据库适配器(通过driverAdapters
预览功能)
1. 配置 Prisma schema & 数据库连接
如果你没有要部署的项目,请按照先决条件中的说明,使用 Prisma ORM 引导一个基本的 Next.js 应用程序。
首先,确保数据库连接已正确配置。在你的 Prisma schema 中,将 datasource
块的 url
设置为 DATABASE_URL
环境变量。你还需要启用 driverAdapters
功能标志
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
接下来,你需要在 .env
文件中设置 DATABASE_URL
环境变量,Prisma 和 Next.js 都使用它来读取你的环境变量
DATABASE_URL="postgresql://janedoe:password@ep-nameless-pond-a23b1mdz.eu-central-1.aws.neon.tech/neondb?sslmode=require"
2. 安装依赖
接下来,安装所需的包
npm install @prisma/adapter-neon
3. 配置 postinstall
钩子
接下来,在你的 package.json
的 scripts
部分添加一个新键
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}
4. 迁移你的数据库 schema(如果适用)
如果你在上面运行了 npx prisma init
,你需要迁移你的数据库 schema 以创建在 Prisma schema 中定义的 User
表(如果你的数据库中已经有所有需要的表,可以跳过此步骤)
npx prisma migrate dev --name init
5. 在 Edge Function 中使用 Prisma Client 向数据库发送查询
如果你从头创建了项目,可以按如下方式创建一个新的边缘函数。
首先,创建一个新的 API 路由,例如使用这些命令
mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts
这是一个示例代码片段,你可以在刚刚创建的 app/api/edge/route.ts
文件中使用它来实例化 PrismaClient
并向数据库发送查询
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaNeon } from '@prisma/adapter-neon'
export const runtime = 'edge'
export async function GET(request: Request) {
const adapter = new PrismaNeon({ connectionString: process.env.DATABASE_URL })
const prisma = new PrismaClient({ adapter })
const users = await prisma.user.findMany()
return NextResponse.json(users, { status: 200 })
}
6. 在本地运行 Edge Function
使用以下命令运行应用程序
npm run dev
你现在可以通过此 URL 访问 Edge Function:http://localhost:3000/api/edge
。
7. 设置 DATABASE_URL
环境变量并部署 Edge Function
运行以下命令以使用 Vercel 部署你的项目
npx vercel deploy
请注意,一旦项目在 Vercel 上创建,你需要设置 DATABASE_URL
环境变量(如果这是你第一次部署,很可能失败了)。你可以通过 Vercel UI 或运行以下命令来完成此操作
npx vercel env add DATABASE_URL
此时,你可以从 Vercel Dashboard 获取已部署应用程序的 URL,并通过 /api/edge
路由访问边缘函数。