# バッチ設計書 7-migrateDown

## 概要

本ドキュメントは、Payloadのデータベースマイグレーションロールバック処理「migrateDown」の設計仕様を定義する。このバッチは、直近のマイグレーションバッチをロールバックする責務を担う。

### 本バッチの処理概要

migrateDownバッチは、直近のマイグレーションバッチに含まれるマイグレーションをロールバック（down関数を実行）するマイグレーション管理処理である。

**業務上の目的・背景**：マイグレーション適用後に問題が発見された場合、変更を取り消して以前の状態に戻す必要がある。migrateDownは、直近に適用されたマイグレーションバッチを安全にロールバックする機能を提供し、データベース変更の可逆性を保証する。

**バッチの実行タイミング**：CLIコマンド（`payload migrate:down`）による手動実行。問題発生時のロールバック操作として使用される。

**主要な処理内容**：
1. マイグレーションファイルの読み込み
2. payload-migrationsコレクションから既存記録と最新バッチ番号を取得
3. 最新バッチに属するマイグレーションを特定
4. 各マイグレーションに対してdown関数を実行
5. 成功したマイグレーション記録をpayload-migrationsから削除
6. エラー発生時はトランザクションロールバック、プロセス終了

**前後の処理との関連**：migrateによって適用されたマイグレーションをロールバック。migrateResetは全マイグレーションをロールバックする点で異なる。

**影響範囲**：データベーススキーマ、payload-migrationsコレクション。

## バッチ種別

データマイグレーション処理（ロールバック）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 手動（必要時） |
| 実行時刻 | 手動実行時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CLIコマンド |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| マイグレーション記録存在 | payload-migrationsにロールバック対象の記録が存在すること |
| マイグレーションファイル存在 | 対応するマイグレーションファイルがローカルに存在すること |
| DB接続 | データベースに接続可能であること |

### 実行可否判定

payload-migrationsに記録が存在する場合に実行可能。記録がない場合は「No migrations to rollback.」とログ出力して終了。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| migrations/ | ファイル | マイグレーションファイル（TypeScript/JavaScript） |
| payload-migrations | DB | 既存マイグレーション記録 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| payload-migrations | DB | 削除されたマイグレーション記録 |
| データベーススキーマ | DB | ロールバックされたスキーマ |

### 出力ファイル仕様

ファイル出力なし（データベース更新のみ）

## 処理フロー

### 処理シーケンス

```
1. マイグレーションファイルの読み込み
   └─ readMigrationFiles()
2. 既存マイグレーション記録の取得
   └─ getMigrations()でexistingMigrationsとlatestBatchを取得
3. ロールバック対象の確認
   └─ existingMigrationsが空の場合は終了
4. 最新バッチのマイグレーション抽出
   └─ batch === latestBatchのマイグレーションをフィルタ
5. 各マイグレーションに対してループ
   └─ ローカルファイルとの照合
6. トランザクション開始
   └─ initTransaction()
7. down関数の実行
   └─ migrationFile.down({ payload, req, session })
8. マイグレーション記録の削除
   └─ payload.delete({ collection: 'payload-migrations', id })
9. トランザクションコミット
   └─ commitTransaction()
10. エラー発生時はロールバックとプロセス終了
    └─ killTransaction(), process.exit(1)
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[マイグレーションファイル読み込み]
    B --> C[既存マイグレーション記録取得]
    C --> D{記録存在?}
    D -->|No| E[No migrations to rollbackログ]
    E --> F[処理終了]
    D -->|Yes| G[最新バッチのマイグレーション抽出]
    G --> H[次のマイグレーション取得]
    H --> I{ローカルファイル存在?}
    I -->|No| J[エラースロー]
    I -->|Yes| K[トランザクション開始]
    K --> L[down関数実行]
    L --> M{成功?}
    M -->|Yes| N[マイグレーション記録削除]
    N --> O[トランザクションコミット]
    O --> P{次のマイグレーションあり?}
    M -->|No| Q[トランザクションロールバック]
    Q --> R[process.exit 1]
    P -->|Yes| H
    P -->|No| F
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 既存記録取得 | payload-migrations | SELECT | マイグレーション履歴の取得 |
| ロールバック実行 | 各種テーブル | DDL/DML | down関数による変更 |
| 記録削除 | payload-migrations | DELETE | マイグレーション記録の削除 |

### テーブル別操作詳細

#### payload-migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name, batch, id | 全件取得 | getMigrations() |
| DELETE | id | migration.id | 成功したマイグレーションの記録削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル未検出 | ローカルにマイグレーションファイルが存在しない | ファイルの復元または手動でのDB修正 |
| - | ロールバックエラー | down関数内でエラー発生 | ログ確認、手動でのDB修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動で再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. エラーログを確認
2. down関数の修正またはDBの手動修正
3. 必要に応じてマイグレーションファイルを復元
4. 再実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | マイグレーション単位 |
| コミットタイミング | 各マイグレーションのdown完了後 |
| ロールバック条件 | down関数内でエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 最新バッチのマイグレーション数（通常1〜数件） |
| 目標処理時間 | マイグレーション内容に依存 |
| メモリ使用量上限 | 制限なし |

## 排他制御

- トランザクションによる整合性保証
- 処理中は他のマイグレーション操作を行わないこと

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 記録なし時 | `No migrations to rollback.` |
| 開始ログ | ロールバック開始時 | `Rolling back batch ${latestBatch} consisting of ${count} migration(s).` |
| 進捗ログ | 各マイグレーション開始時 | `Migrating down: ${name}` |
| 完了ログ | 各マイグレーション完了時 | `Migrated down: ${name} (${time}ms)` |
| エラーログ | エラー発生時 | `Error running migration ${name}` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ロールバック失敗 | 1件以上 | 開発チーム |

## 備考

- **エラー時はprocess.exit(1)で終了**：ロールバック失敗は致命的なため、プロセスを終了する
- 最新バッチのマイグレーションのみがロールバック対象
- 複数回のmigrateDown実行で、順次過去のバッチをロールバック可能
- ローカルにマイグレーションファイルが存在しない場合はエラー
- 処理時間はログに記録される（ミリ秒単位）
