如何从 Sequelize 迁移到 Prisma ORM
简介
本指南向您展示如何将您的应用程序从 Sequelize 迁移到 Prisma ORM。我们将使用 Sequelize Express 示例 的扩展版本作为 示例项目 来演示迁移步骤。
本迁移指南使用 PostgreSQL 作为示例数据库，但它同样适用于 Prisma ORM 支持的 任何其他关系数据库。您可以在 Prisma ORM 与 Sequelize 对比 页面上了解 Prisma ORM 与 Sequelize 的比较。
先决条件
在开始本指南之前，请确保您已拥有
- 您想要迁移的 Sequelize 项目
- 已安装 Node.js（版本 18 或更高版本）
- PostgreSQL 或另一个受支持的数据库
- 基本熟悉 Sequelize 和 Express.js
1. 准备迁移
1.1. 了解迁移过程
从 Sequelize 迁移到 Prisma ORM 的步骤始终相同，无论您构建的是哪种应用程序或 API 层
- 安装 Prisma CLI
- 内省您的数据库
- 创建基线迁移
- 安装 Prisma Client
- 逐步将您的 Sequelize 查询替换为 Prisma Client
无论您是构建 REST API（例如，使用 Express、Koa 或 NestJS）、GraphQL API（例如，使用 Apollo Server、TypeGraphQL 或 Nexus）还是任何其他使用 Sequelize 进行数据库访问的应用程序，这些步骤都适用。
1.2. 设置 Prisma 配置
创建一个新的 Prisma schema 文件
npx prisma init
此命令为您创建了一个名为 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
该命令将通过将其添加到 _prisma_migrations 表中来标记 0_init 为已应用。
您现在拥有当前数据库 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 查询
在本节中，我们将展示一些示例查询，这些查询正在从 Sequelize 迁移到 Prisma Client，基于示例 REST API 项目中的示例路由。有关 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: '[email protected]',
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: '[email protected]',
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 的测试实用程序添加自动化测试
更多信息和更新