# 機能設計書 507-Remove-DbaAgentJobCategory

## 概要

本ドキュメントは、SQL Server Agent ジョブカテゴリを削除する `Remove-DbaAgentJobCategory` コマンドの機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Agent のジョブカテゴリは、ジョブを論理的にグループ化して管理するための組織構造を提供する。本コマンドは、不要になったカスタムジョブカテゴリの削除を自動化し、ジョブ管理構造の標準化やクリーンアップを効率的に行う。削除されたカテゴリに属していたジョブは自動的に [Uncategorized (Local)] カテゴリに再割り当てされる。

**機能の利用シーン**：不要なカスタムカテゴリの整理、環境標準化時のカテゴリ統合、テスト環境のクリーンアップ、ワークロード移行後の obsolete カテゴリ削除、Out-GridView を使用した対話的なカテゴリ選択削除などに利用される。

**主要な処理内容**：
1. 対象インスタンスへの接続とジョブカテゴリ取得（Get-DbaAgentJobCategory 使用）
2. カテゴリタイプ（LocalJob/MultiServerJob/None）によるフィルタリング
3. パイプライン入力またはパラメータ指定によるカテゴリオブジェクト収集
4. ShouldProcess による削除確認
5. SMO（JobCategory.Drop() メソッド）を使用したカテゴリ削除
6. 削除結果のステータスオブジェクト出力

**関連システム・外部連携**：SQL Server Agent サービス、msdb データベース

**権限による制御**：対象インスタンスで sysadmin 権限または SQLAgentOperatorRole が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 10 | ジョブカテゴリ管理 | 主画面 | SQLエージェントジョブカテゴリの削除 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes* | 対象SQL Serverインスタンス | *NonPipelineパラメータセット時必須 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Category | string[] | No | 削除するカテゴリ名 | - |
| CategoryType | string[] | No | カテゴリタイプでフィルタ | LocalJob/MultiServerJob/None |
| InputObject | JobCategory[] | Yes* | パイプライン入力用カテゴリオブジェクト | *Pipelineパラメータセット時必須 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

PowerShell コマンドラインからのパラメータ入力、または Get-DbaAgentJobCategory からのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | 削除されたカテゴリ名 |
| Status | string | 削除結果（"Dropped" または エラーメッセージ） |
| IsRemoved | bool | 削除成功の真偽値 |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ 空の配列 $jobCategories を初期化
2. processブロック
   ├─ SqlInstance 指定時
   │   └─ Get-DbaAgentJobCategory でカテゴリオブジェクト取得
   │       └─ Category, CategoryType でフィルタリング
   └─ パイプライン入力時
       └─ InputObject を $jobCategories に追加
3. endブロック（削除実行）
   └─ 各カテゴリに対するループ
       ├─ ShouldProcess による確認
       ├─ 出力オブジェクト初期化
       ├─ JobCategory.Drop() 実行
       │   ├─ 成功時: Status="Dropped", IsRemoved=true
       │   └─ 失敗時: Status=エラーメッセージ, IsRemoved=false
       └─ 出力オブジェクトをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaAgentJobCategory実行]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[processブロック終了]
    D --> E
    E --> F[endブロック開始]
    F --> G{次のカテゴリ存在?}
    G -->|No| H[終了]
    G -->|Yes| I{ShouldProcess確認}
    I -->|No| G
    I -->|Yes| J[出力オブジェクト初期化]
    J --> K[JobCategory.Drop実行]
    K --> L{成功?}
    L -->|Yes| M[Status=Dropped, IsRemoved=true]
    L -->|No| N[Status=エラー, IsRemoved=false]
    M --> O[出力オブジェクト出力]
    N --> O
    O --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-507-01 | endブロック削除 | パイプラインからの直接削除時の "Collection was modified" エラーを防ぐため、endブロックで削除を実行 | 常時 |
