将 Prisma ORM 添加到现有项目 (TypeScript 和 PlanetScale)
了解如何通过连接到数据库并生成 Prisma Client 以进行数据库访问,将 Prisma ORM 添加到现有的 Node.js 或 TypeScript 项目中。本教程将向你介绍 Prisma CLI、Prisma Client 和 Prisma 内省。
如果你正在从其他 ORM 迁移到 Prisma ORM,请参阅我们的 从 TypeORM 迁移 或 从 Sequelize 迁移 指南。
先决条件
为了成功完成本指南,你需要
- 一个现有且包含
package.json
文件的 Node.js 项目 - Node.js 已安装在你的机器上(请参阅系统要求以获取官方支持的版本)
- 一个正在运行的 PlanetScale 数据库服务器和一个至少包含一个表的数据库
有关确切的版本要求,请参阅系统要求。
请确保你手头有数据库连接 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。
现在你可以通过在命令前添加 npx
来调用 Prisma CLI
npx prisma
请参阅安装说明,了解如何使用不同的包管理器安装 Prisma ORM。
接下来,使用以下命令创建你的 Prisma Schema 文件,从而设置你的 Prisma ORM 项目
npx prisma init --datasource-provider mysql --output ../generated/prisma
此命令完成以下几件事
- 创建一个名为
prisma
的新目录,其中包含一个名为schema.prisma
的文件,该文件包含带有数据库连接变量和 schema 模型的 Prisma Schema。 - 将
datasource
设置为MySQL并将输出分别设置为自定义位置。 - 在项目的根目录中创建
.env
文件,该文件用于定义环境变量(例如你的数据库连接)
请注意,prisma init
创建的默认 schema 使用 PostgreSQL 作为 provider
。如果你没有使用 datasource-provider
选项指定 provider,则需要编辑 datasource
块以使用 mysql
provider,而不是
datasource db {
provider = "mysql"
url = env("DATABASE_URL")
}