# 機能設計書 401-Clear-DbaLatchStatistics

## 概要

本ドキュメントは、SQL Serverのラッチ統計情報をクリアしてパフォーマンスベースラインを確立するための`Clear-DbaLatchStatistics`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverのパフォーマンス分析において、ラッチ統計情報は内部同期メカニズムの競合状態を把握するための重要な指標である。しかし、サーバー起動以降に蓄積された統計情報は、特定のワークロードや期間の影響を正確に測定することを困難にする。本機能は、`sys.dm_os_latch_stats`の統計カウンターをリセットし、新しいベースラインからパフォーマンス測定を開始できるようにする。

**機能の利用シーン**：
- パフォーマンステスト前にクリーンな計測ベースラインを確立する場合
- 特定のクエリやワークロードがラッチ競合に与える影響を測定する場合
- パフォーマンス問題の解決後、改善効果を確認する場合
- 定期的なパフォーマンス監視サイクルの開始時

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. SQL Server 2005以上のバージョン要件の検証
3. ShouldProcess確認（-WhatIfおよび-Confirmパラメータ対応）
4. `DBCC SQLPERF (N'sys.dm_os_latch_stats', CLEAR)`コマンドの実行
5. 実行結果（成功/失敗）を含むPSCustomObjectの出力

**関連システム・外部連携**：SQL Serverの動的管理ビュー`sys.dm_os_latch_stats`を操作する。外部システムとの連携はない。

**権限による制御**：DBCCコマンドの実行にはVIEW SERVER STATE権限またはsysadminロールが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン | 主画面 | PowerShellコンソールからの直接実行 |

## 機能種別

データ操作（統計情報クリア）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | Yes | 対象のSQL Serverインスタンス（カンマ区切りで複数指定可能） | DbaInstance型による検証 |
| SqlCredential | PSCredential | No | SQL Server認証用の資格情報 | PowerShell資格情報オブジェクト |
| EnableException | switch | No | 例外処理を有効化し、try/catchでの捕捉を可能にする | - |
| WhatIf | switch | No | 実行せずに処理内容を表示 | - |
| Confirm | switch | No | 実行前に確認を求める | - |

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverが稼働するコンピュータ名 |
| InstanceName | string | SQL Serverサービス/インスタンス名 |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名（domain\instance形式） |
| Status | string/Exception | 成功時は"Success"、失敗時は例外オブジェクト |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance必須チェック

2. 各インスタンスに対してループ処理
   └─ Connect-DbaInstanceによる接続確立
      └─ MinimumVersion 9（SQL Server 2005）以上の検証
   └─ 接続失敗時はStop-Functionで継続処理

3. ShouldProcess確認
   └─ -WhatIfまたは-Confirmの処理

4. DBCCコマンド実行
   └─ DBCC SQLPERF (N'sys.dm_os_latch_stats', CLEAR)
   └─ 成功時: Status = "Success"
   └─ 失敗時: Status = 例外オブジェクト

5. 結果オブジェクト出力
   └─ PSCustomObjectをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceパラメータ取得]
    B --> C{各インスタンスでループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    F --> C
    E -->|Yes| G{ShouldProcess?}
    G -->|No| C
    G -->|Yes| H[DBCC SQLPERF実行]
    H --> I{実行成功?}
    I -->|Yes| J[Status = Success]
    I -->|No| K[Status = Exception]
    J --> L[PSCustomObject出力]
    K --> L
    L --> C
    C -->|ループ終了| M[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | バージョン要件 | SQL Server 2005以上が必要 | 接続時に検証 |
| BR-002 | 確認プロンプト | ConfirmImpact = 'High'のため確認が必要 | -Confirm:$false指定なしの場合 |
| BR-003 | 統計リセット | すべてのラッチタイプのカウンターがゼロにリセットされる | コマンド実行時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ラッチ統計クリア | sys.dm_os_latch_stats | UPDATE（内部） | DBCCコマンドによる統計カウンターのリセット |

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

#### sys.dm_os_latch_stats

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| CLEAR | waiting_requests_count | 0 | 待機リクエスト数リセット |
| CLEAR | wait_time_ms | 0 | 待機時間リセット |
| CLEAR | max_wait_time_ms | 0 | 最大待機時間リセット |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで処理継続、次のインスタンスへ |
| - | ExecutionError | DBCC SQLPERF実行失敗 | Statusに例外を設定して出力 |
| - | VersionError | SQL Server 2005未満 | MinimumVersionで接続拒否 |

### リトライ仕様

自動リトライなし。エラー発生時は次のインスタンスの処理に継続。

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

DBCCコマンドは暗黙的なトランザクション内で実行される。ロールバック不可。

## パフォーマンス要件

- 各インスタンスに対する実行時間：通常1秒未満
- 複数インスタンス指定時は順次処理

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

- VIEW SERVER STATE権限またはsysadminロールが必要
- SqlCredentialパラメータでSQL認証を使用可能
- Active Directory認証（パスワード/統合）対応

## 備考

- BUFFER以外のすべてのラッチクラス（ACCESS_METHODS_DATASET_PARENT、BUFFER_LATCH_EX等）の統計がリセットされる
- Get-DbaLatchStatisticと組み合わせて使用することで、ベースライン比較が可能

---

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

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

### 推奨読解順序

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

PSCustomObjectとして返却されるオブジェクト構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | 101-106行目の出力オブジェクト定義 |

**読解のコツ**: PowerShellの`[PSCustomObject]@{}`構文でハッシュテーブルからオブジェクトを生成している。

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

処理の起点となる関数定義とパラメータを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | 1-82行目のヘルプドキュメントとパラメータ定義 |

**主要処理フロー**:
1. **75-82行目**: CmdletBinding属性とパラメータブロック定義
2. **77行目**: SuppressMessageAttributeでPSUseSingularNouns警告を抑制
3. **78-81行目**: パラメータ定義（SqlInstance、SqlCredential、EnableException）

#### Step 3: 接続処理を理解する

SQL Serverへの接続確立ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | 84-91行目の接続処理 |

**主要処理フロー**:
- **87-88行目**: Connect-DbaInstance呼び出し（MinimumVersion 9指定）
- **89-91行目**: 接続失敗時のエラーハンドリング

#### Step 4: メイン処理ロジックを理解する

DBCCコマンド実行と結果出力。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | 93-108行目のメイン処理 |

**主要処理フロー**:
- **93行目**: ShouldProcess確認（-WhatIf/-Confirm対応）
- **95行目**: DBCCコマンド実行
- **96-98行目**: 成功/失敗によるステータス設定
- **101-106行目**: 結果オブジェクト生成・出力

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

```
Clear-DbaLatchStatistics
    │
    ├─ Connect-DbaInstance (内部関数)
    │      └─ SQL Server接続確立
    │
    ├─ Stop-Function (内部関数)
    │      └─ エラー処理・継続判定
    │
    └─ $server.Query() (SMOメソッド)
           └─ DBCC SQLPERF実行
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance ─────▶ $server
                              │
SqlCredential ────────────────┘
                              │
                              ▼
                      ShouldProcess確認
                              │
                              ▼
                    DBCC SQLPERF実行
                              │
                              ▼
                    PSCustomObject生成 ─────────▶ パイプライン出力
                    (ComputerName, InstanceName,
                     SqlInstance, Status)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Clear-DbaLatchStatistics.ps1 | `public/Clear-DbaLatchStatistics.ps1` | ソース | メイン機能実装 |
| Clear-DbaLatchStatistics.Tests.ps1 | `tests/Clear-DbaLatchStatistics.Tests.ps1` | テスト | Pesterユニットテスト |