| BR-507-02 | 確認プロンプト | ConfirmImpact が High のため、削除前に確認プロンプトを表示 | 常時 |
| BR-507-03 | ジョブ再割り当て | 削除されたカテゴリに属していたジョブは [Uncategorized (Local)] カテゴリに自動的に再割り当てされる | カテゴリ削除時 |
| BR-507-04 | カテゴリタイプフィルタ | CategoryType でカテゴリの種類を限定可能 | CategoryType 指定時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カテゴリ削除 | msdb.dbo.syscategories | DELETE | SMO経由でカテゴリレコード削除 |
| ジョブ更新 | msdb.dbo.sysjobs | UPDATE | 関連ジョブのカテゴリIDを Uncategorized に更新 |

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

#### msdb.dbo.syscategories

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | category_id | 削除対象カテゴリのID | category_class=1（Job用） |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 削除エラー | JobCategory.Drop() 失敗 | Stop-Function でエラー記録、Status にエラーメッセージ設定 |

### リトライ仕様

リトライ処理は実装されていない。

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

SMO の JobCategory.Drop() メソッドによる暗黙的トランザクション。

## パフォーマンス要件

特に定義されていない。

## セキュリティ考慮事項

- 対象インスタンスへの sysadmin 権限または SQLAgentOperatorRole が必要

## 備考

- Get-DbaAgentJobCategory からのパイプライン入力をサポート
- Out-GridView を使用した対話的選択削除が可能
- SQL Server 2000 以降をサポート
- CategoryType: LocalJob（単一サーバージョブ）、MultiServerJob（マルチサーバー管理ジョブ）、None（未分類）

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

出力オブジェクトの構造とパラメータセットを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgentJobCategory.ps1 | `public/Remove-DbaAgentJobCategory.ps1` | 88-103行目: パラメータ定義、CategoryType の ValidateSet |

**読解のコツ**: CategoryType は LocalJob/MultiServerJob/None の3種類で、syscategories テーブルの category_type に対応する。

#### Step 2: カテゴリ収集処理を理解する

process ブロックでのカテゴリオブジェクト収集。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaAgentJobCategory.ps1 | `public/Remove-DbaAgentJobCategory.ps1` | 105-118行目: begin/processブロック |

**主要処理フロー**:
1. **106行目**: 空の配列 $jobCategories を初期化
2. **110-114行目**: SqlInstance 指定時は Get-DbaAgentJobCategory で取得
3. **115-117行目**: パイプライン入力時は InputObject を追加

#### Step 3: 削除処理を理解する

end ブロックでの実際の削除実行。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaAgentJobCategory.ps1 | `public/Remove-DbaAgentJobCategory.ps1` | 120-144行目: endブロック |

**主要処理フロー**:
- **121行目**: コメントで "Collection was modified" エラー防止の説明
- **124-131行目**: 出力オブジェクトの初期化
- **133行目**: Drop() 実行

### プログラム呼び出し階層図

```
Remove-DbaAgentJobCategory
    │
    ├─ Get-DbaAgentJobCategory (114行目)
    │      └─ カテゴリオブジェクト取得（SqlInstance指定時）
    │
    └─ $jobCategory.Drop() (133行目)
           └─ SMO経由でカテゴリ削除
```

### データフロー図

```
[入力]                      [処理]                           [出力]

SqlInstance ──┬──▶ Get-DbaAgentJobCategory ──▶ JobCategory オブジェクト配列
Category ─────┤                                      │
CategoryType ─┘                                      ▼
                                              (フィルタリング)
InputObject ──────────────────────────────▶ JobCategory オブジェクト配列
                                                     │
                                                     ▼
                                             endブロックで削除
                                                     │
                                                     ▼
                                             PSCustomObject出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgentJobCategory.ps1 | `public/Remove-DbaAgentJobCategory.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentJobCategory.ps1 | `public/Get-DbaAgentJobCategory.ps1` | ソース | カテゴリ取得（SqlInstance指定時） |
