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

瞭解如何將 Prisma ORM 新增到現有的 Node.js 或 TypeScript 專案中，方法是將其連線到您的資料庫並生成 Prisma Client 以進行資料庫訪問。本教程將向您介紹 Prisma CLI、Prisma Client 和 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 選項指定提供者，則需要編輯 datasource 塊以改用 cockroachdb 提供者

prisma/schema.prisma

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