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

warning

目前，PostgreSQL、CockroachDB 和 SQL Server 连接器提供多数据库模式支持。

¥Multiple database schema support is currently available with the PostgreSQL, CockroachDB, and SQL Server connectors.

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

¥Many database providers allow you to organize database tables into named groups. You can use this to make the logical structure of the data model easier to understand, or to avoid naming collisions between tables.

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

¥In PostgreSQL, CockroachDB, and SQL Server, these groups are known as schemas. We will refer to them as database schemas to distinguish them from Prisma ORM's own schema.

本指南解释了如何：

¥This guide explains how to:

• 在 Prisma 模式中包含多个数据库模式

  ¥include multiple database schemas in your Prisma schema

• 使用 Prisma Migrate 和 db push 将架构更改应用到数据库

  ¥apply your schema changes to your database with Prisma Migrate and db push

• 使用多个数据库模式内省现有数据库

  ¥introspect an existing database with multiple database schemas

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

  ¥query across multiple database schemas with Prisma Client

如何启用 multiSchema 预览功能

¥How to enable the multiSchema preview feature

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

¥Multi-schema support is currently in preview. To enable the multiSchema preview feature, add the multiSchema feature flag to the previewFeatures field of the generator block in your Prisma Schema:

schema.prisma

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

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

如何在 Prisma 架构中包含多个数据库架构

¥How to include multiple database schemas in your Prisma schema

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

¥To use multiple database schemas in your Prisma schema file, add the names of your database schemas to an array in the schemas field, in the datasource block. The following example adds a "base" and a "transactional" schema:

schema.prisma

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

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

你不需要更改连接字符串。连接字符串的 schema 值是 Prisma 客户端连接到并用于原始查询的默认数据库架构。所有其他 Prisma 客户端查询都使用你正在查询的模型或枚举的架构。

¥You do not need to change your connection string. The schema value of your connection string is the default database schema that Prisma Client connects to and uses for raw queries. All other Prisma Client queries use the schema of the model or enum that you are querying.

要指定模型或枚举属于特定数据库模式，请添加 @@schema 属性并将数据库模式名称作为参数。在以下示例中，User 模型是 "base" 架构的一部分，Order 模型和 Size 枚举是 "transactional" 架构的一部分：

¥To designate that a model or enum belongs to a specific database schema, add the @@schema attribute with the name of the database schema as a parameter. In the following example, the User model is part of the "base" schema, and the Order model and Size enum are part of the "transactional" schema:

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")
}

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

¥Tables with the same name in different database schemas

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

¥If you have tables with the same name in different database schemas, you will need to map the table names to unique model names in your Prisma schema. This avoids name conflicts when you query models in Prisma Client.

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

¥For example, consider a situation where the config table in the base database schema has the same name as the config table in the users database schema. To avoid name conflicts, give the models in your Prisma schema unique names (BaseConfig and UserConfig) and use the @@map attribute to map each model to the corresponding table name:

schema.prisma

model BaseConfig {
  id Int @id

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

model UserConfig {
  id Int @id

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

如何使用 Prisma Migrate 和 db push 应用架构更改

¥How to apply your schema changes with Prisma Migrate and db push

你可以使用 Prisma Migrate 或 db push 将更改应用到具有多个数据库架构的 Prisma 架构。

¥You can use Prisma Migrate or db push to apply changes to a Prisma schema with multiple database schemas.

例如，将 Profile 模型添加到上面博客文章模型的 base 架构中：

¥As an example, add a Profile model to the base schema of the blog post model above:

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 创建架构更改并将其应用为迁移：

¥You can then apply this schema change to your database. For example, you can use migrate dev to create and apply your schema changes as a migration:

npx prisma migrate dev --name add_profile

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

¥Note that if you move a model or enum from one schema to another, Prisma ORM deletes the model or enum from the source schema and creates a new one in the target schema.

如何使用多个数据库模式内省现有数据库

¥How to introspect an existing database with multiple database schemas

你可以使用 db pull 内省具有多个数据库模式的现有数据库，就像内省具有单个数据库模式的数据库一样：

¥You can introspect an existing database that has multiple database schemas in the same way that you introspect a database that has a single database schema, using db pull:

npx prisma db pull

这会更新你的 Prisma 架构以匹配数据库的当前状态。

¥This updates your Prisma schema to match the current state of the database.

如果不同数据库模式中有同名的表，Prisma ORM 会显示一条验证错误，指出存在冲突。为了解决这个问题，使用 @map 属性重命名内省模型.

¥If you have tables with the same name in different database schemas, Prisma ORM shows a validation error pointing out the conflict. To fix this, rename the introspected models with the @map attribute.

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

¥How to query across multiple database schemas with Prisma Client

你可以在多个数据库模式中查询模型，而无需对 Prisma 客户端查询语法进行任何更改。例如，以下查询使用上面的 Prisma 架构查找给定用户的所有订单：

¥You can query models in multiple database schemas without any change to your Prisma Client query syntax. For example, the following query finds all orders for a given user, using the Prisma schema above:

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

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

¥Learn more about the multiSchema preview feature

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

¥To learn more about future plans for the multiSchema preview feature, or to give feedback, refer to our Github issue.