# バッチ設計書 14-queue:prune-batches

## 概要

本ドキュメントは、Laravelフレームワークの`queue:prune-batches`コマンドの設計仕様を定義するものです。このコマンドは、バッチジョブデータベースから古いエントリを定期的に削除（プルーニング）するためのArtisanコマンドです。

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

**業務上の目的・背景**：Laravelのジョブバッチ機能では、複数のジョブをグループ化して処理し、その進捗状況を`job_batches`テーブルで追跡します。バッチ処理が完了した後もこれらのレコードは残り続け、長期間運用するとデータベースが肥大化します。本コマンドは、完了したバッチ、未完了のバッチ、キャンセルされたバッチそれぞれに対して異なる保持期間を設定し、柔軟なクリーンアップを実現します。

**バッチの実行タイミング**：日次（スケジューラーで定期実行）。Laravelのタスクスケジューラーに登録して自動実行することが推奨されます。

**主要な処理内容**：
1. `--hours`オプションから完了バッチの保持期間を取得（デフォルト24時間）
2. `--unfinished`オプションから未完了バッチの保持期間を取得（指定時のみ）
3. `--cancelled`オプションからキャンセルバッチの保持期間を取得（指定時のみ）
4. 各カテゴリのバッチを順次プルーニング
5. 各削除件数をコンソールに出力

**前後の処理との関連**：ジョブバッチ機能を使用するシステムで定期メンテナンスタスクとして実行されます。バッチ処理の結果確認後に本コマンドでクリーンアップを行うワークフローが想定されます。

**影響範囲**：`job_batches`テーブルから指定期間を超えた古いレコードが削除されます。

## バッチ種別

データクレンジング / 定期メンテナンス

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | 任意（深夜帯推奨） |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron/スケジューラー |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| BatchRepository設定 | BatchRepositoryがDIコンテナに登録されていること |
| PrunableBatchRepository | 基本プルーニングにはPrunableBatchRepositoryが必要 |
| DatabaseBatchRepository | unfinished/cancelledオプションにはDatabaseBatchRepositoryが必要 |

### 実行可否判定

BatchRepositoryの種類によって利用可能な機能が異なる。リポジトリが未設定の場合は削除件数0で正常終了する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| --hours | integer | No | 24 | 完了バッチデータを保持する時間数 |
| --unfinished | integer | No | null | 未完了バッチデータを保持する時間数 |
| --cancelled | integer | No | null | キャンセルバッチデータを保持する時間数 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| job_batches | DB | ジョブバッチの保存先テーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| コンソール | テキスト | 各カテゴリの削除件数メッセージ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. BatchRepository取得
   └─ $this->laravel[BatchRepository::class]
2. 完了バッチのプルーニング
   └─ PrunableBatchRepositoryの場合: repository->prune(Carbon::now()->subHours(hours))
   └─ 削除件数を出力
3. 未完了バッチのプルーニング（--unfinished指定時）
   └─ DatabaseBatchRepositoryの場合: repository->pruneUnfinished(Carbon::now()->subHours(unfinished))
   └─ 削除件数を出力
4. キャンセルバッチのプルーニング（--cancelled指定時）
   └─ DatabaseBatchRepositoryの場合: repository->pruneCancelled(Carbon::now()->subHours(cancelled))
   └─ 削除件数を出力
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[BatchRepository取得]
    B --> C{PrunableBatchRepository?}
    C -->|Yes| D[完了バッチprune実行]
    C -->|No| E[削除件数0]
    D --> F[完了バッチ削除件数出力]
    E --> F
    F --> G{--unfinished指定?}
    G -->|Yes| H{DatabaseBatchRepository?}
    G -->|No| K{--cancelled指定?}
    H -->|Yes| I[未完了バッチpruneUnfinished実行]
    H -->|No| J[削除件数0]
    I --> J2[未完了バッチ削除件数出力]
    J --> J2
    J2 --> K
    K -->|Yes| L{DatabaseBatchRepository?}
    K -->|No| O[バッチ終了]
    L -->|Yes| M[キャンセルバッチpruneCancelled実行]
    L -->|No| N[削除件数0]
    M --> N2[キャンセルバッチ削除件数出力]
    N --> N2
    N2 --> O
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 完了バッチ削除 | job_batches | DELETE | 指定時間より前の完了バッチを削除 |
| 未完了バッチ削除 | job_batches | DELETE | 指定時間より前の未完了バッチを削除 |
| キャンセルバッチ削除 | job_batches | DELETE | 指定時間より前のキャンセルバッチを削除 |

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

#### job_batches

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE (完了) | - | WHERE finished_at IS NOT NULL AND created_at < (現在時刻 - hours) | prune() |
| DELETE (未完了) | - | WHERE finished_at IS NULL AND created_at < (現在時刻 - unfinished) | pruneUnfinished() |
| DELETE (キャンセル) | - | WHERE cancelled_at IS NOT NULL AND created_at < (現在時刻 - cancelled) | pruneCancelled() |

## エラー処理

### エラーケース一覧

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

本コマンドでは明示的なエラーハンドリングは実装されていない。リポジトリが対応していない場合は削除件数0となる。

### リトライ仕様

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

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

### 障害時対応

- データベース接続エラー: データベース設定を確認
- リポジトリ未設定: BatchRepositoryをサービスコンテナに登録

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各プルーニング処理ごと |
| コミットタイミング | 各処理完了時 |
| ロールバック条件 | 各処理中のエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 可変（期間・状態ベース） |
| 目標処理時間 | データ量に依存 |
| メモリ使用量上限 | 最小限 |

## 排他制御

排他制御なし。定期実行時は実行間隔を適切に設定すること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | 完了バッチ削除後 | "{count} entries deleted." |
| 完了ログ | 未完了バッチ削除後 | "{count} unfinished entries deleted." |
| 完了ログ | キャンセルバッチ削除後 | "{count} cancelled entries deleted." |

## 監視・アラート

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

定期実行のメンテナンスタスクのため、スケジューラーでの監視を推奨。

## 備考

- Laravel 12.x対応
- デフォルト保持期間は完了バッチのみ24時間、未完了・キャンセルは明示的な指定が必要
- `--unfinished`および`--cancelled`オプションはDatabaseBatchRepository使用時のみ有効
- スケジューラーでの使用例：`$schedule->command('queue:prune-batches')->daily();`
- ジョブバッチ機能を使用しているアプリケーションでは定期実行を推奨
