# バッチ設計書 41-db:version

## 概要

本ドキュメントは、Railsアプリケーションにおけるデータベースの現在のスキーマバージョン番号を取得するRakeタスク `db:version` の設計仕様を定義する。

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

`db:version` タスクは、現在のRails環境で接続されているデータベースのスキーマバージョンを表示するユーティリティタスクである。マイグレーションの適用状況を確認する際に使用される。

**業務上の目的・背景**：データベースマイグレーションの管理において、現在どのバージョンまでマイグレーションが適用されているかを確認することは重要である。本タスクにより、開発者やデプロイ担当者は、データベースの状態を迅速に把握し、マイグレーションの適用漏れや環境間の差異を検出できる。また、トラブルシューティング時にデータベースの状態を確認する際にも活用される。

**バッチの実行タイミング**：手動実行が主体であり、以下のような場面で使用される。
- デプロイ前後のデータベース状態確認
- マイグレーション実行後の検証
- 環境間のスキーマバージョン比較
- 障害調査時のデータベース状態確認

**主要な処理内容**：
1. Railsアプリケーションの設定を読み込む
2. 現在の環境（Rails.env）に対応するデータベース設定を取得する
3. マルチデータベース構成の場合は、各データベースに対して順次処理を実行する
4. 各データベースの接続プールを使用してマイグレーションコンテキストを取得する
5. `migration_context.current_version` を呼び出して現在のスキーマバージョンを取得する
6. データベース名とバージョン番号を標準出力に表示する

**前後の処理との関連**：本タスクは読み取り専用であり、他のタスクとの依存関係は少ない。ただし、`db:migrate` 実行後に状態確認として使用されることが多い。また、`db:migrate:status` と併用してマイグレーションの詳細な状態を確認することもある。

**影響範囲**：本タスクはデータベースの状態を読み取るのみであり、データやスキーマへの変更は一切行わない。システムへの影響は最小限である。

## バッチ種別

情報表示 / データベース状態確認

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース設定 | config/database.yml が正しく設定されていること |
| データベース接続 | 対象データベースに接続可能であること |
| スキーマ管理テーブル | schema_migrationsテーブルが存在すること |

### 実行可否判定

データベースに接続可能であれば実行可能。データベースが存在しない場合はエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| RAILS_ENV | String | No | development | 対象とする環境 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| schema_migrations | DB | マイグレーション履歴テーブル |
| config/database.yml | YAML | データベース接続設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | データベース名と現在のスキーマバージョン |

### 出力ファイル仕様

ファイル出力なし。標準出力へのテキスト表示のみ。

出力例：
```
database: myapp_development
Current version: 20240101120000
```

## 処理フロー

### 処理シーケンス

```
1. load_config タスクの実行
   └─ データベース設定の読み込みとマイグレーションパスの設定
2. 環境に対応するデータベース接続プールの取得
   └─ with_temporary_pool_for_each を使用して各データベースを処理
3. マイグレーションコンテキストの取得
   └─ pool.migration_context を使用
4. 現在のバージョン取得
   └─ migration_context.current_version を呼び出し
5. 結果の出力
   └─ データベース名とバージョンを puts で表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[load_config タスク実行]
    B --> C[環境のデータベース設定取得]
    C --> D{マルチDB構成？}
    D -->|Yes| E[各データベースをループ]
    D -->|No| F[単一データベース処理]
    E --> G[データベース名を出力]
    F --> G
    G --> H[current_version 取得]
    H --> I[バージョン番号を出力]
    I --> J{次のDB あり？}
    J -->|Yes| E
    J -->|No| K[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| バージョン取得 | schema_migrations | SELECT | 最新のマイグレーションバージョンを取得 |

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

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | version | MAX(version) | 最大バージョン番号を取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続エラー | データベースに接続できない | database.yml の設定を確認 |
| - | テーブル不存在 | schema_migrationsテーブルがない | db:migrate を実行 |

### リトライ仕様

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

### 障害時対応

接続エラーの場合は、データベースの起動状態と接続設定を確認する。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1-数件（データベース数分） |
| 目標処理時間 | 1秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行可能。読み取り専用のため排他制御不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | 処理完了時 | データベース名とバージョン番号 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクは手動実行が主であり、特別な監視は不要。

## 備考

- マルチデータベース構成の場合、個別のデータベースバージョンは `db:version:データベース名` で取得可能
- 取得されるバージョン番号は、schema_migrationsテーブルに記録されている最大のタイムスタンプ値
