内省

您可以使用 Prisma CLI 内省您的数据库，以便在您的 Prisma schema 中生成数据模型。需要数据模型来生成 Prisma Client。

当将 Prisma ORM 添加到现有项目时，内省通常用于生成数据模型的初始版本。

但是，它也可以重复在应用程序中使用。当您不使用Prisma Migrate，而是使用纯 SQL 或其他迁移工具执行模式迁移时，这种情况最为常见。在这种情况下，您还需要重新内省您的数据库，然后重新生成 Prisma Client，以反映您的 Prisma Client API 中的模式更改。

内省有什么作用？

内省有一个主要功能：使用反映当前数据库模式的数据模型填充您的 Prisma schema。

Introspect your database with Prisma

以下是其在 SQL 数据库上的主要功能概述

将数据库中的表映射到 Prisma 模型
将数据库中的列映射到 Prisma 模型的字段
将数据库中的索引映射到 Prisma schema 中的索引
将数据库约束映射到 Prisma schema 中的属性或类型修饰符

在 MongoDB 上，主要功能如下

将数据库中的集合映射到 Prisma 模型。由于 MongoDB 中的集合没有预定义的结构，Prisma ORM 会采样集合中的文档，并相应地派生模型结构（即，它将文档的字段映射到 Prisma 模型的字段）。如果在集合中检测到嵌入式类型，这些类型将映射到 Prisma schema 中的复合类型。
如果集合中至少包含一个文档包含索引中包含的字段，则将数据库中的索引映射到 Prisma schema 中的索引

您可以访问数据源连接器的相应文档页面，了解有关 Prisma ORM 如何将类型从数据库映射到 Prisma schema 中可用类型的更多信息

`prisma db pull` 命令

您可以使用 Prisma CLI 的 prisma db pull 命令内省您的数据库。请注意，使用此命令需要您的连接 URL在您的 Prisma schema datasource 中设置。

以下是 prisma db pull 在内部执行的步骤的高级概述

从 Prisma schema 中的 datasource 配置中读取连接 URL
打开与数据库的连接
内省数据库模式（即读取表、列和其他结构 ...）
将数据库模式转换为 Prisma schema 数据模型
将数据模型写入 Prisma schema 或更新现有 schema

内省工作流程

不使用 Prisma Migrate，而是使用纯 SQL 或其他迁移工具的项目的典型工作流程如下

更改数据库模式（例如，使用纯 SQL）
运行 prisma db pull 以更新 Prisma schema
运行 prisma generate 以更新 Prisma Client
在您的应用程序中使用更新后的 Prisma Client

请注意，随着您发展应用程序，此过程可以无限次重复。

Introspect workflow

规则和约定

Prisma ORM 采用许多约定将数据库模式转换为 Prisma schema 中的数据模型

模型、字段和枚举名称

字段、模型和枚举名称（标识符）必须以字母开头，并且通常只能包含下划线、字母和数字。您可以在相应的文档页面上找到这些标识符中每一个的命名规则和约定

标识符的一般规则是它们需要遵守此正则表达式

[A-Za-z][A-Za-z0-9_]*

无效字符的清理

无效字符在内省期间被清理

如果它们出现在标识符中字母之前，则会被删除。
如果它们出现在第一个字母之后，则会被下划线替换。

此外，转换后的名称使用 @map 或 @@map 映射到数据库，以保留原始名称。

考虑以下表格作为示例

CREATE TABLE "42User" (
  _id SERIAL PRIMARY KEY,
  _name VARCHAR(255),
  two$two INTEGER
);

由于表格名称中开头的 42 以及列上开头的下划线和 $ 在 Prisma ORM 中是被禁止的，因此内省添加了 @map 和 @@map 属性，以便这些名称遵守 Prisma ORM 的命名约定

model User {
  id      Int     @id @default(autoincrement()) @map("_id")
  name    String? @map("_name")
  two_two Int?    @map("two$two")

  @@map("42User")
}

清理后重复的标识符

如果清理导致重复的标识符，则不会立即进行错误处理。您稍后会收到错误，并且可以手动修复它。

