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

## 概要

本ドキュメントはMedusa CLIのdb:migrateコマンドについて、その設計内容を記述したバッチ設計書です。本コマンドはデータベースマイグレーションを実行し、モジュールのスキーマ変更を適用します。

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

db:migrateは、Medusaアプリケーションのデータベースマイグレーションを実行するCLIコマンドです。各モジュールのMikroORMマイグレーションを実行し、リンクテーブルの同期を行い、必要に応じてマイグレーションスクリプトを実行します。

**業務上の目的・背景**：Medusaはモジュラーアーキテクチャを採用しており、各モジュールが独自のデータベーススキーマを持っています。アプリケーションのアップデートや新機能の追加時に、データベーススキーマの変更が必要になります。db:migrateコマンドは、これらのスキーマ変更を安全かつ一貫性を保って適用するための中核的なツールです。開発環境から本番環境まで、すべての環境でデータベースの状態を同期させることができます。

**バッチの実行タイミング**：デプロイ時、アップデート後、または開発中に手動でCLI経由で実行します。

**主要な処理内容**：
1. データベースの存在確認・作成
2. pgstream有効時は並行性を1に制限
3. プラグインのモジュール設定をマージ
4. リンク定義を読み込み
5. マイグレーションテーブルの確保
6. 各モジュールのマイグレーション実行
7. リンクテーブルの同期
8. マイグレーションスクリプトの実行（オプション）

**前後の処理との関連**：通常、新しいバージョンのMedusaをインストールした後や、モジュールの追加・更新後に実行します。db:migrate:scriptsコマンドを内部で呼び出す場合があります。

**影響範囲**：全モジュールのデータベーステーブル、リンクテーブル、マイグレーション履歴テーブルが影響を受けます。

## バッチ種別

CLIコマンド / データベースマイグレーション

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（デプロイ・アップデート時） |
| 実行時刻 | 手動実行 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `npx medusa db:migrate`コマンド |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続設定 | 有効なデータベース接続設定が存在すること |
| Node.js環境 | Node.jsランタイムが利用可能であること |
| 依存関係インストール | npm/yarn installが完了していること |

### 実行可否判定

- データベースが存在しない場合は自動作成を試みる
- マイグレーションテーブルがない場合は自動作成

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| directory | string | Yes | カレントディレクトリ | プロジェクトのルートディレクトリ |
| skipLinks | boolean | No | false | リンク同期をスキップ |
| skipScripts | boolean | No | false | マイグレーションスクリプトをスキップ |
| executeAllLinks | boolean | No | false | 全リンク操作を確認なしで実行 |
| executeSafeLinks | boolean | No | false | 安全なリンク操作のみを実行 |
| allOrNothing | boolean | No | - | 全マイグレーションを単一トランザクションで実行 |
| concurrency | number | No | - | 並列実行数（pgstream時は1に強制） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| モジュールマイグレーション | TypeScript/JavaScript | 各モジュールのマイグレーションファイル |
| プラグイン設定 | TypeScript/JavaScript | プラグインのモジュール設定 |
| リンク定義 | TypeScript/JavaScript | モジュール間リンク定義 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| データベーステーブル | DB | マイグレーション適用後のスキーマ |
| マイグレーション履歴 | DB | 実行済みマイグレーションの記録 |
| リンクテーブル | DB | 同期されたリンクテーブル |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 環境設定
   └─ MEDUSA_WORKER_MODE = "server"
2. コンテナ初期化
   └─ initializeContainer(directory)
3. データベース確認
   └─ ensureDbExists(container)
4. pgstreamチェック
   └─ pgstream有効時は並列数を1に制限
5. プラグインロード
   └─ getResolvedPlugins → mergePluginModules
6. リンク定義ロード
   └─ LinkLoader(linksSourcePaths).load()
7. マイグレーションテーブル確保
   └─ migrator.ensureMigrationsTable()
8. モジュールマイグレーション実行
   └─ medusaAppLoader.runModulesMigrations({action: "run"})
9. リンク同期（skipLinksでない場合）
   └─ syncLinks(medusaAppLoader, options)
10. マイグレーションスクリプト実行（skipScriptsでない場合）
    └─ fork(cliPath, ["db:migrate:scripts"])
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド開始] --> B[コンテナ初期化]
    B --> C[ensureDbExists]
    C --> D{pgstream有効?}
    D -->|Yes| E[並列数=1]
    D -->|No| F[並列数維持]
    E --> G[プラグインロード]
    F --> G
    G --> H[リンク定義ロード]
    H --> I[マイグレーションテーブル確保]
    I --> J[モジュールマイグレーション実行]
    J --> K[マイグレーション完了ログ]
    K --> L{skipLinks?}
    L -->|Yes| M{skipScripts?}
    L -->|No| N[リンク同期]
    N --> M
    M -->|Yes| O[終了]
    M -->|No| P[db:migrate:scripts fork]
    P --> Q[スクリプト完了待機]
    Q --> O
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DB確認/作成 | データベース自体 | CREATE DATABASE | 存在しない場合作成 |
| マイグレーションテーブル確保 | mikro_orm_migrations | CREATE TABLE | 履歴テーブル作成 |
| マイグレーション実行 | 各モジュールテーブル | CREATE/ALTER/DROP | スキーマ変更適用 |
| マイグレーション記録 | mikro_orm_migrations | INSERT | 実行記録 |
| リンク同期 | リンクテーブル | CREATE/ALTER/DROP | リンクテーブル同期 |

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

#### mikro_orm_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | name, executed_at | マイグレーション名, 現在時刻 | 実行完了時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗 | 接続設定を確認 |
| - | マイグレーションエラー | スキーマ変更失敗 | エラー内容を確認して修正 |
| - | 子プロセスエラー | db:migrate:scripts失敗 | スクリプト内容を確認 |

### リトライ仕様

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

### 障害時対応

- マイグレーション失敗時はlogger.errorでエラー出力
- process.exit(1)で異常終了
- allOrNothingオプション使用時は全体ロールバック

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | モジュール単位（デフォルト）/ 全体（allOrNothing時） |
| コミットタイミング | 各モジュールマイグレーション完了時 |
| ロールバック条件 | マイグレーション失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | モジュール数に依存 |
| 目標処理時間 | モジュール数・変更量に依存 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- マイグレーション実行中は他のマイグレーション実行を避ける（手動管理）
- pgstream環境では並列数を強制的に1に制限

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 処理開始時 | `Running migrations...` |
| 区切り線 | 処理完了時 | ターミナル幅のダッシュ |
| 情報ログ | マイグレーション完了時 | `Migrations completed` |
| 区切り線 | リンク同期前 | ターミナル幅のダッシュ |
| 区切り線 | スクリプト実行前 | ターミナル幅のダッシュ |
| エラーログ | エラー発生時 | エラー内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | 呼び出し元 |

## 備考

- 終了コード: 成功時0、失敗時1
- MEDUSA_WORKER_MODEを"server"に設定して実行
- MedusaAppLoaderを使用してモジュールマイグレーションを実行
- Migratorクラスでマイグレーションテーブルを管理
- syncLinks関数でリンクテーブルの同期を実行
- db:migrate:scriptsはfork()で子プロセスとして実行
- DB_MIGRATION_CONCURRENCY環境変数で並列数を制御可能
- 実装箇所: `packages/medusa/src/commands/db/migrate.ts`
