# 機能設計書 411-Get-DbaPlanCache

## 概要

本ドキュメントは、SQL Serverのプランキャッシュにおける単一使用(single-use)のアドホック/プリペアドステートメントの使用量を分析し、メモリ浪費を特定する`Get-DbaPlanCache`機能の設計を定義する。

### 本機能の処理概要

本機能は、SQL Serverのプランキャッシュに蓄積された単一使用のアドホックおよびプリペアドステートメントを分析し、メモリ消費量とプラン数を取得する機能である。

**業務上の目的・背景**：アプリケーションがパラメータ化されていない動的SQLを生成すると、各ユニークなステートメントごとに実行プランが作成される。これらの単一使用プランはメモリを浪費し、プランキャッシュの圧迫を引き起こし、パフォーマンス低下やコンパイルオーバーヘッドの増加につながる。本機能はこの問題を定量的に可視化し、対策の必要性を判断するための基礎データを提供する。

**機能の利用シーン**：
- SQL Serverのメモリ使用量が高い場合の原因調査
- プランキャッシュのブロート(肥大化)診断
- 「optimize for adhoc workloads」設定の有効化判断
- 定期的なサーバーヘルスチェック

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. sys.dm_exec_cached_plansからuse count=1のAdhoc/Preparedプランの集計クエリ実行
3. メモリ使用量(MB)とプラン数の取得
4. dbasizeオブジェクトへの変換と結果出力

**関連システム・外部連携**：SQL Server DMV (sys.dm_exec_cached_plans)との連携

**権限による制御**：VIEW SERVER STATE権限が必要

## 関連画面

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

## 機能種別

データ取得・分析処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| EnableException | switch | No | 例外の詳細表示有効化 | - |

### 入力データソース

SQL Server DMV: sys.dm_exec_cached_plans

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホストのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Size | dbasize | 単一使用プランの合計サイズ(Bytes/KB/MB/GB/TB変換可能) |
| UseCount | int | 単一使用プランの総数 |

### 出力先

PowerShellパイプライン(PSCustomObject)

## 処理フロー

### 処理シーケンス

```
1. beginブロック: SQLクエリ文字列の定義
   └─ sys.dm_exec_cached_plansから単一使用プランを集計するSQLを構築

2. processブロック: インスタンスごとの処理ループ
   └─ 2.1 Connect-DbaInstanceでサーバー接続
   └─ 2.2 $server.Query()でSQLクエリ実行
   └─ 2.3 MB値をdbasizeオブジェクトに変換
   └─ 2.4 Select-DefaultViewで結果出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQLクエリ文字列定義]
    B --> C{各SqlInstanceをループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function/Continue]
    F --> C
    E -->|Yes| G[クエリ実行]
    G --> H[MB値をdbasizeに変換]
    H --> I[Add-Member: Size追加]
    I --> J[Select-DefaultViewで出力]
    J --> C
    C -->|完了| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 単一使用判定 | usecounts=1かつobjtype IN ('Adhoc', 'Prepared')のプランを対象 | 常時 |
| BR-002 | 100MB閾値推奨 | 100MB超の場合は「optimize for adhoc workloads」の有効化を推奨 | 結果分析時 |

### 計算ロジック

```sql
SUM(CAST((CASE WHEN usecounts = 1 AND objtype IN ('Adhoc', 'Prepared')
          THEN size_in_bytes ELSE 0 END) AS DECIMAL(12, 2))) / 1024 / 1024
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| プランキャッシュ分析 | sys.dm_exec_cached_plans | SELECT | DMVから単一使用プラン情報を集計 |

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

#### sys.dm_exec_cached_plans (DMV)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | size_in_bytes | usecounts=1, objtype IN ('Adhoc','Prepared') | 合計サイズ計算用 |
| SELECT | usecounts | =1 | 単一使用判定 |
| SELECT | objtype | IN ('Adhoc','Prepared') | プランタイプ判定 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | Connect-DbaInstance失敗 | Stop-FunctionでContinue |

### リトライ仕様

リトライ処理なし(単一試行)

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

読み取り専用クエリのためトランザクション管理不要

## パフォーマンス要件

- DMVクエリのため通常は高速(数秒以内)
- プランキャッシュサイズが大きい環境では若干の遅延可能性あり

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

- VIEW SERVER STATE権限が必要
- SQL認証/Windows認証/Azure AD認証に対応
- 資格情報はPSCredentialで安全に渡される

## 備考

- Kimberly Tripp氏のブログ記事を参照: https://www.sqlskills.com/blogs/kimberly/plan-cache-adhoc-workloads-and-clearing-the-single-use-plan-cache-bloat/
- Tracy Boggiano氏による開発

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaPlanCache.ps1 | `public/Get-DbaPlanCache.ps1` | 出力オブジェクトの構造(ComputerName, InstanceName, SqlInstance, Size, UseCount) |

**読解のコツ**: dbasizeはdbatools独自の型で、バイト数から各単位への自動変換機能を持つ

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaPlanCache.ps1 | `public/Get-DbaPlanCache.ps1` | 関数全体の構造とパラメータ定義 |

**主要処理フロー**:
1. **73-78行目**: beginブロックでSQLクエリ定義
2. **82-84行目**: Connect-DbaInstanceでサーバー接続
3. **89行目**: $server.Query()でDMVクエリ実行
4. **90-91行目**: dbasizeオブジェクトへの変換とプロパティ追加
5. **93行目**: Select-DefaultViewで結果出力

#### Step 3: SQLクエリロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaPlanCache.ps1 | `public/Get-DbaPlanCache.ps1` | $Sql変数の内容(74-78行目) |

**主要処理フロー**:
- **74-78行目**: SERVERPROPERTY関数でサーバー情報取得、CASE式で単一使用プランのサイズ合計を計算

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

```
Get-DbaPlanCache
    │
    ├─ Connect-DbaInstance
    │      └─ SMO接続の確立
    │
    ├─ $server.Query()
    │      └─ sys.dm_exec_cached_plansへのクエリ実行
    │
    └─ Select-DefaultView
           └─ 出力プロパティの選択
```

### データフロー図

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

SqlInstance ──────▶ Connect-DbaInstance ──────┐
                                              │
SqlCredential ────▶ 認証処理 ────────────────┘
                          │
                          ▼
                   $server.Query($sql)
                          │
                          ▼
              sys.dm_exec_cached_plans
                          │
                          ▼
                   結果をdbasize変換
                          │
                          ▼
                   PSCustomObject ──────▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaPlanCache.ps1 | `public/Get-DbaPlanCache.ps1` | ソース | メイン関数実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
| dbasize.ps1 | `internal/classes/dbasize.ps1` | ソース | サイズ単位変換クラス |