考虑以下两个表格的情况

CREATE TABLE "42User" (
  _id SERIAL PRIMARY KEY
);

CREATE TABLE "24User" (
  _id SERIAL PRIMARY KEY
);

这将导致以下内省结果

model User {
  id Int @id @default(autoincrement()) @map("_id")

  @@map("42User")
}

model User {
  id Int @id @default(autoincrement()) @map("_id")

  @@map("24User")
}

尝试使用 prisma generate 生成您的 Prisma Client，您将收到以下错误

npx prisma generate

显示CLI结果

$ npx prisma generate
Error: Schema parsing
error: The model "User" cannot be defined because a model with that name already exists.
  -->  schema.prisma:17
   |
16 | }
17 | model User {
   |

Validation Error Count: 1

在这种情况下，您必须手动更改两个生成的 User 模型之一的名称，因为 Prisma schema 中不允许重复的模型名称。

字段顺序

内省以与数据库中对应表格列相同的顺序列出模型字段。

属性顺序

内省按以下顺序添加属性（此顺序与 prisma format 相呼应）

块级别：@@id、@@unique、@@index、@@map
字段级别：@id、@unique、@default、@updatedAt、@map、@relation

关系

Prisma ORM 将在您的数据库表格上定义的外键转换为关系。

一对一关系

当表格上的外键具有 UNIQUE 约束时，Prisma ORM 会向您的数据模型添加一对一关系，例如

CREATE TABLE "User" (
    id SERIAL PRIMARY KEY
);
CREATE TABLE "Profile" (
    id SERIAL PRIMARY KEY,
    "user" integer NOT NULL UNIQUE,
    FOREIGN KEY ("user") REFERENCES "User"(id)
);

Prisma ORM 将其转换为以下数据模型

model User {
  id      Int      @id @default(autoincrement())
  Profile Profile?
}

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

一对多关系

默认情况下，对于在您的数据库模式中找到的外键，Prisma ORM 会向您的数据模型添加一对多关系

CREATE TABLE "User" (
    id SERIAL PRIMARY KEY
);
CREATE TABLE "Post" (
    id SERIAL PRIMARY KEY,
    "author" integer NOT NULL,
    FOREIGN KEY ("author") REFERENCES "User"(id)
);

这些表格被转换为以下模型

model User {
  id   Int    @id @default(autoincrement())
  Post Post[]
}

model Post {
  id     Int  @id @default(autoincrement())
  author Int
  User   User @relation(fields: [author], references: [id])
}

多对多关系

多对多关系通常在关系数据库中表示为关系表。

Prisma ORM 支持两种在 Prisma schema 中定义多对多关系的方式

隐式多对多关系（Prisma ORM 在后台管理关系表）
显式多对多关系（关系表作为模型存在）

如果隐式多对多关系符合 Prisma ORM 的关系表约定，则会被识别。否则，关系表在 Prisma schema 中呈现为模型（因此使其成为显式多对多关系）。

关于关系的文档页面广泛介绍了此主题。

消除关系歧义

如果不需要，Prisma ORM 通常会省略 @relation 属性上的 name 参数。考虑上一节中的 User ↔ Post 示例。 @relation 属性仅具有 references 参数，name 被省略，因为在这种情况下不需要它

model Post {
  id     Int  @id @default(autoincrement())
  author Int
  User   User @relation(fields: [author], references: [id])
}

如果在 Post 表上定义了两个外键，则需要它

CREATE TABLE "User" (
    id SERIAL PRIMARY KEY
);
CREATE TABLE "Post" (
    id SERIAL PRIMARY KEY,
    "author" integer NOT NULL,
    "favoritedBy" INTEGER,
    FOREIGN KEY ("author") REFERENCES "User"(id),
    FOREIGN KEY ("favoritedBy") REFERENCES "User"(id)
);

在这种情况下，Prisma ORM 需要使用专用的关系名称消除关系的歧义

model Post {
  id                          Int   @id @default(autoincrement())
  author                      Int
  favoritedBy                 Int?
  User_Post_authorToUser      User  @relation("Post_authorToUser", fields: [author], references: [id])
  User_Post_favoritedByToUser User? @relation("Post_favoritedByToUser", fields: [favoritedBy], references: [id])
}

model User {
  id                          Int    @id @default(autoincrement())
  Post_Post_authorToUser      Post[] @relation("Post_authorToUser")
  Post_Post_favoritedByToUser Post[] @relation("Post_favoritedByToUser")
}

请注意，您可以将Prisma-ORM 级别关系字段重命名为您喜欢的任何名称，以便在生成的 Prisma Client API 中看起来更友好。

使用现有 schema 进行内省

对于具有现有 Prisma Schema 的关系数据库，运行 prisma db pull 会合并对 schema 所做的手动更改以及数据库中所做的更改。（此功能已在 2.6.0 版本中首次添加。）对于 MongoDB，目前的内省仅用于初始数据模型进行一次。重复运行会导致自定义更改丢失，如下所列。

关系数据库的内省维护以下手动更改

model 块的顺序
enum 块的顺序
注释
@map 和 @@map 属性
@updatedAt
@default(cuid()) (cuid() 是 Prisma-ORM 级别函数)
@default(uuid()) (uuid() 是 Prisma-ORM 级别函数)
自定义 @relation 名称

注意：只会拾取数据库级别模型之间的关系。这意味着必须设置外键。

schema 的以下属性由数据库确定

model 块中字段的顺序
enum 块中值的顺序

注意：所有 enum 块都列在 model 块下方。

强制覆盖

要覆盖手动更改，并生成完全基于内省数据库的 schema 并忽略任何现有的 Prisma Schema，请将 --force 标志添加到 db pull 命令

npx prisma db pull --force

用例包括

您想从头开始使用从底层数据库生成的 schema
您有一个无效的 schema，并且必须使用 --force 才能使内省成功

仅内省数据库 schema 的子集

仅内省数据库 schema 的子集 Prisma ORM 尚未正式支持。

但是，您可以通过创建一个新的数据库用户来实现此目的，该用户仅有权访问您希望在 Prisma schema 中看到的表格，然后使用该用户执行内省。然后，内省将仅包括新用户有权访问的表格。

如果您的目标是从Prisma Client 生成中排除某些模型，则可以将 @@ignore 属性添加到您的 Prisma schema 中的模型定义。忽略的模型将从生成的 Prisma Client 中排除。

对不支持的功能的内省警告

Prisma Schema Language (PSL) 可以表达 Prisma ORM 支持的目标数据库的大部分数据库功能。但是，Prisma Schema Language 仍然需要表达某些功能和功能。

对于这些功能，Prisma CLI 将显示检测到您的数据库中使用了该功能并返回警告。 Prisma CLI 还将在 Prisma schema 中功能正在使用的模型和字段中添加注释。警告还将包含解决方法建议。

prisma db pull 命令将显示以下不受支持的功能

来自版本 4.13.0
来自版本 4.14.0
- 检查约束 (MySQL + PostgreSQL)
- 排除约束
- MongoDB $jsonSchema
来自版本 4.16.0
- 表达式索引

您可以在 GitHub (标记为 topic:database-functionality) 上找到我们打算支持的功能列表。

对不支持的功能的内省警告的解决方法

如果您正在使用关系数据库，并且使用了上一节中列出的上述功能之一

创建草稿迁移
```
npx prisma migrate dev --create-only
```
添加 SQL，以添加警告中显示的功能。
将草稿迁移应用于您的数据库
```
npx prisma migrate dev
```

内省有什么作用？​

prisma db pull 命令​

内省工作流程​

规则和约定​

模型、字段和枚举名称​

无效字符的清理​

清理后重复的标识符​

字段顺序​

属性顺序​

关系​

一对一关系​

一对多关系​

多对多关系​

消除关系歧义​

使用现有 schema 进行内省​

强制覆盖​

仅内省数据库 schema 的子集​

对不支持的功能的内省警告​

对不支持的功能的内省警告的解决方法​