07.dataset-retry
- Back
- 00.overview.md
-
01.admin
- 00.overview.md
-
01.auth
-
02.user-management
-
03.group-management
-
04.announcement-management
-
05.guide-management
-
02.general
- 00.overview.md
-
01.analysis
-
02.auth
-
03.chat
-
04.checkout
-
05.packages
-
06.wishlist
- 00.overview.md
-
01.temp-wishlist-to-group
-
02.wishlist-to-group
-
07.file-storage
-
08.unique-product-upload
-
09.dataset-workflow
-
10.landing-page
-
03.widget
データセット管理
概要説明
データセット管理機能は、製品分析に使用されるデータセットを維持および管理するための管理機能を提供します。この機能により、ユーザーはデータセット関連の操作を処理できます。主要な機能の一つは、以前の試行が失敗したり不完全な結果を生成したりした場合にデータセット分析を再試行する機能です。この機能は、分析目的のためのデータの信頼性と完全性を確保します。
この機能は主に、製品分析のためのデータセットの品質と可用性を確保する必要がある管理者とアナリスト向けです。データセットを完全に再作成する必要なく、処理の問題から回復できるようにすることで、システムの整合性維持に役立ちます。
Swagger リンク
API: データセット再試行 API
ケース文書
ケース1: データセット分析の再試行
説明
ユーザーが以前に処理の問題が発生したデータセットの分析プロセスの再試行を開始します。
シーケンス図
sequenceDiagram
participant User as ユーザー
participant API as ProductAnalysisController
participant Service as ProductAnalysisService
participant Repo as WishlistDatasetHistoryRepository
participant Auth as 認証
participant JP as JP API
Note over User,JP: ステップ1: データセット再試行のリクエスト
User->>API: GET /api/v1/general/{wldh_slug}/retry
Note over API,Repo: ステップ2: データセットの検証
API->>Repo: findBySlug(slug)
Repo-->>API: wishlistDatasetHistory
Note over API,Auth: ステップ3: ユーザー権限の検証
API->>Auth: get_logged_in_user()
Auth-->>API: user
API->>API: ユーザーが同じグループに属していることを確認
Note over API,Service: ステップ4: データセット再試行の開始
API->>Service: retryDataset(wishlistDatasetHistory, dataset_id)
Service->>JP: データセットのステータスを更新し、再処理のためにキューに入れる
JP-->>Service: 操作結果
Note over API,User: ステップ5: レスポンスの返却
API-->>User: 200 OK (成功メッセージ)
ステップ
ステップ1: データセット再試行のリクエスト
- 説明: ユーザーがデータセット分析を再試行するリクエストを行います
- リクエスト:
GET /api/v1/general/{wldh_slug}/retry - パラメータ:
- パスパラメータ:
wldh_slug- データセット履歴の一意識別子
- パスパラメータ:
ステップ2: データセットの検証
- 説明: システムはリクエストされたデータセットが存在することを検証します
- アクション: リポジトリでスラグによるデータセット履歴の検索
- 潜在的エラー: データセットが見つからない
ステップ3: ユーザー権限の検証
- 説明: システムはユーザーがデータセットを再試行する権限を持っていることを検証します
- アクション: ログインユーザーがデータセットと同じグループに属しているかどうかを確認
- 潜在的エラー: 権限のないアクセス
ステップ4: データセット再試行の開始
- 説明: システムはデータセットの再試行プロセスを開始します
- アクション: データセット分析を再試行するサービスメソッドを呼び出します
- 実行される操作:
- データセット処理ステータスのリセット
- 以前のエラーフラグのクリア
- 再処理のためのデータセットのキュー登録
- タイムスタンプ情報の更新
ステップ5: レスポンスの返却
- 説明: システムは再試行操作の結果を返します
- レスポンス:
- 成功: 成功メッセージを含む
200 OK - エラー: 適切なエラーメッセージとステータスコード
- 成功: 成功メッセージを含む
関連データベーステーブルとフィールド
ビュー: 分析API仕様
エラー処理
- ログ
- データセット再試行の失敗はアプリケーションログに記録
- エラー詳細:
| ステータスコード | エラーメッセージ | 説明 |
|---|---|---|
| 404 | "データセットが見つかりません" | 指定されたデータセットスラグが存在しない場合 |
| 404 | "ウィッシュリストグループが見つかりません" | 関連するウィッシュリストグループが見つからない場合 |
| 403 | "権限のないアクセス" | ユーザーがデータセットと同じグループに属していない場合 |
| 500 | "データセットの再試行に失敗しました" | 技術的な理由で再試行操作が失敗した場合 |
| 500 | 例外メッセージを含む一般的なエラー | 処理中に予期しないエラーが発生した場合 |
追加メモ
- データセット再試行は、システムリソースを大量に消費する可能性があるため、必要な場合にのみ使用すべきです
- 同じデータセットに対する複数の連続した再試行は、対処すべき根本的なデータの問題を示している可能性があります
- 同じデータセットの再試行試行間にクールダウン期間を実装することを検討してください
- システムは監査とトラブルシューティングのために再試行試行の履歴を維持します
- データセットの再試行は元のデータセットの内容を変更せず、既存のデータを再処理するだけです