# バッチ設計書 25-db:migrate:redo

## 概要

本ドキュメントは、Rails標準Rakeタスク `db:migrate:redo` の設計仕様を定義するものである。

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

`db:migrate:redo` は、直近のマイグレーションをロールバックしてから再度実行する、または指定されたバージョンのマイグレーションを再実行するRakeタスクである。

**業務上の目的・背景**：マイグレーションの動作確認やデバッグを行う際に、up/downの両方向が正しく動作することを検証する必要がある。本タスクを使用することで、マイグレーションの可逆性を効率的にテストでき、マイグレーション開発のイテレーションを高速化できる。

**バッチの実行タイミング**：マイグレーション開発・テスト時、マイグレーションの可逆性検証時、または特定バージョンのマイグレーションを再適用したい場合に随時実行される。

**主要な処理内容**：
1. VERSION指定時：指定バージョンのdownを実行し、upを実行
2. VERSION未指定時：rollbackを実行し、migrateを実行
3. スキーマファイルのダンプ

**前後の処理との関連**：内部で `db:rollback` または `db:migrate:down` と `db:migrate` または `db:migrate:up` を呼び出す。実行後は `db:schema:dump` が呼び出される（設定による）。

**影響範囲**：対象マイグレーションに関連するテーブル・カラム・インデックスなど。ロールバックと再実行によりデータが失われる可能性がある。

## バッチ種別

データベース管理 / マイグレーションテスト

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config/database.yml | データベース設定ファイルが存在すること |
| データベース存在 | 対象データベースが作成済みであること |
| マイグレーション実行済み | ロールバック対象のマイグレーションが存在すること |
| シングルDB構成 | マルチDB構成の場合は個別タスクを使用 |

### 実行可否判定

- マルチデータベース構成の場合、`raise_for_multi_db` により実行が拒否される
- VERSION環境変数が空文字の場合はエラー
- シングルDB構成またはVERSION指定なしの場合のみ実行可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| VERSION | Integer | No | なし | 再実行するマイグレーションのバージョン |
| STEP | Integer | No | 1 | ロールバックするステップ数（VERSION未指定時） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/database.yml | YAML | データベース接続設定ファイル |
| db/migrate/*.rb | Ruby | マイグレーションファイル群 |
| schema_migrations | DB | 実行済みマイグレーション記録 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | マイグレーション実行状況 |
| schema_migrations | DB | 実行済みマイグレーションのバージョン |
| db/schema.rb | Ruby | スキーマダンプファイル（設定による） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | schema.rb または structure.sql |
| 出力先 | db/ |
| 文字コード | UTF-8 |
| 内容 | 現在のスキーマ定義 |

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ database.ymlから設定を読み込み
2. raise_for_multi_db
   └─ マルチDB構成チェック
3. VERSION空チェック
   └─ 空文字の場合はエラー
4. VERSION指定時:
   4a. migrate:down実行
   4b. migrate:up実行
5. VERSION未指定時:
   5a. rollback実行
   5b. migrate実行
6. スキーマダンプ
   └─ _dump タスク実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[load_config実行]
    B --> C[raise_for_multi_db]
    C --> D{マルチDB構成?}
    D -->|Yes| E[エラー: マルチDB非対応]
    E --> F[異常終了]
    D -->|No| G{VERSION指定あり?}
    G -->|Yes| H{VERSION空文字?}
    H -->|Yes| I[エラー: Empty VERSION]
    I --> F
    H -->|No| J[migrate:down実行]
    J --> K[migrate:up実行]
    K --> L[スキーマダンプ]
    G -->|No| M[rollback実行]
    M --> N[migrate実行]
    N --> L
    L --> O[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| migrate:down | マイグレーション定義による | DROP/ALTER等 | スキーマのロールバック |
| schema_migrations | schema_migrations | DELETE | バージョン記録の削除 |
| migrate:up | マイグレーション定義による | CREATE/ALTER等 | スキーマの再適用 |
| schema_migrations | schema_migrations | INSERT | バージョン記録の追加 |

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

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | version | 指定されたVERSION | down実行時 |
| INSERT | version | 指定されたVERSION | up実行時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | RuntimeError | マルチDB構成での実行 | 個別DBタスク（db:migrate:redo:[name]）を使用 |
| - | RuntimeError | VERSION空文字 | 正しいVERSION値を指定 |
| - | IrreversibleMigration | ロールバック不可マイグレーション | マイグレーションファイルを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. ロールバック（down）でエラー発生時：
   - マイグレーションの `down` メソッドを修正
   - 手動でスキーマを修正後、schema_migrationsを更新

2. 再実行（up）でエラー発生時：
   - マイグレーションの `up` または `change` メソッドを修正
   - schema_migrationsからバージョンを削除して再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各マイグレーション操作（down/up）は個別トランザクション |
| コミットタイミング | 各操作完了時 |
| ロールバック条件 | 各操作内でのエラー発生時 |

## パフォーマンス要件

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

## 排他制御

開発・テスト環境での使用を想定。本番環境での使用は非推奨。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ロールバックログ | down実行時 | "== [timestamp] MigrationName: reverting ====" |
| 再実行ログ | up実行時 | "== [timestamp] MigrationName: migrating ====" |
| 完了ログ | 各操作完了時 | "== [timestamp] MigrationName: reverted/migrated (Xs) ===" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | 該当なし（開発用） |
| エラー発生 | 該当なし | 標準エラー出力 |

## 備考

- 本タスクは主に開発・テスト環境での使用を想定しており、本番環境での使用は推奨されない
- マルチデータベース構成の場合は `db:migrate:redo:[database_name]` を使用する
- STEPとVERSIONは排他的であり、VERSION指定時はSTEPは無視される
- downメソッドが定義されていないマイグレーションでは `IrreversibleMigration` エラーが発生する
