# バッチ設計書 12-queue:flush

## 概要

本ドキュメントは、Laravelフレームワークの`queue:flush`コマンドの設計仕様を定義するものです。このコマンドは、失敗したキュージョブを一括削除するためのArtisanコマンドです。

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

**業務上の目的・背景**：キュー処理システムでは、実行に失敗したジョブが`failed_jobs`テーブルに蓄積されます。これらの失敗ジョブは、原因調査やリトライのために保持されますが、長期間蓄積されるとストレージを圧迫し、運用管理が煩雑になります。本コマンドは、不要になった失敗ジョブを一括で削除し、データベースをクリーンな状態に保つために使用されます。`--hours`オプションにより、指定時間より古いジョブのみを削除する柔軟な運用が可能です。

**バッチの実行タイミング**：随時（手動実行）または定期実行（スケジューラー設定による）。運用ポリシーに基づき、定期的なクリーンアップとして実行されることが多い。

**主要な処理内容**：
1. `--hours`オプションの有無を確認
2. `queue.failer`サービスの`flush`メソッドを呼び出し、失敗ジョブを削除
3. 削除完了メッセージをコンソールに出力

**前後の処理との関連**：`queue:failed`コマンドで失敗ジョブを確認し、必要に応じて`queue:retry`でリトライした後、残りのジョブを本コマンドで削除するワークフローが想定されます。`queue:prune-failed`との違いは、本コマンドは基本的に全件削除を行う点です。

**影響範囲**：`failed_jobs`テーブル（または設定されたfailed job provider）の全レコードまたは指定期間以上経過したレコードが削除されます。

## バッチ種別

データクレンジング / 運用保守

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時/日次/週次（運用ポリシーによる） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動/cron |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| 失敗ジョブプロバイダーの設定 | `queue.failer`サービスが正しく設定されていること |

### 実行可否判定

特別な前提条件なし。失敗ジョブが存在しない場合でも正常終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --hours | integer | No | null | 指定時間より前に失敗したジョブのみを削除 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| failed_jobs | DB | 失敗したジョブの保存先テーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | テキスト | 削除完了メッセージ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. オプション解析
   └─ --hours オプションの値を取得
2. 失敗ジョブの一括削除
   └─ queue.failer->flush(hours) を呼び出し
3. 結果メッセージ出力
   └─ hours指定あり: "All jobs that failed more than {hours} hours ago have been deleted successfully."
   └─ hours指定なし: "All failed jobs deleted successfully."
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[--hoursオプション取得]
    B --> C[queue.failer->flush実行]
    C --> D{--hours指定あり?}
    D -->|Yes| E[期間指定メッセージ出力]
    D -->|No| F[全件削除メッセージ出力]
    E --> G[バッチ終了]
    F --> G
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 失敗ジョブ一括削除 | failed_jobs | DELETE | 全件または指定期間以上経過したレコードを削除 |

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

#### failed_jobs

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | hours指定時: WHERE failed_at < NOW() - hours | hoursがnullの場合は全件削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | - | - |

本コマンドでは明示的なエラーハンドリングは実装されていない。データベースエラー等は例外として伝播する。

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | - |
| リトライ間隔 | - |
| リトライ対象エラー | - |

リトライ機構は実装されていない。

### 障害時対応

- データベース接続エラー: データベース設定を確認
- タイムアウト: 大量データがある場合は`--hours`オプションで範囲を絞る

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | プロバイダー実装による |
| コミットタイミング | プロバイダー実装による |
| ロールバック条件 | プロバイダー実装による |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 可変（全件または条件付き） |
| 目標処理時間 | データ量に依存 |
| メモリ使用量上限 | 最小限（一括DELETE） |

## 排他制御

排他制御なし。大量削除時は他のキュー処理との競合に注意が必要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | 削除完了時 | "All failed jobs deleted successfully." または期間指定メッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

手動/定期実行コマンドのため、スケジューラーでの監視を推奨。

## 備考

- Laravel 12.x対応
- `queue:prune-failed`コマンドとの違い：本コマンドは基本的に全件削除、prune-failedはデフォルト24時間経過したジョブを削除
- `--hours`オプションを使用すると、指定時間より前に失敗したジョブのみを削除
- 本番環境での実行時は、事前に`queue:failed`で対象を確認することを推奨
