# バッチ設計書 7-product_keyword_dictionary.cleanup

## 概要

本ドキュメントは、Shopwareシステムにおける商品キーワード辞書クリーンアップバッチ（product_keyword_dictionary.cleanup）の設計仕様を定義するものです。

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

このバッチは、商品検索で使用されていない古いキーワード辞書エントリをデータベースから削除し、検索機能の効率性とデータベースの最適化を実現するためのクリーンアップタスクです。

**業務上の目的・背景**：Shopwareの商品検索機能では、キーワード辞書（product_keyword_dictionary）を使用して検索の効率化を図っています。商品の追加・更新・削除に伴い、実際の商品検索キーワード（product_search_keyword）との整合性が失われることがあります。使用されていないキーワードがデータベースに蓄積されると、検索インデックスのサイズが肥大化し、検索パフォーマンスの低下を招きます。本バッチは、product_search_keywordテーブルに存在しないキーワードを辞書から削除することで、検索機能の効率性を維持します。

**バッチの実行タイミング**：週次実行（604800秒間隔）。システムのスケジュールタスク機能により自動的にトリガーされます。

**主要な処理内容**：
1. product_keyword_dictionaryテーブルからproduct_search_keywordテーブルに存在しないキーワードを抽出
2. 1000件単位でバッチ削除を実行
3. 対象レコードがなくなるまで削除処理を繰り返し

**前後の処理との関連**：本バッチは独立して動作します。商品インデックス再構築バッチの後に実行することが推奨されます。

**影響範囲**：product_keyword_dictionaryテーブルのデータ削除のみ。商品データや検索機能の動作には直接影響を与えません。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 週次 |
| 実行時刻 | システムスケジューラーにより決定 |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | cron（ScheduledTask） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| スケジュールタスク登録 | CleanupProductKeywordDictionaryTaskがscheduled_taskテーブルに登録されていること |
| メッセージキュー稼働 | Symfony Messengerのワーカーが稼働していること |

### 実行可否判定

ScheduledTaskHandlerの基本機能によりタスクのステータスが"scheduled"の場合に実行されます。shouldRescheduleOnFailure()がtrueを返すため、失敗時は自動的に再スケジュールされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | 入力パラメータなし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| product_keyword_dictionary | DB | キーワード辞書テーブル（削除対象） |
| product_search_keyword | DB | 商品検索キーワードテーブル（参照） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| product_keyword_dictionary | DB | 削除処理の対象テーブル（レコード削除） |

### 出力ファイル仕様

ファイル出力はありません。

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ ScheduledTaskHandlerによりrun()メソッドが呼び出される
2. 削除ループ開始
   └─ 削除対象がなくなるまで繰り返し
3. DELETE文実行
   └─ NOT IN サブクエリで未使用キーワードを1000件ずつ削除
4. 削除結果判定
   └─ 削除件数が0より大きければループ継続、0なら終了
5. バッチ終了
   └─ 正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[DELETE文実行 LIMIT 1000]
    B --> C[RetryableQueryでリトライ付き実行]
    C --> D{削除件数 > 0?}
    D -->|Yes| B
    D -->|No| E[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 未使用キーワード削除 | product_keyword_dictionary | DELETE | 検索で使用されていないキーワードの削除 |
| 使用中キーワード参照 | product_search_keyword | SELECT | 使用中キーワードの一覧取得（サブクエリ） |

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

#### product_keyword_dictionary

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | keyword NOT IN (SELECT DISTINCT keyword FROM product_search_keyword) | 1000件単位でバッチ削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗時 | タスク再スケジュール |
| - | デッドロック | 同時アクセス競合時 | RetryableQueryで自動リトライ |
| - | SQL実行エラー | DELETE文実行失敗時 | タスク再スケジュール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | RetryableQueryによる自動リトライ |
| リトライ間隔 | Doctrine DBAL標準設定 |
| リトライ対象エラー | デッドロック、接続タイムアウト |

### 障害時対応

shouldRescheduleOnFailure()がtrueのため、失敗時は自動的に次回実行がスケジュールされます。RetryableQueryを使用しているため、一時的なデッドロックは自動的にリトライされます。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各DELETE文単位（1000件ごと） |
| コミットタイミング | 各DELETE文実行後に即時コミット |
| ロールバック条件 | DELETE文失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数千〜数万件/実行 |
| 目標処理時間 | 10分以内 |
| メモリ使用量上限 | 標準PHPメモリ制限内 |

## 排他制御

同時実行は許可されています。RetryableQueryによりデッドロック発生時は自動リトライが行われます。LIMIT 1000により1回のDELETEで処理する件数を制限し、ロック競合の影響を最小化しています。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | タスク開始（ScheduledTaskHandler標準） |
| 終了ログ | バッチ終了時 | タスク完了（ScheduledTaskHandler標準） |
| エラーログ | エラー発生時 | 例外情報（ScheduledTaskHandler標準） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 30分 | システム管理者 |
| 連続失敗回数 | 3回 | システム管理者 |

## 備考

- Doctrine DBALのConnectionを直接使用してSQL実行
- RetryableQuery::retryable()を使用してデッドロック等の一時的エラーに対応
- NOT IN サブクエリでproduct_search_keywordに存在しないキーワードを特定
- DISTINCT句で重複を排除して比較
- do-whileループで削除対象がなくなるまで繰り返し実行
- 週次実行のため、大量の未使用キーワードが蓄積される可能性は低い
