在 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;

展開以查看錶的圖形概覽

使用者

列名	型別	主鍵	外部索引鍵	必需	預設值
`id`	`INT`	✔️	否	✔️	自增
`name`	`NVARCHAR(1000)`	否	否	否	-
`email`	`NVARCHAR(1000)`	否	否	✔️	-

文章

列名	型別	主鍵	外部索引鍵	必需	預設值
`id`	`INT`	✔️	否	✔️	自增
`createdAt`	`DATETIME2`	否	否	✔️	`now()`
`updatedAt`	`DATETIME2`	否	否	✔️
`title`	`VARCHAR(255)`	否	否	✔️	-
`content`	`NVARCHAR(1000)`	否	否	否	-
`已釋出`	`BIT`	否	否	✔️	`false`
`authorId`	`INT`	否	✔️	✔️	-

個人資料

列名	型別	主鍵	外部索引鍵	必需	預設值
`id`	`INT`	✔️	否	✔️	自增
`bio`	`NVARCHAR(1000)`	否	否	否	-
`userId`	`INT`	否	✔️	✔️	-

下一步，您將對資料庫進行自省。自省的結果將是您 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 頁面上了解更多資訊。

使用 Prisma ORM 自省您的資料庫​

使用 Prisma ORM 自省您的資料庫