將 Prisma ORM 新增到現有專案（TypeScript 和 CockroachDB）

瞭解如何將 Prisma ORM 新增到現有 Node.js 或 TypeScript 專案中，方法是將其連線到資料庫併為資料庫訪問生成 Prisma 客戶端。以下教程將向你介紹 Prisma CLI、Prisma 客戶端和 Prisma 內省。

提示

如果你正在從其他 ORM 遷移到 Prisma ORM，請參閱我們的從 TypeORM 遷移或從 Sequelize 遷移遷移指南。

先決條件

要成功完成本指南，你需要

請參閱系統要求以瞭解確切的版本要求。

確保你手頭有資料庫連線 URL（包括你的認證憑據）！如果你沒有資料庫伺服器正在執行，只是想探索 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 cockroachdb --output ../generated/prisma

此命令執行以下幾項操作

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

請注意，prisma init 建立的預設 schema 使用 PostgreSQL 作為 provider。如果你沒有透過 datasource-provider 選項指定 provider，你需要編輯 datasource 塊以改用 cockroachdb provider

prisma/schema.prisma

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