如何从 Sequelize 迁移到 Prisma ORM
简介
本指南将向您展示如何将应用程序从 Sequelize 迁移到 Prisma ORM。我们将使用扩展版本的 Sequelize Express 示例 作为示例项目来演示迁移步骤。
本迁移指南使用 PostgreSQL 作为示例数据库，但它同样适用于 Prisma ORM 支持的任何其他关系型数据库。您可以在Prisma ORM vs Sequelize页面上了解 Prisma ORM 与 Sequelize 的对比。
先决条件
开始本指南之前，请确保您已具备以下条件
- 您想要迁移的 Sequelize 项目
- 已安装 Node.js（版本 18 或更高）
- PostgreSQL 或其他受支持的数据库
- 对 Sequelize 和 Express.js 有基本的了解
1. 准备迁移
1.1. 理解迁移过程
无论您正在构建何种类型的应用程序或 API 层，从 Sequelize 迁移到 Prisma ORM 的步骤始终相同
- 安装 Prisma CLI
- 内省您的数据库
- 创建基线迁移
- 安装 Prisma Client
- 逐步使用 Prisma Client 替换您的 Sequelize 查询
这些步骤适用于构建 REST API（例如，使用 Express、Koa 或 NestJS）、GraphQL API（例如，使用 Apollo Server、TypeGraphQL 或 Nexus）或任何其他使用 Sequelize 进行数据库访问的应用程序类型。
1.2. 设置 Prisma 配置
创建一个新的 Prisma schema 文件
npx prisma init --output ../generated/prisma
该命令将为您创建一个名为 prisma 的新目录，其中包含以下文件
schema.prisma：您的 Prisma schema，指定您的数据库连接和模型.env：一个dotenv文件，用于将您的数据库连接 URL 配置为环境变量
当前的 Prisma schema 如下所示
// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
如果您正在使用 VS Code，请务必安装 Prisma VS Code 扩展，以获得语法高亮、格式化、自动补全以及更多酷炫功能。
使用您的数据库连接字符串更新 .env 文件中的 DATABASE_URL
DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE"
2. 迁移数据库 schema
2.1. 内省您的数据库
运行 Prisma 的内省功能，从现有数据库创建 Prisma schema
npx prisma db pull
这将生成一个包含您的数据库 schema 的 schema.prisma 文件。
2.2. 创建基线迁移
为了继续使用 Prisma Migrate 来演进您的数据库 schema，您需要为数据库设置基线。
首先，创建一个 migrations 目录，并在其中添加一个目录，名称为您首选的迁移名称。在本例中，我们将使用 0_init 作为迁移名称
mkdir -p prisma/migrations/0_init
接下来，使用 prisma migrate diff 生成迁移文件。使用以下参数
--from-empty：假设您从中迁移的数据模型是空的--to-schema-datamodel：使用datasource块中 URL 表示的当前数据库状态--script：输出一个 SQL 脚本
npx prisma migrate diff --from-empty --to-schema-datamodel prisma/schema.prisma --script > prisma/migrations/0_init/migration.sql
npx prisma migrate resolve --applied 0_init
该命令会将 0_init 标记为已应用，通过将其添加到 _prisma_migrations 表中。
现在您已为当前的数据库 schema 设置了基线。要对数据库 schema 进行进一步更改，您可以更新 Prisma schema 并使用 prisma migrate dev 将更改应用到数据库。
3. 更新应用程序代码
3.1. 安装 Prisma Client
下一步，您可以在项目中安装 Prisma Client，以便开始替换当前使用 Sequelize 进行的数据库查询
npm install @prisma/client
安装 Prisma Client 后，您可以生成 Prisma Client 代码
npx prisma generate
3.2. 替换 Sequelize 查询
在本节中，我们将基于示例 REST API 项目中的示例路由，展示一些从 Sequelize 迁移到 Prisma Client 的查询示例。要全面了解 Prisma Client API 与 Sequelize 的不同之处，请查看API 对比页面。
- Sequelize
- Prisma Client
// Find one
const user = await User.findOne({
where: { id: 1 }
});
// Create
const user = await User.create({
email: 'alice@prisma.io',
name: 'Alice'
});
// Update
await User.update({ name: 'New name' }, {
where: { id: 1 }
});
// Delete
await User.destroy({
where: { id: 1 }
});
// Find one
const user = await prisma.user.findUnique({
where: { id: 1 }
});
// Create
const user = await prisma.user.create({
data: {
email: 'alice@prisma.io',
name: 'Alice'
}
});
// Update
await prisma.user.update({
where: { id: 1 },
data: { name: 'New name' }
});
// Delete
await prisma.user.delete({
where: { id: 1 }
});
3.3. 更新控制器
更新您的 Express 控制器以使用 Prisma Client。例如，以下是如何更新用户控制器的示例
import { prisma } from '../client'
export class UserController {
async create(req: Request, res: Response) {
const { email, name } = req.body
const result = await prisma.user.create({
data: {
email,
name,
},
})
return res.json(result)
}
}
下一步
现在您已迁移到 Prisma ORM，您可以
- 使用 Prisma 强大的查询 API 添加更复杂的查询
- 设置 Prisma Studio 进行数据库管理
- 实施数据库监控
- 使用 Prisma 的测试工具添加自动化测试
更多信息
与 Prisma 保持联系
通过以下方式与我们联系，继续您的 Prisma 之旅 我们的活跃社区。保持信息畅通，参与其中，并与其他开发者协作
- 在 X 上关注我们 获取公告、直播活动和实用技巧。
- 加入我们的 Discord 提问、与社区交流，并通过对话获得积极支持。
- 在 YouTube 上订阅 观看教程、演示和直播。
- 在 GitHub 上互动 通过给仓库加星、报告问题或贡献代码。