跳至主要内容

部署到 Vercel Edge Functions 和 Middleware

此页面涵盖了您需要了解的有关部署使用 Prisma Client 与数据库进行通信的应用程序的所有内容 Vercel Edge Middleware 或者 Vercel 函数 部署到 Vercel Edge Runtime

要将 Vercel 函数部署到 Vercel Edge Runtime,您可以在 Vercel 函数的请求处理程序外部设置 export const runtime = 'edge'

部署到 Vercel Edge Functions 和 Edge Middleware 时的一般注意事项

使用边缘兼容的驱动程序

Vercel 的 Edge Runtime 目前只支持有限的数据库驱动程序集

请注意,node-postgrespg)目前不支持 Vercel Edge Functions。

部署使用 Prisma ORM 的 Vercel Edge 函数时,您需要使用其中一个 边缘兼容驱动程序 及其相应的 驱动程序适配器 用于 Prisma ORM。

注意Prisma Accelerate 使您能够从任何边缘函数提供商访问任何数据库。不需要边缘兼容的驱动程序。

将数据库连接 URL 设置为环境变量

首先,确保 DATABASE_URL 设置为 Prisma 模式中 datasourceurl

datasource db {
provider = "postgresql" // this might also be `mysql` or another value depending on your database
url = env("DATABASE_URL")
}

开发

开发中,您可以通过 DATABASE_URL 环境变量配置您的数据库连接(例如,使用 .env 文件)。

生产

将 Edge 函数部署到生产时,您需要使用 vercel CLI 设置数据库连接

npx vercel env add DATABASE_URL

此命令是交互式的,会要求您在后续步骤中选择环境并提供 DATABASE_URL 的值。

或者,您可以通过 UI 在 Vercel Dashboard 中配置环境变量。

postinstall 钩子中生成 Prisma Client

在您的 package.json 中,您应该添加一个 "postinstall" 部分,如下所示

package.json
{
// ...,
"postinstall": "prisma generate"
}

免费帐户的大小限制

Vercel 对免费帐户有 1 MB 的大小限制。如果您的包含 Prisma ORM 的应用程序包超过该大小,我们建议您升级到付费帐户或使用 Prisma Accelerate 部署您的应用程序。

特定于数据库的注意事项和示例

本节提供了有关使用 Prisma ORM 部署 Vercel Edge Functions 的特定于数据库的说明。

先决条件

作为以下部分的先决条件,您需要在本地运行 Vercel Edge 函数(通常以 Next.js API 路由的形式)并安装 Prisma 和 Vercel CLI。

如果您还没有,您可以运行以下命令从头开始设置 Next.js 应用程序(按照 Vercel Edge 快速入门 中的说明)

npm install -g vercel
npx create-next-app@latest
npm install prisma --save-dev
npx prisma init

我们将使用默认的 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 模式和数据库连接

注意:如果您没有要部署的项目,请按照 先决条件 中的说明使用 Prisma ORM 启动一个基本的 Next.js 应用程序。

首先,确保数据库连接已正确配置。在您的 Prisma 模式中,将 datasource 块的 url 设置为 POSTGRES_PRISMA_URL,将 directUrl 设置为 POSTGRES_URL_NON_POOLING 环境变量。您还需要启用 driverAdapters 特性标志

schema.prisma
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_URLPOSTGRES_URL_NON_POOLING 环境变量设置为您的数据库连接的值。

如果您运行了 npx prisma init,您可以使用此命令创建的 .env 文件来设置这些

.env
POSTGRES_PRISMA_URL="postgres://user:[email protected]:5432/name?pgbouncer=true&connect_timeout=15"
POSTGRES_URL_NON_POOLING="postgres://user:[email protected]:5432/name"

2. 安装依赖

接下来,安装所需的包

npm install @prisma/adapter-neon
npm install @neondatabase/serverless

3. 配置 postinstall 钩子

接下来,在你的 package.json 中的 scripts 部分添加一个新键

package.json
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}

4. 迁移你的数据库模式(如果适用)

