# バッチ設計書 15-migrate

## 概要

本ドキュメントは、Laravelフレームワークの`migrate`コマンドの設計仕様を定義するものです。このコマンドは、データベースマイグレーションを実行するための中核的なArtisanコマンドです。

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

**業務上の目的・背景**：アプリケーション開発において、データベーススキーマの変更は頻繁に発生します。マイグレーションは、これらのスキーマ変更をバージョン管理し、チームメンバー間で一貫したデータベース構造を維持するための仕組みです。本コマンドは、未実行のマイグレーションファイルを検出して順次実行し、データベースを最新の状態に更新します。デプロイ時やローカル環境構築時に不可欠なコマンドです。

**バッチの実行タイミング**：デプロイ時（自動/手動）、ローカル開発環境構築時、新機能リリース時などに実行されます。

**主要な処理内容**：
1. 本番環境での実行確認（--force未指定時）
2. マイグレーションテーブルの存在確認と作成
3. スキーマダンプの読み込み（初回実行時）
4. 未実行のマイグレーションファイルを順次実行
5. シーダーの実行（--seed指定時）

**前後の処理との関連**：`migrate:install`でマイグレーションテーブルを初期化、`migrate:status`で状態確認、`migrate:rollback`でロールバック可能。デプロイパイプラインの一部として組み込まれることが多い。

**影響範囲**：データベーススキーマ全体に影響。テーブルの作成、変更、削除、インデックスの追加などが実行される。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

本番環境（APP_ENV=production）では、`--force`オプションが指定されていない場合は確認プロンプトが表示される。確認に同意しない場合は実行が中止される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | default | 使用するデータベース接続名 |
| --force | boolean | No | false | 本番環境での確認をスキップ |
| --path | string[] | No | - | マイグレーションファイルのパス |
| --realpath | boolean | No | false | pathが絶対パスであることを示す |
| --schema-path | string | No | - | スキーマダンプファイルのパス |
| --pretend | boolean | No | false | SQLクエリを表示のみ（実行しない） |
| --seed | boolean | No | false | マイグレーション後にシーダーを実行 |
| --seeder | string | No | DatabaseSeeder | 実行するシーダークラス名 |
| --step | boolean | No | false | 各マイグレーションを個別にロールバック可能にする |
| --graceful | boolean | No | false | エラー発生時も正常終了コードを返す |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| database/migrations | PHP | マイグレーションファイル群 |
| database/schema | SQL/dump | スキーマダンプファイル（存在する場合） |
| migrations | DB | マイグレーション実行履歴テーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | テキスト | マイグレーション実行結果 |
| migrations | DB | 実行履歴の記録 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 本番環境確認
   └─ confirmToProceed()で確認プロンプト表示（--force未指定時）
2. データベース準備
   └─ マイグレーションテーブル存在確認
   └─ 存在しない場合: migrate:installを実行
3. スキーマ状態の読み込み
   └─ 初回実行時: スキーマダンプファイルがあれば読み込み
4. マイグレーション実行
   └─ 未実行のマイグレーションを順次実行
   └─ 各マイグレーションの結果を出力
5. シーダー実行
   └─ --seed指定時: db:seedを呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{本番環境確認OK?}
    B -->|No| C[終了コード1で終了]
    B -->|Yes| D{migrationsテーブル存在?}
    D -->|No| E[migrate:install実行]
    D -->|Yes| F{初回実行?}
    E --> F
    F -->|Yes| G{スキーマダンプ存在?}
    F -->|No| H[マイグレーション実行]
    G -->|Yes| I[スキーマダンプ読み込み]
    G -->|No| H
    I --> H
    H --> J{--seed指定?}
    J -->|Yes| K[db:seed実行]
    J -->|No| L[正常終了]
    K --> L
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション履歴記録 | migrations | INSERT | 実行したマイグレーション名とバッチ番号を記録 |
| スキーマ変更 | 各種テーブル | CREATE/ALTER/DROP | マイグレーションファイルの定義に基づく |

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

#### migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | migration | マイグレーションファイル名 | 拡張子なし |
| INSERT | batch | 現在のバッチ番号 | 実行ごとにインクリメント |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | 確認拒否 | 本番環境で確認を拒否 | --forceを指定して再実行 |
| 例外 | SQLエラー | マイグレーションSQL実行エラー | マイグレーションファイルを修正 |
| 例外 | 接続エラー | データベース接続失敗 | 接続設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 2回（repositoryExists確認時） |
| リトライ間隔 | 0秒 |
| リトライ対象エラー | データベース接続エラー |

### 障害時対応

- SQLエラー: 該当マイグレーションファイルを修正し、再実行
- 部分実行後のエラー: `migrate:rollback`で戻すか、手動でスキーマを修正
- `--graceful`オプション: エラー発生時も正常終了コードを返す（CI/CD向け）

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

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

## パフォーマンス要件

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

## 排他制御

Isolatableインターフェースを実装しており、同時実行を防止可能。`--isolated`オプションでアトミックロックを取得。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 準備ログ | テーブル作成時 | "Preparing database." / "Creating migration table" |
| スキーマログ | スキーマ読み込み時 | "Loading stored database schemas." |
| 実行ログ | 各マイグレーション実行時 | マイグレーション名と実行結果 |
| 警告ログ | gracefulモードエラー時 | エラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 0以外 | デプロイ監視 |
| 実行時間 | 環境依存 | 運用監視 |

## 備考

- Laravel 12.x対応
- Isolatableインターフェース実装により排他制御対応
- SQLite/MySQL/MariaDB/PostgreSQLで存在しないデータベースの自動作成をサポート
- SchemaLoadedイベントを発火してスキーマ読み込み後の処理が可能
- `--pretend`オプションでドライラン可能（SQLの確認用）
- `--step`オプションで各マイグレーションを個別ロールバック可能な形式で記録
