跳到主要内容

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

警告

目前，Prisma 支持通过 PostgreSQL、CockroachDB 和 SQL Server 连接器使用多个数据库模式。

许多数据库提供商允许你将数据库表组织成命名组。你可以利用这一点来使数据模型的逻辑结构更易于理解，或者避免表之间的命名冲突。

在 PostgreSQL、CockroachDB 和 SQL Server 中，这些组被称为模式（schemas）。我们将它们称为 数据库模式，以区别于 Prisma ORM 自身的模式。

本指南讲解了如何

  • 在 Prisma schema 中包含多个数据库模式
  • 使用 Prisma Migrate 和 db push 将 schema 更改应用到数据库
  • 自省包含多个数据库模式的现有数据库
  • 使用 Prisma Client 跨多个数据库模式进行查询

如何启用 multiSchema 预览功能​

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

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

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

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

要在 Prisma schema 文件中使用多个数据库模式，请将数据库模式的名称添加到 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 schema 中将表名映射到唯一的模型名称。这可以在你使用 Prisma Client 查询模型时避免命名冲突。

例如，考虑 base 数据库模式中的 config 表与 users 数据库模式中的 config 表同名的情况。为了避免命名冲突，请在你的 Prisma schema 中为模型提供唯一的名称（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 应用 schema 更改​

你可以使用 Prisma Migrate 或 db push 将更改应用到包含多个数据库模式的 Prisma schema。

例如，将一个 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")
}

然后你可以将此 schema 更改应用到数据库。例如，你可以使用 migrate dev 创建并应用 schema 更改作为迁移

npx prisma migrate dev --name add_profile

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

如何自省包含多个数据库模式的现有数据库​

你可以像自省单个数据库模式的数据库一样，使用 db pull 自省包含多个数据库模式的现有数据库

npx prisma db pull

这将更新你的 Prisma schema，使其与数据库的当前状态一致。

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

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

你可以在多个数据库模式中查询模型，而无需更改 Prisma Client 查询语法。例如，以下查询使用上述 Prisma schema 查找给定用户的所有订单

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

了解有关 multiSchema 预览功能的更多信息​

要了解有关 multiSchema 预览功能的未来计划或提供反馈，请参阅我们的 Github Issue。