入门

先决条件

信息

Prisma Pulse 目前支持 PostgreSQL。我们很乐意听取您希望看到支持哪些数据库的反馈。

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

一个Prisma 数据平台工作区。
Prisma Client 版本 4.16.1 或更高，以及 @prisma/extension-pulse 版本 1.0.1 或更高。
一个公开可访问的 PostgreSQL（版本 12+）数据库，并启用了逻辑复制。查看我们的设置指南，了解如何为您的数据库配置逻辑复制。

1. 启用 Pulse

导航到您的 Prisma Data Platform 项目，选择一个环境，并启用 Pulse。我们将在设置过程中连接到您的数据库并验证连接。

启用后，系统会提示您生成一个 API 密钥，您将在扩展的 Prisma Client 中使用该密钥来验证请求。将此 API 密钥存储在应用程序的 .env 文件中

.env
PULSE_API_KEY="your_secure_pulse_api_key"

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

启用 Pulse 后，请按照以下步骤将 Pulse 集成到您的应用程序中。您也可以使用我们的示例仓库作为参考指南。

2.1. 安装 Pulse Client 扩展

信息

Pulse 需要 Prisma Client 版本 4.16.1 或更高，以及 @prisma/extension-pulse 版本 1.0.1 或更高

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

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

2.2. 使用 Pulse 扩展扩展您的 Prisma Client 实例

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

import { PrismaClient } from '@prisma/client'
import { withPulse } from '@prisma/extension-pulse'

const prisma = new PrismaClient().$extends(
  withPulse({ apiKey: process.env.PULSE_API_KEY })
)

注意

您在启用 Pulse后将此 API 密钥存储在您的 .env 文件中。如果需要，您可以导航到您的项目环境并生成新的 API 密钥。

2.3. 创建您的第一个 Pulse 订阅

应用 Pulse 扩展后，您可以对 Prisma Schema 中定义的任何模型使用 Pulse 的 subscribe() 方法来订阅数据更改事件。

在以下示例中，对 notification 模型进行订阅，该模型监听该表上的任何更改事件

const prisma = new PrismaClient().$extends(withPulse({ apiKey: apiKey }))

async function main() {
  const subscription = await prisma.notification.subscribe()

  for await (const event of subscription) {
    console.log('just received a notification:', event)
  }
}

main()

全部完成！您已成功将 Pulse 添加到您的应用程序。探索下一步以了解更多信息。

下一步

导航到 API 部分以探索 Pulse 的 subscribe() 方法的可用过滤选项。

const subscription = await prisma.notification.subscribe({
  create: {
    userId: 123, // subscribe to all notifications created for the user with ID 123
  },
})

需要帮助？

在我们的Discord的 #help-and-questions 频道中联系我们，或与我们的社区联系，了解其他人如何使用 Pulse。

先决条件​

1. 启用 Pulse​

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

2.1. 安装 Pulse Client 扩展​

2.2. 使用 Pulse 扩展扩展您的 Prisma Client 实例​

2.3. 创建您的第一个 Pulse 订阅​

下一步​

需要帮助？​