# 機能設計書 74-Invoke-DbaDbccDropCleanBuffer

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Invoke-DbaDbccDropCleanBuffer` コマンドレットに関する機能設計書です。このコマンドは、SQL ServerのバッファプールキャッシュとカラムストアオブジェクトプールをクリアするDBCC DROPCLEANBUFFERSコマンドを実行します。

### 本機能の処理概要

**業務上の目的・背景**：パフォーマンステストやクエリ最適化を行う際、キャッシュされたデータページの影響を排除した「コールドキャッシュ」状態でのベースライン測定が必要になります。本機能は、DBCC DROPCLEANBUFFERSを実行してバッファプールから全てのクリーンデータページを削除し、後続のクエリがディスクからデータを読み取るよう強制します。

**機能の利用シーン**：
- クエリパフォーマンステストの前準備
- I/Oパフォーマンスのベースライン測定
- インデックスチューニング効果の検証
- 複数回のテスト実行間での一貫性確保
- 開発・テスト環境でのパフォーマンス分析

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. DBCC DROPCLEANBUFFERSコマンドの構築
3. コマンドの実行
4. 実行結果の出力

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

**権限による制御**：sysadminロールのメンバーシップが必要

## 関連画面

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

## 機能種別

DBCC操作 / パフォーマンステスト / キャッシュ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| NoInformationalMessages | switch | No | 情報メッセージを抑制 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック：DBCCコマンドの構築
   └─ DBCC DROPCLEANBUFFERS の基本形を準備
   └─ NoInformationalMessages時にWITH NO_INFOMSGSを追加
2. processブロック：各インスタンスの処理
   └─ Connect-DbaInstanceでサーバー接続
3. ShouldProcessによる確認とコマンド実行
4. 結果の出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[DBCCコマンド構築]
    B --> C{NoInformationalMessages?}
    C -->|Yes| D[WITH NO_INFOMSGS追加]
    C -->|No| E[コマンド確定]
    D --> E
    E --> F[インスタンスループ開始]
    F --> G[Connect-DbaInstance]
    G --> H{接続成功?}
    H -->|No| I[Stop-Function]
    H -->|Yes| J{ShouldProcess?}
    J -->|No| K[スキップ]
    J -->|Yes| L[Invoke-DbaQuery実行]
    L --> M{実行成功?}
    M -->|No| N[Stop-Function]
    M -->|Yes| O[結果出力]
    O --> P{次のインスタンス?}
    K --> P
    I --> P
    N --> P
    P -->|Yes| F
    P -->|No| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-74-01 | クリーンバッファのみ | ダーティページ（未書き込み）は削除されない | 常時 |
| BR-74-02 | グローバル影響 | 全てのデータベースのバッファが影響を受ける | 常時 |
| BR-74-03 | 本番非推奨 | 本番環境での実行は推奨されない | 常時 |
| BR-74-04 | 高確認 | ConfirmImpactがHighに設定 | 常時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC DROPCLEANBUFFERS | バッファプール | メモリ操作 | クリーンバッファの削除 |

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

- データベーステーブルへの直接操作なし
- メモリ内のバッファプールキャッシュをクリア

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

- 実行は即時完了
- 実行後、後続のクエリはディスクI/Oが増加（キャッシュヒット率が低下）

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

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

## 備考

- 本番環境での使用は推奨されない（パフォーマンス低下の原因となる）
- SQL Server 2008以降で使用可能
- Microsoft公式ドキュメント: https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-dropcleanbuffers-transact-sql

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Invoke-DbaDbccDropCleanBuffer.ps1 | `public/Invoke-DbaDbccDropCleanBuffer.ps1` | シンプルなコマンド構造、パラメータが最小限 |

**読解のコツ**: 他のDBCCコマンドと比較して最もシンプルな構造。データベース指定がなく、インスタンス単位で動作する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Invoke-DbaDbccDropCleanBuffer.ps1 | `public/Invoke-DbaDbccDropCleanBuffer.ps1` | 90-97行目：非常にシンプルなコマンド構築 |

**主要処理フロー**:
1. **92-93行目**: StringBuilderの初期化とベースコマンド
2. **94-96行目**: NoInformationalMessagesオプションの追加

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

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

**主要処理フロー**:
- **99行目**: クエリ文字列の取得
- **101-107行目**: Connect-DbaInstanceによる接続
- **109-116行目**: ShouldProcess確認と実行
- **117-126行目**: 結果オブジェクトの出力

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

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

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ $server
                        │
NoInformational ──▶ コマンド構築 ─────────▶ $query
Messages                │
                 Invoke-DbaQuery ─────────▶ $results
                        │
                 結果出力 ─────────────────▶ PSCustomObject
                                              │
                                              ├─ ComputerName
                                              ├─ InstanceName
                                              ├─ SqlInstance
                                              ├─ Cmd
                                              └─ Output
```

### 関連ファイル一覧

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