イントロスペクション
Prisma ORMは、指定されたデータベースに保存されているデータをサンプリングし、そのデータのスキーマを推測することで、MongoDBスキーマをイントロスペクトします。
イントロスペクションを説明するために、このガイドではMongoDBをゼロからセットアップする方法を説明します。すでにMongoDBデータベースをお持ちの場合は、プロジェクトの「Prisma ORMの初期化」にスキップしてください。
データベースのセットアップ
実際に動作を確認するには、まずblog
データベースと2つのコレクション(User
とPost
)を作成します。セットアップにはMongoDB Compassをお勧めします。
まず、ユーザーをUser
コレクションに追加します。
次に、いくつかの投稿をPost
コレクションに追加します。userId
のObjectIDが、上記で作成したユーザーと一致していることが重要です。
Prisma ORMの初期化
MongoDBデータベースができたので、次のステップは新しいプロジェクトを作成し、Prisma ORMを初期化することです。
mkdir blog
cd blog
npm init -y
npm install -D prisma
npx prisma init --datasource-provider mongodb --output ../generated/prisma
Prisma ORMを初期化すると、次のようなprisma/schema.prisma
ファイルが作成されます。
datasource db {
provider = "mongodb"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
次に、DATABASE_URL
がMongoDBデータベースを指すように、.env
ファイルを調整する必要があります。
Prisma ORMを使用したMongoDBのイントロスペクション
これでイントロスペクションの準備ができました。次のコマンドを実行してデータベースをイントロスペクトします。
npx prisma db pull
このコマンドはデータベースをイントロスペクトし、推測されたスキーマをprisma/schema.prisma
ファイルに書き込みます。
datasource db {
provider = "mongodb"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
model Post {
id String @id @default(auto()) @map("_id") @db.ObjectId
title String
userId String @db.ObjectId
}
model User {
id String @id @default(auto()) @map("_id") @db.ObjectId
email String
}
スキーマの調整
Prisma Clientを使用してデータを結合できるようにするには、モデルに@relation
属性を追加できます。
datasource db {
provider = "mongodb"
url = env("DATABASE_URL")
}
generator client {
provider = "prisma-client-js"
}
model Post {
id String @id @default(auto()) @map("_id") @db.ObjectId
title String
userId String @db.ObjectId
user User @relation(fields: [userId], references: [id])
}
model User {
id String @id @default(auto()) @map("_id") @db.ObjectId
email String
posts Post[]
}
現在、MongoDBのイントロスペクションに積極的に取り組んでいます。この機能に関するフィードバックは、こちらのissueでお寄せください。
これで、Prisma Clientを生成する準備ができました。