跳到主要内容

在 JavaScript 项目中对 PlanetScale 进行内省

JavaScript
PlanetScale

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

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

CREATE TABLE `Post` (
  `id` int NOT NULL AUTO_INCREMENT,
  `createdAt` datetime(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
  `updatedAt` datetime(3) NOT NULL,
  `title` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL,
  `content` varchar(191) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `published` tinyint(1) NOT NULL DEFAULT '0',
  `authorId` int NOT NULL,
  PRIMARY KEY (`id`),
  KEY `Post_authorId_idx` (`authorId`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE TABLE `Profile` (
  `id` int NOT NULL AUTO_INCREMENT,
  `bio` varchar(191) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `userId` int NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `Profile_userId_key` (`userId`),
  KEY `Profile_userId_idx` (`userId`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

CREATE TABLE `User` (
  `id` int NOT NULL AUTO_INCREMENT,
  `email` varchar(191) COLLATE utf8mb4_unicode_ci NOT NULL,
  `name` varchar(191) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `User_email_key` (`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
展开查看表的图形概述

Post

列名类型主键外键必需默认值
idint✔️否✔️自增
createdAtdatetime(3)否否✔️now()
updatedAtdatetime(3)否否✔️
titlevarchar(255)否否✔️-
contentvarchar(191)否否否-
publishedtinyint(1)否否✔️false
authorIdint否否✔️-

Profile

列名类型主键外键必需默认值
idint✔️否✔️自增
biovarchar(191)否否否-
userIdint否否✔️-

User

列名类型主键外键必需默认值
idint✔️否✔️自增
namevarchar(191)否否否-
emailvarchar(191)否否✔️-

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

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

npx prisma db pull

此命令读取在 `.env` 中定义的 `DATABASE_URL` 环境变量并连接到您的数据库。连接建立后，它会内省数据库（即_读取数据库 schema_）。然后它将 SQL 数据库 schema 转换为 Prisma 数据模型。

内省完成后，您的 Prisma schema 将被更新

Introspect your database

数据模型现在看起来类似于这样

prisma/schema.prisma
model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime
  title     String   @db.VarChar(255)
  content   String?
  published Boolean  @default(false)
  authorId  Int

  @@index([authorId])
}

model Profile {
  id     Int     @id @default(autoincrement())
  bio    String?
  userId Int     @unique

  @@index([userId])
}

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}
信息

有关 schema 定义的详细信息，请参阅Prisma schema 参考。

Prisma 的数据模型是您的数据库 schema 的声明性表示，并作为生成的 Prisma Client 库的基础。您的 Prisma Client 实例将暴露_为这些模型量身定制_的查询。

然后，您需要使用关系字段添加数据之间任何缺失的关系

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

  @@index([authorId])
}

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

  @@index([userId])
}

model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  name    String?
  posts   Post[]
  profile Profile?
}

在此之后，再次对您的数据库运行内省

npx prisma db pull

Prisma Migrate 现在将保留手动添加的关系字段。

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

在此示例中，数据库 schema 遵循 Prisma ORM 模型的命名约定。这优化了生成的 Prisma Client API 的人体工程学。

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

然而，有时您可能希望对 Prisma Client API 中暴露的列和表的名称进行额外更改。一个常见的例子是将数据库 schema 中常用的_蛇形命名法_转换为 JavaScript/TypeScript 开发者感觉更自然的_帕斯卡命名法_和_驼峰命名法_。

假设您从内省中获得了以下基于_蛇形命名法_的模型

model my_user {
  user_id    Int     @id @default(autoincrement())
  first_name String?
  last_name  String  @unique
}

如果您为该模型生成 Prisma Client API，它将在其 API 中采用_蛇形命名法_

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.