跳到主要內容

Prisma Config 參考

概觀​

警告

此功能目前處於搶先體驗階段，仍可能變更。

Prisma Config 檔案是一個 TypeScript 檔案，可讓您設定 Prisma ORM。它接受以下選項

名稱類型必填描述
earlyAccess布林值是當 Prisma Config 處於搶先體驗階段時為必填。
schema物件否指定您的 Prisma Schema 路徑（若 Prisma Schema 分散在多個檔案中，則為單一檔案或資料夾）。

參考​

earlyAccess: Boolean​

描述​

當 prisma.config.ts 在搶先體驗中執行時，您需要使用此屬性明確啟用它。

範例​

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

schema: Object​

描述​

schema 屬性可讓您指定 Prisma schema 檔案位置的自訂路徑。它接受兩個屬性

  • kind：若您的 Prisma schema 只有單一 .prisma 檔案，則為 'single'；若您使用 prismaSchemaFolder 預覽功能並將您的資料模型分散在多個 .prisma 檔案中，則為 'multi'。
  • 單一檔案 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