イントロスペクション

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

このガイドの目的のために、3つのテーブルを持つデモSQLスキーマを使用します。

CREATE TABLE "User" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  name STRING(255),
  email STRING(255) UNIQUE NOT NULL
);

CREATE TABLE "Post" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  title STRING(255) UNIQUE NOT NULL,
  "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
  content STRING,
  published BOOLEAN NOT NULL DEFAULT false,
  "authorId" INT8 NOT NULL,
  FOREIGN KEY ("authorId") REFERENCES "User"(id)
);

CREATE TABLE "Profile" (
  id INT8 PRIMARY KEY DEFAULT unique_rowid(),
  bio STRING,
  "userId" INT8 UNIQUE NOT NULL,
  FOREIGN KEY ("userId") REFERENCES "User"(id)
);

注記: 一部のフィールドは、CockroachDBが適切なケーシングを使用するように二重引用符で囲まれています。二重引用符を使用しない場合、CockroachDBはすべて小文字として読み取ります。

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

User

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

Post

カラム名	型	主キー	外部キー	必須	デフォルト
`id`	`INT8`	✔️	いいえ	✔️	自動インクリメント
`createdAt`	`TIMESTAMP`	いいえ	いいえ	✔️	`now()`
`title`	`STRING(255)`	いいえ	いいえ	✔️	-
`content`	`STRING`	いいえ	いいえ	いいえ	-
`published`	`BOOLEAN`	いいえ	いいえ	✔️	`false`
`authorId`	`INT8`	いいえ	✔️	✔️	-

Profile

カラム名	型	主キー	外部キー	必須	デフォルト
`id`	`INT8`	✔️	いいえ	✔️	自動インクリメント
`bio`	`STRING`	いいえ	いいえ	いいえ	-
`userId`	`INT8`	いいえ	✔️	✔️	-

次のステップとして、データベースをイントロスペクトします。イントロスペクションの結果は、Prismaスキーマ内のデータモデルになります。

データベースをイントロスペクトするには、次のコマンドを実行します。

npx prisma db pull

このコマンドは、schema.prismaのurlを定義するために使用される環境変数DATABASE_URLを読み取ります。この変数は、このケースでは.envに設定されており、データベースに接続します。接続が確立されると、データベースをイントロスペクトします（つまり、データベーススキーマを読み取ります）。次に、データベーススキーマをSQLからPrismaデータモデルに変換します。

イントロスペクションが完了すると、Prismaスキーマが更新されます。

Introspect your database

データモデルは次のようになります。

prisma/schema.prisma

model Post {
  id        BigInt   @id @default(autoincrement())
  title     String   @unique @db.String(255)
  createdAt DateTime @default(now()) @db.Timestamp(6)
  content   String?
  published Boolean  @default(false)
  authorId  BigInt
  User      User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model Profile {
  id     BigInt  @id @default(autoincrement())
  bio    String?
  userId BigInt  @unique
  User   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model User {
  id      BigInt   @id @default(autoincrement())
  name    String?  @db.String(255)
  email   String   @unique @db.String(255)
  Post    Post[]
  Profile Profile?
}

Prisma ORMのデータモデルは、データベーススキーマの宣言的な表現であり、生成されたPrisma Clientライブラリの基盤として機能します。Prisma Clientインスタンスは、これらのモデルに合わせて調整されたクエリを公開します。

現在、データモデルにはいくつかの小さな「問題」があります。

Userリレーションフィールドは大文字で始まり、Prismaの命名規則に準拠していません。より多くの「セマンティクス」を表現するために、このフィールドがUserとPost間の関係をより良く記述するためにauthorと呼ばれると良いでしょう。
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        BigInt   @id @default(autoincrement())
  title     String   @unique @db.String(255)
  createdAt DateTime @default(now()) @db.Timestamp(6)
  content   String?
  published Boolean  @default(false)
  authorId  BigInt
  author    User     @relation(fields: [authorId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model Profile {
  id     BigInt  @id @default(autoincrement())
  bio    String?
  userId BigInt  @unique
  user   User    @relation(fields: [userId], references: [id], onDelete: NoAction, onUpdate: NoAction)
}

model User {
  id      BigInt   @id @default(autoincrement())
  name    String?  @db.String(255)
  email   String   @unique @db.String(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(sequence())
  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(sequence()) @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でデータベースをイントロスペクトする