# バッチ設計書 31-db:reset

## 概要

本ドキュメントは、Railsフレームワークが提供するデータベースリセット用Rakeタスク `db:reset` の設計仕様について記載する。

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

`db:reset` タスクは、現在の環境（development/test/production等）のデータベースを完全にリセットし、初期状態に再構築するためのRakeタスクである。

**業務上の目的・背景**：開発中やテスト実行時において、データベースの状態を完全にクリーンな状態に戻す必要がある場合に使用する。マイグレーションの変更やスキーマの大幅な変更後に、データベースを一から再構築する際に特に有用である。本番環境では保護機能により実行が制限される。

**バッチの実行タイミング**：開発者が手動で実行する随時タスクである。主に以下のタイミングで使用される：
- 開発環境でデータベースを初期状態に戻したい場合
- マイグレーションファイルの大幅な変更後
- シードデータを含む完全な初期化が必要な場合

**主要な処理内容**：
1. `db:drop` タスクを実行し、既存のデータベースを削除する
2. `db:setup` タスクを実行し、データベースを再作成・スキーマロード・シードデータ投入を行う

**前後の処理との関連**：
- 前提：データベース設定（config/database.yml）が正しく構成されていること
- 依存タスク：`db:drop`（データベース削除）、`db:setup`（データベースセットアップ）
- 関連タスク：`db:migrate:reset`（マイグレーションを使用したリセット）

**影響範囲**：指定された環境のデータベース内の全データが削除され、スキーマファイルに基づいて再構築される。development環境で実行した場合、test環境のデータベースも同時にリセットされる（DATABASE_URLが設定されていない場合）。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース設定 | config/database.yml が正しく設定されていること |
| スキーマファイル | db/schema.rb または db/structure.sql が存在すること |
| 環境保護チェック | 本番環境では DISABLE_DATABASE_ENVIRONMENT_CHECK=1 が必要 |

### 実行可否判定

- 本番環境（production）では、`check_protected_environments` により保護されており、`DISABLE_DATABASE_ENVIRONMENT_CHECK=1` を設定しない限り実行不可
- ローカルホスト（127.0.0.1, localhost）以外のリモートデータベースは処理対象外

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | 環境変数 | No | development | 対象環境を指定 |
| DISABLE_DATABASE_ENVIRONMENT_CHECK | 環境変数 | No | なし | 本番環境での実行を許可 |
| VERBOSE | 環境変数 | No | true | 処理の詳細出力を制御 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/database.yml | YAML | データベース接続設定 |
| db/schema.rb | Ruby | スキーマ定義ファイル（Ruby形式） |
| db/structure.sql | SQL | スキーマ定義ファイル（SQL形式） |
| db/seeds.rb | Ruby | シードデータ定義ファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| データベース | DB | スキーマに基づいて再構築されたデータベース |
| 標準出力 | テキスト | 処理結果メッセージ |

### 出力ファイル仕様

ファイル出力は行わない。データベースの再構築のみを実行する。

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ Railsアプリケーションとデータベース設定をロード
2. check_protected_environments
   └─ 本番環境保護のチェック実行
3. db:drop タスク実行
   └─ 現在の環境のデータベースを削除
4. db:setup タスク実行
   └─ 4.1 db:create（データベース作成）
   └─ 4.2 db:schema:load（スキーマロード）
   └─ 4.3 db:seed（シードデータ投入）
```

### フローチャート

```mermaid
flowchart TD
    A[db:reset 開始] --> B[設定ロード]
    B --> C{環境保護チェック}
    C -->|保護対象| D[エラー: 保護環境]
    C -->|OK| E[db:drop 実行]
    E --> F[データベース削除]
    F --> G[db:setup 実行]
    G --> H[db:create]
    H --> I[db:schema:load]
    I --> J[db:seed]
    J --> K[db:reset 完了]
    D --> L[処理中断]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| db:drop | 全テーブル | DROP DATABASE | データベース全体を削除 |
| db:create | - | CREATE DATABASE | 新規データベースを作成 |
| db:schema:load | 全テーブル | CREATE TABLE | スキーマに基づきテーブル作成 |
| db:seed | シード対象テーブル | INSERT | 初期データを投入 |

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

#### ar_internal_metadata

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | key, value, created_at, updated_at | environment, schema_sha1 等 | スキーマロード後に自動作成 |

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | version | スキーマファイル内の全バージョン | スキーマロード時に記録 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | EnvironmentStorageError | 環境情報の保存に失敗 | データベース権限を確認 |
| - | ActiveRecordError | データベース接続失敗 | database.yml設定を確認 |
| - | 保護環境エラー | 本番環境で実行を試行 | DISABLE_DATABASE_ENVIRONMENT_CHECK=1 を設定 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動タスクのため） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. database.yml の設定を確認
3. データベースサーバーの稼働状態を確認
4. 必要に応じてスキーマファイルの存在を確認
5. 権限エラーの場合は、データベースユーザーの権限を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各サブタスク単位 |
| コミットタイミング | 各操作完了時 |
| ロールバック条件 | エラー発生時（ただしDROP後は復元不可） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | スキーマ内の全テーブル数に依存 |
| 目標処理時間 | スキーマサイズに依存（通常数秒〜数分） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行は非推奨
- 他のデータベース操作との競合を避けるため、単独で実行すること
- データベースレベルでのロックはDROP/CREATE時に自動的に取得される

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 各サブタスク開始時 | タスク名 |
| 進捗ログ | 処理中 | "Dropped database 'xxx'", "Created database 'xxx'" 等 |
| 終了ログ | 各サブタスク終了時 | 完了メッセージ |
| エラーログ | エラー発生時 | エラー詳細メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | プロジェクトに応じて設定 | 開発者 |
| エラー件数 | 1件以上 | 開発者 |

## 備考

- `db:reset` と `db:migrate:reset` の違い：
  - `db:reset`：スキーマファイル（schema.rb/structure.sql）を使用してデータベースを再構築
  - `db:migrate:reset`：全マイグレーションを最初から実行してデータベースを再構築
- development環境で実行すると、SKIP_TEST_DATABASE環境変数が設定されていない限り、test環境のデータベースも同時にリセットされる
- 本タスクはローカルデータベースのみを対象とし、リモートホスト上のデータベースはスキップされる
