# バッチ設計書 29-reset-db.ts

## 概要

本ドキュメントは、データベースをリセットする管理スクリプトの設計を記載したバッチ設計書です。

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

reset-db.tsは、開発・テスト環境（frank ステージ）のデータベースから全データを削除するリセットスクリプトです。複数のテーブルを順番に削除し、環境を初期状態に戻します。本番環境での誤実行を防ぐため、frankステージでのみ動作するよう制限されています。

**業務上の目的・背景**：開発・テスト作業では、テストデータの蓄積によりデータベースが肥大化したり、不整合なデータが残留したりする問題が発生します。本スクリプトにより、開発者はデータベースを迅速にクリーンな状態に戻し、再現性のあるテストを実行できます。本番環境での誤実行による甚大な被害を防ぐため、frankステージ限定の安全機構が組み込まれています。

**バッチの実行タイミング**：開発者による手動実行。開発環境のリセット、テストデータのクリア、環境再構築時に使用されます。

**主要な処理内容**：
1. ステージ確認（frankステージのみ許可）
2. 以下のテーブルを順番に全件削除：
   - AccountTable
   - BillingTable
   - KeyTable
   - PaymentTable
   - UsageTable
   - UserTable
   - WorkspaceTable

**前後の処理との関連**：リセット後はデータベースが空になるため、必要に応じてシードデータの投入が必要です。

**影響範囲**：frankステージのデータベース全体に影響し、すべてのユーザー・ワークスペース・課金データが削除されます。

## バッチ種別

データクレンジング / 環境リセット

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 開発者による手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ステージ制限 | Resource.App.stage === "frank" であること |
| データベース接続 | Database.useが機能すること |

### 実行可否判定

- 現在のステージがfrankであること
- frankでない場合はエラーで即時終了

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| （なし） | - | - | - | コマンドライン引数なし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Resource.App.stage | Environment | 現在のステージ名 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Database | DB | 全テーブルの全データ削除 |

### 出力ファイル仕様

ファイル出力なし

| 項目 | 内容 |
|-----|------|
| ファイル名 | - |
| 出力先 | - |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. ステージ確認
   └─ Resource.App.stage === "frank" をチェック
   └─ frankでない場合はエラースロー
2. テーブル削除ループ
   └─ AccountTable を DELETE
   └─ BillingTable を DELETE
   └─ KeyTable を DELETE
   └─ PaymentTable を DELETE
   └─ UsageTable を DELETE
   └─ UserTable を DELETE
   └─ WorkspaceTable を DELETE
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{stage === frank?}
    B -->|No| C[Error: This script is only for frank]
    B -->|Yes| D[AccountTable DELETE]
    D --> E[BillingTable DELETE]
    E --> F[KeyTable DELETE]
    F --> G[PaymentTable DELETE]
    G --> H[UsageTable DELETE]
    H --> I[UserTable DELETE]
    I --> J[WorkspaceTable DELETE]
    J --> K[バッチ終了]
    C --> L[異常終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 全削除 | AccountTable | DELETE | 全レコード削除 |
| 全削除 | BillingTable | DELETE | 全レコード削除 |
| 全削除 | KeyTable | DELETE | 全レコード削除 |
| 全削除 | PaymentTable | DELETE | 全レコード削除 |
| 全削除 | UsageTable | DELETE | 全レコード削除 |
| 全削除 | UserTable | DELETE | 全レコード削除 |
| 全削除 | WorkspaceTable | DELETE | 全レコード削除 |

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

#### AccountTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | アカウント情報 |

#### BillingTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | 課金情報 |

#### KeyTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | APIキー情報 |

#### PaymentTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | 支払い履歴 |

#### UsageTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | 利用量データ |

#### UserTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | ユーザー情報 |

#### WorkspaceTable

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | 全カラム | 条件なし（全件） | ワークスペース情報 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ステージエラー | frankステージ以外で実行 | frankステージで再実行 |
| - | データベースエラー | DELETE失敗 | エラー内容を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

- ステージエラー時はthrowで即時終了
- 削除途中でエラーが発生した場合、一部テーブルのみ削除された状態になる可能性あり
- リカバリは不可能（削除データは復元できない）

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | テーブル単位 |
| コミットタイミング | 各テーブル削除完了時 |
| ロールバック条件 | 全体トランザクションなし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 全テーブル全件 |
| 目標処理時間 | データ量依存 |
| メモリ使用量上限 | 制限なし |

## 排他制御

- 同時実行は非推奨
- 他のバッチ・アプリケーションが動作していない状態で実行することを推奨

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | - | - |
| 進捗ログ | - | - |
| 終了ログ | - | - |
| エラーログ | エラー発生時 | throw Error メッセージ |

## 監視・アラート

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

## 備考

- **重要**: frankステージ専用スクリプト。本番環境では絶対に実行しないこと
- 削除順序は外部キー制約を考慮していない可能性があるため、エラーが発生した場合は順序の調整が必要
- 削除後はシードデータの再投入が必要な場合がある
- 7つのテーブルがリセット対象：Account, Billing, Key, Payment, Usage, User, Workspace
