# バッチ設計書 41-migrate

## 概要

本ドキュメントは、InvenTreeシステムにおけるデータベースマイグレーションを実行するinvokeタスク「migrate」の設計書です。

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

**業務上の目的・背景**：InvenTreeのバージョンアップやスキーマ変更に伴い、データベースの構造を新しいモデル定義に合わせて更新する必要があります。このバッチは、Djangoのマイグレーション機能を活用し、データを保持したままデータベーススキーマを安全に変更します。システムの継続的な運用とアップデートにおいて不可欠な処理です。

**バッチの実行タイミング**：ソースコードの更新後、特にモデル定義の変更を含むアップデート後に手動で実行します。updateタスクの一部としても自動的に呼び出されます。

**主要な処理内容**：
1. `makemigrations`コマンドでマイグレーションファイルを生成
2. `runmigrations`コマンドでメンテナンスモードでマイグレーションを実行
3. `migrate --run-syncdb`コマンドでデータベース同期を実行
4. `remove_stale_contenttypes`コマンドで古いコンテンツタイプを削除
5. 処理完了後、`rebuild_models`と`rebuild_thumbnails`タスクを自動実行

**前後の処理との関連**：updateタスクの中核的な処理として位置付けられ、install（依存パッケージインストール）の後、static（静的ファイル収集）の前に実行されます。また、import_recordsタスクの後処理としても呼び出されます。

**影響範囲**：データベースのスキーマ全体に影響を与えます。MPTTツリー構造を持つモデル（Part、StockLocation、PartCategory等）の再構築も行われます。

## バッチ種別

データベースマイグレーション / システムメンテナンス

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（バージョンアップ時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / updateタスクからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | データベースへの接続が確立されていること |
| Python環境 | 正しいPython仮想環境がアクティブであること |
| 依存パッケージ | 必要なPythonパッケージがインストール済みであること |
| バックアップ | マイグレーション前にデータベースバックアップを推奨 |

### 実行可否判定

Djangoの内部マイグレーションステータスにより、適用すべきマイグレーションが存在するかを自動判定します。マイグレーションが不要な場合も安全に実行可能です（No migrations to apply）。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このタスクは入力パラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| マイグレーションファイル | Python | 各アプリのmigrationsディレクトリ内のマイグレーションファイル |
| django_migrations | DB | 適用済みマイグレーションの履歴テーブル |
| モデル定義 | Python | 各アプリのmodels.pyに定義されたモデルクラス |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| データベーススキーマ | DB | 更新されたテーブル構造 |
| django_migrations | DB | 新たに適用されたマイグレーションレコード |
| コンソール | テキスト | マイグレーション実行結果のログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | マイグレーションファイル（自動生成時）: `NNNN_auto_YYYYMMDD_HHMM.py` |
| 出力先 | 各アプリの`migrations/`ディレクトリ |
| 文字コード | UTF-8 |
| 区切り文字 | 該当なし |

## 処理フロー

### 処理シーケンス

```
1. makemigrations実行
   └─ モデル定義の変更を検出し、マイグレーションファイルを生成

2. runmigrations実行
   └─ メンテナンスモードを有効化してマイグレーションを実行

3. migrate --run-syncdb実行
   └─ データベースの同期処理を実行

4. remove_stale_contenttypes実行
   └─ 古いコンテンツタイプエントリを削除

5. rebuild_models実行（後処理）
   └─ MPTTツリー構造を再構築

6. rebuild_thumbnails実行（後処理）
   └─ 欠落しているサムネイル画像を再生成
```

### フローチャート

```mermaid
flowchart TD
    A[migrate開始] --> B[makemigrations]
    B --> C[マイグレーションファイル生成]
    C --> D[runmigrations]
    D --> E{メンテナンスモード}
    E --> F[migrate --run-syncdb]
    F --> G[remove_stale_contenttypes]
    G --> H[rebuild_models]
    H --> I[rebuild_thumbnails]
    I --> J[migrate完了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| makemigrations | なし | - | マイグレーションファイル生成のみ |
| runmigrations | 全対象テーブル | ALTER/CREATE/DROP | スキーマ変更を実行 |
| migrate --run-syncdb | django_migrations | INSERT | 適用済みマイグレーションを記録 |
| remove_stale_contenttypes | django_content_type | DELETE | 古いコンテンツタイプを削除 |

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

#### django_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | app | アプリ名 | マイグレーション適用時 |
| INSERT | name | マイグレーション名 | マイグレーション適用時 |
| INSERT | applied | 現在日時 | マイグレーション適用時 |

#### 各アプリケーションテーブル

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| ALTER | 各カラム | マイグレーション定義に依存 | スキーマ変更 |
| CREATE | 新規テーブル | マイグレーション定義に依存 | テーブル追加時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | OperationalError | データベース接続失敗 | データベースサーバーの起動確認 |
| - | ProgrammingError | SQLエラー | マイグレーションファイルの確認 |
| - | IntegrityError | データ整合性エラー | データの確認と修正 |
| - | MigrationSchemaMissing | マイグレーションテーブル未作成 | 初期マイグレーションの実行 |

### リトライ仕様

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

### 障害時対応

1. マイグレーション失敗時はデータベースバックアップから復元
2. 部分的に適用されたマイグレーションは`migrate <app> <migration_name>`で個別にロールバック可能
3. 致命的なエラーの場合は`--fake`オプションでマイグレーション履歴を調整

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | マイグレーション単位 |
| コミットタイミング | 各マイグレーション完了時 |
| ロールバック条件 | マイグレーション実行中のエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | マイグレーション数に依存 |
| 目標処理時間 | マイグレーション内容に依存（通常数秒〜数分） |
| メモリ使用量上限 | 通常のDjango動作範囲内 |

## 排他制御

- 同時実行は禁止（メンテナンスモードで他のアクセスをブロック）
- `runmigrations`コマンドにより、マイグレーション中はシステムがメンテナンスモードに移行
- 複数インスタンス環境では、1つのインスタンスのみでマイグレーションを実行すること

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "Running InvenTree database migrations..." |
| 進捗ログ | マイグレーション適用時 | 各マイグレーションの適用状況 |
| 終了ログ | バッチ終了時 | "InvenTree database migrations completed" |
| エラーログ | エラー発生時 | エラー詳細とスタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 実行時間 | 環境依存 | システム管理者 |
| エラー発生 | 1件以上 | システム管理者 |

## 備考

- 本番環境での実行前には必ずバックアップを取得すること
- 大規模なマイグレーションの場合は、事前にステージング環境でテストすること
- `@state_logger('TASK05')`デコレータにより、デバッグモード時は実行状態がログ出力される
- 後処理として`rebuild_models`と`rebuild_thumbnails`が自動実行される（`post`パラメータで定義）
