# バッチ設計書 25-wait_for_db

## 概要

本ドキュメントは、データベース接続が確立されるまで待機するDjango管理コマンド「wait_for_db」の設計仕様を定義する。

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

このコマンドは、InvenTreeシステムの起動時にデータベース接続が確立されるまで待機することで、コンテナ環境やマイクロサービス環境でのデータベース依存関係の問題を解決する。

**業務上の目的・背景**：Docker環境やKubernetes環境では、アプリケーションコンテナがデータベースコンテナより先に起動する可能性がある。このような場合、データベース接続が確立される前にアプリケーションが起動を試みると、接続エラーが発生する。本コマンドは、データベースが利用可能になるまでブロッキング待機することで、起動順序の問題を解消し、安定したシステム起動を実現する。

**バッチの実行タイミング**：手動実行（CLI）。主にシステム起動スクリプトやDockerエントリーポイントで使用される。

**主要な処理内容**：
1. データベース接続を試行
2. 接続失敗時は2秒間スリープして再試行
3. 接続成功まで無限ループで繰り返し
4. 接続成功時にメッセージを出力して終了

**前後の処理との関連**：本コマンドは他の管理コマンド（migrate、runserverなど）の前に実行されることを想定している。

**影響範囲**：システム起動プロセスに影響する。データベースへの影響はない（参照のみ）。

## バッチ種別

システム管理 / ヘルスチェック / CLIコマンド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | システム起動時 |
| 実行曜日 | 不定 |
| 実行日 | 不定 |
| トリガー | CLIコマンド: `python manage.py wait_for_db` |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django設定 | データベース設定が正しく構成されていること |
| ネットワーク | データベースサーバーへのネットワーク接続が可能であること |

### 実行可否判定

特別な実行可否判定はなく、コマンド実行時に即座に処理を開始する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本コマンドは入力パラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Django settings | Python | DATABASE設定 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| stdout | Text | 接続状態メッセージ |

### 出力ファイル仕様

本コマンドはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. 待機開始メッセージ出力
   └─ "Waiting for database..."
2. 接続ループ開始
   └─ connected = False; while not connected:
3. 2秒間スリープ
   └─ time.sleep(2)
4. データベース接続試行
   └─ connection.ensure_connection()
5. 接続結果の判定
   └─ OperationalError: 接続失敗メッセージを出力、ループ継続
   └─ ImproperlyConfigured: 設定エラーメッセージを出力、ループ継続
   └─ 成功: connection.is_usable()で追加確認
6. 接続成功時
   └─ "Database connection successful!" を出力
   └─ connected = True でループ終了
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド開始] --> B[Waiting for database... 出力]
    B --> C[2秒スリープ]
    C --> D[connection.ensure_connection]
    D --> E{接続成功?}
    E -->|OperationalError| F[エラーメッセージ出力]
    E -->|ImproperlyConfigured| G[設定エラー出力]
    E -->|成功| H{connection.is_usable?}
    F --> C
    G --> C
    H -->|No| I[設定が使用不可メッセージ]
    H -->|Yes| J[接続成功メッセージ出力]
    I --> C
    J --> K[コマンド終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 接続確認 | なし | CONNECTION | 接続の確立確認のみ |

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

本コマンドはテーブル操作を行わない。接続確認のみを実施する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | OperationalError | データベースサーバー未起動、接続拒否 | メッセージ出力後、再試行 |
| - | ImproperlyConfigured | DATABASE設定の誤り | メッセージ出力後、再試行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 無制限（成功まで継続） |
| リトライ間隔 | 2秒 |
| リトライ対象エラー | OperationalError, ImproperlyConfigured |

### 障害時対応

データベースが永続的に利用不可の場合、本コマンドは無限に待機し続ける。タイムアウト機構はないため、必要に応じてプロセスを手動で終了する必要がある。

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の接続確認 |
| 目標処理時間 | データベース起動後数秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

排他制御は不要。複数のプロセスが同時に実行しても問題ない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | コマンド開始時 | "Waiting for database..." |
| エラーログ | 接続失敗時 | "Could not connect to database: {エラー}" |
| 設定エラーログ | 設定不正時 | "Improperly configured: {エラー}" |
| 使用不可ログ | 接続後確認失敗時 | "Database configuration is not usable" |
| 成功ログ | 接続成功時 | "Database connection successful!" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 待機時間 | 運用環境依存 | システム管理者 |

## 備考

- 本コマンドはDjango管理コマンド（BaseCommand）として実装されている
- 実行方法: `python manage.py wait_for_db`
- 主にDockerのentrypoint.shやdocker-compose.ymlのcommandで使用される
- タイムアウト機構がないため、長時間の待機が発生する可能性がある
- `connection.ensure_connection()` はDjango標準のデータベース接続APIを使用
- `connection.is_usable()` で接続後の追加検証を実施
- 2秒間隔のスリープはハードコードされている
