Prisma ORM、JavaScript、PostgreSQLによるベースライン
初期マイグレーションを作成する
前セクションでイントロスペクトしたデータベースでPrisma Migrateを使用するには、データベースをベースライン化する必要があります。
ベースライン化とは、既にデータが含まれており、リセットできない可能性のあるデータベース(本番データベースなど)のマイグレーション履歴を初期化することを指します。ベースライン化は、1つ以上のマイグレーションが既にデータベースに適用されているとPrisma Migrateに仮定させます。
データベースをベースライン化するには、prisma migrate diff
を使用してスキーマとデータベースを比較し、その出力をSQLファイルに保存します。
まず、migrations
ディレクトリを作成し、その中にマイグレーションの任意の名前でディレクトリを追加します。この例では、マイグレーション名として0_init
を使用します。
mkdir -p prisma/migrations/0_init
-p
は、指定したパス内の不足しているフォルダを再帰的に作成します。
次に、prisma migrate diff
を使用してマイグレーションファイルを生成します。以下の引数を使用します。
--from-empty
: マイグレーション元のデータモデルが空であると仮定します。--to-schema-datamodel
:datasource
ブロック内のURLを使用して現在のデータベースの状態を表します。--script
: SQLスクリプトを出力します。
npx prisma migrate diff --from-empty --to-schema-datamodel prisma/schema.prisma --script > prisma/migrations/0_init/migration.sql
マイグレーションを確認する
このコマンドは、以下のスクリプトに似たマイグレーションを生成します。
-- CreateTable
CREATE TABLE "Post" (
"id" SERIAL NOT NULL,
"title" VARCHAR(255) NOT NULL,
"createdAt" TIMESTAMP(6) NOT NULL DEFAULT CURRENT_TIMESTAMP,
"content" TEXT,
"published" BOOLEAN NOT NULL DEFAULT false,
"authorId" INTEGER NOT NULL,
CONSTRAINT "Post_pkey" PRIMARY KEY ("id")
);
-- CreateTable
CREATE TABLE "Profile" (
"id" SERIAL NOT NULL,
"bio" TEXT,
"userId" INTEGER NOT NULL,
CONSTRAINT "Profile_pkey" PRIMARY KEY ("id")
);
-- CreateTable
CREATE TABLE "User" (
"id" SERIAL NOT NULL,
"name" VARCHAR(255),
"email" VARCHAR(255) NOT NULL,
CONSTRAINT "User_pkey" PRIMARY KEY ("id")
);
-- CreateIndex
CREATE UNIQUE INDEX "Profile_userId_key" ON "Profile"("userId");
-- CreateIndex
CREATE UNIQUE INDEX "User_email_key" ON "User"("email");
-- AddForeignKey
ALTER TABLE "Post" ADD CONSTRAINT "Post_authorId_fkey" FOREIGN KEY ("authorId") REFERENCES "User"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
-- AddForeignKey
ALTER TABLE "Profile" ADD CONSTRAINT "Profile_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User"("id") ON DELETE NO ACTION ON UPDATE NO ACTION;
SQLマイグレーションファイルを確認し、すべてが正しいことを確認します。
次に、prisma migrate resolve
に--applied
引数を使用して、マイグレーションを適用済みとしてマークします。
npx prisma migrate resolve --applied 0_init
このコマンドは、_prisma_migrations
テーブルに0_init
を追加することで、適用済みとしてマークします。
これで、現在のデータベーススキーマのベースラインができました。データベーススキーマにさらなる変更を加えるには、Prismaスキーマを更新し、prisma migrate dev
を使用してその変更をデータベースに適用できます。