# 機能設計書 75-Invoke-DbaDbccFreeCache

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Invoke-DbaDbccFreeCache` コマンドレットに関する機能設計書です。このコマンドは、SQL Serverの各種メモリキャッシュをクリアするDBCCコマンド（FREEPROCCACHE、FREESESSIONCACHE、FREESYSTEMCACHE）を実行します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverのパフォーマンス問題のトラブルシューティングやリソース解放のために、様々なメモリキャッシュをクリアする必要があります。本機能は、パラメータスニッフィング問題の解決、プランキャッシュの肥大化対応、メモリプレッシャーの軽減など、DBCCコマンドを使用して各種キャッシュをクリアします。

**機能の利用シーン**：
- パラメータスニッフィングによる非効率なクエリプランの解消（FREEPROCCACHE）
- リンクサーバー接続問題の解決（FREESESSIONCACHE）
- 認証トークンキャッシュのクリア（FREESYSTEMCACHE）
- メモリ不足時のキャッシュ解放
- パフォーマンステスト前のキャッシュクリア

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 操作タイプ（FreeProcCache/FreeSessionCache/FreeSystemCache）に基づくDBCCコマンドの構築
3. オプションパラメータ（InputValue、MarkInUseForRemoval）の適用
4. コマンドの実行
5. 実行結果の出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)、Invoke-DbaQueryを使用してT-SQLを実行

**権限による制御**：ALTER SERVER STATEまたはsysadminロールのメンバーシップが必要

## 関連画面

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

## 機能種別

DBCC操作 / キャッシュ管理 / パフォーマンスチューニング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Operation | string | No | 操作タイプ | FreeProcCache/FreeSessionCache/FreeSystemCache |
| InputValue | string | No | 特定対象を指定（plan_handle、プール名等） | - |
| NoInformationalMessages | switch | No | 情報メッセージを抑制 | - |
| MarkInUseForRemoval | switch | No | 使用中エントリを削除対象にマーク | FreeSystemCacheのみ有効 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なインスタンス名 |
| Operation | string | 実行された操作タイプ |
| Cmd | string | 実行されたDBCCコマンド |
| Output | string | DBCC出力メッセージ |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック：操作タイプに基づくDBCCコマンドの構築
   └─ Operation未指定時は警告メッセージ
   └─ FREESESSIONCACHE: シンプルなコマンド
   └─ FREEPROCCACHE: InputValueの有無で分岐（0xで始まる場合はplan_handle）
   └─ FREESYSTEMCACHE: InputValueの有無とMarkInUseForRemovalの組み合わせ
2. processブロック：各インスタンスの処理
   └─ Connect-DbaInstanceでサーバー接続
3. ShouldProcessによる確認とコマンド実行
4. 結果の出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Operation指定?}
    B -->|No| C[警告表示]
    B -->|Yes| D[Operationを大文字化]
    D --> E{FREESESSIONCACHE?}
    E -->|Yes| F[シンプルコマンド構築]
    E -->|No| G{FREEPROCCACHE?}
    G -->|Yes| H{InputValue指定?}
    H -->|Yes| I{0xで始まる?}
    I -->|Yes| J[plan_handle形式]
    I -->|No| K[プール名形式]
    H -->|No| L[引数なし]
    G -->|No| M{FREESYSTEMCACHE?}
    M -->|Yes| N{InputValue指定?}
    N -->|Yes| O[プール指定]
    N -->|No| P[ALL指定]
    O --> Q{MarkInUseForRemoval?}
    P --> Q
    Q -->|Yes| R[WITH MARK_IN_USE_FOR_REMOVAL追加]
    Q -->|No| S[オプション確定]
    F --> T[インスタンスループ]
    J --> T
    K --> T
    L --> T
    R --> T
    S --> T
    T --> U[Connect-DbaInstance]
    U --> V{接続成功?}
    V -->|No| W[Stop-Function]
    V -->|Yes| X[Invoke-DbaQuery実行]
    X --> Y[結果出力]
    Y --> Z{次のインスタンス?}
    Z -->|Yes| T
    Z -->|No| AA[終了]
    W --> Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-75-01 | デフォルト操作 | OperationのデフォルトはFreeProcCache | Operation未指定時 |
| BR-75-02 | plan_handle形式 | InputValueが0xで始まる場合はplan_handleとして処理 | FREEPROCCACHE + InputValue |
| BR-75-03 | リソースプール名 | InputValueが文字列の場合はプール名として処理 | FREEPROCCACHE/FREESYSTEMCACHE + InputValue |
| BR-75-04 | MarkInUseForRemoval | FreeSystemCacheでのみ有効なオプション | FREESYSTEMCACHE時 |
| BR-75-05 | 高確認 | ConfirmImpactがHighに設定 | 常時 |

### 計算ロジック

- 特になし（DBCCコマンドを実行するのみ）

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| DBCC FREEPROCCACHE | プロシージャキャッシュ | メモリ操作 | クエリプランの削除 |
| DBCC FREESESSIONCACHE | セッションキャッシュ | メモリ操作 | 分散クエリ接続キャッシュの削除 |
| DBCC FREESYSTEMCACHE | システムキャッシュ | メモリ操作 | トークンキャッシュ等の削除 |

### 各操作の詳細

#### FREEPROCCACHE
- 全プランキャッシュのクリア、または特定のplan_handle/sql_handle/リソースプールのみクリア

#### FREESESSIONCACHE
- リンクサーバーへの分散クエリ接続キャッシュのクリア

#### FREESYSTEMCACHE
- 認証トークン、リングバッファ等のシステムレベルキャッシュのクリア

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverに接続できない | Stop-Functionで処理継続 |
| ExecutionError | 実行エラー | DBCCコマンド実行失敗 | Stop-Functionで処理継続 |
| PermissionError | 権限エラー | ALTER SERVER STATE権限がない | エラーメッセージを表示 |

### リトライ仕様

- リトライ機能なし（手動で再実行が必要）

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

- トランザクション不要（メモリ操作のみ）

## パフォーマンス要件

- 実行は即時完了
- FREEPROCCACHE実行後、クエリの再コンパイルが発生しCPU使用率が一時的に上昇する可能性

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

- ALTER SERVER STATEまたはsysadminロールが必要
- SqlCredentialパラメータで安全な認証情報の受け渡しをサポート
- ConfirmImpact = 'High'により確認プロンプトがデフォルトで表示

## 備考

- 本番環境でのFREEPROCCACHEの使用は慎重に（全プランの再コンパイルが発生）
- Microsoft公式ドキュメント:
  - https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-freeproccache-transact-sql
  - https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-freesessioncache-transact-sql
  - https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-freesystemcache-transact-sql

---

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

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

### 推奨読解順序

#### Step 1: コマンドの全体構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Invoke-DbaDbccFreeCache.ps1 | `public/Invoke-DbaDbccFreeCache.ps1` | 3種類の操作タイプとパラメータの関係性 |

**読解のコツ**: Operationパラメータの値によって全く異なるDBCCコマンドが構築される点に注目。

#### Step 2: beginブロック - 複雑なコマンド構築ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Invoke-DbaDbccFreeCache.ps1 | `public/Invoke-DbaDbccFreeCache.ps1` | 131-180行目：操作タイプごとの分岐処理 |

**主要処理フロー**:
1. **133-138行目**: Operation指定チェックと大文字化
2. **141-146行目**: FREESESSIONCACHE処理
3. **147-163行目**: FREEPROCCACHE処理（InputValueの形式判定含む）
4. **164-179行目**: FREESYSTEMCACHE処理（MarkInUseForRemovalの組み合わせ）

#### Step 3: processブロック - メイン処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Invoke-DbaDbccFreeCache.ps1 | `public/Invoke-DbaDbccFreeCache.ps1` | 181-211行目：インスタンスループと結果出力 |

**主要処理フロー**:
- **182行目**: クエリ文字列の取得
- **184-190行目**: Connect-DbaInstanceによる接続
- **192-199行目**: ShouldProcess確認と実行
- **200-209行目**: 結果オブジェクトの出力（Operationプロパティ含む）

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

```
Invoke-DbaDbccFreeCache
    │
    ├─ Test-Bound (dbatools内部関数)
    │      └─ パラメータバインド確認
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ Invoke-DbaQuery
    │      └─ DBCC FREEPROCCACHE/FREESESSIONCACHE/FREESYSTEMCACHEの実行
    │
    └─ Stop-Function (dbatools内部関数)
           └─ エラーハンドリング
```

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ $server
                        │
Operation ──────▶ コマンド選択 ───────────▶ $query
    │                   │
InputValue ─────▶ コマンド構築 ───────────┘
    │                   │
MarkInUse ──────▶ オプション追加 ─────────┘
                        │
                 Invoke-DbaQuery ─────────▶ $results
                        │
                 結果出力 ─────────────────▶ PSCustomObject
                                              │
                                              ├─ ComputerName
                                              ├─ InstanceName
                                              ├─ SqlInstance
                                              ├─ Operation
                                              ├─ Cmd
                                              └─ Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Invoke-DbaDbccFreeCache.ps1 | `public/Invoke-DbaDbccFreeCache.ps1` | ソース | メインコマンド実装 |
| Invoke-DbaDbccFreeCache.Tests.ps1 | `tests/Invoke-DbaDbccFreeCache.Tests.ps1` | テスト | Pester v5テストファイル |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続関数 |
| Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | ソース | クエリ実行関数 |
