跳到主内容

如何在团队中管理 Schema 变更

10 分钟

引言​

在团队中工作时，管理数据库 Schema 变更是具有挑战性的。本指南将向您展示如何使用 Prisma Migrate 有效地协作进行 Schema 变更，确保所有团队成员都能安全地贡献和合并 Schema 变更。

先决条件​

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

  • 已安装 Node.js (版本 18 或更高)
  • 已设置并包含迁移的 Prisma 项目
  • 一个关系型数据库 (PostgreSQL, MySQL, SQLite, SQL Server 等)
  • 对 Git 有基本了解
  • 对 Prisma Migrate 有基本熟悉
警告

本指南不适用于 MongoDB。
对于 MongoDB，使用 db push 而不是 migrate dev。

1. 理解迁移基础知识​

1.1. 迁移顺序​

迁移按照创建顺序应用。创建日期是迁移子文件夹名称的一部分 - 例如，20210316081837-updated-fields 是在 2021-03-16-08:18:37 创建的。

1.2. 版本控制要求​

您应该将以下文件提交到版本控制：

  • .prisma/migrations 文件夹的内容，包括 migration_lock.toml 文件
  • Prisma Schema (schema.prisma)

仅对 schema.prisma 文件进行版本控制是不够的 - 您必须包含您的迁移历史，因为：

  • 自定义迁移包含无法在 Prisma Schema 中表示的信息
  • prisma migrate deploy 命令只运行迁移文件

2. 合并团队变更​

2.1. 拉取最新变更​

要合并协作者的变更：

  1. 拉取已更改的 Prisma schema 和 ./prisma/migrations 文件夹
  2. 运行 migrate 命令
npx prisma migrate dev

2.2. 示例场景​

让我们通过一个三个开发者共享 schema 变更的示例场景

schema.prisma
model Post {
  id        Int     @id @default(autoincrement())
  title     String
  content   String?
  published Boolean @default(false)
  author    User?   @relation(fields: [authorId], references: [id])
  authorId  Int?
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

3. 处理并行变更​

3.1. 开发者 A 的变更​

Ania 添加了一个新字段

model User {
  /* ... */
  favoriteColor String?
}

并生成了一个迁移

npx prisma migrate dev --name new-field

3.2. 开发者 B 的变更​

Javier 添加了一个新模型

model Tag {
  tagName     String   @id
  tagCategory Category
}

并生成了一个迁移

npx prisma migrate dev --name new-model

3.3. 合并变更​

迁移历史现在有两个新的迁移

A diagram showing changes by two separate developers converging in a single migration history.

4. 集成您的变更​

4.1. 拉取团队变更​

  1. 拉取最新的变更

    • 两个新的迁移
    • 更新的 schema 文件

  2. 审查合并后的 schema

model User {
  /* ... */
  favoriteColor   String?
  bestPacmanScore Int?
}

model Tag {
  tagName     String   @id
  tagCategory Category
  posts       Post[]
}

4.2. 生成您的迁移​

运行 migrate 命令

npx prisma migrate dev

这将

  1. 应用您团队的迁移
  2. 为您的变更创建一个新的迁移
  3. 应用您的新迁移

4.3. 提交变更​

提交

  • 合并后的 schema.prisma
  • 您的新迁移文件

下一步​

现在您已经了解了团队 schema 管理，您可以：

更多信息


与 Prisma 保持联系

通过联系以下方式继续您的 Prisma 之旅： 我们的活跃社区。及时了解信息、参与其中并与其他开发者协作

我们真心珍视您的参与，并期待您成为我们社区的一员！