Neon
本指南解释了如何
什么是 Neon?
Neon 是一个功能齐全的无服务器 PostgreSQL,提供慷慨的免费套餐。Neon 分离了存储和计算,并提供了现代化的开发者功能,如无服务器、分支、无限存储等。Neon 是开源的,并使用 Rust 编写。
在此了解更多关于 Neon 的信息 此处。
与其他数据库提供商的共同点
将 Prisma ORM 与 Neon 结合使用的许多方面,与将 Prisma ORM 与任何其他 PostgreSQL 数据库结合使用一样。您可以
- 使用 Prisma Schema Language 建模您的数据库
- 在您的 schema 中使用 Prisma ORM 的
postgresql
数据库连接器,以及 Neon 为您提供的连接字符串 - 如果您已经在 Neon 上拥有数据库 schema,则可为现有项目使用 内省
- 使用
prisma migrate dev
来跟踪 Neon 数据库中的 schema 迁移 - 使用
prisma db push
将您的 schema 更改推送到 Neon - 在您的应用程序中使用 Prisma Client 与 Neon 托管的数据库进行通信
需要考虑的差异
在决定将 Neon 与 Prisma ORM 结合使用时,您应该注意 Neon 和 PostgreSQL 之间的一些差异
- Neon 的无服务器模型 — 默认情况下,Neon 会在 5 分钟不活动后将 计算实例 缩放到零。在此状态下,计算实例处于空闲状态。此功能的一个特点是“冷启动”的概念。从空闲状态激活计算实例需要 500 毫秒到几秒钟。根据连接到数据库所需的时间,您的应用程序可能会超时。欲了解更多信息,请参阅:连接延迟和超时。
- Neon 的连接池器 — Neon 使用 PgBouncer 提供连接池,支持多达 10,000 个并发连接。欲了解更多信息,请参阅:连接池。
如何使用 Neon 的连接池
如果您希望使用 Neon 中可用的 连接池,您需要在 Prisma schema 的 datasource
块中 url
属性使用的 DATABASE_URL
环境变量的主机名中添加 -pooler
# Connect to Neon with Pooling.
DATABASE_URL=postgres://daniel:<password>@ep-mute-rain-952417-pooler.us-east-2.aws.neon.tech:5432/neondb?sslmode=require
如果您希望使用 Prisma CLI 对数据库执行其他操作(例如用于迁移),您将需要添加一个 DIRECT_URL
环境变量,并在 Prisma schema 的 datasource
块的 directUrl
属性中使用,以便 CLI 将使用直接连接字符串(不含 PgBouncer)
# Connect to Neon with Pooling.
DATABASE_URL=postgres://daniel:<password>@ep-mute-rain-952417-pooler.us-east-2.aws.neon.tech/neondb?sslmode=require
# Direct connection to the database used by Prisma CLI for e.g. migrations.
DIRECT_URL="postgres://daniel:<password>@ep-mute-rain-952417.us-east-2.aws.neon.tech/neondb"
然后您可以更新 schema.prisma
以使用新的直接 URL
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
directUrl = env("DIRECT_URL")
}
有关 directUrl
字段的更多信息,请参见 此处。
我们强烈建议在您的 DATABASE_URL
环境变量中使用连接池字符串。您将获得 Prisma CLI 带来的出色开发体验,同时无论部署策略如何,都能够进行连接池。虽然这对于每个应用程序来说并非严格必要,但无服务器解决方案将不可避免地需要连接池。
解决连接超时问题
从 Prisma ORM 连接到 Neon 时发生的连接超时会导致类似以下错误
Error: P1001: Can't reach database server at `ep-white-thunder-826300.us-east-2.aws.neon.tech`:`5432`
Please make sure your database server is running at `ep-white-thunder-826300.us-east-2.aws.neon.tech`:`5432`.
此错误很可能意味着 Prisma Client 创建的连接在 Neon 计算实例激活之前超时。
Neon 计算实例有两种主要状态:活跃和空闲。活跃表示计算实例正在运行。如果 5 分钟内没有查询活动,Neon 默认会将计算实例置于空闲状态。请参阅 Neon 文档以 了解更多。
当您从 Prisma ORM 连接到空闲的计算实例时,Neon 会自动激活它。激活通常在几秒钟内完成,但增加的延迟可能导致连接超时。为解决此问题,您可以通过添加 connect_timeout
参数来调整 Neon 连接字符串。此参数定义了等待新连接打开的最大秒数。默认值为 5 秒。更高的设置应该能提供避免连接超时问题所需的时间。例如
DATABASE_URL=postgres://daniel:<password>@ep-mute-rain-952417.us-east-2.aws.neon.tech/neondb?connect_timeout=10
connect_timeout
设置为 0 表示没有超时。
连接超时的另一个可能原因是 Prisma ORM 的 连接池,其默认超时时间为 10 秒。这对于 Neon 通常是足够的,但如果您仍然遇到连接超时,您可以尝试通过将 pool_timeout
参数设置为更高值来增加此限制(除了上述的 connect_timeout
设置)。例如
DATABASE_URL=postgres://daniel:<password>@ep-mute-rain-952417.us-east-2.aws.neon.tech/neondb?connect_timeout=15&pool_timeout=15
如何将 Neon 的无服务器驱动程序与 Prisma ORM 结合使用(预览版)
Neon 无服务器驱动程序 是一款低延迟的 Postgres 驱动程序,适用于 JavaScript 和 TypeScript,允许您通过 HTTP 或 WebSockets 而非 TCP 从无服务器和边缘环境中查询数据。
您可以将 Prisma ORM 与 Neon 无服务器驱动程序结合使用,方法是使用 驱动程序适配器。驱动程序适配器允许您使用与 Prisma ORM 提供的默认数据库驱动程序不同的驱动程序来与您的数据库通信。
此功能从 Prisma ORM 5.4.2 及更高版本开始提供预览版。
首先,启用 driverAdapters
预览功能标志
generator client {
provider = "prisma-client-js"
previewFeatures = ["driverAdapters"]
}
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
生成 Prisma Client
npx prisma generate
安装 Neon 的 Prisma ORM 适配器
npm install @prisma/adapter-neon
更新您的 Prisma Client 实例
import { PrismaClient } from '@prisma/client'
import { PrismaNeon } from '@prisma/adapter-neon'
import dotenv from 'dotenv'
dotenv.config()
const connectionString = `${process.env.DATABASE_URL}`
const adapter = new PrismaNeon({ connectionString })
const prisma = new PrismaClient({ adapter })
然后,您可以像往常一样使用 Prisma Client,并享受完整的类型安全。Prisma Migrate、内省和 Prisma Studio 将继续像以前一样工作,使用 Prisma schema 中定义的连接字符串。
备注
指定 PostgreSQL schema
您可以在实例化 PrismaNeon
时,通过传入 schema
选项来指定一个 PostgreSQL schema
const adapter = new PrismaNeon(
{ connectionString },
{ schema: 'myPostgresSchema' })