跳至主要内容

Prisma 加速入门

先决条件​

要开始使用加速，您需要以下内容

  • 一个
  • 使用 Prisma Client 4.16.1 或更高版本的项目。如果您的项目使用交互式事务，则需要使用 5.1.1 或更高版本。（我们始终建议使用最新版本的 Prisma。）
  • 托管的 PostgreSQL、MySQL/MariaDB、PlanetScale、CockroachDB 或 MongoDB 数据库

1. 启用加速​

导航到您的 Prisma 数据平台项目，选择一个环境，并通过提供您的数据库连接字符串并选择最靠近您数据库的区域来启用加速。

注意

如果您需要 IP 允许列表或具有受信任 IP 地址的防火墙配置，请启用静态 IP 以增强安全性。了解有关 如何在平台控制台中为加速启用静态 IP 的更多信息。

2. 将加速添加到您的应用程序​

2.1. 更新您的数据库连接字符串​

启用后，系统将提示您生成一个 API 密钥，您将在新的加速连接字符串中使用该密钥来验证请求。

将您的直接数据库 URL 替换为新的加速连接字符串。

.env
# New Accelerate connection string with generated API_KEY
DATABASE_URL="prisma://accelerate.prisma-data.net/?api_key=__API_KEY__"

# Previous (direct) database connection string
# DATABASE_URL="postgresql://user:password@host:port/db_name?schema=public"

更新后的连接字符串将用作您 Prisma 架构文件中的数据源 url；

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

Prisma Migrate 和 Introspection 不适用于 prisma:// 连接字符串。为了继续使用这些功能，请在 .env 文件中添加一个名为 DIRECT_DATABASE_URL 的新变量，其值为直接数据库连接字符串

.env
DATABASE_URL="prisma://accelerate.prisma-data.net/?api_key=__API_KEY__"
DIRECT_DATABASE_URL="postgresql://user:password@host:port/db_name?schema=public"

然后，在您 Prisma 架构的 datasource 块中添加一个名为 directUrl 的字段，其中包含以下内容

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

当提供此配置时，迁移和内省将使用 directUrl 连接字符串而不是 url 中定义的连接字符串。

directUrl 对您执行迁移和内省很有用。但是，您不需要 directUrl 就能在您的应用程序中使用加速。

2.2. 安装加速 Prisma Client 扩展​

信息

💡 加速需要 Prisma Client 版本 4.16.1 或更高版本和 @prisma/extension-accelerate 版本 1.0.0 或更高版本

安装最新版本的 Prisma Client 和加速 Prisma Client 扩展

npm install @prisma/client@latest @prisma/extension-accelerate

2.3. 为加速生成 Prisma Client​

如果您使用的是 Prisma 版本 5.2.0 或更高版本，Prisma Client 将自动确定它应如何根据数据库连接字符串中的协议连接到数据库。如果 DATABASE_URL 中的连接字符串以 prisma:// 开头，Prisma Client 将尝试使用 Prisma 加速连接到您的数据库。

在长时间运行的应用程序服务器（例如部署在 AWS EC2 上的服务器）中使用 Prisma 加速时，您可以通过执行以下命令来生成 Prisma Client

npx prisma generate

在无服务器或边缘应用程序中使用 Prisma 加速时，我们建议您运行以下命令来生成 Prisma Client

npx prisma generate --no-engine

--no-engine 标志会阻止将查询引擎文件包含在生成的 Prisma Client 中，这将确保您的应用程序的捆绑包大小保持较小。

警告

如果您的 Prisma 版本低于 5.2.0，请使用 --accelerate 选项生成 Prisma Client

npx prisma generate --accelerate

如果您的 Prisma 版本低于 5.0.0，请使用 --data-proxy 选项生成 Prisma Client

npx prisma generate --data-proxy

2.4. 使用加速扩展扩展您的 Prisma Client 实例​

添加以下内容以使用加速扩展扩展您现有的 Prisma Client 实例

import { PrismaClient } from '@prisma/client'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

如果您要部署到边缘运行时（例如 Cloudflare Workers、Vercel Edge Functions、Deno Deploy 或 Supabase Edge Functions），请使用我们的边缘客户端。

import { PrismaClient } from '@prisma/client/edge'
import { withAccelerate } from '@prisma/extension-accelerate'

const prisma = new PrismaClient().$extends(withAccelerate())

如果 VS Code 无法识别 $extends 方法，请参考 本节了解如何解决此问题。

在其他扩展或中间件中使用加速扩展​

由于 扩展是按顺序应用的，请确保以正确的顺序应用它们。扩展不能共享行为，最后应用的扩展优先。

如果您在应用程序中使用 Prisma Optimize，请确保在加速扩展之前应用它。例如

const prisma = new PrismaClient().$extends(withOptimize()).$extends(withAccelerate())

如果您在应用程序中使用 Prisma 中间件，请确保在任何 Prisma Client 扩展（例如加速）之前添加它们。例如

const prisma = new PrismaClient().$use(middleware).$extends(withAccelerate())

2.5. 在您的数据库查询中使用加速​

withAccelerate 扩展主要做两件事

  • 让您可以在每个适用的模型方法中访问 cacheStrategy 字段，允许您为每个查询定义一个缓存策略。
  • 通过连接池路由所有查询。

没有缓存策略只使用连接池​

如果您只是想利用加速的连接池功能，而无需应用缓存策略，您可以像没有加速一样运行您的查询。

通过启用加速并提供加速连接字符串，您的查询现在默认情况下使用连接池。

定义缓存策略​

使用新的 cacheStrategy 属性更新查询，该属性允许您为该特定查询定义一个缓存策略

const user = await prisma.user.findMany({
  where: {
    email: {
      contains: '[email protected]',
    },
  },
  cacheStrategy: { swr: 60, ttl: 60 },
})

在上面的示例中，swr: 60 和 ttl: 60 意味着加速将在 60 秒内提供缓存数据，然后在加速在后台获取新数据时再持续 60 秒。

您现在应该看到缓存查询的性能有所提高。

信息

有关哪种策略最适合您的应用程序的信息，请参阅 选择缓存策略。

信息

从 Prisma 版本 5.2.0 开始，您可以将 Prisma Studio 与加速连接字符串一起使用。

使缓存的查询结果失效​

要使缓存的查询结果失效，您可以添加标签，然后使用 $accelerate.invalidate API。

注意

按需缓存失效在我们的付费计划中提供。有关更多详细信息，请参阅我们的 定价。

要使以下查询失效

await prisma.user.findMany({
  where: {
    email: {
      contains: "[email protected]",
    },
  },
  cacheStrategy: {
    swr: 60,
    ttl: 60,
    tags: ["emails_with_alice"],
  },
});

您需要在 $accelerate.invalidate API 中提供缓存标签

try {
  await prisma.$accelerate.invalidate({
    tags: ["emails_with_alice"],
  });
} catch (e) {
  if (e instanceof Prisma.PrismaClientKnownRequestError) {
    // The .code property can be accessed in a type-safe manner
    if (e.code === "P6003") {
      console.log(
        "You've reached the cache invalidation rate limit. Please try again shortly."
      );
    }
  }
  throw e;
}