# 機能設計書 400-Stop-DbaPfDataCollectorSet

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Stop-DbaPfDataCollectorSet` 関数の機能設計を記述する。この関数は、SQL Serverパフォーマンスモニタリングに使用されるWindows Performance Monitor Data Collector Setsを停止するための機能を提供する。

### 本機能の処理概要

`Stop-DbaPfDataCollectorSet` は、パフォーマンスカウンターを収集しているPerformance Monitor Data Collector Setsを停止する機能である。Windows Performance Logs and Alerts (PLA) サービスと対話して、データ収集プロセスを正常に停止する。ベースラインデータ収集の完了後や、メンテナンスウィンドウ中にカウンターデータが不要な場合に使用される。

**業務上の目的・背景**：パフォーマンスモニタリングでは、必要なデータを収集した後にData Collector Setsを停止することで、システムリソースを解放し、ログファイルを確定する必要がある。本機能により、DBAは効率的にモニタリングセッションを終了できる。

**機能の利用シーン**：
- 十分なパフォーマンスメトリクスを収集した後のデータ収集停止
- メンテナンスウィンドウ開始前のモニタリング停止
- Collector Set削除前の停止（Remove-DbaPfDataCollectorSetの前提条件）
- トラブルシューティングセッション終了時の停止

**主要な処理内容**：
1. Get-DbaPfDataCollectorSetでCollector Set情報を取得
2. Collector Setの状態確認（Running以外は停止不可）
3. Pla.DataCollectorSet.Stop()で停止実行

**関連システム・外部連携**：Windows Performance Logs and Alerts (Pla.DataCollectorSet COM) サービスと連携する。

**権限による制御**：ターゲットコンピューターへの管理者権限が推奨。リモートコンピューターへのアクセスにはWMI/CIM権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | PowerShellコンソール | 主画面 | コマンドライン実行 |
| N/A | Windows Performance Monitor | 参照画面 | 停止結果確認 |

## 機能種別

制御処理（状態変更）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstance[] | No | Data Collector Setsを停止するコンピューター名 | デフォルト: $env:COMPUTERNAME |
| Credential | PSCredential | No | 代替資格情報 | - |
| CollectorSet | string[] | No | 停止対象のData Collector Set名 | エイリアス: DataCollectorSet |
| InputObject | object[] | No | Get-DbaPfDataCollectorSetからのパイプライン入力 | ValueFromPipeline |
| NoWait | switch | No | 停止完了を待たずに戻る | - |
| WhatIf | switch | No | 実行シミュレーション | - |
| Confirm | switch | No | 確認プロンプト | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- Get-DbaPfDataCollectorSetからのパイプライン入力
- 直接指定のCollector Set名

## 出力仕様

### 出力データ

Get-DbaPfDataCollectorSetと同じ構造のオブジェクトを返す。

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | コンピューター名 |
| Name | string | Data Collector Set名 |
| State | string | 状態（停止後は"Stopped"または"Ready"） |
| ... | ... | Get-DbaPfDataCollectorSetと同等のプロパティ |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. NoWait処理
   └─ NoWait == $falseの場合、$wait = $true

2. InputObject/Collector Set情報の取得
   └─ InputObject未指定時はGet-DbaPfDataCollectorSetを呼び出し

3. InputObject型の検証
   └─ DataCollectorSetObjectプロパティの存在確認

4. Collector Setごとの処理
   ├─ 状態確認（Running以外は停止不可）
   ├─ ShouldProcess確認
   └─ Pla.DataCollectorSet.Stop()実行

5. 結果出力
   └─ Get-DbaPfDataCollectorSetで最新状態を取得して返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[NoWait処理]
    B --> C{InputObject指定?}
    C -->|No| D[Get-DbaPfDataCollectorSet呼び出し]
    C -->|Yes| E{型チェック}
    D --> E
    E -->|不正| F[Stop-Function]
    E -->|正常| G[Collector Setループ]
    G --> H{State !=<br>Running?}
    H -->|Yes| I[Stop-Function: 既に停止]
    H -->|No| J{ShouldProcess<br>確認?}
    I --> G
    J -->|Yes| K[Stop実行]
    J -->|No| L[スキップ]
    K --> M[Get-DbaPfDataCollectorSet]
    M --> N[パイプライン出力]
    L --> G
    N --> G
    G -->|完了| O[終了]
    F --> O
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 非Running停止禁止 | StateがRunning以外のCollector Setは停止不可 | State != "Running" |
| BR-002 | 型検証 | InputObjectはGet-DbaPfDataCollectorSetからの出力であること | InputObject指定時 |
| BR-003 | 待機制御 | NoWait未指定時は停止完了まで待機 | NoWait未指定時 |

### 計算ロジック

特になし

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

本機能はデータベース操作を行わない。Windows Performance Monitor Data Collector Setを停止する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型エラー | InputObjectがGet-DbaPfDataCollectorSetからの出力でない | Stop-Functionでエラー |
| - | 状態エラー | Collector SetがRunning状態でない | Stop-Function -Continue（既に停止済みと案内） |
| - | 停止エラー | Stop()メソッドの実行失敗 | Stop-Function -Continue |

### リトライ仕様

リトライ機能なし

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

トランザクション管理なし。Pla.DataCollectorSet.Stop()で即座に停止。

## パフォーマンス要件

- NoWait未指定時は停止完了まで待機
- 大量のバッファがフラッシュされる場合は時間がかかる場合がある

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

- ターゲットコンピューターへの適切な権限が必要
- リモートアクセスには資格情報が必要な場合がある

## 備考

- SupportsShouldProcess対応（-WhatIf, -Confirm）
- NoWaitスイッチで非同期停止が可能
- `Get-DbaPfDataCollectorSet | Stop-DbaPfDataCollectorSet | Remove-DbaPfDataCollectorSet` のワークフローで使用可能
- 注: ソースコード内で "Stoping" とタイポがあるが、機能に影響なし

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する（Get-DbaPfDataCollectorSetと同じ）。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Stop-DbaPfDataCollectorSet.ps1 | `public/Stop-DbaPfDataCollectorSet.ps1` | 145行目のGet-DbaPfDataCollectorSet呼び出しを確認 |

**読解のコツ**: 停止後のCollector Set状態を取得するためGet-DbaPfDataCollectorSetを再呼び出ししている。

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

パラメーター定義とbeginブロックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Stop-DbaPfDataCollectorSet.ps1 | `public/Stop-DbaPfDataCollectorSet.ps1` | 89-99行目のパラメーター定義、100-110行目のbeginブロック |

**主要処理フロー**:
1. **97行目**: NoWaitスイッチでStop()の待機動作を制御
2. **103行目**: `$wait = $NoWait -eq $false` で待機フラグを設定

#### Step 3: 状態チェック処理を理解する

Running状態以外のチェックロジックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Stop-DbaPfDataCollectorSet.ps1 | `public/Stop-DbaPfDataCollectorSet.ps1` | 129-137行目の状態チェック |

**主要処理フロー**:
- **132行目**: Stateプロパティを取得
- **135-137行目**: Running以外の場合はStop-Function（既に停止済み）

#### Step 4: 停止処理を理解する

COMオブジェクトを使用した停止処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Stop-DbaPfDataCollectorSet.ps1 | `public/Stop-DbaPfDataCollectorSet.ps1` | 105-110行目のsetscript、138-146行目の実行処理 |

**主要処理フロー**:
- **107行目**: Pla.DataCollectorSet COMオブジェクト作成
- **108行目**: Queryでコレクターセット取得
- **109行目**: Stop($wait)で停止（待機パラメーター付き）

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

```
Stop-DbaPfDataCollectorSet
    │
    ├─ Get-DbaPfDataCollectorSet (InputObject未指定時)
    │
    ├─ Invoke-Command2 (リモート実行)
    │      └─ COM: Pla.DataCollectorSet
    │             ├─ Query()
    │             └─ Stop($wait)
    │
    └─ Get-DbaPfDataCollectorSet (結果取得)
```

### データフロー図

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

CollectorSet ─────▶ Get-DbaPfDataCollectorSet ─▶ PSCustomObject
ComputerName                   │                    (停止後の状態)
Credential                     ▼
InputObject         状態チェック (Running?)
NoWait                  │
                        ▼
            Pla.DataCollectorSet.Stop()
                        │
                        ▼
            Get-DbaPfDataCollectorSet (結果)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Stop-DbaPfDataCollectorSet.ps1 | `public/Stop-DbaPfDataCollectorSet.ps1` | ソース | 本機能のメイン実装 |
| Get-DbaPfDataCollectorSet.ps1 | `public/Get-DbaPfDataCollectorSet.ps1` | ソース | Collector Set情報取得 |
| Start-DbaPfDataCollectorSet.ps1 | `public/Start-DbaPfDataCollectorSet.ps1` | ソース | 逆操作（開始） |
| Remove-DbaPfDataCollectorSet.ps1 | `public/Remove-DbaPfDataCollectorSet.ps1` | ソース | 停止後に削除可能 |
