# バッチ設計書 24-db:migrate

## 概要

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

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

`db:migrate` は、未実行のデータベースマイグレーションを実行し、スキーマを最新の状態に更新するRakeタスクである。Railsアプリケーションにおける最も重要なデータベース管理タスクの一つである。

**業務上の目的・背景**：アプリケーションの機能追加や変更に伴い、データベーススキーマを進化させる必要がある。マイグレーションにより、スキーマ変更を再現可能かつバージョン管理可能な形で管理できる。チーム開発において、各開発者のローカル環境やステージング・本番環境で一貫したスキーマを維持するために不可欠である。

**バッチの実行タイミング**：デプロイ時、新機能開発後のローカル環境更新時、他の開発者の変更をプル後、または `db:setup` / `db:prepare` の一部として実行される。

**主要な処理内容**：
1. 未実行マイグレーションの特定
2. バージョン順でのマイグレーション実行
3. schema_migrations テーブルへの実行記録
4. スキーマファイル（schema.rb/structure.sql）のダンプ

**前後の処理との関連**：`db:create` でデータベースが作成された後に実行される。実行後は自動的に `db:schema:dump` が呼び出される（設定による）。`db:rollback` で変更を取り消すことができる。

**影響範囲**：対象データベースのスキーマ全体。テーブルの作成・変更・削除、インデックス操作、データ変更など、マイグレーションファイルに定義されたすべての操作が影響する。

## バッチ種別

データベース管理 / スキーママイグレーション

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | デプロイ時、開発時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / デプロイスクリプト |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| config/database.yml | データベース設定ファイルが存在すること |
| データベース存在 | 対象データベースが作成済みであること |
| マイグレーションファイル | db/migrate/ にマイグレーションファイルが存在すること |

### 実行可否判定

- データベースが存在しない場合は自動的に作成される（initialize_database）
- VERSION環境変数が指定されている場合は、形式の妥当性をチェック
- SCOPE環境変数が指定されている場合は、対象スコープのマイグレーションのみを実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| VERSION | Integer | No | なし | 特定バージョンまでのマイグレーション実行 |
| VERBOSE | Boolean | No | true | 詳細出力の有効化 |
| SCOPE | String | No | なし | マイグレーションスコープのフィルタ |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | マイグレーション実行状況 |
| schema_migrations | DB | 実行済みマイグレーションのバージョン |
| db/schema.rb | Ruby | スキーマダンプファイル（設定による） |
| db/structure.sql | SQL | SQLスキーマダンプファイル（設定による） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | schema.rb または structure.sql |
| 出力先 | db/ |
| 文字コード | UTF-8 |
| 内容 | 現在のスキーマ定義 |

## 処理フロー

### 処理シーケンス

```
1. load_config
   └─ database.ymlから設定を読み込み
2. migrate_all
   └─ すべてのデータベース設定に対してマイグレーション実行
3. initialize_database（必要に応じて）
   └─ DBが存在しない場合は作成、スキーマがあればロード
4. migration_context.migrate
   └─ 未実行マイグレーションを順次実行
5. schema_migrations更新
   └─ 各マイグレーションの実行を記録
6. _dump
   └─ スキーマファイルをダンプ（設定による）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[load_config実行]
    B --> C[VERSION形式チェック]
    C --> D{VERSION有効?}
    D -->|No| E[エラー終了]
    D -->|Yes| F[migrate_all実行]
    F --> G{DB存在?}
    G -->|No| H[DB作成・スキーマロード]
    G -->|Yes| I[migration_context.migrate]
    H --> I
    I --> J{未実行マイグレーションあり?}
    J -->|あり| K[マイグレーション実行]
    K --> L[schema_migrations更新]
    L --> M{次のマイグレーション?}
    M -->|あり| K
    M -->|なし| N[スキーマキャッシュクリア]
    J -->|なし| N
    N --> O{dump_schema_after_migration?}
    O -->|Yes| P[schema:dump実行]
    O -->|No| Q[バッチ終了]
    P --> Q
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| initialize_database | schema_migrations | SELECT | テーブル存在確認 |
| migrate | マイグレーション定義による | CREATE/ALTER/DROP等 | スキーマ変更 |
| record_version | schema_migrations | INSERT | 実行バージョンの記録 |
| set_metadata | ar_internal_metadata | INSERT/UPDATE | 環境情報の記録 |

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

#### schema_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | version | マイグレーションのタイムスタンプ | 14桁の数値 |

#### ar_internal_metadata

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT/UPDATE | key, value | environment, schema_sha1等 | 環境・スキーマ情報 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | InvalidVersion | VERSION形式が不正 | 正しい形式（数値）でVERSIONを指定 |
| - | IrreversibleMigration | ロールバック不可マイグレーション | マイグレーションファイルを修正 |
| - | StandardError | マイグレーション内のエラー | マイグレーションファイルを修正、手動ロールバック |

### リトライ仕様

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

### 障害時対応

マイグレーション失敗時：
1. エラーメッセージを確認
2. 部分的に適用された変更を手動でロールバック
3. マイグレーションファイルを修正
4. 再度 `db:migrate` を実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各マイグレーションファイル単位（アダプタ依存） |
| コミットタイミング | マイグレーション完了時 |
| ロールバック条件 | マイグレーション内でのエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数件〜数十件のマイグレーション |
| 目標処理時間 | マイグレーション内容に依存 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時実行は避けるべき。特に本番環境では、デプロイ時に単一プロセスでのみ実行することを推奨。Advisory Lockなどの機構は標準では提供されていない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | 各マイグレーション開始時 | "== [timestamp] MigrationName: migrating ====" |
| 完了ログ | 各マイグレーション完了時 | "== [timestamp] MigrationName: migrated (Xs) ===" |
| 操作ログ | 各DDL操作時 | "-- create_table(:table_name)" 等 |
| スコープログ | SCOPEで実行なしの場合 | "No migrations ran. (using [scope] scope)" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | マイグレーション内容に依存 | デプロイ監視 |
| エラー発生 | 1件以上 | デプロイ失敗通知 |

## 備考

- `ActiveRecord.dump_schema_after_migration` が `true`（デフォルト）の場合、マイグレーション後に自動的にスキーマファイルがダンプされる
- マルチデータベース構成の場合、すべてのデータベースに対してマイグレーションが実行される
- VERSION指定時は、その特定バージョンのみが実行される（up方向への移動）
- VERBOSE=false で詳細出力を抑制可能
