將 Prisma ORM 新增到現有專案 (TypeScript 和 PlanetScale)
瞭解如何透過連線到資料庫並生成 Prisma Client 以進行資料庫訪問,將 Prisma ORM 新增到現有的 Node.js 或 TypeScript 專案中。本教程將向你介紹 Prisma CLI、Prisma Client 和 Prisma 內省。
如果你正在從其他 ORM 遷移到 Prisma ORM,請參閱我們的 從 TypeORM 遷移 或 從 Sequelize 遷移 指南。
先決條件
為了成功完成本指南,你需要
- 一個現有且包含
package.json檔案的 Node.js 專案 - Node.js 已安裝在你的機器上(請參閱系統要求以獲取官方支援的版本)
- 一個正在執行的 PlanetScale 資料庫伺服器和一個至少包含一個表的資料庫
有關確切的版本要求,請參閱系統要求。
請確保你手頭有資料庫連線 URL(其中包含你的身份驗證憑據)!如果你沒有正在執行的資料庫伺服器,只是想探索 Prisma ORM,請查閱快速入門。
設定 Prisma ORM
第一步,進入包含 package.json 檔案的專案目錄。
接下來,將 Prisma CLI 作為開發依賴項新增到你的專案中
npm install prisma --save-dev
如果你的專案包含多個帶有 package.json 檔案的目錄(例如 frontend、backend 等),請注意 Prisma ORM 專門設計用於 API/後端層。要設定 Prisma,請導航到包含相關 package.json 檔案的適當後端目錄並在那裡配置 Prisma。
現在你可以透過在命令前新增 npx 來呼叫 Prisma CLI
npx prisma
請參閱安裝說明,瞭解如何使用不同的包管理器安裝 Prisma ORM。
接下來,使用以下命令建立你的 Prisma Schema 檔案,從而設定你的 Prisma ORM 專案
npx prisma init --datasource-provider mysql --output ../generated/prisma
此命令完成以下幾件事
- 建立一個名為
prisma的新目錄,其中包含一個名為schema.prisma的檔案,該檔案包含帶有資料庫連線變數和 schema 模型的 Prisma Schema。 - 將
datasource設定為MySQL並將輸出分別設定為自定義位置。 - 在專案的根目錄中建立
.env檔案,該檔案用於定義環境變數(例如你的資料庫連線)
請注意,prisma init 建立的預設 schema 使用 PostgreSQL 作為 provider。如果你沒有使用 datasource-provider 選項指定 provider,則需要編輯 datasource 塊以使用 mysql provider,而不是
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
}