# バッチ設計書 11-queue:forget

## 概要

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

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

**業務上の目的・背景**：キュー処理システムにおいて、ジョブの実行が失敗すると`failed_jobs`テーブルに記録されます。運用中に特定の失敗ジョブのみを削除したい場合（例：既に手動で対応済み、不要なジョブ、テスト時のゴミデータなど）に、このコマンドを使用します。全件削除ではなく、ピンポイントで特定のジョブを削除できることで、運用の柔軟性を確保します。

**バッチの実行タイミング**：随時（手動実行）。運用担当者が失敗ジョブ一覧を確認し、個別に削除が必要と判断した際に実行されます。

**主要な処理内容**：
1. コマンドライン引数から削除対象の失敗ジョブIDを取得
2. `queue.failer`サービスを通じて指定IDの失敗ジョブを削除
3. 削除結果（成功/失敗）をコンソールに出力

**前後の処理との関連**：`queue:failed`コマンドで失敗ジョブ一覧を確認した後に実行されることが想定されます。`queue:retry`でリトライするか、本コマンドで削除するかを運用担当者が判断します。

**影響範囲**：`failed_jobs`テーブル（または設定されたfailed job provider）から指定されたレコードが削除されます。他のシステムやプロセスへの影響はありません。

## バッチ種別

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

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 |

## 実行条件

### 前提条件

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

### 実行可否判定

削除対象のジョブIDが引数として指定されていれば実行可能。ジョブIDは必須引数であり、指定がない場合はコマンド実行時にエラーとなる。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| id | string | Yes | - | 削除対象の失敗ジョブID |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. コマンド引数からジョブIDを取得
   └─ $this->argument('id') でIDを取得
2. 失敗ジョブの削除を実行
   └─ queue.failer->forget(id) を呼び出し
3. 結果判定と出力
   └─ 成功時: "Failed job deleted successfully."
   └─ 失敗時: "No failed job matches the given ID." + 終了コード1
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ジョブIDを引数から取得]
    B --> C[queue.failer->forget実行]
    C --> D{削除成功?}
    D -->|Yes| E[成功メッセージ出力]
    D -->|No| F[エラーメッセージ出力]
    E --> G[終了コード0で終了]
    F --> H[終了コード1で終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 失敗ジョブ削除 | failed_jobs | DELETE | 指定IDのレコードを削除 |

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

#### failed_jobs

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | WHERE id = {指定ID} または uuid = {指定ID} | プロバイダーにより条件が異なる |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | ジョブ未検出 | 指定IDのジョブが存在しない | 正しいIDを指定して再実行 |

### リトライ仕様

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

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

### 障害時対応

- ジョブIDが存在しない場合: `queue:failed`コマンドで正しいIDを確認
- データベース接続エラー: データベース設定を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 単一レコード |
| コミットタイミング | 即時 |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件 |
| 目標処理時間 | 1秒未満 |
| メモリ使用量上限 | 最小限 |

## 排他制御

排他制御なし。単一レコードの削除であり、同時実行の制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 成功ログ | 削除成功時 | "Failed job deleted successfully." |
| エラーログ | 削除失敗時 | "No failed job matches the given ID." |

## 監視・アラート

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

手動実行コマンドのため、特別な監視設定は不要。

## 備考

- Laravel 12.x対応
- `queue:failed`コマンドと併用して使用することを想定
- DatabaseFailedJobProviderがデフォルトの失敗ジョブプロバイダーとして使用される
