# 機能設計書 251-Test-DbaOptimizeForAdHoc

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Test-DbaOptimizeForAdHoc`コマンドレットの機能設計書です。SQL Serverの「optimize for ad-hoc workloads」構成設定が有効化されているかをテストし、ベストプラクティスに対する準拠状況を確認します。

### 本機能の処理概要

`Test-DbaOptimizeForAdHoc`コマンドは、SQL Serverインスタンスの「optimize for ad-hoc workloads」サーバー構成オプションの現在値を取得し、推奨設定値（有効化=1）と比較して、設定が最適かどうかを判定します。

**業務上の目的・背景**：SQL Serverでは、アドホッククエリが多い環境において、単回使用のクエリに対して完全な実行プランを保存することでプランキャッシュが肥大化し、メモリ圧迫を引き起こす可能性があります。「optimize for ad-hoc workloads」オプションを有効にすることで、単回使用のアドホッククエリに対してはプランスタブのみを保存し、メモリ使用効率を向上させることができます。本機能は、この重要な構成設定がベストプラクティスに従って設定されているかを検証するために使用されます。

**機能の利用シーン**：
- 新規SQL Serverインスタンスのセットアップ時の構成チェック
- 定期的なSQL Server健全性監査の一環
- パフォーマンス問題のトラブルシューティング時
- 複数インスタンスの構成標準化確認

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続を確立（SQL Server 2008以降が必要）
2. `Configuration.OptimizeAdhocWorkloads`プロパティから現在の設定値を取得
3. 推奨値（1=有効）と比較し、準拠状況を判定
4. 結果をPSCustomObjectとして出力

**関連システム・外部連携**：本機能はSMO（SQL Server Management Objects）を使用してSQL Serverの構成値を取得します。外部APIや他システムとの連携はありません。

**権限による制御**：SQL Serverへの接続権限が必要です。構成値の読み取りには特別な権限は不要ですが、通常はサーバーへの接続権限があれば取得可能です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能はPowerShellコマンドレットであり、関連するGUI画面はありません |

## 機能種別

バリデーション / 構成監査

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | Yes | クエリ対象の1つ以上のSQL Serverインスタンス名 | パイプラインから受け付け可能 |
| SqlCredential | PSCredential | No | 代替認証情報（SQL認証、AD認証対応） | Get-Credentialで生成された資格情報オブジェクト |
| EnableException | switch | No | 例外を有効にし、try/catchでのエラーハンドリングを可能にする | - |

### 入力データソース

- PowerShellコマンドラインからの直接入力
- パイプライン経由での入力（他のdbatools関数からのインスタンス情報など）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（computer\instance形式） |
| CurrentOptimizeAdHoc | int | 現在の「optimize for ad-hoc workloads」設定値（0または1） |
| RecommendedOptimizeAdHoc | int | 推奨設定値（常に1=有効） |
| Notes | string | 設定状況に関するガイダンスメッセージ |

### 出力先

- PowerShellパイプライン（PSCustomObject）
- コンソール表示
- ファイルへのエクスポート（ユーザーが後続処理で指定）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 定数の初期化（推奨値=1、メッセージ文字列）
2. process ブロック
   └─ 各SqlInstanceに対してループ処理
      ├─ Connect-DbaInstanceでSQL Server接続（MinimumVersion 10=SQL 2008）
      ├─ 接続エラー時はStop-FunctionでスキップしてContinue
      ├─ Configuration.OptimizeAdhocWorkloads.ConfigValueを取得
      ├─ 推奨値と比較してNotesメッセージを設定
      └─ PSCustomObjectを出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[定数初期化]
    B --> C{SqlInstanceループ}
    C -->|次のインスタンス| D[Connect-DbaInstance]
    D -->|成功| E[OptimizeAdhocWorkloads取得]
    D -->|失敗| F[Stop-Function/Continue]
    F --> C
    E --> G{現在値 == 推奨値?}
    G -->|Yes| H["Notes = 推奨通り"]
    G -->|No| I["Notes = 有効化推奨"]
    H --> J[PSCustomObject出力]
    I --> J
    J --> C
    C -->|完了| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン要件 | SQL Server 2008（バージョン10）以上が必要 | 接続時に検証 |
| BR-002 | 推奨値判定 | optimize for ad-hoc workloadsの推奨値は1（有効） | 常に適用 |

### 計算ロジック

- 現在値（CurrentOptimizeAdHoc）が推奨値（1）と等しい場合：「Configuration is already set as recommended.」
- 現在値が推奨値と異なる場合：「Recommended configuration is 1 (enabled).」

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 構成値取得 | sys.configurations（SMO経由） | SELECT | optimize for ad-hoc workloads設定値の読み取り |

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

#### sys.configurations（SMO経由で参照）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | value（ConfigValue） | name = 'optimize for ad hoc workloads' | SMOのConfigurationプロパティ経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで警告を出力し、次のインスタンスへ続行 |
| VersionError | バージョン不適合 | SQL Server 2008未満 | MinimumVersion 10で自動的にブロック |

### リトライ仕様

本機能にはリトライ機能はありません。接続失敗時は警告を出力して次のインスタンスの処理に移行します。

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

本機能は読み取り専用であり、トランザクション管理は不要です。

## パフォーマンス要件

- 各インスタンスへの接続とメタデータ取得は通常1秒以内に完了
- 大量のインスタンスを処理する場合は、パイプラインによる並列処理を検討

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

- SQL Server認証、Windows認証、Active Directory認証に対応
- 資格情報はPSCredentialオブジェクトとして安全に受け渡し
- 読み取り専用操作のため、データ改変のリスクなし

## 備考

- 本機能はMicrosoft公式ドキュメント（KB記事）およびSQL Server Central推奨設定に基づいています
- 参考URL: https://msdn.microsoft.com/en-us/library/cc645587.aspx

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **1-65行目**: パラメータ定義（SqlInstance、SqlCredential、EnableException）
2. **67-71行目**: beginブロックでの定数初期化（推奨値、メッセージ文字列）
3. **72-100行目**: processブロックでの各インスタンス処理

**読解のコツ**:
- beginブロックで初期化される定数（$notesAdHocZero、$notesAsRecommended、$recommendedValue）がprocessブロックで参照される
- `Connect-DbaInstance -MinimumVersion 10`でSQL Server 2008以降に限定

#### Step 2: SMO経由の構成値取得を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaOptimizeForAdHoc.ps1 | `public/Test-DbaOptimizeForAdHoc.ps1` | 82行目：SMOサーバーオブジェクトから構成値取得 |

**主要処理フロー**:
- **82行目**: `$server.Configuration.OptimizeAdhocWorkloads.ConfigValue`でoptimize for ad-hocの現在値を取得
- **85-89行目**: 推奨値との比較とNotesメッセージの設定
- **91-98行目**: PSCustomObjectの生成と出力

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

```
Test-DbaOptimizeForAdHoc
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMOオブジェクト取得
    │
    └─ $server.Configuration.OptimizeAdhocWorkloads
           └─ ConfigValue（構成値取得）
```

### データフロー図

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

SqlInstance     ───▶ Connect-DbaInstance    ───▶ SMO Server Object
                            │
SqlCredential   ───────────┘
                            │
                            ▼
                     Configuration.OptimizeAdhocWorkloads.ConfigValue
                            │
                            ▼
                     推奨値(1)と比較
                            │
                            ▼
                     PSCustomObject ───▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaOptimizeForAdHoc.ps1 | `public/Test-DbaOptimizeForAdHoc.ps1` | ソース | メイン関数定義 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
| Stop-Function.ps1 | `internal/functions/flowcontrol/Stop-Function.ps1` | ソース | エラーハンドリング関数 |
