跳至主要内容

引擎

从技术角度来看，Prisma Client 由三个主要组件组成

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

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

此页面涵盖了有关查询引擎的相关技术细节。

Prisma 引擎​

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

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

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

Prisma engine

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

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

  • 无法自动下载引擎文件。
  • 您已为测试目的或不支持的 OS 创建了自己的引擎库或二进制文件。

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

警告
  • 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 存储桶或其他云存储来托管引擎文件。如果您有需要自定义构建引擎的自定义 OS，这将非常有用。

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 Client 的 runtime 目录中。

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

运行时的查询引擎​

默认情况下，Prisma Client 将查询引擎加载为一个Node-API 库。您可以选择配置 Prisma 使用编译为可执行二进制文件的查询引擎，该引擎作为辅助进程与您的应用程序一起运行。建议使用 Node-API 库方法，因为它减少了 Prisma Client 和查询引擎之间的通信开销。

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代替。

信息
  • 在 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将其配置为使用查询引擎的二进制版本。