將 Prisma ORM 新增到現有 JavaScript 專案 (PostgreSQL)

JavaScript

PostgreSQL

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

提示

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

先決條件

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

• 一個包含 package.json 檔案的現有 Node.js 專案
• Node.js已安裝在您的機器上（請參閱系統要求以瞭解官方支援的版本）
• 一個正在執行的 PostgreSQL 資料庫伺服器，以及一個至少包含一張表的資料庫

有關確切版本要求，請參閱系統要求。

確保您手頭有資料庫連線 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 --datasource-provider postgresql --output ../generated/prisma

此命令執行以下操作

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

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

prisma/schema.prisma

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