自省

使用 Prisma ORM 自省你的数据库

在本指南中，我们将使用一个包含三个表的演示 SQL 模式

CREATE TABLE "User" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  name STRING(255),
  email STRING(255) UNIQUE NOT NULL
);

CREATE TABLE "Post" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  title STRING(255) UNIQUE NOT NULL,
  "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
  content STRING,
  published BOOLEAN NOT NULL DEFAULT false,
  "authorId" INT8 NOT NULL,
  FOREIGN KEY ("authorId") REFERENCES "User"(id)
);

CREATE TABLE "Profile" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  bio STRING,
  "userId" INT8 UNIQUE NOT NULL,
  FOREIGN KEY ("userId") REFERENCES "User"(id)
);

注意：某些字段用双引号括起来以确保 CockroachDB 使用正确的区分大小写。如果没有使用双引号，CockroachDB 将只读取所有内容为小写字符。

展开以查看表的图形概述

用户

列名	类型	主键	外键	必填	默认值
`id`	`INT8`	✔️	否	✔️	自动递增
`name`	`STRING(255)`	否	否	否	-
`email`	`STRING(255)`	否	否	✔️	-

帖子

列名	类型	主键	外键	必填	默认值
`id`	`INT8`	✔️	否	✔️	自动递增
`createdAt`	`TIMESTAMP`	否	否	✔️	`now()`
`title`	`STRING(255)`	否	否	✔️	-
`content`	`STRING`	否	否	否	-
`published`	`BOOLEAN`	否	否	✔️	`false`
`authorId`	`INT8`	否	✔️	✔️	-

个人资料

列名	类型	主键	外键	必填	默认值
`id`	`INT8`	✔️	否	✔️	自动递增
`bio`	`STRING`	否	否	否	-
`userId`	`INT8`	否	✔️	✔️	-

下一步，您将对数据库进行自省。自省的结果将在您的 Prisma 模式中生成一个数据模型。

运行以下命令对数据库进行自省

npx prisma db pull

此命令读取用于在您的schema.prisma中定义url的环境变量DATABASE_URL（在本例中，它设置在.env中）并连接到您的数据库。一旦建立连接，它就会对数据库进行自省（即读取数据库模式）。然后，它将数据库模式从 SQL 转换为 Prisma 数据模型。

自省完成后，您的 Prisma 模式将更新

Introspect your database

数据模型现在看起来类似于此

prisma/schema.prisma

model Post {
  id        BigInt   @id @default(autoincrement())
  title     String   @unique @db.String(255)
  createdAt DateTime @default(now()) @db.Timestamp(6)
  content   String?
  published Boolean  @default(false)
  authorId  BigInt
  User      User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model Profile {
  id     BigInt  @id @default(autoincrement())
  bio    String?
  userId BigInt  @unique
  User   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model User {
  id      BigInt   @id @default(autoincrement())
  name    String?  @db.String(255)
  email   String   @unique @db.String(255)
  Post    Post[]
  Profile Profile?
}

Prisma ORM 的数据模型是数据库模式的声明性表示，并作为生成的 Prisma Client 库的基础。您的 Prisma Client 实例将公开针对这些模型定制的查询。

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

User关系字段是大写的，因此不符合 Prisma 的命名约定。为了表达更多“语义”，如果将此字段命名为author来更好地描述User和Post之间的关系，将会更好。
User上的Post和Profile关系字段以及Profile上的User关系字段都是大写的。为了符合 Prisma 的命名约定，这两个字段都应更改为小写，即post、profile和user。
即使在更改为小写后，User上的post字段仍然命名略有不当。这是因为它实际上指的是一组帖子——因此更好的名称应该是复数形式：posts。

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

因为关系字段是虚拟的（即它们不会直接体现在数据库中），所以您可以在 Prisma 模式中手动重命名它们，而无需更改数据库

prisma/schema.prisma

model Post {
  id        BigInt   @id @default(autoincrement())
  title     String   @unique @db.String(255)
  createdAt DateTime @default(now()) @db.Timestamp(6)
  content   String?
  published Boolean  @default(false)
  authorId  BigInt
  author    User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model Profile {
  id     BigInt  @id @default(autoincrement())
  bio    String?
  userId BigInt  @unique
  user   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

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

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

使用自定义模型和字段名称

有时，您可能希望对 Prisma Client API 中公开的列和表的名称进行其他更改。一个常见的示例是将数据库模式中常用的snake_case表示法转换为对于 JavaScript/TypeScript 开发人员来说更自然的PascalCase和camelCase表示法。

假设您从基于snake_case表示法的自省中获得了以下模型

model my_user {
  user_id    Int     @id @default(sequence())
  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(sequence()) @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 自省你的数据库