Prismaのシャドウデータベースの動作を確認してみる

version: '3'

volumes:
  prisma-main-db-volume:
  prisma-shadow-db-volume:
services:
  prisma-main-db:
    image: postgres:17.0-alpine
    ports:
      - 5440:5432
    environment:
      POSTGRES_USER: test
      POSTGRES_PASSWORD: test
      TZ: 'Asia/Tokyo'
    volumes:
      - prisma-main-db-volume:/var/lib/postgresql/data

  prisma-shadow-db:
    image: postgres:17.0-alpine
    ports:
      - 5441:5432
    environment:
      POSTGRES_USER: test
      POSTGRES_PASSWORD: test
      TZ: 'Asia/Tokyo'
    volumes:
      - prisma-shadow-db-volume:/var/lib/postgresql/data

npm install prisma --save-dev

npx prisma init --datasource-provider postgresql --output ../generated/prisma

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
  shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
}

DATABASE_URL="postgresql://test:test@127.0.0.1:5440/postgres?schema=public"
SHADOW_DATABASE_URL="postgresql://test:test@127.0.0.1:5441/postgres?schema=public"

model users {
  id         Int       @id @default(autoincrement())
  name       String    @db.VarChar(100)
  email      String    @unique @db.VarChar(255)
  age        Int
  created_at DateTime? @default(now()) @db.Timestamp(6)
}

npx prisma migrate dev

-- CreateTable
CREATE TABLE "public"."users" (
    "id" SERIAL NOT NULL,
    "name" VARCHAR(100) NOT NULL,
    "email" VARCHAR(255) NOT NULL,
    "age" INTEGER NOT NULL,
    "created_at" TIMESTAMP(6) DEFAULT CURRENT_TIMESTAMP,

    CONSTRAINT "users_pkey" PRIMARY KEY ("id")
);

-- CreateIndex
CREATE UNIQUE INDEX "users_email_key" ON "public"."users"("email");

model users {
  id         Int       @id @default(autoincrement())
  name       String    @db.VarChar(100)
  email      String    @unique @db.VarChar(255)
  age        Int
  is_validated Boolean
  created_at DateTime? @default(now()) @db.Timestamp(6)
}

/*
  Warnings:

  - Added the required column `is_validated` to the `users` table without a default value. This is not possible if the table is not empty.

*/
-- AlterTable
ALTER TABLE "public"."users" ADD COLUMN     "is_validated" BOOLEAN NOT NULL;

model users {
  id         Int       @id @default(autoincrement())
  name       String    @db.VarChar(100)
  email      String    @unique @db.VarChar(255)
  age        Int
  is_validated Boolean @default(false)
  address    String?
  created_at DateTime? @default(now()) @db.Timestamp(6)
}

npx prisma migrate dev --create-only

model users {
  id         Int       @id @default(autoincrement())
  name       String    @db.VarChar(100)
  email      String    @unique @db.VarChar(255)
  age        Int
  is_validated Boolean @default(false)
  address    String?
  height     Int?
  created_at DateTime? @default(now()) @db.Timestamp(6)
}

npx prisma migrate dev

-- AlterTable
ALTER TABLE "public"."users" ADD COLUMN     "height" INTEGER;

-- AlterTable
ALTER TABLE "public"."users" ADD COLUMN     "height_hoge" INTEGER;

- The migration `20250830005127_add_height` was modified after it was applied.
- Drift detected: Your database schema is not in sync with your migration history.

The following is a summary of the differences between the expected database schema given your migrations files, and the actual schema of the database.

It should be understood as the set of changes to get from the expected schema to the actual schema.

[*] Changed the `users` table
  [-] Removed column `height_hoge`
  [+] Added column `height`

migrate dev コマンドは以下の手順を実行します：

1. スキーマドリフトの検出: シャドウデータベースで既存のマイグレーション履歴を再実行し、スキーマドリフト（マイグレーションファイルの編集・削除、またはデータベーススキーマへの手動変更）を検出します

2. 保留中のマイグレーションの適用: シャドウデータベースに保留中のマイグレーション（例：同僚が作成した新しいマイグレーション）を適用します

3. 新しいマイグレーションの生成: migrate dev 実行前にPrismaスキーマに加えた変更から新しいマイグレーションを生成します

4. 開発データベースへの適用: 未適用のすべてのマイグレーションを開発データベースに適用し、_prisma_migrations テーブルを更新します

5. アーティファクトの生成: アーティファクト（例：Prisma Client）の生成をトリガーします

DEBUG=prisma:* npx prisma migrate dev