使用 TypeScript 將 Prisma ORM 新增到現有 MongoDB 專案中

瞭解如何將 Prisma ORM 新增到現有 Node.js 或 TypeScript 專案中，透過連線到您的資料庫並生成 Prisma Client 以進行資料庫訪問。本教程將向您介紹 Prisma CLI、Prisma Client 和 Prisma 內省（Introspection）。

提示

如果您正在從 Mongoose 遷移到 Prisma ORM，請參閱我們的“從 Mongoose 遷移”指南。

先決條件

為了成功完成本指南，您需要

您的機器上安裝了Node.js（請參閱系統要求以獲取官方支援的版本）
訪問具有副本集部署的 MongoDB 4.2+ 伺服器。我們推薦使用MongoDB Atlas。

警告
MongoDB 資料庫聯結器使用事務來支援巢狀寫入。事務需要副本集部署。部署副本集最簡單的方法是使用Atlas。它可免費開始使用。

請確保您手頭有資料庫連線 URL（包含您的身份驗證憑據）！如果您沒有執行中的資料庫伺服器，只是想探索 Prisma ORM，請檢視“快速入門”。

請參閱系統要求以獲取確切的版本要求。

首先，導航到包含 `package.json` 檔案的專案目錄中。

接下來，將 Prisma CLI 作為開發依賴項新增到您的專案中

npm install prisma --save-dev

注意

如果您的專案包含多個帶有 `package.json` 檔案的目錄（例如 `frontend`、`backend` 等），請注意 Prisma ORM 專門設計用於 API/後端層。要設定 Prisma，請導航到包含相關 `package.json` 檔案的相應後端目錄並在那裡配置 Prisma。

現在您可以透過在 Prisma CLI 前面加上 `npx` 來呼叫它

npx prisma

資訊

請參閱安裝說明，瞭解如何使用不同的包管理器安裝 Prisma ORM。

接下來，使用以下命令建立 Prisma Schema 檔案來設定您的 Prisma ORM 專案

npx prisma init --datasource-provider mongodb --output ../generated/prisma

此命令會執行以下幾項操作

建立一個名為 `prisma` 的新目錄，其中包含一個名為 `schema.prisma` 的檔案，該檔案包含 Prisma Schema 以及您的資料庫連線變數和 schema 模型。
將 `datasource` 設定為MongoDB並將輸出分別設定到自定義位置。
在專案根目錄中建立 `.env` 檔案，該檔案用於定義環境變數（例如您的資料庫連線）

請注意，`prisma init` 建立的預設 schema 使用 PostgreSQL 作為 `provider`。如果您沒有透過 `datasource-provider` 選項指定提供程式，則需要編輯 `datasource` 塊以改用 `mongodb` 提供程式

prisma/schema.prisma

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}