如果你在上面运行了 npx prisma init,你需要迁移你的数据库模式来创建 User 表,它是在你的 Prisma 模式中定义的(如果你已经在你的数据库中拥有了所有需要的表,你可以跳过此步骤)

npx prisma migrate dev --name init

5. 在你的 Vercel Edge 函数中使用 Prisma Client 向数据库发送查询

如果你从头开始创建了项目,你可以创建一个新的 edge 函数,如下所示。

首先,创建一个新的 API 路由,例如,使用以下命令

mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts

以下是一个示例代码片段,你可以使用它来实例化 PrismaClient 并向你刚刚创建的 app/api/edge/route.ts 文件中的数据库发送查询

app/api/edge/route.ts
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaNeon } from '@prisma/adapter-neon'
import { Pool } from '@neondatabase/serverless'

export const runtime = 'edge'

export async function GET(request: Request) {
const neon = new Pool({ connectionString: process.env.POSTGRES_PRISMA_URL })
const adapter = new PrismaNeon(neon)
const prisma = new PrismaClient({ adapter })

const users = await prisma.user.findMany()

return NextResponse.json(users, { status: 200 })
}

6. 在本地运行 Edge 函数

使用以下命令运行应用程序

npm run dev

你现在可以通过此 URL 访问 Edge 函数:https://127.0.0.1:3000/api/edge.

7. 设置 POSTGRES_PRISMA_URL 环境变量并部署 Edge 函数

运行以下命令使用 Vercel 部署你的项目

npx vercel deploy

注意,一旦项目在 Vercel 上创建,你将需要设置 POSTGRES_PRISMA_URL 环境变量(如果这是你第一次部署,它可能失败)。你可以通过 Vercel UI 或运行以下命令来完成此操作

npx vercel env add POSTGRES_PRISMA_URL

此时,你可以从 Vercel 仪表板获取已部署应用程序的 URL,并通过 /api/edge 路由访问 edge 函数。

PlanetScale

如果你正在使用 PlanetScale 数据库,你需要

  • 使用 @prisma/adapter-planetscale 数据库适配器(通过 driverAdapters 预览功能)

1. 配置 Prisma 模式和数据库连接

注意:如果您没有要部署的项目,请按照 先决条件 中的说明使用 Prisma ORM 启动一个基本的 Next.js 应用程序。

首先,确保数据库连接配置正确。在你的 Prisma 模式中,将 datasource 块的 url 设置为 DATABASE_URL 环境变量。你还需要启用 driverAdapters 功能标志

schema.prisma
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 用于读取你的环境变量

.env
DATABASE_URL="mysql://32qxa2r7hfl3102wrccj:[email protected]/demo-cf-worker-ps?sslaccept=strict"

2. 安装依赖

接下来,安装所需的包

npm install @prisma/adapter-planetscale
npm install @planetscale/database

3. 配置 postinstall 钩子

接下来,在你的 package.json 中的 scripts 部分添加一个新键

package.json
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}

4. 迁移你的数据库模式(如果适用)

如果你在上面运行了 npx prisma init,你需要迁移你的数据库模式来创建 User 表,它是在你的 Prisma 模式中定义的(如果你已经在你的数据库中拥有了所有需要的表,你可以跳过此步骤)

npx prisma db push

5. 在 Edge 函数中使用 Prisma Client 向数据库发送查询

如果你从头开始创建了项目,你可以创建一个新的 edge 函数,如下所示。

首先,创建一个新的 API 路由,例如,使用以下命令

mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts

以下是一个示例代码片段,你可以使用它来实例化 PrismaClient 并向你刚刚创建的 app/api/edge/route.ts 文件中的数据库发送查询

app/api/edge/route.ts
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaPlanetScale } from '@prisma/adapter-planetscale'
import { Client } from '@planetscale/database'

export const runtime = 'edge'

export async function GET(request: Request) {
const client = new Client({ url: process.env.DATABASE_URL })
const adapter = new PrismaPlanetScale(client)
const prisma = new PrismaClient({ adapter })

const users = await prisma.user.findMany()

return NextResponse.json(users, { status: 200 })
}

