イントロスペクション

Prisma ORMでデータベースをイントロスペクトする

このガイドの目的のために、3つのテーブルを持つデモ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)
);

テーブルのグラフィカルな概要を展開

ユーザー

カラム名	タイプ	主キー	外部キー	必須	デフォルト
`id`	`INTEGER`	✔️	いいえ	✔️	自動インクリメント
`name`	`VARCHAR(255)`	いいえ	いいえ	いいえ	-
`email`	`VARCHAR(255)`	いいえ	いいえ	✔️	-

投稿

カラム名	タイプ	主キー	外部キー	必須	デフォルト
`id`	`INTEGER`	✔️	いいえ	✔️	自動インクリメント
`createdAt`	`DATETIME(3)`	いいえ	いいえ	✔️	`now()`
`title`	`VARCHAR(255)`	いいえ	いいえ	✔️	-
`content`	`TEXT`	いいえ	いいえ	いいえ	-
`published`	`BOOLEAN`	いいえ	いいえ	✔️	`false`
`authorId`	`INTEGER`	いいえ	✔️	✔️	`false`

プロフィール

カラム名	タイプ	主キー	外部キー	必須	デフォルト
`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でしょう。

これらの変更は、生成された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表記を、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でデータベースをイントロスペクトする