跳到主要内容

生成器

一个 Prisma schema 可以有一个或多个生成器，由 generator 块表示

generator client {
  provider = "prisma-client-js"
  output   = "./generated/prisma-client-js"
}

生成器决定了当您运行 prisma generate 命令时创建哪些资源。

Prisma Client 有两个生成器

  • prisma-client-js：将 Prisma Client 生成到 node_modules 中
  • prisma-client (Early Access)：更新且更灵活的 prisma-client-js 版本，支持 ESM；它输出纯 TypeScript 代码，并且需要自定义 output 路径

或者，您可以配置任何符合我们生成器规范的 npm 包。

prisma-client-js​

prisma-client-js 是 Prisma ORM 6.X 版本及之前的默认生成器。它需要 @prisma/client npm 包，并将 Prisma Client 生成到 node_modules 中。

字段参考​

Prisma JavaScript 客户端的生成器接受多个附加属性

  • previewFeatures：要包含的预览功能
  • binaryTargets：prisma-client-js 的引擎二进制目标（例如，如果您部署到 Ubuntu 18+，则为 debian-openssl-1.1.x；如果您在本地工作，则为 native）
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["sample-preview-feature"]
  binaryTargets   = ["debian-openssl-1.1.x"] // defaults to `"native"`
}

二进制目标​

prisma-client-js 生成器使用多个引擎。引擎是用 Rust 实现的，并以可执行的、平台相关的引擎文件形式被 Prisma Client 使用。根据您在哪个平台上执行代码，您需要正确的文件。“二进制目标”用于定义目标平台应存在的哪些文件。

当部署您的应用程序到生产环境时，正确的文件尤为重要，生产环境通常与您的本地开发环境不同。

native 二进制目标​

native 二进制目标是特殊的。它不映射到具体的操作系统。相反，当在 binaryTargets 中指定 native 时，Prisma Client 会检测当前操作系统，并自动为其指定正确的二进制目标。

例如，假设您正在运行 macOS，并且您指定了以下生成器

prisma/schema.prisma
generator client {
  provider      = "prisma-client-js"
  binaryTargets = ["native"]
}

在这种情况下，Prisma Client 会检测您的操作系统，并根据支持的操作系统列表找到适合它的二进制文件。如果您使用 macOS Intel x86 (darwin)，则将选择为 darwin 编译的二进制文件。如果您使用 macOS ARM64 (darwin-arm64)，则将选择为 darwin-arm64 编译的二进制文件。

注意：native 二进制目标是默认值。如果您希望包含额外的二进制目标以部署到不同的环境，您可以显式设置它。

prisma-client (Early Access)​

新的 prisma-client 生成器在使用 Prisma ORM 跨不同 JavaScript 环境（例如 ESM、Bun、Deno、...）时，提供了更大的控制和灵活性。

它将 Prisma Client 生成到您应用程序代码库中的自定义目录中，该目录通过 generator 块上的 output 字段指定。这使您可以完全可见和控制生成的代码，包括查询引擎。

目前处于 Early Access 阶段，此生成器确保您可以完全按照您想要的方式捆绑您的应用程序代码，而无需依赖隐藏或自动行为。

以下是与 prisma-client-js 相比的主要区别

  • 需要 output 路径；不再“魔法般”地生成到 node_modules 中
  • 通过 moduleFormat 字段支持 ESM 和 CommonJS
  • 由于附加字段而更加灵活
  • 输出纯 TypeScript，它像应用程序代码的其余部分一样被捆绑

prisma-client 生成器将成为 Prisma ORM v7 的新默认值。

开始使用​

按照以下步骤在您的项目中使用新的 prisma-client 生成器。

1. 在 schema.prisma 中配置 prisma-client 生成器​

更新您的 generator 块

prisma/schema.prisma
generator client {
  provider = "prisma-client"            // Required
  output   = "../src/generated/prisma"  // Required path
}

output 选项是必需的，它告诉 Prisma ORM 将生成的 Prisma Client 代码放在哪里。您可以选择适合您的项目结构的任何位置。例如，如果您有以下布局

.
├── package.json
├── prisma
│   └── schema.prisma
├── src
│   └── index.ts
└── tsconfig.json

那么 ../src/generated/prisma 会将生成的代码放在相对于 schema.prisma 的 src/generated/prisma 中。

2. 生成 Prisma Client​

通过运行以下命令生成 Prisma Client

npx prisma generate

这会将 Prisma Client 的代码（包括查询引擎二进制文件）生成到指定的 output 文件夹中。

3. 从版本控制中排除生成的目录​

新的生成器既包含 TypeScript 客户端代码也包含查询引擎。在版本控制中包含查询引擎可能会在不同的机器上导致兼容性问题。为了避免这种情况，请将生成的目录添加到 .gitignore

.gitignore
# Keep the generated Prisma Client + query engine out of version control
/src/generated/prisma
注意

在未来，当 Prisma ORM 完全从 Rust 过渡到 TypeScript 时，您可以安全地将生成的目录包含在版本控制中。

4. 在您的应用程序中使用 Prisma Client​

生成 Prisma Client 后，从您指定的路径导入类型

src/index.ts
import { PrismaClient } from "./generated/prisma/client"

const prisma = new PrismaClient()

Prisma Client 现在可以在您的项目中使用了。

字段参考​

在 generator client { ... } 块中使用以下选项。只有 output 是必需的。其他字段具有默认值或从您的环境和 tsconfig.json 推断出来。

schema.prisma
generator client {
  // Required
  provider = "prisma-client"
  output   = "../src/generated/prisma"

  // Optional
  runtime                = "nodejs"
  moduleFormat           = "esm"
  generatedFileExtension = "ts"
  importFileExtension    = "ts"
}

以下是 prisma-client 生成器的选项

选项默认值描述
output (必需)生成 Prisma Client 的目录，例如 ../src/generated/prisma。
runtimenodejs目标运行时环境。
支持的值
nodejs (别名 node)、deno、bun、deno-deploy、workerd (别名 cloudflare)、edge-light (别名 vercel)、react-native。
moduleFormat从环境推断模块格式（esm 或 cjs）。确定是否使用 import.meta.url 或 __dirname。
generatedFileExtensionts生成的 TypeScript 文件的文件扩展名 (ts, mts, cts)。
importFileExtension从环境推断import 语句中使用的文件扩展名。可以是 ts、mts、cts、js、mjs、cjs 或空（对于裸导入）。

局限性​

  • 命名空间用法：生成的代码仍然依赖于 TypeScript 功能，如 namespace，这可能会导致与某些仅运行时设置（例如，没有 --experimental-transform-types 的 Node.js 22+）不兼容。它仍然与标准运行时、tsx、ts-node 和大多数捆绑器完全兼容。
  • 没有浏览器捆绑包：目前没有官方的浏览器构建，并且不支持在前端代码中导入类型或枚举。
注意

这两个限制将在未来的版本中很快解决。

社区生成器​

注意

如果您正在使用 prismaSchemaFolder 预览功能来管理多个 schema 文件，则现有生成器或新生成器不应受到影响，除非生成器手动读取 schema。

以下是社区创建的生成器列表。