内省

使用 Prisma ORM 内省数据库

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

CREATE TABLE [dbo].[Post] (
    [id] INT NOT NULL IDENTITY(1,1),
    [createdAt] DATETIME2 NOT NULL CONSTRAINT [Post_createdAt_df] DEFAULT CURRENT_TIMESTAMP,
    [updatedAt] DATETIME2 NOT NULL,
    [title] VARCHAR(255) NOT NULL,
    [content] NVARCHAR(1000),
    [published] BIT NOT NULL CONSTRAINT [Post_published_df] DEFAULT 0,
    [authorId] INT NOT NULL,
    CONSTRAINT [Post_pkey] PRIMARY KEY ([id])
);

CREATE TABLE [dbo].[Profile] (
    [id] INT NOT NULL IDENTITY(1,1),
    [bio] NVARCHAR(1000),
    [userId] INT NOT NULL,
    CONSTRAINT [Profile_pkey] PRIMARY KEY ([id]),
    CONSTRAINT [Profile_userId_key] UNIQUE ([userId])
);

CREATE TABLE [dbo].[User] (
    [id] INT NOT NULL IDENTITY(1,1),
    [email] NVARCHAR(1000) NOT NULL,
    [name] NVARCHAR(1000),
    CONSTRAINT [User_pkey] PRIMARY KEY ([id]),
    CONSTRAINT [User_email_key] UNIQUE ([email])
);

ALTER TABLE [dbo].[Post] ADD CONSTRAINT [Post_authorId_fkey] FOREIGN KEY ([authorId]) REFERENCES [dbo].[User]([id]) ON DELETE NO ACTION ON UPDATE CASCADE;

ALTER TABLE [dbo].[Profile] ADD CONSTRAINT [Profile_userId_fkey] FOREIGN KEY ([userId]) REFERENCES [dbo].[User]([id]) ON DELETE NO ACTION ON UPDATE CASCADE;

展开查看表的图形概览

用户

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

文章

列名	类型	主键	外键	必需	默认值
`id`	`INT`	✔️	否	✔️	自增
`createdAt`	`DATETIME2`	否	否	✔️	`now()`
`updatedAt`	`DATETIME2`	否	否	✔️
`title`	`VARCHAR(255)`	否	否	✔️	-
`content`	`NVARCHAR(1000)`	否	否	否	-
`published`	`BIT`	否	否	✔️	`false`
`authorId`	`INT`	否	✔️	✔️	-

Profile

列名	类型	主键	外键	必需	默认值
`id`	`INT`	✔️	否	✔️	自增
`bio`	`NVARCHAR(1000)`	否	否	否	-
`userId`	`INT`	否	✔️	✔️	-

下一步，你将内省数据库。内省的结果将在你的 Prisma 模式中生成一个数据模型。

运行以下命令内省数据库

npx prisma db pull

该命令读取在 .env 中定义的 DATABASE_URL 环境变量并连接到你的数据库。连接建立后，它将内省数据库（即，它读取数据库模式）。然后将数据库模式从 SQL 转换为 Prisma 数据模型。

内省完成后，你的 Prisma 模式将更新

Introspect your database

数据模型现在看起来像这样（注意：模型中的字段已重新排序以提高可读性）

prisma/schema.prisma

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

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

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

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

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

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

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

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

prisma/schema.prisma

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

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

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique @db.VarChar(255)
  name    String?  @db.VarChar(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(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 内省数据库