# バッチ設計書 26-db:migrate:reset

## 概要

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

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

`db:migrate:reset` は、データベースを削除・再作成し、すべてのマイグレーションを最初から実行することでデータベースをリセットするRakeタスクである。

**業務上の目的・背景**：開発中にスキーマが複雑に変更された場合や、マイグレーション履歴に問題が発生した場合に、クリーンな状態からマイグレーションを再実行する必要がある。本タスクは `db:reset`（スキーマファイルからロード）とは異なり、すべてのマイグレーションファイルを順次実行するため、マイグレーションの整合性確認やデータマイグレーションのテストに有用である。

**バッチの実行タイミング**：開発環境でのスキーマリセット時、マイグレーション履歴の検証時、またはマイグレーションファイルの修正後に全体を再適用したい場合に随時実行される。

**主要な処理内容**：
1. db:drop - データベースの削除
2. db:create - データベースの作成
3. db:schema:dump - 空スキーマのダンプ（初期状態）
4. db:migrate - すべてのマイグレーションを実行

**前後の処理との関連**：本タスクは `db:drop`、`db:create`、`db:schema:dump`、`db:migrate` を順次呼び出す。実行後のデータベースには `db:seed` でシードデータを投入可能。

**影響範囲**：対象データベース全体。すべてのデータが削除され、スキーマがマイグレーションから再構築される。

## バッチ種別

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

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config/database.yml | データベース設定ファイルが存在すること |
| マイグレーションファイル | db/migrate/ にマイグレーションファイルが存在すること |
| データベースサーバー稼働 | 対象データベースサーバーが起動していること |
| 環境保護パス | 保護環境でないこと、または保護が無効化されていること |

### 実行可否判定

- `db:drop` で環境保護チェックが実行される
- 保護環境では `ActiveRecord::ProtectedEnvironmentError` が発生
- `DISABLE_DATABASE_ENVIRONMENT_CHECK` 環境変数で保護を無効化可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | String | No | development | 対象環境の指定 |
| DISABLE_DATABASE_ENVIRONMENT_CHECK | String | No | なし | 環境保護チェックを無効化 |
| VERSION | Integer | No | なし | 特定バージョンまでのマイグレーション |
| VERBOSE | Boolean | No | true | 詳細出力の有効化 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/database.yml | YAML | データベース接続設定ファイル |
| db/migrate/*.rb | Ruby | マイグレーションファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 各タスクの実行状況 |
| schema_migrations | DB | 実行済みマイグレーションのバージョン |
| db/schema.rb | Ruby | スキーマダンプファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | schema.rb または structure.sql |
| 出力先 | db/ |
| 文字コード | UTF-8 |
| 内容 | 再構築後のスキーマ定義 |

## 処理フロー

### 処理シーケンス

```
1. db:drop
   └─ 現在環境のデータベースを削除
2. db:create
   └─ 新規データベースを作成
3. db:schema:dump
   └─ 空のスキーマをダンプ
4. db:migrate
   └─ すべてのマイグレーションを順次実行
   └─ 最終的なスキーマをダンプ
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[db:drop実行]
    B --> C{drop成功?}
    C -->|No| D[異常終了]
    C -->|Yes| E[db:create実行]
    E --> F{create成功?}
    F -->|No| D
    F -->|Yes| G[db:schema:dump実行]
    G --> H[db:migrate実行]
    H --> I{全マイグレーション成功?}
    I -->|No| J[マイグレーションエラー]
    J --> D
    I -->|Yes| K[最終schema:dump実行]
    K --> L[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| db:drop | データベース全体 | DROP DATABASE | データベースの削除 |
| db:create | データベース全体 | CREATE DATABASE | データベースの作成 |
| db:migrate | マイグレーション定義による | CREATE/ALTER等 | スキーマの構築 |
| schema_migrations | schema_migrations | INSERT | マイグレーション記録 |

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

すべてのテーブルが削除後に再作成されるため、マイグレーションファイルの定義に依存する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ProtectedEnvironmentError | 保護環境での実行 | DISABLE_DATABASE_ENVIRONMENT_CHECKを設定 |
| - | DatabaseError | DB削除/作成失敗 | 接続設定・権限を確認 |
| - | MigrationError | マイグレーション実行失敗 | マイグレーションファイルを修正 |

### リトライ仕様

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

### 障害時対応

1. db:drop失敗時：接続をすべて切断して再実行
2. db:create失敗時：権限を確認
3. db:migrate失敗時：失敗したマイグレーションを修正し、必要に応じて手動でスキーマを調整

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各マイグレーション単位 |
| コミットタイミング | 各マイグレーション完了時 |
| ロールバック条件 | 各マイグレーション内でのエラー |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | マイグレーションファイル数に依存 |
| 目標処理時間 | マイグレーション内容に依存（通常数分） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

開発環境での単独実行を想定。同時実行は避けるべき。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 削除ログ | db:drop完了時 | "Dropped database 'データベース名'" |
| 作成ログ | db:create完了時 | "Created database 'データベース名'" |
| マイグレーションログ | 各マイグレーション時 | "== [timestamp] MigrationName: migrating ====" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 環境依存 | 該当なし（開発用） |
| エラー発生 | 該当なし | 標準エラー出力 |

## 備考

- `db:reset` とは異なり、スキーマファイルではなくマイグレーションファイルからスキーマを再構築する
- マイグレーションの整合性テストに有用
- 本番環境での使用は非推奨（データが完全に失われる）
- マルチデータベース構成の場合は `db:migrate:reset:[database_name]` を使用
