跳到主要内容

在 TypeScript 项目中对 SQL Server 进行自省

TypeScript
SQL Server

使用 Prisma ORM 自省您的数据库​

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

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)否否否-
已发布BIT否否✔️false
authorIdINT否✔️✔️-

个人资料

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

下一步，您将对数据库进行自省。自省的结果将是您 Prisma schema 中的一个数据模型。

运行以下命令以自省您的数据库

npx prisma db pull

此命令读取在 .env 中定义的 DATABASE_URL 环境变量并连接到您的数据库。连接建立后，它会自省数据库（即读取数据库 Schema）。然后，它将数据库 Schema 从 SQL 转换为 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(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 的数据模型是数据库 Schema 的声明性表示，并作为生成的 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 Schema 中手动重命名它们而无需更改数据库。

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?
}

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

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

然而，有时您可能希望对 Prisma Client API 中公开的列和表的名称进行额外更改。一个常见的例子是将数据库 Schema 中常用的 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 页面上了解更多信息。

© . All rights reserved.