6. 在本地运行 Edge 函数

使用以下命令运行应用程序

npm run dev

你现在可以通过此 URL 访问 Edge 函数:https://127.0.0.1:3000/api/edge.

7. 设置 DATABASE_URL 环境变量并部署 Edge 函数

运行以下命令使用 Vercel 部署你的项目

npx vercel deploy

注意,一旦项目在 Vercel 上创建,你将需要设置 DATABASE_URL 环境变量(如果这是你第一次部署,它可能失败)。你可以通过 Vercel UI 或运行以下命令来完成此操作

npx vercel env add DATABASE_URL

此时,你可以从 Vercel 仪表板获取已部署应用程序的 URL,并通过 /api/edge 路由访问 edge 函数。

Neon

如果你正在使用 Neon 数据库,你需要

  • 使用 @prisma/adapter-neon 数据库适配器(通过 driverAdapters 预览功能)

1. 配置 Prisma 模式和数据库连接

注意:如果您没有要部署的项目,请按照 先决条件 中的说明使用 Prisma ORM 启动一个基本的 Next.js 应用程序。

首先,确保数据库连接配置正确。在你的 Prisma 模式中,将 datasource 块的 url 设置为 DATABASE_URL 环境变量。你还需要启用 driverAdapters 功能标志

schema.prisma
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}

datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}

接下来,你需要在你的 .env 文件中设置 DATABASE_URL 环境变量,该文件被 Prisma 和 Next.js 用于读取你的环境变量

.env
DATABASE_URL="postgresql://janedoe:[email protected]/neondb?sslmode=require"

2. 安装依赖

接下来,安装所需的包

npm install @prisma/adapter-neon
npm install @neondatabase/serverless

3. 配置 postinstall 钩子

接下来,在你的 package.json 中的 scripts 部分添加一个新键

package.json
{
// ...
"scripts": {
// ...
"postinstall": "prisma generate"
}
}

4. 迁移你的数据库模式(如果适用)

如果你在上面运行了 npx prisma init,你需要迁移你的数据库模式来创建 User 表,它是在你的 Prisma 模式中定义的(如果你已经在你的数据库中拥有了所有需要的表,你可以跳过此步骤)

npx prisma migrate dev --name init

5. 在 Edge 函数中使用 Prisma Client 向数据库发送查询

如果你从头开始创建了项目,你可以创建一个新的 edge 函数,如下所示。

首先,创建一个新的 API 路由,例如,使用以下命令

mkdir src/app/api
mkdir src/app/api/edge
touch src/app/api/edge/route.ts

以下是一个示例代码片段,你可以使用它来实例化 PrismaClient 并向你刚刚创建的 app/api/edge/route.ts 文件中的数据库发送查询

app/api/edge/route.ts
import { NextResponse } from 'next/server'
import { PrismaClient } from '@prisma/client'
import { PrismaNeon } from '@prisma/adapter-neon'
import { Pool } from '@neondatabase/serverless'

export const runtime = 'edge'

export async function GET(request: Request) {
const neon = new Pool({ connectionString: process.env.DATABASE_URL })
const adapter = new PrismaNeon(neon)
const prisma = new PrismaClient({ adapter })

const users = await prisma.user.findMany()

return NextResponse.json(users, { status: 200 })
}

6. 在本地运行 Edge 函数

使用以下命令运行应用程序

npm run dev

你现在可以通过此 URL 访问 Edge 函数:https://127.0.0.1:3000/api/edge.

7. 设置 DATABASE_URL 环境变量并部署 Edge 函数

运行以下命令使用 Vercel 部署你的项目

npx vercel deploy

注意,一旦项目在 Vercel 上创建,你将需要设置 DATABASE_URL 环境变量(如果这是你第一次部署,它可能失败)。你可以通过 Vercel UI 或运行以下命令来完成此操作

npx vercel env add DATABASE_URL

此时,你可以从 Vercel 仪表板获取已部署应用程序的 URL,并通过 /api/edge 路由访问 edge 函数。