将 Prisma ORM 添加到现有项目(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 数据库
请参阅 系统要求 以了解确切的版本要求。
请确保您已准备好数据库 连接 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。
datasource db {
provider = "sqlserver"
url = env("DATABASE_URL")
}