# バッチ設計書 38-db:schema:cache:dump

## 概要

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

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

`db:schema:cache:dump` タスクは、データベースのスキーマ情報をYAML形式のキャッシュファイル（db/schema_cache.yml）に出力するためのRakeタスクである。アプリケーション起動時のスキーマ情報取得を高速化するために使用する。

**業務上の目的・背景**：本番環境でのアプリケーション起動時間を短縮するために使用される。通常、Railsアプリケーションは起動時にデータベースに接続してスキーマ情報を取得するが、スキーマキャッシュを使用することでこのオーバーヘッドを削減できる。特に大規模なスキーマを持つアプリケーションや、コールドスタートが頻繁に発生するサーバーレス環境で効果的である。

**バッチの実行タイミング**：以下のタイミングで実行される：
- デプロイメント時の自動実行
- スキーマ変更後の手動実行
- CI/CDパイプラインでのキャッシュ生成

**主要な処理内容**：
1. 現在の環境のすべてのデータベース設定に対してループ処理
2. 各データベースに対して一時的なコネクションプールを確立
3. キャッシュファイルのパスを決定
4. `schema_cache.dump_to` メソッドでスキーマ情報をYAML形式で出力

**前後の処理との関連**：
- 前提：データベースが作成済みで、スキーマがロードされていること
- 関連タスク：`db:schema:cache:clear`（キャッシュファイルを削除）
- 関連設定：`config.active_record.use_schema_cache_dump`（キャッシュ使用の有無）

**影響範囲**：db/schema_cache.yml ファイルが生成・更新される。データベース自体への変更は行わない。

## バッチ種別

スキーマ管理 / キャッシュ生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（デプロイ時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動/自動（デプロイ時） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース存在 | 対象データベースが作成済みであること |
| スキーマロード済み | テーブル構造が構築されていること |
| データベース接続可能 | 接続情報が正しく設定されていること |

### 実行可否判定

- データベースに接続できない場合はエラー
- db_configが取得できない場合はスキップ

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| データベース | DB | スキーマメタデータ（カラム情報等） |
| config/database.yml | YAML | データベース接続設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| db/schema_cache.yml | YAML | スキーマキャッシュファイル |
| 標準出力 | テキスト | 処理結果メッセージ（VERBOSEモード） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | schema_cache.yml（デフォルト） |
| 出力先 | db/ ディレクトリ |
| 文字コード | UTF-8 |
| 形式 | YAML |
| 上書き動作 | 既存ファイルを上書き |

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ Railsアプリケーションとデータベース設定をロード
2. with_temporary_pool_for_each 実行
   └─ 各データベース設定に対してループ処理
   └─ 一時的なコネクションプールを確立
3. cache_dump_filename 取得
   └─ db_config.schema_cache_path または
   └─ db_config.default_schema_cache_path を使用
4. dump_schema_cache 実行
   └─ pool.schema_cache.dump_to(filename)
   └─ スキーマ情報をYAML形式でファイルに出力
```

### フローチャート

```mermaid
flowchart TD
    A[db:schema:cache:dump 開始] --> B[設定ロード]
    B --> C[with_temporary_pool_for_each]
    C --> D[各DB設定をループ]
    D --> E[一時コネクションプール確立]
    E --> F[cache_dump_filename取得]
    F --> G[dump_schema_cache]
    G --> H[schema_cache.dump_to実行]
    H --> I[YAMLファイル書き込み]
    I --> J[次のDB設定へ]
    J --> K{全DB処理完了?}
    K -->|No| D
    K -->|Yes| L[db:schema:cache:dump 完了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマ取得 | 全テーブル | SELECT (メタデータ) | カラム情報等を取得 |

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

データベースへの書き込み操作は行わない（メタデータの読み取りのみ）。

**取得される情報**：
- テーブル名一覧
- 各テーブルのカラム情報（名前、型、デフォルト値、NULL許可等）
- 主キー情報
- インデックス情報

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | データベース接続失敗 | database.yml設定を確認 |
| - | IOError | ファイル書き込み失敗 | db/ディレクトリの権限を確認 |
| - | NoDatabaseError | データベースが存在しない | db:create を実行 |

### リトライ仕様

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

### 障害時対応

1. エラーメッセージを確認し、原因を特定
2. データベース接続を確認
3. db/ディレクトリの書き込み権限を確認
4. データベースが存在しない場合は db:create を実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（読み取り専用） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | テーブル数に依存 |
| 目標処理時間 | 通常数秒以内 |
| メモリ使用量上限 | スキーマサイズに依存 |

## 排他制御

- 同時実行可能（読み取り専用のため）
- ファイル書き込み時の競合に注意
- スキーマ変更中の同時ダンプは避けること

## ログ出力

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

## 監視・アラート

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

## 備考

- スキーマキャッシュはアプリケーション起動時間の短縮に有効
- マイグレーション実行後は必ずキャッシュを再生成すること
- `config.active_record.use_schema_cache_dump = true` で有効化
- マルチデータベース構成では、各DBごとに別のキャッシュファイルを生成可能
- キャッシュファイルのパスは `db_config.schema_cache_path` で設定可能
- デフォルトでは `db/schema_cache.yml` に出力される
- キャッシュファイルはバージョン管理に含めることが推奨される
- Docker環境やサーバーレス環境でのコールドスタート最適化に特に有効
