# バッチ設計書 29-db:migrate:status

## 概要

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

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

`db:migrate:status` は、マイグレーションの実行状況（ステータス）を一覧表示するRakeタスクである。各マイグレーションが「up」（適用済み）か「down」（未適用）かを確認できる。

**業務上の目的・背景**：開発チームでマイグレーションの状態を把握することは、スキーマ管理において重要である。どのマイグレーションが適用済みで、どれが未適用かを確認することで、環境間の差異を特定し、デプロイ前の確認やトラブルシューティングを効率的に行える。

**バッチの実行タイミング**：マイグレーション状況の確認時、デプロイ前の確認時、環境間の差異調査時、またはトラブルシューティング時に随時実行される。

**主要な処理内容**：
1. schema_migrationsテーブルから適用済みバージョンを取得
2. db/migrate/ディレクトリからマイグレーションファイルを取得
3. 各マイグレーションのステータスを判定
4. 一覧形式で表示

**前後の処理との関連**：読み取り専用のタスクであり、他のタスクとの直接的な依存関係はない。`db:migrate` 前後の状態確認に使用される。

**影響範囲**：読み取り専用のため、データベースへの変更は行わない。

## バッチ種別

データベース管理 / 状態確認

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config/database.yml | データベース設定ファイルが存在すること |
| データベース存在 | 対象データベースが作成済みであること |
| schema_migrations | schema_migrationsテーブルが存在すること |

### 実行可否判定

- schema_migrationsテーブルが存在しない場合はエラーメッセージを出力してabort
- データベース接続が確立できない場合はエラー

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本タスクはパラメータを受け取らない |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | マイグレーションステータス一覧 |

### 出力ファイル仕様

ファイル出力なし。

### 出力フォーマット

```
database: データベース名

 Status   Migration ID    Migration Name
--------------------------------------------------
   up     20240101000000  CreateUsers
   up     20240102000000  AddEmailToUsers
  down    20240103000000  CreatePosts
********** NO FILE **********
   up     20240104000000  *** NO FILE ***
```

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ database.ymlから設定を読み込み
2. with_temporary_pool_for_each
   └─ 各データベース接続でステータスを確認
3. schema_migration.table_exists?チェック
   └─ テーブルが存在しない場合はabort
4. migrations_status取得
   └─ 適用済みバージョンとファイルを照合
5. ステータス一覧出力
   └─ フォーマットに従って出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[load_config実行]
    B --> C[with_temporary_pool_for_each]
    C --> D{schema_migrations存在?}
    D -->|No| E[エラー: Table does not exist yet]
    E --> F[abort終了]
    D -->|Yes| G[データベース名出力]
    G --> H[ヘッダー出力]
    H --> I[migrations_status取得]
    I --> J{次のマイグレーションあり?}
    J -->|あり| K[ステータス行出力]
    K --> J
    J -->|なし| L{次のDB接続あり?}
    L -->|あり| C
    L -->|なし| M[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| table_exists? | schema_migrations | SELECT | テーブル存在確認 |
| migrations_status | schema_migrations | SELECT | 適用済みバージョン取得 |

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

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | version | 全件取得 | 適用済みバージョン一覧 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Abort | schema_migrationsテーブル不存在 | db:migrateを実行してテーブルを作成 |
| - | ConnectionError | DB接続失敗 | 接続設定を確認 |

### リトライ仕様

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

### 障害時対応

1. schema_migrationsテーブル不存在時：
   - `db:migrate` を実行してテーブルを作成
   - または新規環境では `db:create` から実行

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

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

## パフォーマンス要件

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

## 排他制御

読み取り専用のため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| ヘッダー | 処理開始時 | "database: [name]"、カラムヘッダー |
| ステータス行 | 各マイグレーション | "  up/down  [version]  [name]" |
| エラーログ | テーブル不存在時 | "Schema migrations table does not exist yet." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- ステータスの種類：
  - `up`: マイグレーションが適用済み
  - `down`: マイグレーションが未適用
  - `*** NO FILE ***`: schema_migrationsにレコードはあるが、対応するファイルが存在しない
- マルチデータベース構成の場合、すべてのデータベースのステータスが順次表示される
- `db:migrate:status:[database_name]` で特定のデータベースのみ表示可能
- ファイル名からマイグレーション名を抽出（スネークケースからタイトルケースに変換）
