內省

使用 Prisma ORM 內省您的資料庫

為了本指南的目的，我們將使用包含三個表格的示範 SQL 結構描述

CREATE TABLE User (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  name VARCHAR(255),
  email VARCHAR(255) UNIQUE NOT NULL
);

CREATE TABLE Post (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  title VARCHAR(255) NOT NULL,
  createdAt TIMESTAMP NOT NULL DEFAULT now(),
  content TEXT,
  published BOOLEAN NOT NULL DEFAULT false,
  authorId INTEGER NOT NULL,
  FOREIGN KEY (authorId) REFERENCES User(id)
);

CREATE TABLE Profile (
  id INTEGER PRIMARY KEY AUTO_INCREMENT NOT NULL,
  bio TEXT,
  userId INTEGER UNIQUE NOT NULL,
  FOREIGN KEY (userId) REFERENCES User(id)
);

展開以查看表格的圖形化概覽

User

欄位名稱	類型	主鍵	外鍵	必要	預設
`id`	`INTEGER`	✔️	否	✔️	自動遞增
`name`	`VARCHAR(255)`	否	否	否	-
`email`	`VARCHAR(255)`	否	否	✔️	-

Post

欄位名稱	類型	主鍵	外鍵	必要	預設
`id`	`INTEGER`	✔️	否	✔️	自動遞增
`createdAt`	`DATETIME(3)`	否	否	✔️	`now()`
`title`	`VARCHAR(255)`	否	否	✔️	-
`content`	`TEXT`	否	否	否	-
`published`	`BOOLEAN`	否	否	✔️	`false`
`authorId`	`INTEGER`	否	✔️	✔️	`false`

Profile

欄位名稱	類型	主鍵	外鍵	必要	預設
`id`	`INTEGER`	✔️	否	✔️	自動遞增
`bio`	`TEXT`	否	否	否	-
`userId`	`INTEGER`	否	✔️	✔️	-

作為下一步，您將內省您的資料庫。內省的結果將會是 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(0)
  content   String?  @db.Text
  published Boolean  @default(false)
  authorId  Int
  User      User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Post_ibfk_1")

  @@index([authorId], map: "authorId")
}

model Profile {
  id     Int     @id @default(autoincrement())
  bio    String? @db.Text
  userId Int     @unique(map: "userId")
  User   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Profile_ibfk_1")
}

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

資訊

有關結構描述定義的詳細資訊，請參閱 Prisma 結構描述參考。

Prisma ORM 的資料模型是您的資料庫結構描述的宣告式表示，並且作為產生的 Prisma Client 函式庫的基礎。您的 Prisma Client 實例將公開針對這些模型量身定制的查詢。

目前，資料模型存在一些小的「問題」

User 關聯欄位為大寫，因此不符合 Prisma 的命名慣例。為了表達更多「語義」，如果此欄位被稱為 author 以更好地描述 User 和 Post 之間的關係，也會更好。
User 上的 Post 和 Profile 關聯欄位以及 Profile 上的 User 關聯欄位均為大寫。為了符合 Prisma 的命名慣例，這兩個欄位都應小寫為 post、profile 和 user。
即使在小寫之後，User 上的 post 欄位仍然略有誤稱。那是因為它實際上指的是一個 posts 列表 – 因此更好的名稱應該是複數形式：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(0)
  content   String?  @db.Text
  published Boolean  @default(false)
  authorId  Int
  author    User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Post_ibfk_1")

  @@index([authorId], map: "authorId")
}

model Profile {
  id     Int     @id @default(autoincrement())
  bio    String? @db.Text
  userId Int     @unique(map: "userId")
  user   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction, map: "Profile_ibfk_1")
}

model User {
  id      Int      @id @default(autoincrement())
  name    String?  @db.VarChar(255)
  email   String   @unique(map: "email") @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 頁面上了解更多資訊。

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

使用 Prisma ORM 內省您的資料庫