跳至主要内容

引擎

从技术角度来看，Prisma 客户端包含三个主要组件

  • JavaScript 客户端库
  • TypeScript 类型定义
  • 查询引擎

所有这些组件都位于 运行 prisma generate 后生成的 .prisma/client 文件夹 中。

本页介绍了查询引擎的相关技术细节。

Prisma 引擎​

每个模块的核心通常都有一个 Prisma 引擎，它实现了核心功能集。引擎是用 Rust 实现的，并公开了一个低级 API，供高级接口使用。

Prisma 引擎是与数据库的直接接口，任何高级接口始终通过引擎层与数据库通信。

例如，Prisma 客户端连接到 查询引擎 以便读取和写入数据库中的数据

Prisma engine

使用自定义引擎库或二进制文件​

默认情况下，所有引擎文件在安装或更新 prisma（Prisma CLI 包）时会自动下载到 node_modules/@prisma/engines 文件夹中。当您调用 prisma generate 时，查询引擎 也会复制到生成的 Prisma 客户端。您可能需要使用 自定义库或二进制文件 文件，如果

  • 无法自动下载引擎文件。
  • 您为测试目的或为未正式支持的操作系统创建了自己的引擎库或二进制文件。

使用以下环境变量来指定自定义二进制文件的位置

警告
  • PRISMA_MIGRATION_ENGINE_BINARY 变量已在 5.0.0 中弃用。
  • 从 4.9.0 开始，内省引擎由迁移引擎提供服务。因此，不会使用 PRISMA_INTROSPECTION_ENGINE 环境变量。
  • PRISMA_FMT_BINARY 变量用于 4.2.0 或更低版本。

设置环境变量​

您可以在您的机器上全局定义环境变量，或在 .env 文件中定义环境变量。

a) .env 文件​

将环境变量添加到 .env 文件 中。

PRISMA_QUERY_ENGINE_BINARY=custom/my-query-engine-unix

注意：可以 在 prisma 文件夹之外的位置使用 .env 文件。

b) 全局环境变量​

运行以下命令以全局设置环境变量（在本例中为 PRISMA_QUERY_ENGINE_BINARY）

export PRISMA_QUERY_ENGINE_BINARY=/custom/my-query-engine-unix

测试您的环境变量​

运行以下命令以输出所有二进制文件的路径

npx prisma -v

输出显示查询引擎路径来自 PRISMA_QUERY_ENGINE_BINARY 环境变量

Current platform     : darwin
Query Engine         : query-engine d6ff7119649922b84e413b3b69660e2f49e2ddf3 (at /custom/my-query-engine-unix)
Migration Engine     : migration-engine-cli d6ff7119649922b84e413b3b69660e2f49e2ddf3 (at /myproject/node_modules/@prisma/engines/migration-engine-unix)
Introspection Engine : introspection-core d6ff7119649922b84e413b3b69660e2f49e2ddf3 (at /myproject/node_modules/@prisma/engines/introspection-engine-unix)

托管引擎​

PRISMA_ENGINES_MIRROR 环境变量允许您通过私有服务器、AWS 存储桶或其他云存储托管引擎文件。如果您使用的是需要自定义构建引擎的自定义操作系统，这将很有用。

PRISMA_ENGINES_MIRROR=https://my-aws-bucket

查询引擎文件​

查询引擎文件因操作系统而异。它被命名为 query-engine-PLATFORM 或 libquery_engine-PLATFORM，其中 PLATFORM 对应于编译目标的名称。查询引擎文件扩展名也取决于平台。例如，如果查询引擎必须在 Darwin（如 macOS Intel）操作系统上运行，则它被称为 libquery_engine-darwin.dylib.node 或 query-engine-darwin。您可以在 此处 找到所有支持平台的概述。

调用 prisma generate 时，查询引擎文件将下载到生成的 Prisma 客户端的 runtime 目录中。

请注意，查询引擎是用 Rust 实现的。源代码位于 prisma-engines 存储库中。

运行时的查询引擎​

默认情况下，Prisma 客户端将查询引擎加载为 Node-API 库。您也可以 配置 Prisma 以使用编译为可执行二进制文件的查询引擎，该引擎作为您的应用程序的旁路进程运行。建议使用 Node-API 库方法，因为它可以减少 Prisma 客户端和查询引擎之间的通信开销。

Diagram showing the query engine and Node.js at runtime

当第一次调用 Prisma Client 查询或在您的 PrismaClient 实例上调用 $connect() 方法时，查询引擎将启动。查询引擎启动后，会创建一个 连接池 并管理与数据库的物理连接。从那时起，Prisma Client 就可以将 查询 发送到数据库（例如，findUnique()、findMany、create 等）。

当调用 $disconnect() 时，查询引擎将停止，数据库连接将关闭。

下图描绘了一个“典型流程”

  1. 在 Prisma Client 上调用 $connect()
  2. 查询引擎启动
  3. 查询引擎建立与数据库的连接并创建连接池
  4. Prisma Client 现在可以将查询发送到数据库
  5. Prisma Client 将 findMany() 查询发送到查询引擎
  6. 查询引擎将查询转换为 SQL 并发送到数据库
  7. 查询引擎从数据库接收 SQL 响应
  8. 查询引擎将结果作为普通 JavaScript 对象返回到 Prisma Client
  9. 在 Prisma Client 上调用 $disconnect()
  10. 查询引擎关闭数据库连接
  11. 查询引擎停止

Typical flow of the query engine at run time

查询引擎的职责​

在使用 Prisma Client 的应用程序中，查询引擎具有以下职责

  • 管理连接池中的物理数据库连接
  • 接收来自 Prisma Client Node.js 进程的传入查询
  • 生成 SQL 查询
  • 将 SQL 查询发送到数据库
  • 处理来自数据库的响应并将其发送回 Prisma Client

调试查询引擎​

您可以通过将 DEBUG 环境变量设置为 engine 来访问查询引擎的日志

export DEBUG="engine"

您还可以通过在 Prisma Client 中设置 query 日志级别 来更清晰地了解查询引擎生成的 SQL 查询。

const prisma = new PrismaClient({
  log: ['query'],
})

了解有关 调试 和 日志记录 的更多信息。

配置查询引擎​

为 Prisma Client 定义查询引擎类型​

如上所述，默认查询引擎是一个加载到 Prisma Client 中的 Node-API 库，但还有一种可替代的实现，它是一个在自己的进程中运行的可执行二进制文件。您可以通过向 Prisma Client 的 generator 提供 engineType 属性来配置查询引擎类型。

generator client {
  provider   = "prisma-client-js"
  engineType = "binary"
}

engineType 的有效值为 binary 和 library。您也可以使用环境变量 PRISMA_CLIENT_ENGINE_TYPE 来代替。

info
  • 在 Prisma 3.x 之前，默认且唯一可用的引擎类型是 binary，因此无法配置 Prisma Client 和 Prisma CLI 要使用的引擎类型。
  • 从版本 2.20.0 到 3.x，library 引擎类型可用，并且通过 激活预览功能标志 “nApi” 或使用 PRISMA_FORCE_NAPI=true 环境变量默认使用。

为 Prisma CLI 定义查询引擎类型​

Prisma CLI 也使用自己的查询引擎来满足自己的需求。您可以通过定义环境变量 PRISMA_CLI_QUERY_ENGINE_TYPE=binary 来配置它使用查询引擎的二进制版本。