生成 Prisma Client

Prisma Client 是一个根据你的数据库 schema 自动生成的数据库客户端。默认情况下，Prisma Client 生成到 node_modules/.prisma/client 文件夹中，但是你可以指定自定义位置。

生成和实例化 Prisma Client

1. 确保你的机器上已经安装了 Prisma CLI。

2. 将以下 generator 定义添加到你的 Prisma schema

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

3. 安装 @prisma/client npm 包

   npm install @prisma/client
   警告

   我们建议你保持 prisma 和 @prisma/client 包同步，以避免任何意外的错误或行为。

4. 使用以下命令生成 Prisma Client

   prisma generate

5. 你现在可以在你的代码中实例化 Prisma Client

TypeScript

import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
// use `prisma` in your application to read and write data in your DB

JavaScript

const { PrismaClient } = require('@prisma/client')
const prisma = new PrismaClient()
// use `prisma` in your application to read and write data in your DB

重要提示：在每次更改 Prisma schema 后，你需要重新运行 prisma generate 命令来更新生成的 Prisma Client 代码。

这是一个 Prisma Client 生成的典型工作流程的图形化说明

还要注意，当你安装 @prisma/client npm 包时，prisma generate 会被自动调用。因此，当你最初设置 Prisma Client 时，你通常可以省略上面列表中的第三步。

@prisma/client npm 包

@prisma/client npm 包由两个主要部分组成

• @prisma/client 模块本身，它只在你重新安装包时才会更改
• .prisma/client 文件夹，它是从你的 schema 生成的唯一 Prisma Client 的默认位置

@prisma/client/index.d.ts 导出 .prisma/client

export * from '.prisma/client'

这意味着你仍然在自己的 .ts 文件中导入 @prisma/client

import { PrismaClient } from '@prisma/client'

Prisma Client 是从你的 Prisma schema 生成的，并且对你的项目是唯一的。每次你更改 schema（例如，通过执行schema 迁移）并运行 prisma generate，Prisma Client 的代码都会更改

.prisma 文件夹不受 Node.js 包管理器中pruning的影响。

Prisma Client 的位置

如果你没有在 generator 代码块中指定自定义 output，Prisma Client 默认生成到 ./node_modules/.prisma/client 文件夹中。保持默认位置有一些优点。

使用自定义 output 路径

你还可以在 generator 配置中指定自定义 output 路径，例如（假设你的 schema.prisma 文件位于默认的 prisma 子文件夹中）

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

为该 schema 文件运行 prisma generate 后，Prisma Client 包将位于

./src/generated/client

要从自定义位置导入 PrismaClient（例如，从名为 ./src/script.ts 的文件）

import { PrismaClient } from './generated/client'

为什么 Prisma Client 默认生成到 node_modules/.prisma/client？

导入 Prisma Client

通过将 Prisma Client 生成到 node_modules/.prisma/client 并从 @prisma/client 导出它，你可以按如下方式导入并在你的代码中实例化 Prisma Client

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient()

// use `prisma` in your application to read and write data in your DB

或

const { PrismaClient } = require('@prisma/client')

const prisma = new PrismaClient()

// use `prisma` in your application to read and write data in your DB

默认情况下将查询引擎排除在版本控制之外

Prisma Client 使用查询引擎来针对数据库运行查询。此查询引擎在调用 prisma generate 时下载，并与生成的 Client 一起存储在 output 路径中。

通过将 Prisma Client 生成到 node_modules 中，查询引擎通常默认排除在版本控制之外，因为 node_modules 通常被版本控制忽略。当为生成的 Prisma Client 使用自定义 output 路径时，建议将其从你的版本控制中排除。对于 Git，这意味着将 output 路径添加到你的 .gitignore 文件。

在 @prisma/client 的 postinstall 钩子中生成 Prisma Client

@prisma/client 包定义了自己的 postinstall 钩子，该钩子在每次安装包时执行。此钩子调用 prisma generate 命令，该命令反过来将 Prisma Client 代码生成到默认位置 node_modules/.prisma/client。请注意，这需要 prisma CLI 可用，无论是作为本地依赖项还是全局安装。建议始终将 prisma 包作为开发依赖项安装，使用 npm install prisma --save-dev，以避免版本冲突。