跳到主内容

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

警告

多个数据库模式支持目前可通过 PostgreSQL、CockroachDB 和 SQL Server 连接器获得。

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

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

本指南将解释如何

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

如何启用 multiSchema 预览特性​

多模式支持目前处于预览阶段。要启用 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 应用你的模式更改​

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

例如，向上述博客文章模型所在的 base 模式添加一个 Profile 模型

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 Schema 更新为与数据库的当前状态相匹配。

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

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

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

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

了解更多关于 multiSchema 预览特性的信息​

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

© . All rights reserved.