跳到主要内容

Neon

本指南解释了如何

什么是 Neon?​

Neon's logo

Neon 是一个完全托管的 serverless PostgreSQL，提供慷慨的免费层级。Neon 分离了存储和计算，并提供现代开发者功能，例如 serverless、分支、无限存储等等。Neon 是开源的，使用 Rust 编写。

了解更多关于 Neon 的信息 here。

与其他数据库提供商的共同点​

使用 Prisma ORM 和 Neon 的许多方面就像使用 Prisma ORM 和任何其他 PostgreSQL 数据库一样。你可以

需要考虑的差异​

在决定将 Neon 与 Prisma ORM 一起使用时，你应该注意 Neon 和 PostgreSQL 之间的一些差异，如下所示

  • Neon 的 serverless 模型 — 默认情况下，Neon 会在 5 分钟不活动后将 计算实例 缩放到零。在此状态期间，计算实例处于空闲状态。此功能的一个特点是“冷启动”的概念。从空闲状态激活计算实例需要 500 毫秒到几秒钟不等。根据连接到数据库所需的时间，你的应用程序可能会超时。要了解更多信息，请参阅： 连接延迟和超时。
  • Neon 的连接池 — Neon 使用 PgBouncer 提供连接池，最多可实现 10,000 个并发连接。要了解更多信息，请参阅： 连接池。

如何使用 Neon 的连接池​

如果你想使用 Neon 中提供的 连接池，你需要在你的 Prisma schema 的 datasource 块的 url 属性中使用的 DATABASE_URL 环境变量的主机名中添加 -pooler

.env
# 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 来对你的数据库执行其他操作（例如，用于迁移），你需要在你的 Prisma schema 的 datasource 块的 directUrl 属性中使用 DIRECT_URL 环境变量，以便 CLI 将使用直接连接字符串（不带 PgBouncer）

.env
# 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

schema.prisma
datasource db {
  provider  = "postgresql"
  url       = env("DATABASE_URL")
  directUrl = env("DIRECT_URL")
}

关于 directUrl 字段的更多信息可以在这里找到。

信息

我们强烈建议在你的 DATABASE_URL 环境变量中使用池化连接字符串。你将获得 Prisma CLI 的出色开发者体验，同时允许连接被池化，而无需考虑部署策略。虽然这对于每个应用程序来说不是绝对必要的，但 serverless 解决方案将不可避免地需要连接池。

解决连接超时问题​

当从 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 来说足够了，但如果你仍然遇到连接超时，你可以尝试增加此限制（除了上面描述的 connect_timeout 设置），方法是将 pool_timeout 参数设置为更高的值。例如

DATABASE_URL=postgres://daniel:<password>@ep-mute-rain-952417.us-east-2.aws.neon.tech/neondb?connect_timeout=15&pool_timeout=15

如何将 Neon 的 serverless 驱动程序与 Prisma ORM 一起使用（预览）​

Neon serverless 驱动程序 是一个低延迟的 Postgres 驱动程序，用于 JavaScript 和 TypeScript，它允许你通过 HTTP 或 WebSockets 而不是 TCP 从 serverless 和边缘环境查询数据。

你可以将 Prisma ORM 与 Neon serverless 驱动程序一起使用 driver adapter 。driver adapter 允许你使用与 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 适配器、Neon serverless 驱动程序和 ws 包

npm install @prisma/adapter-neon @neondatabase/serverless ws
npm install --save-dev @types/ws

更新你的 Prisma Client 实例

import { Pool, neonConfig } from '@neondatabase/serverless'
import { PrismaNeon } from '@prisma/adapter-neon'
import { PrismaClient } from '@prisma/client'
import dotenv from 'dotenv'
import ws from 'ws'

dotenv.config()
neonConfig.webSocketConstructor = ws
const connectionString = `${process.env.DATABASE_URL}`

const pool = new Pool({ connectionString })
const adapter = new PrismaNeon(pool)
const prisma = new PrismaClient({ adapter })

然后你可以像往常一样使用 Prisma Client，并具有完全的类型安全。Prisma Migrate、内省和 Prisma Studio 将继续像以前一样工作，使用在 Prisma schema 中定义的连接字符串。

注释​

指定 PostgreSQL schema​

你可以通过在实例化 PrismaNeon 时传入 schema 选项来指定 PostgreSQL schema

const adapter = new PrismaNeon(pool, {
  schema: 'myPostgresSchema'
})