# 機能設計書 68-Get-DbaDbccProcCache

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Get-DbaDbccProcCache` コマンドレットの機能設計書です。DBCC PROCCACHEコマンドを実行し、SQL Serverのプランキャッシュメモリ使用統計を取得する機能について、その仕様と実装詳細を記述します。

### 本機能の処理概要

`Get-DbaDbccProcCache` は、SQL ServerのDBCC PROCCACHEコマンドを実行し、プランキャッシュのメモリ使用状況に関する構造化された情報を返すコマンドレットです。コンパイルされた実行プランの格納に割り当てられているメモリ量、使用量、アクティブなエントリ数を確認できます。

**業務上の目的・背景**：SQL Serverのプランキャッシュは、クエリパフォーマンスに大きな影響を与えます。プランキャッシュが過度にメモリを消費している場合や、頻繁なプラン退去が発生している場合、クエリパフォーマンスが低下します。本機能により、DBAはプランキャッシュの状態を迅速に把握し、メモリプレッシャーや効率の問題を診断できます。

**機能の利用シーン**：
- メモリプレッシャー問題の診断
- プランキャッシュ効率の監視
- プランキャッシュクリア前後の状態比較
- パフォーマンストラブルシューティング

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. DBCC PROCCACHEの実行
3. 結果を構造化オブジェクトとして出力

**関連システム・外部連携**：
- SQL Server インスタンス

**権限による制御**：
- DBCC PROCCACHEの実行にはVIEW SERVER STATE権限が必要

## 関連画面

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

## 機能種別

データベース診断（読み取り専用）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 接続先SQL Serverインスタンス | Mandatory, パイプライン入力可 |
| SqlCredential | PSCredential | No | 認証用資格情報 | - |
| EnableException | switch | No | 例外を有効にするフラグ | - |

### 入力データソース

- SQL Server インスタンスへの接続

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名（サービス名） |
| SqlInstance | string | 完全なSQL Server名（DomainInstanceName） |
| Count | int | プランキャッシュエントリ数 |
| Used | int | プランキャッシュに割り当てられたメモリ（ページ単位） |
| Active | int | アクティブなプランキャッシュエントリ数 |
| CacheSize | int | 合計プランキャッシュサイズ（ページ単位） |
| CacheUsed | int | 現在使用中のプランキャッシュ量（ページ単位） |
| CacheActive | int | アクティブなキャッシュエントリ数 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. クエリテンプレート準備
   └─ DBCC PROCCACHE WITH NO_INFOMSGS
2. インスタンス接続
   └─ Connect-DbaInstanceでSQL Server接続
3. クエリ実行
   └─ server.Query()でDBCC PROCCACHE実行
4. 結果出力
   └─ 各行をPSCustomObjectとして出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[クエリテンプレート準備]
    B --> C[インスタンスループ開始]
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function]
    E -->|Yes| G[DBCC PROCCACHE実行]
    G --> H{実行成功?}
    H -->|No| I[Stop-Function]
    H -->|Yes| J[結果行ループ開始]
    J --> K[PSCustomObject生成]
    K --> L{次の行?}
    L -->|Yes| J
    L -->|No| M{次のインスタンス?}
    M -->|Yes| C
    M -->|No| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | WITH NO_INFOMSGS | 情報メッセージを抑制してデータのみ取得 | 常時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC PROCCACHE | なし | 読み取り | プランキャッシュ統計の取得 |

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

データベースへの書き込みは行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続失敗 | SQL Serverへの接続に失敗 | 接続情報を確認 |
| - | 権限不足 | VIEW SERVER STATE権限がない | 権限を付与 |
| - | DBCC実行エラー | DBCC PROCCACHEの実行に失敗 | エラー詳細を確認 |

### リトライ仕様

リトライ処理なし

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

該当なし（読み取り専用操作）

## パフォーマンス要件

- 軽量な診断コマンドのため、即座に完了

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

- VIEW SERVER STATE権限が必要
- 読み取り専用操作のため、データへの影響なし

## 備考

- DBCC PROCCACHEは非推奨であり、将来のSQL Serverバージョンで削除される可能性がある
- 代替としてsys.dm_exec_cached_plansを使用することが推奨される場合もある

---

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

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

### 推奨読解順序

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

出力されるPSCustomObjectの構造を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbccProcCache.ps1 | `public/Get-DbaDbccProcCache.ps1` | 98-108行目: 出力オブジェクトの構造 |

**読解のコツ**: $row配列のインデックスと出力プロパティの対応を確認。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbccProcCache.ps1 | `public/Get-DbaDbccProcCache.ps1` | 70-76行目: パラメータ定義 |

**主要処理フロー**:
1. **70-76行目**: パラメータ定義
2. **77-81行目**: begin ブロック - クエリ構築
3. **82-111行目**: process ブロック - メイン処理

#### Step 3: 実行ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbccProcCache.ps1 | `public/Get-DbaDbccProcCache.ps1` | 処理ロジック |

**主要処理フロー**:
- **79-80行目**: StringBuilderでクエリ構築
- **86行目**: Connect-DbaInstance
- **93行目**: server.Query()でDBCC実行
- **97-108行目**: 結果行のPSCustomObject変換

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

```
Get-DbaDbccProcCache (public/Get-DbaDbccProcCache.ps1)
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    └─ server.Query()
           └─ DBCC PROCCACHE WITH NO_INFOMSGS
```

### データフロー図

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

SqlInstance ──────▶ Connect-DbaInstance ──┐
                                          │
                                          ▼
                                   server.Query()
                                   DBCC PROCCACHE
                                          │
                                          ▼
                                   結果行データ
                                          │
                                          ▼
                                   PSCustomObject
                              (Count, Used, Active,
                               CacheSize, CacheUsed, CacheActive)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbccProcCache.ps1 | `public/Get-DbaDbccProcCache.ps1` | ソース | メイン実装ファイル |
| Get-DbaDbccProcCache.Tests.ps1 | `tests/Get-DbaDbccProcCache.Tests.ps1` | テスト | 単体テスト |
| Invoke-DbaDbccFreeCache.ps1 | `public/Invoke-DbaDbccFreeCache.ps1` | ソース | キャッシュクリア（関連機能） |
