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

## 概要

本ドキュメントは、Rails標準Rakeタスク `db:drop` の設計仕様を定義するものである。

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

`db:drop` は、現在の環境（RAILS_ENV）用のデータベースを削除するRakeタスクである。development環境の場合は、test環境のデータベースも同時に削除される。

**業務上の目的・背景**：開発中のデータベースをクリーンな状態にリセットする際や、スキーマ変更により既存データベースを破棄して再構築する必要がある場合に使用する。`db:reset` や `db:migrate:reset` の内部で呼び出されることも多い。本番環境の誤削除を防ぐため、保護機能が組み込まれている。

**バッチの実行タイミング**：開発環境のリセット時、テストデータベースの再構築時、または `db:reset` コマンドの一部として随時実行される。

**主要な処理内容**：
1. 環境保護チェックの実行
2. database.ymlから現在環境の設定読み込み
3. 対象データベースの削除処理実行
4. development環境の場合はtest環境も削除

**前後の処理との関連**：本タスクの後には通常 `db:create` および `db:schema:load` または `db:migrate` が実行される。`db:reset` は内部で `db:drop` を呼び出す。

**影響範囲**：現在の環境のデータベースおよびそのすべてのデータ。development環境の場合はtest環境のデータベースも対象となる。

## バッチ種別

データベース管理 / 環境リセット

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config/database.yml | データベース設定ファイルが存在すること |
| データベースサーバー稼働 | 対象データベースサーバーが起動していること |
| 接続権限 | データベース削除権限を持つユーザーで接続できること |
| 環境保護 | 保護環境でないこと、または保護が無効化されていること |

### 実行可否判定

- `DISABLE_DATABASE_ENVIRONMENT_CHECK` 環境変数が設定されていない場合、保護環境チェックが実行される
- 保護環境では `ActiveRecord::ProtectedEnvironmentError` が発生する
- check_protected_environments! メソッドにより、internal_metadata テーブルの環境フラグを確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | String | No | development | 対象環境の指定 |
| DISABLE_DATABASE_ENVIRONMENT_CHECK | String | No | なし | 環境保護チェックを無効化 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/database.yml | YAML | データベース接続設定ファイル |
| ar_internal_metadata | DB | 環境保護フラグ確認用 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 削除成功メッセージ |
| 標準エラー出力 | テキスト | エラーメッセージ、存在しないDB警告 |

### 出力ファイル仕様

ファイル出力なし。

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ database.ymlから設定を読み込み
2. check_protected_environments
   └─ 保護環境チェックを実行
3. drop:_unsafe
   └─ 実際のdrop処理を実行
4. drop_current
   └─ 現在環境のデータベースを削除
5. development環境の場合
   └─ test環境のデータベースも削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[load_config実行]
    B --> C[check_protected_environments]
    C --> D{保護環境?}
    D -->|Yes| E[EnvironmentStorageError送出]
    E --> F[異常終了]
    D -->|No| G[drop_current実行]
    G --> H{development環境?}
    H -->|Yes| I[development DB削除]
    I --> J[test DB削除]
    J --> K[終了]
    H -->|No| L[現在環境のDB削除]
    L --> K
    K --> M{削除成功?}
    M -->|成功| N[成功メッセージ出力]
    M -->|DB不存在| O[警告メッセージ出力]
    M -->|失敗| P[エラー出力・例外送出]
    N --> Q[バッチ終了]
    O --> Q
    P --> R[異常終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| check_protected_environments | ar_internal_metadata | SELECT | 環境フラグの確認 |
| drop | データベース全体 | DROP DATABASE | データベースの削除 |

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

データベースレベルの操作であり、個別テーブル操作は環境チェック時のみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ProtectedEnvironmentError | 保護環境での実行 | DISABLE_DATABASE_ENVIRONMENT_CHECKを設定 |
| - | NoDatabaseError | 対象データベースが存在しない | 警告を出力して処理続行 |
| - | Exception | 接続失敗、権限不足等 | エラーメッセージを出力して例外を再送出 |

### リトライ仕様

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

### 障害時対応

データベース削除失敗時は、エラーメッセージを確認し、以下を確認する：
- アクティブな接続がないこと
- 接続ユーザーのDROP DATABASE権限
- database.ymlの設定内容

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（DDL操作） |
| コミットタイミング | データベース削除時に即時 |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 通常1〜2データベース |
| 目標処理時間 | 各データベース数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

データベース削除時はすべての接続が切断されている必要がある。アクティブ接続がある場合は失敗する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 成功ログ | DB削除成功時 | "Dropped database 'データベース名'" |
| 警告ログ | DB不存在時 | "Database 'データベース名' does not exist" |
| エラーログ | DB削除失敗時 | エラー詳細、"Couldn't drop database 'データベース名'" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | 該当なし（手動実行） |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- development環境で実行した場合、DATABASE_URL環境変数が設定されておらず、かつSKIP_TEST_DATABASE環境変数も設定されていない場合は、test環境のデータベースも削除される
- 保護環境チェックにより、production環境等での誤削除を防止
- `db:drop:all` を使用すると、すべての環境のデータベースを削除可能
