# バッチ設計書 22-db:wipe

## 概要

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

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

`db:wipe` コマンドは、指定されたデータベースからすべてのテーブル、ビュー、および型（PostgreSQL）を削除するバッチ処理です。データベースを完全にクリーンな状態に戻すことで、テスト環境のリセットや再構築を可能にします。

**業務上の目的・背景**：開発・テスト環境において、データベースを完全にリセットする必要がある場面は頻繁に発生します。マイグレーションの再実行、テストデータの完全クリア、スキーマ変更のテストなど、データベースを白紙状態に戻すことで、一貫した環境での開発・テストが可能になります。`migrate:fresh` コマンドの内部でも使用されており、データベース再構築の基盤となるコマンドです。

**バッチの実行タイミング**：主に以下のタイミングで実行されます。
- テスト環境の完全リセット時
- `migrate:fresh` コマンドの内部処理として
- 開発環境でのスキーマ再構築時
- データベース移行テスト前の環境クリア時

**主要な処理内容**：
1. 本番環境の場合、`--force` オプションまたは確認プロンプトによる実行確認を行う
2. `--drop-views` オプション指定時、すべてのビューを削除
3. すべてのテーブルを削除
4. `--drop-types` オプション指定時、すべての型を削除（PostgreSQLのみ）
5. データベース接続をフラッシュして状態をリセット

**前後の処理との関連**：`migrate:fresh` コマンドの前処理として実行されることが多く、その後に `migrate` が実行されます。単独で実行する場合は、その後に `migrate` および `db:seed` を実行してデータベースを再構築します。

**影響範囲**：指定されたデータベース内のすべてのテーブル、ビュー（オプション時）、型（オプション時）が完全に削除されます。復元不可能な破壊的操作であるため、本番環境での実行には細心の注意が必要です。

## バッチ種別

データクレンジング / 環境リセット

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / migrate:fresh内部呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | 対象データベースへの接続が確立されていること |
| 削除権限 | DROP TABLE, DROP VIEW, DROP TYPE の権限を持つこと |
| 本番環境での実行 | `--force` オプション指定または対話的確認での承認 |

### 実行可否判定

1. `Prohibitable` トレイトによる実行禁止チェック
2. 本番環境での `ConfirmableTrait` による確認（`--force` オプションでスキップ可能）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --database | string | No | null | 使用するデータベース接続名 |
| --drop-views | bool | No | false | すべてのビューも削除する |
| --drop-types | bool | No | false | すべての型も削除する（PostgreSQLのみ） |
| --force | bool | No | false | 本番環境で確認なしに実行 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| データベースメタデータ | DB | 削除対象のテーブル/ビュー/型一覧 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | 標準出力 | 削除完了メッセージ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 実行可否チェック
   └─ Prohibitable/ConfirmableTraitによる確認
2. ビュー削除（オプション）
   └─ --drop-views指定時、dropAllViews()実行
3. テーブル削除
   └─ dropAllTables()実行
4. 型削除（オプション）
   └─ --drop-types指定時、dropAllTypes()実行（PostgreSQLのみ）
5. 接続フラッシュ
   └─ disconnect()で接続状態をリセット
6. 終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{実行禁止チェック}
    B -->|禁止| C[FAILURE終了]
    B -->|許可| D{本番環境確認}
    D -->|拒否| C
    D -->|承認| E{--drop-views?}
    E -->|Yes| F[全ビュー削除]
    F --> G[Dropped all views successfully.]
    E -->|No| H[全テーブル削除]
    G --> H
    H --> I[Dropped all tables successfully.]
    I --> J{--drop-types?}
    J -->|Yes| K[全型削除]
    K --> L[Dropped all types successfully.]
    J -->|No| M[接続フラッシュ]
    L --> M
    M --> N[正常終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ビュー削除 | 全ビュー | DROP VIEW | すべてのビューを削除 |
| テーブル削除 | 全テーブル | DROP TABLE | すべてのテーブルを削除 |
| 型削除 | 全型 | DROP TYPE | すべてのカスタム型を削除（PostgreSQL） |

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

#### すべてのテーブル

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DROP TABLE | - | SchemaBuilder::dropAllTables() | データベース内のすべてのテーブル |

#### すべてのビュー

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DROP VIEW | - | SchemaBuilder::dropAllViews() | --drop-viewsオプション時のみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FAILURE | 実行禁止 | Prohibitableで禁止設定時 | 禁止設定を解除 |
| FAILURE | 確認拒否 | 本番環境で確認を拒否 | `--force` オプション使用または確認で承認 |
| PDOException | DB接続エラー | データベース接続失敗 | 接続設定を確認 |
| PDOException | 権限エラー | DROP権限がない | データベースユーザーに権限を付与 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. データベース接続設定を確認
3. ユーザー権限を確認
4. 破壊的操作のため、バックアップからの復元が必要な場合あり

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（DDL操作のため） |
| コミットタイミング | 各DDL操作は即時コミット |
| ロールバック条件 | DDLはロールバック不可 |

注意：DROP操作はDDL（データ定義言語）であり、多くのデータベースでトランザクションによるロールバックがサポートされません。

## パフォーマンス要件

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

## 排他制御

- 同時実行：不可（データベース全体に影響するため）
- ロック機構：SchemaBuilderのDROP操作は内部でロックを取得
- 注意：実行中は他のデータベース操作がブロックされる可能性あり

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ビュー削除後 | "Dropped all views successfully." |
| 進捗ログ | テーブル削除後 | "Dropped all tables successfully." |
| 進捗ログ | 型削除後 | "Dropped all types successfully." |
| エラーログ | エラー発生時 | 例外メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 本番実行検知 | 1回 | 運用担当者 |
| エラー件数 | 1件以上 | 開発者/運用担当者 |

## 備考

- `--drop-types` オプションはPostgreSQL専用です。MySQL等では効果がありません
- 削除順序は ビュー → テーブル → 型 の順で、依存関係を考慮しています
- 処理完了後に `disconnect()` が呼ばれ、接続プールから切断されます
- 本番環境での実行は極めて危険です。必ずバックアップを取得してから実行してください
