# バッチ設計書 30-db:rollback

## 概要

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

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

`db:rollback` は、スキーマを前のバージョンにロールバックするRakeタスクである。デフォルトでは直近の1つのマイグレーションをロールバックし、STEPパラメータで複数のマイグレーションをロールバックすることも可能である。

**業務上の目的・背景**：マイグレーション適用後に問題が発見された場合や、開発中にスキーマ変更を取り消したい場合に使用する。迅速なロールバック機能は、デプロイ失敗時の復旧やスキーマ変更のイテレーションにおいて重要な役割を果たす。

**バッチの実行タイミング**：マイグレーション適用後の問題発覚時、開発中のスキーマ変更取り消し時、またはデプロイロールバック時に随時実行される。

**主要な処理内容**：
1. ロールバック対象のマイグレーション特定（STEP数分）
2. 対象マイグレーションのdown実行
3. schema_migrationsからの記録削除
4. スキーマファイルのダンプ

**前後の処理との関連**：`db:migrate` の逆操作。`db:migrate:redo` の内部処理として使用される。実行後は `db:schema:dump` が呼び出される（設定による）。

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

## バッチ種別

データベース管理 / スキーマロールバック

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

- VERSION環境変数が指定されている場合はエラー（db:migrate:downの使用を案内）
- マルチデータベース構成の場合は `raise_for_multi_db` により実行が拒否される

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| STEP | Integer | No | 1 | ロールバックするマイグレーションの数 |
| VERSION | Integer | No | なし | 指定不可（指定時はエラー） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 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指定チェック
   └─ VERSIONが指定されている場合はエラー
4. STEP値取得
   └─ ENV["STEP"]を整数に変換（デフォルト: 1）
5. migration_context.rollback(step)
   └─ STEP数分のマイグレーションをロールバック
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[エラー: use db:migrate:down]
    H --> F
    G -->|No| I[STEP値取得]
    I --> J[migration_context.rollback]
    J --> K{ロールバック対象あり?}
    K -->|なし| L[何もせず終了]
    K -->|あり| M{STEP分処理完了?}
    M -->|No| N[1つロールバック実行]
    N --> O[schema_migrationsから削除]
    O --> M
    M -->|Yes| P[スキーマダンプ]
    P --> Q[バッチ終了]
    L --> Q
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| rollback | マイグレーション定義による | DROP/ALTER等 | スキーマのロールバック |
| delete_version | schema_migrations | DELETE | バージョン記録の削除 |

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

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | version | 直近STEP件のバージョン | 新しい順に削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | RuntimeError | VERSION指定時 | db:migrate:downを使用 |
| - | RuntimeError | マルチDB構成での実行 | 個別DBタスクを使用 |
| - | IrreversibleMigration | downメソッド未定義 | マイグレーションにdownメソッドを追加 |

### リトライ仕様

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

### 障害時対応

1. IrreversibleMigrationエラー時：
   - downメソッドを実装
   - または手動でスキーマを修正し、schema_migrationsを更新

2. 部分的なロールバック失敗時：
   - 失敗したマイグレーションを確認
   - 手動でスキーマを修正後、schema_migrationsを更新

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | STEP数分のマイグレーション（デフォルト1件） |
| 目標処理時間 | マイグレーション内容に依存 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行は避けるべき。本番環境での使用は特に注意が必要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各ロールバック開始時 | "== [timestamp] MigrationName: reverting ====" |
| 操作ログ | 各DDL操作時 | "-- drop_table(:table_name)" 等 |
| 完了ログ | 各ロールバック完了時 | "== [timestamp] MigrationName: reverted (Xs) ===" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | マイグレーション内容に依存 | 該当なし |
| エラー発生 | 該当なし | 標準エラー出力 |

## 備考

- VERSION指定は不可。特定バージョンをロールバックしたい場合は `db:migrate:down VERSION=xxx` を使用
- STEP=2 を指定すると、直近2つのマイグレーションがロールバックされる
- ロールバック対象がない場合（マイグレーションが1つも適用されていない場合）は何も実行されない
- `change` メソッドを使用したマイグレーションでも、可逆的な操作であれば自動的にロールバック可能
- マルチデータベース構成の場合は `db:rollback:[database_name]` を使用
- MigrationContext#rollback 内で move(:down, steps) が呼び出される
