从 MongoDB Beta 升级
介绍
本指南帮助您从 Prisma 1 MongoDB Beta 迁移到 Prisma ORM 2 或更高版本上的 MongoDB。要了解 Prisma 1 与 Prisma ORM 2.x 及更高版本之间的差异,请参阅本文档。
本指南的范围是为您提供执行迁移所需的工作流程,并强调您可能遇到的一些问题。
我们很遗憾无法涵盖所有可能的情况或所需的更改,但本指南应该能帮助您。如有任何问题,请加入我们的 Discord 或在 Github 上创建问题。
在生产环境中尝试之前,请在您的 staging 环境中执行此迁移!
要求
安装 Prisma ORM 3.12.0 或更高版本
在您的项目目录中运行以下命令
npm install prisma@latest && npm install @prisma/client
npx prisma init --datasource-provider=mongodb
这将创建以下文件
prisma/schema.prisma:初始 Prisma schema.env:您将存储连接字符串的环境文件
如果您看到以下错误
ERROR File schema.prisma already exists in your project.
Please try again in a project that is not yet using Prisma.
您的项目中可能已经存在一个 prisma/ 目录。将该目录重命名为 _prisma/ 之类的名称,然后重试
查找您的 MongoDB 数据库的连接字符串
接下来,您需要找到 MongoDB 数据库的连接字符串。您应该能够在 docker-compose.yml 文件或 MongoDB Atlas 上找到它。它就是您将传递给 MongoDB Compass 的内容。连接字符串应该类似于这样
mongodb://<user>:<pass>@<host>:27017
在 Prisma 1 中存储应用程序数据的数据库名为 default_default,因此我们将其添加到连接字符串的末尾并更新 .env 文件中的 DATABASE_URL 键
DATABASE_URL="mongodb://prisma:prisma@localhost:27017/default_default"
内省您的 MongoDB 数据库
您现在可以准备将数据库结构拉入您的 Prisma Schema。
$ npx prisma db pull
您应该会看到 prisma/schema.prisma 中的 Prisma schema 已填充您的模型。
如果您看到以下错误:Error in connector: SCRAM failure: Authentication failed.,请尝试在连接字符串的末尾添加 ?authSource=admin,然后重试。
修饰您的 Prisma Schema
从全新内省的基于 Prisma 1 的 MongoDB 数据库生成的 Prisma Client 可能没有最佳 API。您可以调整模型名称和字段,只需确保使用 @map 和 @@map 将原始名称映射到底层数据库集合和字段名称即可
- model posts {
+ model Post {
id String @id @default(auto()) @map("_id") @db.ObjectId
published Boolean
title String
+ @@map("posts")
}
- model users {
+ model User {
id String @id @default(auto()) @map("_id") @db.ObjectId
email String @unique(map: "email_U")
name String
- posts String[] @db.ObjectId
+ postIds String[] @db.ObjectId @map("posts")
@@index([posts], map: "posts_R")
+ @@map("users")
}
重命名时请务必小心,因为您需要确保 Prisma Schema 仍然正确映射到底层数据库集合和字段名称。
与 SQL 数据库不同,MongoDB 没有明确理解数据之间的关系。这意味着 Prisma ORM 的内省无法为您推断出这些关系。
我们通常建议借助此文档手动添加关系。然而,Prisma 1 存储外键的方式与 Prisma ORM 2 及更高版本期望外键的方式不同,因此如果您想利用关系,则需要在添加关系之前更改数据库上外键的位置。
💡 下载 Prisma VSCode 扩展以在您转换 Prisma schema 时提供自动完成和有用的错误消息。
生成 Prisma Client
Prisma schema 填充了数据模式后,您现在可以生成一个 Typescript Client 来读写您的 MongoDB 数据库。
$ npx prisma generate
测试读取
创建一个简单的 test.ts 脚本来验证 Prisma Client 是否可以读写您的应用程序。请注意,本指南使用的是 Prisma 1 示例仓库 中的示例,但代码会根据您的应用程序而改变。
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
await prisma.$connect()
const posts = await prisma.post.findMany()
console.log(posts)
}
main()
.catch(console.error)
.finally(() => prisma.$disconnect())
确保 ts-node 已全局安装并运行
ts-node test.ts
您应该会看到您的数据列表
[
{
comments: [],
id: '62435a83fca136000996ba16',
content: 'https://prisma.org.cn/day/',
published: true,
title: 'Join us for Prisma Day 2019 in Berlin',
wasCreated: 2022-03-29T19:14:11.172Z,
wasUpdated: 2022-03-29T19:14:11.172Z
},
{
comments: [ [Object] ],
id: '62435a83fca136000996ba18',
content: 'https://graphqlweekly.com/',
published: true,
title: 'Subscribe to GraphQL Weekly for community news',
wasCreated: 2022-03-29T19:14:11.369Z,
wasUpdated: 2022-03-29T19:14:11.369Z
},
{
comments: [],
id: '62435a83fca136000996ba1a',
content: 'https://twitter.com/prisma',
published: false,
title: 'Follow Prisma on Twitter',
wasCreated: 2022-03-29T19:14:11.375Z,
wasUpdated: 2022-03-29T19:14:11.375Z
}
]
测试写入
然后您可以修改 test.ts 来尝试写入
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
async function main() {
await prisma.$connect()
const user = await prisma.user.create({
data: {
email: 'alice@prisma.io',
name: 'Alice',
},
})
console.log(user)
}
main()
.catch(console.error)
.finally(() => prisma.$disconnect())
您应该会看到已创建了一个用户。
如果您看到以下错误
Prisma needs to perform transactions, which requires your MongoDB server to be run as a replica set. https://pris.ly/d/mongodb-replica-set
这意味着您的 MongoDB 数据库未作为副本集运行。请参阅上面的链接 以了解解决此问题的步骤。
升级您的应用程序
现在您已经拥有一个正常工作的 Prisma Client,您可以开始用最新的 Prisma Client 查询替换 Prisma Client 1 查询。Prisma Client 参考是学习如何使用最新 Prisma Client 的有用资源。
结论
希望这份简短的指南能帮助您走上正确的道路。如果您有任何问题或疑问,请告诉我们。我们非常感谢您多年来的支持。