跳到主要内容

视图

警告

对视图的支持目前是一个非常早期的预览功能。您可以使用 view 关键字将视图添加到 Prisma schema，或使用 db pull 内省数据库 schema 中的视图。您目前无法使用 Prisma Migrate 和 db push 将 schema 中的视图应用于数据库，除非使用 --create-only 标志手动将更改添加到迁移文件中。

有关此功能进度的更新，请关注我们的 GitHub issue。

数据库视图允许您命名和存储查询。在关系数据库中，视图是存储的 SQL 查询，可能包含多个表中的列或计算值（如聚合）。在 MongoDB 中，视图是可查询的对象，其内容由其他集合上的聚合管道定义。

views 预览功能允许您使用 view 关键字在 Prisma schema 中表示视图。要在 Prisma ORM 中使用视图，请遵循以下步骤：

启用 views 预览功能​

对视图的支持目前处于早期预览阶段。要启用 views 预览功能，请将 views 功能标志添加到 Prisma Schema 中 generator 块的 previewFeatures 字段中

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

请在我们的专门的 views 预览功能反馈 issue中留下对此预览功能的反馈。

在底层数据库中创建视图​

目前，您无法使用 Prisma Migrate 和 db push 将您在 Prisma schema 中定义的视图应用于数据库。相反，您必须首先在底层数据库中创建视图，无论是手动创建还是作为迁移的一部分。

例如，考虑以下 Prisma schema，其中包含一个 User 模型和一个相关的 Profile 模型

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  profile Profile?
}

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

接下来，在底层数据库中创建一个 UserInfo 视图，它结合了 User 模型的 email 和 name 字段以及 Profile 模型的 bio 字段。

对于关系数据库，创建此视图的 SQL 语句是

CREATE VIEW "UserInfo" AS
    SELECT u.id, email, name, bio
    FROM "User" u
    LEFT JOIN "Profile" p ON u.id = p."userId";

对于 MongoDB，您可以使用以下命令创建视图

db.createView('UserInfo', 'User', [
  {
    $lookup: {
      from: 'Profile',
      localField: '_id',
      foreignField: 'userId',
      as: 'ProfileData',
    },
  },
  {
    $project: {
      _id: 1,
      email: 1,
      name: 1,
      bio: '$ProfileData.bio',
    },
  },
  { $unwind: '$bio' },
])

将视图与 Prisma Migrate 和 db push 配合使用​

如果您使用 Prisma Migrate 或 db push 应用对 Prisma schema 的更改，Prisma ORM 不会创建或运行任何与视图相关的 SQL。

要在迁移中包含视图，请运行 migrate dev --create-only，然后手动将视图的 SQL 添加到您的迁移文件中。或者，您也可以在数据库中手动创建视图。

将视图添加到您的 Prisma schema​

要将视图添加到您的 Prisma schema，请使用 view 关键字。

您可以如下在 Prisma schema 中表示上面示例中的 UserInfo 视图

view UserInfo {
  id    Int    @unique
  email String
  name  String
  bio   String
}

手动编写​

一个 view 块由两部分组成

  • view 块定义
  • 视图的字段定义

这两部分允许您定义在生成的 Prisma Client 中视图的名称以及视图查询结果中存在的列。

定义 view 块​

要定义上面示例中的 UserInfo 视图，首先使用 view 关键字在您的 schema 中定义一个名为 UserInfo 的 view 块

view UserInfo {
  // Fields
}

定义字段​

视图的属性称为字段，它们包括

  • 字段名称
  • 字段类型

UserInfo 示例视图的字段可以定义如下

view UserInfo {
  id    Int    @unique
  email String
  name  String
  bio   String
}

view 块的每个字段都代表底层数据库中视图查询结果中的一列。

使用内省​

警告

目前仅适用于 PostgreSQL、MySQL、SQL Server 和 CockroachDB。

如果您在数据库中定义了一个或多个现有视图，内省将自动在您的 Prisma schema 中生成表示这些视图的 view 块。

假设示例 UserInfo 视图存在于您的底层数据库中，运行以下命令将在您的 Prisma schema 中生成一个表示该视图的 view 块

npx prisma db pull

生成的 view 块将定义如下

/// The underlying view does not contain a valid unique identifier and can therefore currently not be handled by Prisma Client.
view UserInfo {
  id    Int?
  email String?
  name  String?
  bio   String?

  @@ignore
}

view 块最初生成时带有一个 @@ignore 属性，因为没有定义唯一标识符（这是目前视图预览功能的限制）。

警告

