内省

使用 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`	✔️	否	✔️	自动递增
`姓名`	`STRING(255)`	否	否	否	-
`电子邮件`	`STRING(255)`	否	否	✔️	-

帖子

列名	类型	主键	外键	必需	默认值
`id`	`INT8`	✔️	否	✔️	自动递增
`创建时间`	`TIMESTAMP`	否	否	✔️	`now()`
`标题`	`STRING(255)`	否	否	✔️	-
`内容`	`STRING`	否	否	否	-
`已发布`	`BOOLEAN`	否	否	✔️	`false`
`作者ID`	`INT8`	否	✔️	✔️	-

个人资料

列名	类型	主键	外键	必需	默认值
`id`	`INT8`	✔️	否	✔️	自动递增
`简介`	`STRING`	否	否	否	-
`用户ID`	`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 中公开的列和表的名称进行额外的更改。一个常见的例子是将数据库模式中经常使用的蛇形命名法转换为帕斯卡命名法和驼峰命名法，这对于 JavaScript/TypeScript 开发者来说感觉更自然。

假设您从内省中获得了以下基于蛇形命名法的模型

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

如果您为这个模型生成了一个 Prisma Client API，它会在其 API 中使用蛇形命名法

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 内省您的数据库