跳至主要内容

如何使用 Prisma ORM 与多个数据库模式

警告

多个数据库模式支持目前可用于 PostgreSQL、CockroachDB 和 SQL Server 连接器。

许多数据库提供商允许您将数据库表组织到命名组中。您可以使用此功能使数据模型的逻辑结构更易于理解，或避免表之间的命名冲突。

在 PostgreSQL、CockroachDB 和 SQL Server 中，这些组称为模式。我们将它们称为数据库模式，以将它们与 Prisma ORM 自己的模式区分开来。

本指南介绍如何

  • 在您的 Prisma 模式中包含多个数据库模式
  • 使用 Prisma Migrate 和 db push 将模式更改应用于您的数据库
  • 内省具有多个数据库模式的现有数据库
  • 使用 Prisma Client 跨多个数据库模式查询

如何启用 multiSchema 预览功能​

多模式支持目前处于预览阶段。要启用 multiSchema 预览功能，请将 multiSchema 功能标志添加到 Prisma 模式中 generator 块的 previewFeatures 字段

schema.prisma
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["multiSchema"]
}

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

如何在 Prisma 模式中包含多个数据库模式​

要在 Prisma 模式文件中使用多个数据库模式，请将数据库模式的名称添加到 datasource 块中 schemas 字段的数组中。以下示例添加了 "base" 和 "transactional" 模式

schema.prisma
generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["multiSchema"]
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
  schemas  = ["base", "transactional"]
}

您无需更改连接字符串。连接字符串的 schema 值是 Prisma Client 连接到的并用于原始查询的默认数据库模式。所有其他 Prisma Client 查询都使用您正在查询的模型或枚举的模式。

要指定模型或枚举属于特定数据库模式，请使用 @@schema 属性并将其参数设置为数据库模式的名称。在以下示例中，User 模型是 "base" 模式的一部分，而 Order 模型和 Size 枚举是 "transactional" 模式的一部分

schema.prisma
model User {
  id     Int     @id
  orders Order[]

  @@schema("base")
}

model Order {
  id      Int  @id
  user    User @relation(fields: [id], references: [id])
  user_id Int

  @@schema("transactional")
}

enum Size {
  Small
  Medium
  Large

  @@schema("transactional")
}

不同数据库模式中名称相同的表​

如果在不同的数据库模式中具有名称相同的表，则需要将表名映射到 Prisma 模式中的唯一模型名称。这可以避免在 Prisma Client 中查询模型时发生名称冲突。

例如，考虑一种情况，其中 base 数据库模式中的 config 表与 users 数据库模式中的 config 表具有相同的名称。为了避免名称冲突，请在 Prisma 模式中为模型提供唯一的名称（BaseConfig 和 UserConfig），并使用 @@map 属性将每个模型映射到相应的表名

schema.prisma
model BaseConfig {
  id Int @id

  @@map("config")
  @@schema("base")
}

model UserConfig {
  id Int @id

  @@map("config")
  @@schema("users")
}

如何使用 Prisma Migrate 和 db push 应用模式更改​

您可以使用 Prisma Migrate 或 db push 将更改应用于具有多个数据库模式的 Prisma 模式。

例如，将 Profile 模型添加到上面博客文章模型的 base 模式

schema.prisma
model User {
  id      Int      @id
  orders  Order[]
  profile Profile?

  @@schema("base")
}

model Profile {
  id     Int    @id @default(autoincrement())
  bio    String
  user   User   @relation(fields: [userId], references: [id])
  userId Int    @unique

  @@schema("base")
}

model Order {
  id      Int  @id
  user    User @relation(fields: [id], references: [id])
  user_id Int

  @@schema("transactional")
}

enum Size {
  Small
  Medium
  Large

  @@schema("transactional")
}

然后，您可以将此模式更改应用于您的数据库。例如，您可以使用 migrate dev 创建并应用模式更改作为迁移

npx prisma migrate dev --name add_profile

请注意，如果您将模型或枚举从一个模式移动到另一个模式，Prisma ORM 会从源模式中删除模型或枚举，并在目标模式中创建一个新的模型或枚举。

如何内省具有多个数据库模式的现有数据库​

您可以使用 db pull 以与内省具有单个数据库模式的数据库相同的方式内省具有多个数据库模式的现有数据库。

npx prisma db pull

这会更新您的 Prisma 模式以匹配数据库的当前状态。

如果在不同的数据库模式中具有名称相同的表，Prisma ORM 会显示一个验证错误，指出冲突。要解决此问题，请使用 @map 属性重命名内省的模型。

如何使用 Prisma Client 跨多个数据库模式查询​

您可以查询多个数据库模式中的模型，而无需更改 Prisma Client 查询语法。例如，以下查询查找给定用户的全部订单，使用上面的 Prisma 模式

const orders = await prisma.order.findMany({
  where: {
    user: {
      id: 1,
    },
  },
})

详细了解 multiSchema 预览功能​

要详细了解 multiSchema 预览功能的未来计划，或提供反馈，请参阅我们的 Github 问题。