跳到主要內容

關聯式資料庫

JavaScript
CockroachDB

了解如何將 Prisma ORM 新增至現有的 Node.js 或 TypeScript 專案，方法是將其連線到您的資料庫並產生 Prisma Client 以進行資料庫存取。以下教學將向您介紹 Prisma CLI、Prisma Client 和 Prisma Introspection。

提示

如果您要從另一個 ORM 遷移到 Prisma ORM，請參閱我們的 從 TypeORM 遷移 或 從 Sequelize 遷移 遷移指南。

先決條件​

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

  • 具有 package.json 的現有 Node.js 專案
  • Node.js 安裝在您的機器上 (請參閱 系統需求 以取得官方支援的版本)
  • 執行中的 CockroachDB 資料庫伺服器，以及至少有一個資料表的資料庫

請參閱 系統需求 以取得精確的版本需求。

請確保您手邊有資料庫連線 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。

您現在可以透過在 Prisma CLI 前面加上 npx 來調用它

npx prisma
資訊

請參閱安裝說明以了解如何使用不同的套件管理器安裝 Prisma ORM。

接下來，透過使用以下命令建立您的 Prisma schema 檔案範本來設定您的 Prisma ORM 專案

npx prisma init

此命令執行兩項操作

  • 建立一個名為 prisma 的新目錄，其中包含一個名為 schema.prisma 的檔案，其中包含 Prisma schema 以及您的資料庫連線變數和 schema 模型
  • 在專案的根目錄中建立 .env 檔案，用於定義環境變數 (例如您的資料庫連線)