跳至主要内容

如何从 Mongoose 迁移到 Prisma ORM

15 分钟

介绍​

本指南将向您展示如何将应用程序从 Mongoose 迁移到 Prisma ORM。我们将使用示例项目来演示迁移步骤。

Prisma ORM v7 的 MongoDB 支持

Prisma ORM v7 的 MongoDB 支持即将推出。在此期间，使用 MongoDB 时请使用 Prisma ORM v6.19（最新的 v6 版本）。

本指南使用 Prisma ORM v6.19 以确保与 MongoDB 的完全兼容性。

您可以在Prisma ORM 与 Mongoose页面上了解 Prisma ORM 与 Mongoose 的比较。

警告

本指南目前假设您正在使用 Prisma ORM v6。对 Prisma ORM v7 和 MongoDB 的支持正在进行中。

先决条件​

在开始本指南之前，请确保您已具备以下条件：

  • 您想要迁移的 Mongoose 项目
  • 安装了受支持版本的 Node.js
  • MongoDB 数据库（建议使用 4.2+ 和副本集部署）
  • 对 Mongoose 和 Express.js 有基本了解

1. 准备迁移​

1.1. 理解迁移过程​

从 Mongoose 迁移到 Prisma ORM 的步骤始终相同，无论您构建何种应用程序或 API 层

  1. 安装 Prisma CLI
  2. 内省您的数据库
  3. 安装并生成 Prisma Client
  4. 逐步用 Prisma Client 替换您的 Mongoose 查询

这些步骤适用于您正在构建 REST API（例如，使用 Express、Koa 或 NestJS）、GraphQL API（例如，使用 Apollo Server、TypeGraphQL 或 Nexus）或任何其他使用 Mongoose 进行数据库访问的应用程序。

1.2. 安装 Prisma 依赖项​

首先，安装所需的 Prisma 软件包

npm install prisma@6.19 @types/node --save-dev
npm install @prisma/client@6.19 dotenv
为什么选择 Prisma v6.19？

这是完全支持 MongoDB 的 Prisma ORM v6 最新稳定版本。Prisma ORM v7 对 MongoDB 的支持即将推出。

你也可以安装 prisma@6 和 @prisma/client@6 以自动获取最新的 v6 版本。

1.3. 设置 Prisma 配置​

创建一个新的 Prisma 模式文件

npx prisma init --datasource-provider mongodb --output ../generated/prisma

此命令创建

  • 一个名为 prisma 的新目录，其中包含一个 schema.prisma 文件；您的 Prisma 模式指定了您的数据库连接和模型
  • .env：项目根目录下的 dotenv 文件（如果尚不存在），用于将数据库连接 URL 配置为环境变量
  • prisma.config.ts：Prisma 配置文件

Prisma 模式使用 ESM-first prisma-client 生成器

prisma/schema.prisma
generator client {
  provider = "prisma-client"
  output   = "../generated/prisma"
}

datasource db {
  provider = "mongodb"
  url      = env("DATABASE_URL")
}

提示

为了获得最佳的 Prisma ORM 开发体验，请参阅编辑器设置以了解语法高亮、格式化、自动补全以及更多炫酷功能。

使用您的 MongoDB 连接字符串更新 .env 文件中的 DATABASE_URL

DATABASE_URL="mongodb+srv://username:password@cluster.mongodb.net/mydb"
提示

将 username、password、cluster 和 mydb 替换为您的实际 MongoDB 凭据和数据库名称。您可以从MongoDB Atlas或您的 MongoDB 部署中获取连接字符串。

1.4. 配置 Prisma​

生成的 prisma.config.ts 文件应如下所示

prisma.config.ts
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
  schema: 'prisma/schema.prisma',
  migrations: {
    path: 'prisma/migrations',
  },
  engine: "classic",
  datasource: {
    url: env('DATABASE_URL'),
  },
})

添加 dotenv 以从您的 .env 文件加载环境变量

prisma.config.ts
import 'dotenv/config'
import { defineConfig, env } from 'prisma/config'

export default defineConfig({
  schema: 'prisma/schema.prisma',
  migrations: {
    path: 'prisma/migrations',
  },
  engine: "classic",
  datasource: {
    url: env('DATABASE_URL'),
  },
})

2. 迁移数据库模式​

2.1. 内省您的数据库​

警告

MongoDB 是一个无模式数据库。为了在您的项目中逐步采用 Prisma ORM，请确保您的数据库已填充示例数据。Prisma ORM 通过采样存储的数据并从数据库中的数据推断模式来内省 MongoDB 模式。

运行 Prisma 的自省功能，从现有数据库创建 Prisma 模式

npx prisma db pull

