# バッチ設計書 18-migrate:refresh

## 概要

本ドキュメントは、Laravelフレームワークの`migrate:refresh`コマンドの設計仕様を定義するものです。このコマンドは、すべてのマイグレーションをリセットした後、再度実行するためのArtisanコマンドです。

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

**業務上の目的・背景**：開発中やテスト環境において、データベーススキーマを初期状態から再構築したい場合があります。本コマンドは、`migrate:reset`と`migrate`を組み合わせた複合コマンドであり、既存のマイグレーションをすべてロールバックした後、再度マイグレーションを実行します。これにより、スキーマの整合性確認やテストデータの初期化が効率的に行えます。`--step`オプションを使用すると、指定した数のマイグレーションのみをロールバックして再実行することも可能です。

**バッチの実行タイミング**：開発環境でのスキーマ再構築時、テスト環境の初期化時、CI/CDパイプラインでのテスト前初期化時などに実行されます。

**主要な処理内容**：
1. 本番環境での実行確認（--force未指定時）
2. Prohibitableチェック（コマンド禁止設定の確認）
3. `migrate:rollback`（--step指定時）または`migrate:reset`を実行
4. `migrate`を実行してマイグレーションを再適用
5. DatabaseRefreshedイベントを発火
6. シーダーの実行（--seed/--seeder指定時）

**前後の処理との関連**：`migrate:reset` + `migrate`を一括で実行する。`migrate:fresh`との違いは、本コマンドがマイグレーションのdownメソッドを実行するのに対し、freshはテーブルを直接削除する点です。

**影響範囲**：データベースの全テーブルスキーマが一度リセットされ、再構築される。全データが失われる。

## バッチ種別

データベース管理 / スキーマ再構築

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

1. Prohibitableチェック：`isProhibited()`がtrueの場合は実行中止
2. 本番環境確認：`--force`未指定かつ本番環境の場合は確認プロンプト表示

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | default | 使用するデータベース接続名 |
| --force | boolean | No | false | 本番環境での確認をスキップ |
| --path | string[] | No | - | マイグレーションファイルのパス |
| --realpath | boolean | No | false | pathが絶対パスであることを示す |
| --seed | boolean | No | false | マイグレーション後にシーダーを実行 |
| --seeder | string | No | DatabaseSeeder | 実行するシーダークラス名 |
| --step | integer | No | 0 | ロールバック&再実行するマイグレーション数 |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | テキスト | リフレッシュ実行結果 |
| migrations | DB | 更新された実行履歴 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. Prohibitableチェック
   └─ isProhibited()で禁止設定確認
2. 本番環境確認
   └─ confirmToProceed()で確認プロンプト表示（--force未指定時）
3. ロールバック実行
   └─ --step > 0: migrate:rollback --step=N を実行
   └─ --step なし: migrate:reset を実行
4. マイグレーション再実行
   └─ migrate コマンドを実行
5. イベント発火
   └─ DatabaseRefreshedイベントを発火
6. シーダー実行
   └─ --seed/--seeder 指定時: db:seed を実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{Prohibitable?}
    B -->|Yes| C[終了コード1で終了]
    B -->|No| D{本番環境確認OK?}
    D -->|No| C
    D -->|Yes| E{--step > 0?}
    E -->|Yes| F[migrate:rollback --step=N]
    E -->|No| G[migrate:reset]
    F --> H[migrate実行]
    G --> H
    H --> I[DatabaseRefreshedイベント発火]
    I --> J{--seed/--seeder指定?}
    J -->|Yes| K[db:seed実行]
    J -->|No| L[正常終了]
    K --> L
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション履歴 | migrations | DELETE/INSERT | リセット後に再記録 |
| スキーマ変更 | 各種テーブル | DROP/CREATE/ALTER | マイグレーションのdown/upメソッドに基づく |

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

#### migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | 対象マイグレーション | リセット/ロールバック時 |
| INSERT | migration, batch | マイグレーション情報 | 再実行時 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

### 障害時対応

- ロールバック中のエラー: 手動でスキーマを修正
- マイグレーション中のエラー: 該当マイグレーションを修正し、再実行

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

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

## 監視・アラート

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

## 備考

- Laravel 12.x対応
- Prohibitableトレイトにより、本番環境でのリフレッシュを禁止可能
- `--step`オプション: 指定した数のマイグレーションのみをロールバック&再実行
- `--seed`/`--seeder`オプション: マイグレーション後にシーダーを自動実行
- DatabaseRefreshedイベント: リフレッシュ完了後に発火し、カスタム処理が可能
- `migrate:fresh`との違い: refreshはdownメソッドを実行、freshはテーブルを直接DROP
- 全データが失われるため、本番環境での実行は原則禁止
