跳到主要内容

Prisma Config 参考

概览​

警告

此功能目前处于 Early Access 阶段，仍可能发生变化。

Prisma Config 文件是一个 TypeScript 文件，允许您配置 Prisma ORM。它接受以下选项

名称类型必需描述
earlyAccess布尔值是当 Prisma Config 处于 Early Access 阶段时为必需。
schema对象否指定 Prisma schema 的路径（可以是单个文件，也可以是文件夹，如果 Prisma schema 拆分到多个文件）。

参考​

earlyAccess: Boolean​

描述​

当 prisma.config.ts 在 Early Access 中运行时，您需要使用此属性显式启用它。

示例​

prisma.config.ts
export default {
  earlyAccess: true,
};

schema: Object​

描述​

schema 属性允许您指定 Prisma schema 文件位置的自定义路径。它接受两个属性

  • kind: 'single' 如果您的 Prisma schema 是单个 .prisma 文件；'multi' 如果您正在使用 prismaSchemaFolder 预览功能并将您的数据模型拆分到多个 .prisma 文件中。
  • 单文件 schema 的 filePath 和多文件 schema 的 folderPath。

示例​

指定单文件 Prisma schema 的路径​
prisma.config.ts
import path from "node:path";

export default {
  schema: {
    kind: "single",
    filePath: path.join("custom", "prisma", "schema.prisma"),
  },
};
指定包含多个 Prisma schema 文件的文件夹的路径​

这需要启用 prismaSchemaFolder 预览功能。

prisma.config.ts
import path from "node:path";

export default {
  schema: {
    kind: "multi",
    filePath: path.join("custom", "prisma", "schema/"),
  },
};

使用 Prisma Config​

安装 @prisma/config 包以获得自动完成功能​

为了在 Prisma Config 文件中获得属性的自动完成功能，您需要安装 @prisma/config npm 包

npm install @prisma/config --save-dev

将 Prisma Config 添加到您的项目​

prisma.config.ts 需要存在于您运行 Prisma CLI 命令的同一文件夹中。我们建议将其放置在整个项目的根目录（而不是 prisma 文件夹中），因为 CLI 命令通常在那里执行。

手动加载环境变量​

如果您向项目中添加了 prisma.config.ts，Prisma CLI 将不会自动从 .env 文件加载您的环境变量。

相反，您需要使用 dotenv 包手动加载环境变量

1. 安装 dotenv​

npm install dotenv

2. 在需要的地方导入 'dotenv/config'​

在您访问 .env 文件中定义的环境变量的文件中，将此行添加到 import 语句中

prisma.config.ts
import "dotenv/config";

// now you can access env vars via:
// `process.env`
// for example:
// `process.env.DATABASE_URL`

使用自定义 Prisma Config 位置/名称​

当调用 Prisma CLI 命令时，您可以使用 --config 选项为 Prisma Config 文件指定自定义位置/名称。例如

prisma validate --config ./path/to/myconfig.ts