# バッチ設計書 34-db:seed

## 概要

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

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

`db:seed` タスクは、`db/seeds.rb` ファイルに定義された初期データ（シードデータ）をデータベースにロードするためのRakeタスクである。マスタデータや初期設定データなど、アプリケーション動作に必要な基本データの投入に使用する。

**業務上の目的・背景**：アプリケーションが正常に動作するために必要な初期データ（都道府県マスタ、ロールマスタ、システム設定等）を投入するために使用される。開発環境のセットアップ、ステージング環境の構築、本番環境の初期化時に、一貫したデータを投入することで、環境間の整合性を保つ。

**バッチの実行タイミング**：主に以下のタイミングで手動実行される：
- `db:setup` の一部として自動実行
- 新規環境構築後の初期データ投入
- シードデータの更新後の再投入
- 開発者による手動実行

**主要な処理内容**：
1. `abort_if_pending_migrations` タスクを実行し、未適用マイグレーションがないことを確認
2. `seed_loader`（通常は Rails.application）の `load_seed` メソッドを呼び出し
3. `db/seeds.rb` ファイルを読み込み、Rubyコードとして実行
4. seeds.rb内で定義されたデータ投入処理を実行

**前後の処理との関連**：
- 前提：データベースが作成済みで、スキーマがロードされていること
- 前提：未適用のマイグレーションがないこと
- 関連タスク：`db:setup`（内部的にdb:seedを呼び出す）
- 関連タスク：`db:seed:replant`（テーブルをクリアしてからシードを実行）

**影響範囲**：seeds.rbに定義されたテーブルに対してデータが投入される。既存データの扱いはseeds.rbの実装に依存する（通常は冪等性を持たせた実装が推奨される）。

## バッチ種別

データ投入 / 初期化処理

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース存在 | 対象データベースが作成済みであること |
| スキーマロード済み | テーブル構造が構築されていること |
| マイグレーション適用済み | 未適用マイグレーションがないこと |
| シードファイル存在 | db/seeds.rb が存在すること |

### 実行可否判定

- `abort_if_pending_migrations` で未適用マイグレーションをチェック
- 未適用マイグレーションがある場合は処理を中断し、`db:migrate` を実行するよう促す
- seed_loaderが設定されていない場合はエラー

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | 環境変数 | No | development | 対象環境を指定 |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| データベース | DB | seeds.rbで定義されたテーブルにデータ投入 |
| 標準出力 | テキスト | seeds.rb内で出力された内容 |

### 出力ファイル仕様

ファイル出力は行わない。データベースへのデータ投入のみを実行する。

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ Railsアプリケーションとデータベース設定をロード
2. abort_if_pending_migrations タスク実行
   └─ 各データベースで未適用マイグレーションをチェック
   └─ 未適用マイグレーションがあれば処理中断
3. load_seed メソッド実行
   └─ seed_loader.load_seed を呼び出し
   └─ Rails.application.load_seed が実行される
4. db/seeds.rb の実行
   └─ ファイルを読み込みRubyコードとして評価
   └─ 定義されたデータ投入処理を実行
```

### フローチャート

```mermaid
flowchart TD
    A[db:seed 開始] --> B[設定ロード]
    B --> C[abort_if_pending_migrations]
    C --> D{未適用マイグレーション?}
    D -->|あり| E[エラー: マイグレーション実行を促す]
    D -->|なし| F[seed_loader.load_seed]
    F --> G{seed_loader設定済み?}
    G -->|Yes| H[db/seeds.rb 読み込み]
    G -->|No| I[エラー: seed_loader未設定]
    H --> J[seeds.rb 内の処理実行]
    J --> K[db:seed 完了]
    E --> L[処理中断]
    I --> L
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| migration_context.open | schema_migrations | SELECT | 未適用マイグレーションチェック |
| seeds.rb実行 | seeds.rb内で指定 | INSERT/UPDATE等 | シードデータ投入 |

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

seeds.rbの実装に依存する。一般的なパターン：

#### マスタテーブル等

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | 全カラム | seeds.rbで定義された値 | create または create! |
| UPSERT | 全カラム | seeds.rbで定義された値 | find_or_create_by 等 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | PendingMigrationError | 未適用マイグレーションが存在 | db:migrate を実行 |
| - | SeedLoaderError | seed_loaderが未設定 | Rails環境を確認 |
| - | SyntaxError | seeds.rbに文法エラー | seeds.rbを修正 |
| - | ActiveRecordError | データ投入時のDB制約違反 | seeds.rbのデータを確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. 未適用マイグレーションエラーの場合は `db:migrate` を実行
3. seeds.rb内のエラーの場合はファイルを修正
4. DB制約違反の場合はデータ内容を確認・修正
5. 必要に応じて `db:rollback` でデータベースを元に戻す

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | seeds.rb内の実装に依存 |
| コミットタイミング | seeds.rb内の実装に依存 |
| ロールバック条件 | seeds.rb内の実装に依存 |

**注意**: seeds.rb自体はトランザクションで囲まれていない。必要に応じてseeds.rb内でトランザクションを明示的に使用すること。

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | seeds.rbで定義されたデータ量に依存 |
| 目標処理時間 | データ量に依存 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行は非推奨
- seeds.rb内で排他制御が必要な場合は明示的に実装すること
- find_or_create_by 等を使用して冪等性を確保することを推奨

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | タスク開始時 | （seeds.rb内で実装） |
| 進捗ログ | 処理中 | （seeds.rb内で実装） |
| 終了ログ | タスク終了時 | （seeds.rb内で実装） |
| エラーログ | エラー発生時 | エラー詳細メッセージ |

## 監視・アラート

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

## 備考

- seeds.rbは冪等性を持たせた実装が推奨される（複数回実行しても同じ結果になる）
- 大量データの投入には `activerecord-import` gem 等の使用を検討
- 環境別のシードデータは `db/seeds/` ディレクトリに分割して管理することも可能
- `Rails.application.load_seed` は内部的に `db/seeds.rb` を load する
- seeds.rbではモデルの検証やコールバックが実行される。バイパスする場合は明示的に指定が必要
- `db:setup` タスクの一部として自動実行されるため、通常は個別に実行する必要はない
