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

TypeScript

SQL Server

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

提示

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

先決條件

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

• Node.js 安裝在您的機器上（請參閱 系統要求 以瞭解官方支援的版本）
• 一個 Microsoft SQL Server 資料庫
  • 適用於 Docker 的 Linux 版 Microsoft SQL Server
  • Windows 版 Microsoft SQL Server（本地）

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

請確保您已準備好資料庫 連線 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 sqlserver --output ../generated/prisma

此命令會執行以下幾項操作

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

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

prisma/schema.prisma

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