# バッチ設計書 23-schema:dump

## 概要

本ドキュメントは、Laravelフレームワークのデータベーススキーマダンプコマンド `schema:dump` の設計仕様を定義します。

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

`schema:dump` コマンドは、現在のデータベーススキーマをSQLファイルとしてエクスポートするバッチ処理です。マイグレーション履歴を含むスキーマ全体を単一のSQLファイルに出力することで、大規模なマイグレーション履歴を持つプロジェクトでの初期スキーマロード時間を短縮し、マイグレーションファイルの整理を可能にします。

**業務上の目的・背景**：長期間運用されるプロジェクトでは、マイグレーションファイルが数十〜数百に達することがあります。新規環境構築時にすべてのマイグレーションを順次実行するのは非効率的であり、時間がかかります。スキーマダンプを使用することで、現在のデータベース構造を単一のSQLファイルとして保存し、新規環境では直接このSQLを読み込むことで高速にデータベースを構築できます。また、マイグレーション履歴の整理（プルーニング）により、プロジェクトの見通しを改善できます。

**バッチの実行タイミング**：主に以下のタイミングで実行されます。
- マイグレーションファイルの整理・統合時
- メジャーリリース前のスキーマスナップショット作成時
- 新規環境構築の高速化を目的とした事前準備時
- データベース構造の文書化・バックアップ時

**主要な処理内容**：
1. 指定されたデータベース接続からSchemaStateインスタンスを取得
2. マイグレーションテーブル名を設定に基づいて決定
3. スキーマをSQLファイルとしてダンプ
4. `SchemaDumped` イベントを発火
5. `--prune` オプション指定時、マイグレーションディレクトリを削除
6. `--prune` オプション指定時、`MigrationsPruned` イベントを発火

**前後の処理との関連**：通常、`migrate` コマンドですべてのマイグレーションを実行した後に使用します。生成されたスキーマファイルは、新規環境で `migrate` 実行時に自動的に読み込まれます。

**影響範囲**：`database/schema/` ディレクトリにSQLファイルが生成されます。`--prune` オプション使用時は `database/migrations/` ディレクトリが削除されます。

## バッチ種別

スキーマエクスポート / 環境構築支援

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | 対象データベースへの接続が確立されていること |
| スキーマダンプ対応 | データベースドライバがスキーマダンプをサポートしていること |
| 書き込み権限 | `database/schema/` ディレクトリへの書き込み権限 |

### 実行可否判定

1. `Prohibitable` トレイトによる実行禁止チェック

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | null | 使用するデータベース接続名 |
| --path | string | No | database/schema/{connection}-schema.sql | スキーマダンプファイルの出力先パス |
| --prune | bool | No | false | 既存のマイグレーションファイルをすべて削除 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| データベーススキーマ | DB | 現在のデータベース構造 |
| マイグレーション設定 | PHP Config | `config/database.php` のmigrationsテーブル設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| スキーマファイル | SQL | データベーススキーマのSQLダンプ |
| コンソール | 標準出力 | 実行ステータスメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | `{connection}-schema.sql` または `--path` で指定 |
| 出力先 | `database/schema/` または `--path` で指定 |
| 文字コード | データベース設定に依存 |
| 形式 | SQLステートメント |

## 処理フロー

### 処理シーケンス

```
1. 実行可否チェック
   └─ Prohibitableによる確認
2. データベース接続取得
   └─ ConnectionResolverから接続を取得
3. SchemaState作成
   └─ マイグレーションテーブル名を設定
4. スキーマダンプ実行
   └─ SchemaState::dump()でSQLファイル生成
5. SchemaDumpedイベント発火
   └─ イベントディスパッチャーで通知
6. マイグレーション削除（オプション）
   └─ --prune指定時、database/migrations/削除
7. MigrationsPrunedイベント発火（オプション）
   └─ --prune指定時、イベント通知
8. 完了メッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{実行禁止チェック}
    B -->|禁止| C[FAILURE終了]
    B -->|許可| D[DB接続取得]
    D --> E[SchemaState作成]
    E --> F[マイグレーションテーブル名設定]
    F --> G[スキーマダンプ実行]
    G --> H[SchemaDumpedイベント発火]
    H --> I{--prune?}
    I -->|Yes| J[migrations/削除]
    J --> K[MigrationsPrunedイベント発火]
    K --> L[完了メッセージ出力]
    I -->|No| L
    L --> M[正常終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマ読み取り | 全テーブル | SELECT（メタデータ） | テーブル定義情報の取得 |
| マイグレーション情報 | migrations | SELECT | マイグレーション履歴の取得 |

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

本コマンドはデータベースの構造を読み取るのみで、データの変更は行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FAILURE | 実行禁止 | Prohibitableで禁止設定時 | 禁止設定を解除 |
| RuntimeException | ダンプ未対応 | DBドライバがスキーマダンプ未対応 | 対応するDBドライバを使用 |
| IOException | 書き込みエラー | 出力先に書き込み不可 | ディレクトリ権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. データベース接続設定を確認
3. 出力先ディレクトリの権限を確認
4. データベースドライバの対応状況を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（読み取り専用） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テーブル数に依存 |
| 目標処理時間 | データベースサイズに依存 |
| メモリ使用量上限 | スキーマサイズに依存 |

## 排他制御

- 同時実行：可能（読み取り専用）
- ロック機構：なし
- 注意：スキーマ変更中の実行は避けることを推奨

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ダンプ中 | ネイティブコマンドの出力 |
| 終了ログ | バッチ終了時 | "Database schema dumped successfully." または "Database schema dumped and pruned successfully." |
| エラーログ | エラー発生時 | 例外メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | アプリケーション設定に依存 | - |
| エラー件数 | 1件以上 | 開発者 |

## 備考

- 出力先ディレクトリ（`database/schema/`）は自動的に作成されます
- `--prune` オプションは破壊的操作です。マイグレーションファイルが完全に削除されます
- スキーマダンプはデータベースドライバによって実装が異なります（MySQL、PostgreSQL等）
- `SchemaDumped` イベントと `MigrationsPruned` イベントを購読することで、後処理を実装できます
- マイグレーションテーブル名は `config/database.php` の `migrations` 設定から取得されます
