内省

你可以使用 Prisma CLI 对你的数据库进行内省，以便在你的数据模型中生成 Prisma 模式。数据模型是生成 Prisma Client 所必需的。

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

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

内省的作用是什么？

内省的主要功能是：使用反映当前数据库模式的数据模型填充你的 Prisma 模式。

Introspect your database with Prisma

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

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

在 MongoDB 上，主要功能如下

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

你可以在数据源连接器的相应文档页面上详细了解 Prisma ORM 如何将数据库中的类型映射到 Prisma 模式中可用的类型

`prisma db pull` 命令

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

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

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

内省工作流程

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

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

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

Introspect workflow

规则和约定

Prisma ORM 采用了一些约定来将数据库模式转换为 Prisma 模式中的数据模型

模型、字段和枚举名称

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

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

[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 模式不允许重复的模型名称。

字段顺序

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

属性顺序

内省按以下顺序添加属性（此顺序由 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 的子集

Prisma ORM尚不支持仅内省数据库 Schema 的子集。

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

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

不支持的功能的内省警告

Prisma Schema 语言 (PSL) 可以表达 Prisma ORM 支持的目标数据库的大多数数据库功能。但是，Prisma Schema 语言仍然需要表达一些功能和特性。

对于这些功能，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 的子集​

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

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