跳到主要內容

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

瞭解如何將 Prisma ORM 新增到現有的 Node.js 或 TypeScript 專案中,透過連線到你的資料庫並生成 Prisma Client 來訪問資料庫。本教程將向你介紹 Prisma CLIPrisma ClientPrisma Introspection

提示

如果你正在從其他 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 檔案的目錄(例如 frontendbackend 等),請注意 Prisma ORM 專門設計用於 API/後端層。要設定 Prisma,請導航到包含相關 package.json 檔案的相應後端目錄並在那裡配置 Prisma。

現在你可以使用 npx 字首呼叫 Prisma CLI

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")
}
© . This site is unofficial and not affiliated with Prisma Data, Inc.