这将创建一个包含您的数据库模式的 schema.prisma 文件。

prisma/schema.prisma
type UsersProfile {
  bio String
}

model categories {
  id   String @id @default(auto()) @map("_id") @db.ObjectId
  v    Int    @map("__v")
  name String
}

model posts {
  id         String   @id @default(auto()) @map("_id") @db.ObjectId
  v          Int      @map("__v")
  author     String   @db.ObjectId
  categories String[] @db.ObjectId
  content    String
  published  Boolean
  title      String
}

model users {
  id      String        @id @default(auto()) @map("_id") @db.ObjectId
  v       Int           @map("__v")
  email   String        @unique(map: "email_1")
  name    String
  profile UsersProfile?
}

2.2. 更新关系​

MongoDB 不支持不同集合之间的关系。但是，您可以使用ObjectId字段类型在文档之间创建引用，或使用集合中 ObjectId 数组从一个文档引用多个文档。该引用将存储相关文档的 ID。您可以使用 Mongoose 提供的 populate() 方法来用相关文档的数据填充引用。

按如下方式更新 posts <-> users 之间的一对多关系

  • 将 posts 模型中现有的 author 引用重命名为 authorId 并添加 @map("author") 属性
  • 在 posts 模型中添加 author 关系字段及其指定 fields 和 references 的 @relation 属性
  • 在 users 模型中添加 posts 关系

您的模式现在应该如下所示

schema.prisma
type UsersProfile {
  bio String
}

model categories {
  id   String @id @default(auto()) @map("_id") @db.ObjectId
  v    Int    @map("__v")
  name String
}

model posts {
  id        String  @id @default(auto()) @map("_id") @db.ObjectId
  title     String
  content   String
  published Boolean
  v         Int     @map("__v")
  author   String   @db.ObjectId
  author   users  @relation(fields: [authorId], references: [id])
  authorId String @map("author") @db.ObjectId

  categories String[] @db.ObjectId
}

model users {
  id      String        @id @default(auto()) @map("_id") @db.ObjectId
  v       Int           @map("__v")
  email   String        @unique(map: "email_1")
  name    String
  profile UsersProfile?
  posts   posts[]
}

然后，按如下方式更新 posts <-> categories 之间的多对多引用

  • 将 posts 模型中的 categories 字段重命名为 categoryIds 并使用 @map("categories") 进行映射
  • 在 posts 模型中添加一个新的 categories 关系字段
  • 在 categories 模型中添加 postIds 标量列表字段
  • 在 categories 模型中添加 posts 关系
  • 在两个模型上添加关系标量
  • 在两边添加指定 fields 和 references 参数的 @relation 属性

您的模式现在应该如下所示

schema.prisma
type UsersProfile {
  bio String
}

model categories {
  id   String @id @default(auto()) @map("_id") @db.ObjectId
  v    Int    @map("__v")
  name String
  posts    posts[]  @relation(fields: [postIds], references: [id])
  postIds String[] @db.ObjectId
}

model posts {
  id        String  @id @default(auto()) @map("_id") @db.ObjectId
  title     String
  content   String
  published Boolean
  v         Int     @map("__v")

  author   users  @relation(fields: [authorId], references: [id])
  authorId String @map("author") @db.ObjectId

  categories  String[] @db.ObjectId
  categories  categories[] @relation(fields: [categoryIds], references: [id])
  categoryIds String[] @map("categories") @db.ObjectId
}

model users {
  id      String        @id @default(auto()) @map("_id") @db.ObjectId
  v       Int           @map("__v")
  email   String        @unique(map: "email_1")
  name    String
  profile UsersProfile?
  posts   posts[]
}

3. 更新您的应用程序代码​

3.1. 生成 Prisma Client​

根据您的模式生成 Prisma Client

npx prisma generate

这将在 generated/prisma 目录中创建一个类型安全的 Prisma Client。

3.2. 替换 Mongoose 查询​

开始用 Prisma Client 替换您的 Mongoose 查询。以下是如何转换一些常见查询的示例

// Find one
const user = await User.findById(id);

// Create
const user = await User.create({
  email: 'alice@prisma.io',
  name: 'Alice'
});

// Update
await User.findByIdAndUpdate(id, { 
  name: 'New name' 
});

// Delete
await User.findByIdAndDelete(id);

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 之旅： 我们的活跃社区。保持信息灵通，参与其中，并与其他开发人员协作。

我们真诚地感谢你的参与，并期待你成为我们社区的一部分！

打开方式
复制为 Markdown
在 Claude 中打开
在 ChatGPT 中打开
在 T3.chat 中打开
在 GitHub 中编辑
© . This site is unofficial and not affiliated with Prisma Data, Inc.