# バッチ設計書 39-db:schema:cache:clear

## 概要

本ドキュメントは、Railsフレームワークが提供するスキーマキャッシュクリア用Rakeタスク `db:schema:cache:clear` の設計仕様について記載する。

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

`db:schema:cache:clear` タスクは、データベースのスキーマキャッシュファイル（db/schema_cache.yml）を削除するためのRakeタスクである。スキーマ変更後にキャッシュを無効化する際に使用する。

**業務上の目的・背景**：スキーマキャッシュが古くなった場合や、キャッシュに起因する問題が発生した場合に、キャッシュファイルを削除してアプリケーションがデータベースから最新のスキーマ情報を取得するようにするために使用される。マイグレーション実行後やテーブル構造の変更後に実行されることが多い。

**バッチの実行タイミング**：以下のタイミングで実行される：
- スキーマ変更後の手動実行
- キャッシュに起因する問題のトラブルシューティング時
- デプロイメント時のクリーンアップ

**主要な処理内容**：
1. 現在の環境のすべてのデータベース設定に対してループ処理
2. 各データベースに対応するキャッシュファイルのパスを取得
3. `clear_schema_cache` メソッドでキャッシュファイルを削除

**前後の処理との関連**：
- 関連タスク：`db:schema:cache:dump`（キャッシュファイルを生成）
- 関連タスク：`db:migrate`（マイグレーション後にキャッシュクリアが必要な場合がある）
- 後続処理：キャッシュ再生成が必要な場合は `db:schema:cache:dump` を実行

**影響範囲**：db/schema_cache.yml ファイルが削除される。アプリケーション次回起動時はデータベースから直接スキーマ情報を取得するため、起動時間が若干長くなる可能性がある。

## バッチ種別

スキーマ管理 / キャッシュクリア

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| キャッシュファイル存在 | db/schema_cache.yml が存在すること（任意） |

### 実行可否判定

- キャッシュファイルが存在しない場合でもエラーにはならない（FileUtils.rm_fを使用）
- データベース接続は不要

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| config/database.yml | YAML | データベース接続設定（キャッシュパス取得用） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ファイルシステム | - | キャッシュファイルの削除 |

### 出力ファイル仕様

ファイル出力は行わない。既存のキャッシュファイルの削除のみを実行する。

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ Railsアプリケーションとデータベース設定をロード
2. 各データベース設定をループ処理
   └─ configs_for(env_name: current_env) で設定一覧を取得
3. cache_dump_filename 取得
   └─ 各db_configに対応するキャッシュファイルパスを取得
4. clear_schema_cache 実行
   └─ FileUtils.rm_f でファイルを削除
   └─ verbose: false で出力を抑制
```

### フローチャート

```mermaid
flowchart TD
    A[db:schema:cache:clear 開始] --> B[設定ロード]
    B --> C[configs_for取得]
    C --> D[各DB設定をループ]
    D --> E[cache_dump_filename取得]
    E --> F[clear_schema_cache]
    F --> G[FileUtils.rm_f実行]
    G --> H[次のDB設定へ]
    H --> I{全DB処理完了?}
    I -->|No| D
    I -->|Yes| J[db:schema:cache:clear 完了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし |

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

本タスクはデータベースへのアクセスを行わない。ファイルシステム操作のみを実行する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | IOError | ファイル削除失敗（権限エラー等） | ファイル権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. ファイル権限を確認
3. 手動でファイルを削除

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | データベース設定数（通常1〜数個） |
| 目標処理時間 | 即時（ミリ秒単位） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行可能
- ファイル削除は冪等操作のため競合なし

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | タスク開始時 | （標準では出力なし） |
| 進捗ログ | 処理中 | （verbose: falseのため出力なし） |
| 終了ログ | タスク終了時 | （標準では出力なし） |
| エラーログ | エラー発生時 | エラー詳細メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| エラー件数 | 1件以上 | 開発者 |

## 備考

- `FileUtils.rm_f` を使用しているため、ファイルが存在しなくてもエラーにならない
- `verbose: false` で出力を抑制しているため、削除のログは出力されない
- マルチデータベース構成では、各DBごとのキャッシュファイルが全て削除される
- キャッシュクリア後は `db:schema:cache:dump` で再生成することを推奨
- 本番環境では、キャッシュクリア後の初回起動時間が長くなる可能性があることに注意
- CI/CDパイプラインでは、クリア後に必ずダンプを実行するフローを推奨
- スキーマ変更を伴うマイグレーション後は、必ずキャッシュのクリアと再生成を行うこと
