内省

使用 Prisma ORM 内省你的数据库

在本指南中，我们将使用一个包含三个表的示例 SQL schema。

CREATE TABLE User (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  name VARCHAR(255),
  email VARCHAR(255) UNIQUE NOT NULL
);

CREATE TABLE Post (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  title VARCHAR(255) NOT NULL,
  createdAt TIMESTAMP NOT NULL DEFAULT now(),
  content TEXT,
  published BOOLEAN NOT NULL DEFAULT false,
  authorId INTEGER NOT NULL,
  FOREIGN KEY (authorId) REFERENCES User(id)
);

CREATE TABLE Profile (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  bio TEXT,
  userId INTEGER UNIQUE NOT NULL,
  FOREIGN KEY (userId) REFERENCES User(id)
);

展开查看表的图形概览

User

列名	类型	主键	外键	必需	默认值
`id`	`INTEGER`	✔️	否	✔️	自增
`name`	`VARCHAR(255)`	否	否	否	-
`email`	`VARCHAR(255)`	否	否	✔️	-

Post

列名	类型	主键	外键	必需	默认值
`id`	`INTEGER`	✔️	否	✔️	自增
`createdAt`	`DATETIME(3)`	否	否	✔️	`now()`
`title`	`VARCHAR(255)`	否	否	✔️	-
`content`	`TEXT`	否	否	否	-
`published`	`BOOLEAN`	否	否	✔️	`false`
`authorId`	`INTEGER`	否	✔️	✔️	`false`

Profile

列名	类型	主键	外键	必需	默认值
`id`	`INTEGER`	✔️	否	✔️	自增
`bio`	`TEXT`	否	否	否	-
`userId`	`INTEGER`	否	✔️	✔️	-

下一步，你将内省你的数据库。内省的结果将是你的 Prisma schema 中的一个数据模型。

运行以下命令来内省你的数据库

npx prisma db pull

此命令会读取 `.env` 文件中定义的 `DATABASE_URL` 环境变量并连接到你的数据库。连接建立后，它会内省数据库（即读取数据库 schema）。然后它会将 SQL 数据库 schema 转换成 Prisma 数据模型。

内省完成后，你的 Prisma schema 将会更新

Introspect your database

现在数据模型看起来与此类似（请注意，模型上的字段已重新排序以提高可读性）

prisma/schema.prisma

model Post {
  id        Int      @id @default(autoincrement())
  title     String   @db.VarChar(255)
  createdAt DateTime @default(now()) @db.Timestamp(0)
  content   String?  @db.Text
  published Boolean  @default(false)
  authorId  Int
  User      User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Post_ibfk_1")

  @@index([authorId], map: "authorId")
}

model Profile {
  id     Int     @id @default(autoincrement())
  bio    String? @db.Text
  userId Int     @unique(map: "userId")
  User   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Profile_ibfk_1")
}

model User {
  id      Int      @id @default(autoincrement())
  name    String?  @db.VarChar(255)
  email   String   @unique(map: "email") @db.VarChar(255)
  Post    Post[]
  Profile Profile?
}

信息

有关 schema 定义的详细信息，请参阅Prisma schema 参考。

Prisma ORM 的数据模型是数据库 schema 的声明性表示，并作为生成的 Prisma Client 库的基础。你的 Prisma Client 实例将暴露根据这些模型定制的查询。

现在，数据模型中存在一些小“问题”

`User` 关系字段是大写的，因此不符合 Prisma 的命名约定。为了表达更多“语义”，如果这个字段被命名为 `author` 以更好地描述 `User` 和 `Post` 之间的关系，那就更好了。
`User` 上的 `Post` 和 `Profile` 关系字段以及 `Profile` 上的 `User` 关系字段都是大写的。为了符合 Prisma 的命名约定，这两个字段都应该小写为 `post`、`profile` 和 `user`。
即使小写后， `User` 上的 `post` 字段仍然有点命名不当。这是因为它实际上引用了一系列posts – 因此，更好的名称应该是复数形式： `posts`。

这些更改与生成的 Prisma Client API 相关，在其中使用小写的关系字段 `author`、`posts`、`profile` 和 `user` 对于 JavaScript/TypeScript 开发者来说会感觉更自然和符合习惯用法。因此，你可以配置你的 Prisma Client API。

由于关系字段是虚拟的（即它们并非直接体现在数据库中），你可以在 Prisma schema 中手动重命名它们，而无需改动数据库

prisma/schema.prisma

model Post {
  id        Int      @id @default(autoincrement())
  title     String   @db.VarChar(255)
  createdAt DateTime @default(now()) @db.Timestamp(0)
  content   String?  @db.Text
  published Boolean  @default(false)
  authorId  Int
  author    User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Post_ibfk_1")

  @@index([authorId], map: "authorId")
}

model Profile {
  id     Int     @id @default(autoincrement())
  bio    String? @db.Text
  userId Int     @unique(map: "userId")
  user   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Profile_ibfk_1")
}

model User {
  id      Int      @id @default(autoincrement())
  name    String?  @db.VarChar(255)
  email   String   @unique(map: "email") @db.VarChar(255)
  posts   Post[]
  profile Profile?
}

在此示例中，数据库 schema 遵循了 Prisma ORM 模型的命名约定（只有通过内省生成的虚拟关系字段不符合要求，需要调整）。这优化了生成的 Prisma Client API 的易用性。

然而，有时你可能希望对 Prisma Client API 中暴露的列和表的名称进行额外更改。一个常见的例子是将数据库 schema 中常用的 snake_case 命名法转换为 PascalCase 和 camelCase 命名法，这对于 JavaScript/TypeScript 开发者来说更自然。

假设你从内省中获得了基于 snake_case 命名法的以下模型

model my_user {
  user_id    Int     @id @default(autoincrement())
  first_name String?
  last_name  String  @unique
}

如果你为此模型生成了 Prisma Client API，它将在其 API 中沿用 snake_case 命名法

const user = await prisma.my_user.create({
    data: {
        first_name: 'Alice',
        last_name: 'Smith',
    },
})

如果你不想在 Prisma Client API 中使用数据库中的表名和列名，你可以通过@map 和 @@map 来配置它们。

model MyUser {
  userId    Int     @id @default(autoincrement()) @map("user_id")
  firstName String? @map("first_name")
  lastName  String  @unique @map("last_name")

  @@map("my_user")
}

通过这种方法，你可以随意命名你的模型及其字段，并使用 @map （用于字段名）和 @@map （用于模型名）指向底层的表和列。你的 Prisma Client API 现在看起来如下所示

const user = await prisma.myUser.create({
    data: {
        firstName: 'Alice',
        lastName: 'Smith',
    },
})

在配置你的 Prisma Client API 页面了解更多信息。

使用 Prisma ORM 内省你的数据库​

使用 Prisma ORM 内省你的数据库