# バッチ設計書 17-migrate:reset

## 概要

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

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

**業務上の目的・背景**：開発中やテスト環境において、データベーススキーマを完全に初期状態に戻す必要がある場合があります。本コマンドは、実行されたすべてのマイグレーションを逆順でロールバックし、データベースを空の状態に戻します。これにより、マイグレーションの動作確認やスキーマの再構築が可能になります。`migrate:rollback`が部分的なロールバックを行うのに対し、本コマンドは全マイグレーションを対象とします。

**バッチの実行タイミング**：開発環境でのスキーマリセット時、テスト環境の初期化時、マイグレーション全体のテスト時などに実行されます。本番環境での実行は推奨されません。

**主要な処理内容**：
1. 本番環境での実行確認（--force未指定時）
2. Prohibitableチェック（コマンド禁止設定の確認）
3. マイグレーションテーブルの存在確認
4. すべてのマイグレーションを逆順でロールバック

**前後の処理との関連**：本コマンド実行後、`migrate`コマンドで再度マイグレーションを実行することで、スキーマを再構築できます。`migrate:refresh`は本コマンド + `migrate`を組み合わせたコマンドです。

**影響範囲**：データベースの全テーブルスキーマが元に戻される。大量のデータ損失が発生する可能性がある。

## バッチ種別

データベース管理 / スキーマリセット

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

1. Prohibitableチェック：`isProhibited()`がtrueの場合は実行中止
2. 本番環境確認：`--force`未指定かつ本番環境の場合は確認プロンプト表示
3. マイグレーションテーブルが存在しない場合は警告メッセージを表示して終了

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. Prohibitableチェック
   └─ isProhibited()で禁止設定確認
2. 本番環境確認
   └─ confirmToProceed()で確認プロンプト表示（--force未指定時）
3. データベース接続設定
   └─ --databaseオプションで指定された接続を使用
4. マイグレーションテーブル確認
   └─ repositoryExists()でテーブル存在確認
   └─ 存在しない場合: 警告メッセージ出力して終了
5. リセット実行
   └─ migrator->reset()を呼び出し
   └─ すべてのマイグレーションを逆順でロールバック
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Prohibitable?}
    B -->|Yes| C[終了コード1で終了]
    B -->|No| D{本番環境確認OK?}
    D -->|No| C
    D -->|Yes| E[データベース接続設定]
    E --> F{migrationsテーブル存在?}
    F -->|No| G[警告メッセージ出力]
    G --> H[終了]
    F -->|Yes| I[全マイグレーションをリセット]
    I --> J[各マイグレーションdown実行]
    J --> K[migrations履歴全削除]
    K --> L[正常終了]
```

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

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

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

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

#### migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | 全レコード | リセット完了後に全削除 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

### 障害時対応

- 部分リセット後のエラー: 残りのマイグレーションを手動でロールバックまたはスキーマを修正
- テーブル未存在: `migrate:install`でマイグレーションテーブルを作成

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 警告ログ | テーブル未存在時 | "Migration table not found." |
| 実行ログ | 各マイグレーションロールバック時 | マイグレーション名と実行結果 |

## 監視・アラート

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

## 備考

- Laravel 12.x対応
- Prohibitableトレイトにより、本番環境でのリセットを禁止可能
- `--pretend`オプションでドライラン可能（SQLの確認用）
- 全データが失われるため、本番環境での実行は原則禁止
- `migrate:refresh`はこのコマンドの後に`migrate`を実行する複合コマンド
- マイグレーションテーブルが存在しない場合は警告を出して正常終了
