# バッチ設計書 16-migrate:rollback

## 概要

本ドキュメントは、Laravelフレームワークの`migrate:rollback`コマンドの設計仕様を定義するものです。このコマンドは、直前のデータベースマイグレーションをロールバック（元に戻す）するためのArtisanコマンドです。

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

**業務上の目的・背景**：マイグレーション実行後に問題が発見された場合、スキーマ変更を元に戻す必要があります。本コマンドは、マイグレーションのdownメソッドを実行してデータベーススキーマを以前の状態に復元します。開発中のスキーマ修正や、デプロイ後の緊急ロールバック時に使用されます。`--step`または`--batch`オプションにより、ロールバック対象を細かく制御できます。

**バッチの実行タイミング**：障害発生時の緊急対応、開発中のスキーマ修正時、テスト環境のリセット時などに実行されます。

**主要な処理内容**：
1. 本番環境での実行確認（--force未指定時）
2. Prohibitableチェック（コマンド禁止設定の確認）
3. 指定されたステップ数またはバッチ番号のマイグレーションをロールバック
4. 各マイグレーションのdownメソッドを実行

**前後の処理との関連**：`migrate`コマンドで実行されたマイグレーションを元に戻す。`migrate:status`で現在の状態を確認してからロールバック対象を決定することが推奨されます。

**影響範囲**：ロールバック対象のマイグレーションで定義されたスキーマ変更が元に戻される。テーブルの削除、カラムの削除などが発生する可能性がある。

## バッチ種別

データベース管理 / スキーマ変更

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | 対象データベースへの接続が可能であること |
| マイグレーション履歴 | migrationsテーブルにロールバック対象が存在すること |
| 本番環境確認 | 本番環境では--forceオプションまたは対話的確認が必要 |
| Prohibitable設定 | コマンドが禁止設定されていないこと |

### 実行可否判定

1. Prohibitableチェック：`isProhibited()`がtrueの場合は実行中止
2. 本番環境確認：`--force`未指定かつ本番環境の場合は確認プロンプト表示
3. いずれかの確認で拒否された場合は終了コード1で終了

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | default | 使用するデータベース接続名 |
| --force | boolean | No | false | 本番環境での確認をスキップ |
| --path | string[] | No | - | マイグレーションファイルのパス |
| --realpath | boolean | No | false | pathが絶対パスであることを示す |
| --pretend | boolean | No | false | SQLクエリを表示のみ（実行しない） |
| --step | integer | No | - | ロールバックするマイグレーション数 |
| --batch | integer | No | - | ロールバック対象のバッチ番号 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| database/migrations | PHP | マイグレーションファイル群 |
| migrations | DB | マイグレーション実行履歴テーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | テキスト | ロールバック実行結果 |
| migrations | DB | 実行履歴の削除 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. Prohibitableチェック
   └─ isProhibited()で禁止設定確認
2. 本番環境確認
   └─ confirmToProceed()で確認プロンプト表示（--force未指定時）
3. データベース接続設定
   └─ --databaseオプションで指定された接続を使用
4. ロールバック実行
   └─ migrator->rollback()を呼び出し
   └─ --pretend, --step, --batch オプションを渡す
5. 結果出力
   └─ 各マイグレーションのロールバック結果を表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Prohibitable?}
    B -->|Yes| C[終了コード1で終了]
    B -->|No| D{本番環境確認OK?}
    D -->|No| C
    D -->|Yes| E[データベース接続設定]
    E --> F[ロールバック実行]
    F --> G[各マイグレーションdown実行]
    G --> H[migrations履歴削除]
    H --> I[結果出力]
    I --> J[正常終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション履歴削除 | migrations | DELETE | ロールバックしたマイグレーションの履歴を削除 |
| スキーマ変更 | 各種テーブル | DROP/ALTER | マイグレーションのdownメソッドに基づく |

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

#### migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | WHERE migration IN (ロールバック対象) | ロールバック完了後に削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 禁止設定 | isProhibited()がtrue | 禁止設定を解除 |
| 1 | 確認拒否 | 本番環境で確認を拒否 | --forceを指定して再実行 |
| 例外 | SQLエラー | ロールバックSQL実行エラー | マイグレーションファイルを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | - |
| リトライ間隔 | - |
| リトライ対象エラー | - |

リトライ機構は実装されていない。

### 障害時対応

- SQLエラー: 該当マイグレーションのdownメソッドを修正し、再実行
- データ不整合: 手動でスキーマを修正

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | データベースドライバによる |
| コミットタイミング | 各マイグレーションロールバック後 |
| ロールバック条件 | down実行中のエラー |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | --step/--batchで指定された件数 |
| 目標処理時間 | マイグレーション内容に依存 |
| メモリ使用量上限 | 標準的なPHPメモリ制限内 |

## 排他制御

排他制御なし。同時実行には注意が必要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 実行ログ | 各マイグレーションロールバック時 | マイグレーション名と実行結果 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | 運用監視 |

## 備考

- Laravel 12.x対応
- Prohibitableトレイトにより、本番環境でのロールバックを禁止可能
- `--step`オプション: 指定した数のマイグレーションをロールバック
- `--batch`オプション: 指定したバッチ番号のマイグレーションをロールバック
- `--pretend`オプションでドライラン可能（SQLの確認用）
- データ損失の可能性があるため、本番環境での実行は慎重に
