# バッチ設計書 19-migrate:fresh

## 概要

本ドキュメントは、Laravelフレームワークの`migrate:fresh`コマンドの設計仕様を定義するものです。このコマンドは、全テーブルを削除してからマイグレーションを最初から実行するためのArtisanコマンドです。

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

**業務上の目的・背景**：開発中やテスト環境において、データベースを完全にクリーンな状態から再構築したい場合があります。本コマンドは、`db:wipe`でデータベースの全オブジェクト（テーブル、ビュー、型）を削除した後、`migrate`で全マイグレーションを実行します。`migrate:refresh`がマイグレーションのdownメソッドに依存するのに対し、本コマンドはテーブルを直接削除するため、downメソッドが不完全な場合でも確実にクリーンな状態を作れます。

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

**主要な処理内容**：
1. 本番環境での実行確認（--force未指定時）
2. Prohibitableチェック（コマンド禁止設定の確認）
3. `db:wipe`を実行して全テーブル・ビュー・型を削除
4. `migrate`を実行してマイグレーションを適用
5. DatabaseRefreshedイベントを発火
6. シーダーの実行（--seed/--seeder指定時）

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

**影響範囲**：データベースの全テーブル、ビュー、型が削除され、マイグレーションで再構築される。全データが完全に失われる。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | default | 使用するデータベース接続名 |
| --drop-views | boolean | No | false | ビューも削除する |
| --drop-types | boolean | No | false | 型も削除する（PostgreSQL専用） |
| --force | boolean | No | false | 本番環境での確認をスキップ |
| --path | string[] | No | - | マイグレーションファイルのパス |
| --realpath | boolean | No | false | pathが絶対パスであることを示す |
| --schema-path | string | No | - | スキーマダンプファイルのパス |
| --seed | boolean | No | false | マイグレーション後にシーダーを実行 |
| --seeder | string | No | DatabaseSeeder | 実行するシーダークラス名 |
| --step | boolean | No | false | 各マイグレーションを個別にロールバック可能にする |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| database/migrations | PHP | マイグレーションファイル群 |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. Prohibitableチェック
   └─ isProhibited()で禁止設定確認
2. 本番環境確認
   └─ confirmToProceed()で確認プロンプト表示（--force未指定時）
3. テーブル削除
   └─ migrationsテーブル存在時のみ: db:wipe を実行
   └─ --drop-views, --drop-types オプションを渡す
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{migrationsテーブル存在?}
    E -->|Yes| F[db:wipe実行]
    E -->|No| G[migrate実行]
    F --> G
    G --> H[DatabaseRefreshedイベント発火]
    H --> I{--seed/--seeder指定?}
    I -->|Yes| J[db:seed実行]
    I -->|No| K[正常終了]
    J --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 全テーブル削除 | 全テーブル | DROP | db:wipeによる全削除 |
| ビュー削除 | 全ビュー | DROP | --drop-views指定時 |
| 型削除 | 全型 | DROP | --drop-types指定時（PostgreSQL） |
| マイグレーション履歴作成 | migrations | CREATE/INSERT | 新規に作成 |
| スキーマ作成 | 各種テーブル | CREATE/ALTER | マイグレーションのupメソッドに基づく |

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

#### 全テーブル

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DROP | - | 全テーブル | db:wipeで削除 |
| CREATE | - | マイグレーション定義に基づく | migrate実行時 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

### 障害時対応

- db:wipe後のマイグレーションエラー: マイグレーションを修正し、再度freshを実行
- データベースが空の状態から復旧が必要な場合: バックアップから復元

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 処理ログ | テーブル削除時 | "Dropping all tables" |
| 実行ログ | 各マイグレーション実行時 | マイグレーション名と実行結果 |

## 監視・アラート

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

## 備考

- Laravel 12.x対応
- Prohibitableトレイトにより、本番環境でのフレッシュを禁止可能
- `--drop-views`オプション: ビューも削除（デフォルトはテーブルのみ）
- `--drop-types`オプション: PostgreSQLの型も削除
- `--step`オプション: 各マイグレーションを個別にロールバック可能な形式で記録
- DatabaseRefreshedイベント: フレッシュ完了後に発火し、カスタム処理が可能
- `migrate:refresh`との違い: freshはdb:wipeでテーブルを直接削除、refreshはdownメソッドを実行
- downメソッドが不完全な場合でも確実にクリーンな状態を作れる
- 全データが完全に失われるため、本番環境での実行は原則禁止
