跳至主要内容

内省

使用 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;
展开以查看表的图形概述

用户

列名类型主键外键必需默认值
idINT✔️✔️自动递增
nameNVARCHAR(1000)-
emailNVARCHAR(1000)✔️-

帖子

列名类型主键外键必需默认值
idINT✔️✔️自动递增
createdAtDATETIME2✔️now()
updatedAtDATETIME2✔️
titleVARCHAR(255)✔️-
contentNVARCHAR(1000)-
publishedBIT✔️false
authorIdINT✔️✔️-

个人资料

列名类型主键外键必需默认值
idINT✔️✔️自动递增
bioNVARCHAR(1000)-
userIdINT✔️✔️-

下一步,您将内省您的数据库。内省的结果将是您 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,以更好地 *描述* UserPost 之间的关系。
  • User 上的 PostProfile 关系字段以及 Profile 上的 User 关系字段都是大写的。为了符合 Prisma 的 命名约定,这两个字段都应该小写为 postprofileuser
  • 即使小写后,User 上的 post 字段仍然有一点命名错误。这是因为它实际上是指 帖子列表 - 因此更好的名称应该是复数形式:posts

这些更改与生成的 Prisma Client API 相关,在该 API 中,使用小写的关系字段 authorpostsprofileuser 将对 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* 符号转换为 *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 页面上了解更多信息。