请注意，目前 db pull 仅在使用 PostgreSQL、MySQL、SQL Server 或 CockroachDB 时内省您的 schema 中的视图。对其他数据库提供商的支持将扩展此工作流。

向内省视图添加唯一标识符​

为了能够在 Prisma Client 中使用内省视图，您需要选择并定义一个或多个字段作为唯一标识符。

在上述视图的情况下，id 列指的是底层 User 表中唯一可标识的字段，因此该字段也可以用作 view 块中唯一可标识的字段。

为了使此 view 块有效，您需要

  • 从 id 字段中移除可选标志 ?
  • 将 @unique 属性添加到 id 字段
  • 移除 @@ignore 属性
  • 移除生成的关于无效视图的警告注释
/// The underlying view does not contain a valid unique identifier and can therefore currently not be handled by Prisma Client.
view UserInfo {
  id    Int?
  id    Int    @unique
  email String?
  name  String?
  bio   String?
  
  @@ignore
}

重新内省数据库时，您对视图定义的任何自定义更改都将保留。

views 目录​

内省一个或多个现有视图的数据库还将在您的 prisma 目录中创建一个新的 views 目录（从 Prisma 4.12.0 版本开始）。此目录将包含一个以您的数据库 schema 命名的子目录，其中包含该 schema 中每个内省视图的 .sql 文件。每个文件都将以单个视图命名，并包含相关视图定义的查询。

例如，在使用上述模型内省具有默认 public schema 的数据库后，您将发现创建了一个 prisma/views/public/UserInfo.sql 文件，其内容如下

SELECT
  u.id,
  u.email,
  u.name,
  p.bio
FROM
  (
    "User" u
    LEFT JOIN "Profile" p ON ((u.id = p."userId"))
  );

限制​

唯一标识符​

目前，Prisma ORM 将视图视为模型。这意味着视图需要至少有一个唯一标识符，可以由以下任何一种表示

  • 使用@unique表示的唯一约束
  • 使用@@unique表示的复合唯一约束
  • @id 字段
  • 使用@@id表示的复合标识符

在关系数据库中，视图的唯一标识符可以定义为一个字段上的 @unique 属性，或多个字段上的 @@unique 属性。如果可能，最好使用 @unique 或 @@unique 约束而不是 @id 或 @@id 字段。

然而，在 MongoDB 中，唯一标识符必须是一个 @id 属性，通过 @map("_id") 映射到底层数据库中的 _id 字段。

在上面的示例中，id 字段具有 @unique 属性。如果底层 User 表中的另一列被定义为唯一标识符并在视图的查询结果中可用，则可以使用该列作为唯一标识符。

内省​

目前，视图的内省仅适用于 PostgreSQL、MySQL、SQL Server 和 CockroachDB。如果您正在使用其他数据库提供商，您的视图必须手动添加。

这是一个临时限制，内省支持将扩展到其他受支持的数据源提供商。

在 Prisma Client 中查询视图​

您可以在 Prisma Client 中像查询模型一样查询视图。例如，以下查询在上面定义的 UserInfo 视图中查找所有 name 为 'Alice' 的用户。

const userinfo = await prisma.userInfo.findMany({
  where: {
    name: 'Alice',
  },
})

目前，Prisma Client 允许您在底层数据库允许的情况下更新视图，而无需任何额外的验证。

特殊类型的视图​

本节介绍如何在数据库中将 Prisma ORM 与可更新视图和物化视图一起使用。

可更新视图​

一些数据库支持可更新视图（例如 PostgreSQL、MySQL 和 SQL Server）。可更新视图允许您创建、更新或删除条目。

目前 Prisma ORM 将所有 view 都视为可更新视图。如果底层数据库支持视图的此功能，则操作应该成功。如果视图未标记为可更新，数据库将返回错误，Prisma Client 将抛出此错误。

将来，Prisma Client 可能会支持将单个视图标记为可更新或不可更新。请在我们的views 反馈 issue中评论您的用例。

物化视图​

一些数据库支持物化视图，例如 PostgreSQL、CockroachDB、MongoDB 和 SQL Server（其中它们被称为“索引视图”）。

物化视图持久化视图查询的结果以实现更快访问，并且仅在需要时更新。

目前，Prisma ORM 不支持物化视图。然而，当您手动创建视图时，您也可以使用底层数据库中相应的命令创建物化视图。然后，您可以使用 Prisma Client 的类型化 SQL 功能来执行命令并手动刷新视图。

将来 Prisma Client 可能会支持将单个视图标记为物化视图，并添加 Prisma Client 方法来刷新物化视图。请在我们的views 反馈 issue中评论您的用例。

© . All rights reserved.