# 機能設計書 514-Set-DbaAgentJobCategory

## 概要

本ドキュメントは、SQL Server Agentジョブカテゴリの名前を変更するdbatools関数「Set-DbaAgentJobCategory」の機能設計書である。

### 本機能の処理概要

Set-DbaAgentJobCategoryは、既存のSQL Server Agentジョブカテゴリの名前を変更する機能を提供する。

**業務上の目的・背景**：SQL Server Agentでは、ジョブをカテゴリで分類・整理することが推奨される。複数環境間でカテゴリ名の命名規則が異なる場合や、組織のポリシー変更によりカテゴリ名を標準化する必要がある場合に、本機能を使用してカテゴリ名を一括変更できる。これにより、SSMSを使った手動作業を省略し、複数サーバーへの一括適用を可能にする。

**機能の利用シーン**：
- 環境間でのジョブカテゴリ名の標準化
- 命名規則の変更に伴うカテゴリ名の一括更新
- 組織ポリシー変更への対応
- 複数サーバーでのカテゴリ名統一

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続
2. 指定されたカテゴリの存在確認
3. 新しいカテゴリ名の重複確認
4. SMO Rename()メソッドによるカテゴリ名変更
5. 更新後のカテゴリオブジェクトの返却

**関連システム・外部連携**：SQL Server JobServer.JobCategoriesコレクション、SMO (SQL Server Management Objects)

**権限による制御**：sysadmin権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SQL Server Management Studio - Job Activity Monitor | 参照画面 | ジョブカテゴリの確認 |
| - | PowerShell Console | 主画面 | コマンド実行インターフェース |

## 機能種別

データ更新操作 (UPDATE)

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可、sysadmin権限、SQL Server 2000以上 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Category | string[] | No | 変更するカテゴリ名 | 空値不可 |
| NewName | string[] | No | 新しいカテゴリ名 | - |
| Force | switch | No | 確認プロンプトをスキップ | - |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

- SQL Server JobServer.JobCategoriesコレクション

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | カテゴリ名 |
| ID | int | カテゴリID |
| CategoryType | string | カテゴリタイプ |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.Agent.JobCategory）

## 処理フロー

### 処理シーケンス

```
1. 初期設定（beginブロック）
   ├─ Forceフラグによる確認プロンプト制御
   └─ 複数カテゴリの単一名へのリネーム検証

2. 各インスタンスの処理（processブロック）
   ├─ Connect-DbaInstanceで接続
   └─ 各カテゴリをループ処理
       ├─ カテゴリ存在確認
       ├─ 新名前の重複確認
       ├─ Rename()メソッド呼び出し
       └─ Get-DbaAgentJobCategoryで結果取得

3. 完了処理（endブロック）
   └─ 完了メッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Force指定?}
    B -->|Yes| C[ConfirmPreference = none]
    B -->|No| D{複数カテゴリを同一名にリネーム?}
    C --> D
    D -->|Yes| E[エラー: 同一名リネーム不可]
    D -->|No| F[各インスタンスをループ]
    F --> G[Connect-DbaInstance]
    G --> H[各カテゴリをループ]
    H --> I{カテゴリ存在?}
    I -->|No| J[エラー: カテゴリ不存在]
    I -->|Yes| K{新名前が既に存在?}
    K -->|Yes| L[エラー: 名前重複]
    K -->|No| M[ShouldProcess確認]
    M --> N[カテゴリオブジェクト取得]
    N --> O[Rename実行]
    O --> P[Get-DbaAgentJobCategoryで結果取得]
    P --> Q{次のカテゴリ?}
    Q -->|Yes| H
    Q -->|No| R{次のインスタンス?}
    R -->|Yes| F
    R -->|No| S[完了メッセージ]
    S --> T[終了]
    E --> T
    J --> Q
    L --> Q
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 同一名リネーム禁止 | 複数カテゴリを同じ名前にリネームすることは不可 | Category.Count > 1 かつ NewName.Count = 1 |
| BR-002 | カテゴリ存在確認 | リネーム対象カテゴリが存在する必要がある | 常時 |
| BR-003 | 新名前重複禁止 | 新しい名前が既に使用されている場合はエラー | NewName指定時 |
| BR-004 | インデックス対応 | 複数カテゴリを複数の新名前にリネームする場合、順序に対応 | Category.Count > 1 かつ NewName.Count > 1 |

### 計算ロジック

**インデックス対応の計算**：
- `$NewName[$Category.IndexOf($cat)]` でカテゴリと新名前を対応付け

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カテゴリ更新 | msdb.dbo.syscategories | UPDATE | カテゴリ名の更新 |

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

#### msdb.dbo.syscategories

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | name | NewName指定値 | Rename()メソッド経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop-Function | 複数カテゴリを同一名にリネーム | 異なる名前を指定 |
| - | ConnectionError | インスタンス接続失敗 | 接続情報を確認 |
| - | Stop-Function | カテゴリが存在しない | カテゴリ名を確認 |
| - | Stop-Function | 新名前が既に存在する | 別の名前を指定 |
| - | Stop-Function | カテゴリ変更失敗 | 権限を確認 |

### リトライ仕様

リトライ機能なし。エラー発生時は-Continueにより次の処理を継続。

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

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

## パフォーマンス要件

特に定義なし。

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

- sysadmin権限が必要
- WhatIf/Confirmパラメータによる事前確認が可能

## 備考

- SQL Server 2000以上に対応
- カテゴリタイプ（LocalJob, MultiServerJob, DatabaseMaintenance）は変更されない
- PSScriptAnalyzer警告が抑制されている（PSUseOutputTypeCorrectly）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Management.Smo.Agent.JobCategory | SMO | カテゴリオブジェクトのプロパティ（Name, ID, CategoryType） |

**読解のコツ**: SMOのJobCategoryクラスにはRename()メソッドがあり、カテゴリ名の変更に使用する。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Set-DbaAgentJobCategory.ps1 | `public/Set-DbaAgentJobCategory.ps1` | 関数定義、パラメータ、ブロック構造 |

**主要処理フロー**:
1. **83-94行目**: CmdletBinding属性とパラメータ定義
2. **96-104行目**: beginブロック - 初期設定と検証
3. **106-150行目**: processブロック - メイン処理
4. **152-154行目**: endブロック - 完了メッセージ

#### Step 3: カテゴリリネーム処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaAgentJobCategory.ps1 | `public/Set-DbaAgentJobCategory.ps1` | processブロック内のリネームロジック |

**主要処理フロー**:
- **117-121行目**: カテゴリ存在確認
- **123-126行目**: 新名前の重複確認
- **128-147行目**: カテゴリオブジェクト取得とRename実行

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

```
Set-DbaAgentJobCategory
    │
    ├─ Connect-DbaInstance
    │
    ├─ JobServer.JobCategories[$cat] (カテゴリ取得)
    │
    ├─ JobCategory.Rename() (名前変更)
    │
    └─ Get-DbaAgentJobCategory (結果取得)
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance
      │                        │
Category名 ──────────▶ カテゴリ存在確認
      │                        │
NewName ────────────▶ 重複確認
      │                        │
      ▼                        ▼
                       カテゴリオブジェクト取得
                              │
                              ▼
                         Rename()
                              │
                              ▼
               Get-DbaAgentJobCategory ───▶ [JobCategoryオブジェクト出力]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Set-DbaAgentJobCategory.ps1 | `public/Set-DbaAgentJobCategory.ps1` | ソース | メイン関数 |
| Get-DbaAgentJobCategory.ps1 | `public/Get-DbaAgentJobCategory.ps1` | ソース | カテゴリ取得（依存関数） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
