# 機能設計書 77-Clear-DbaConnectionPool

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Clear-DbaConnectionPool` コマンドレットに関する機能設計書です。このコマンドは、指定されたコンピュータ上のSQL Server接続プールをクリアし、接続問題を解決します。

### 本機能の処理概要

**業務上の目的・背景**：.NET SqlClientは接続パフォーマンスを向上させるために接続プールを維持しますが、時として古い接続や問題のある接続が残り、断続的な接続エラーや認証失敗、パフォーマンス低下の原因となります。本機能は、接続プールをクリアして新しい接続を強制的に作成させることで、これらの問題を解決します。

**機能の利用シーン**：
- 断続的なSQL Server接続エラーの解決
- 認証情報変更後の接続問題のトラブルシューティング
- パスワード変更後の古い接続のクリア
- アプリケーションサーバーでの接続リセット
- 開発・テスト環境での接続状態のリフレッシュ

**主要な処理内容**：
1. 対象コンピュータの特定（ローカルまたはリモート）
2. .NET SqlConnectionのClearAllPools()メソッドの呼び出し
3. プールされた接続の破棄マーク
4. サイレント完了（出力なし）

**関連システム・外部連携**：Microsoft.Data.SqlClient（.NET SQL Client）

**権限による制御**：リモートコンピュータの場合はPowerShell Remotingのアクセス権が必要

## 関連画面

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

## 機能種別

診断 / 接続管理 / トラブルシューティング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstanceParameter[] | No | 対象コンピュータ | デフォルトはローカル、エイリアス: cn, host, Server |
| Credential | PSCredential | No | リモートアクセス用資格情報 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | None | このコマンドは出力を返さない |

### 出力先

- なし（サイレント実行）

## 処理フロー

### 処理シーケンス

```
1. processブロック：各コンピュータの処理
   └─ IsLocalhostプロパティで判定
2. リモートコンピュータの場合
   └─ Invoke-Command2でリモート実行
   └─ Credential指定の有無で分岐
3. ローカルコンピュータの場合
   └─ 直接SqlConnection.ClearAllPools()を呼び出し
   └─ Credential指定の有無で分岐
4. 正常終了（出力なし）
   └─ エラー時のみStop-Function
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各コンピュータループ]
    B --> C{ローカルホスト?}
    C -->|No| D[リモート実行準備]
    D --> E{Credential指定?}
    E -->|Yes| F[Invoke-Command2 + Credential]
    E -->|No| G[Invoke-Command2]
    C -->|Yes| H[ローカル実行準備]
    H --> I{Credential指定?}
    I -->|Yes| J[Invoke-Command2 + Credential]
    I -->|No| K[Invoke-Command2]
    F --> L[ClearAllPools実行]
    G --> L
    J --> L
    K --> L
    L --> M{成功?}
    M -->|No| N[Stop-Function]
    M -->|Yes| O{次のコンピュータ?}
    N --> O
    O -->|Yes| B
    O -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-77-01 | デフォルトローカル | ComputerName未指定時はローカルコンピュータ | ComputerName未指定 |
| BR-77-02 | アクティブ接続 | アクティブ接続は破棄マークされクローズ時に破棄 | 常時 |
| BR-77-03 | プール再作成 | クリア後の接続は新規プールから作成 | 常時 |
| BR-77-04 | 出力なし | コマンドは成功時に出力を返さない | 常時 |

### 計算ロジック

- 特になし（SqlConnection.ClearAllPools()を呼び出すのみ）

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| ClearAllPools | .NET接続プール | メモリ操作 | プールされた接続の破棄 |

### 詳細

- SQL Serverへのデータベース操作は行わない
- クライアント側の.NET接続プールのみをクリア
- SQL Server側のセッションには直接影響しない

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| RemoteError | リモート実行エラー | PowerShell Remotingが無効 | Stop-Functionで処理継続 |
| PermissionError | 権限エラー | リモートアクセス権がない | Stop-Functionで処理継続 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- 実行は即時完了
- 次回の接続時に新規接続が作成される

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

- リモートコンピュータの場合はPowerShell Remotingのアクセス権が必要
- Credentialパラメータで安全な認証情報の受け渡しをサポート

## 備考

- Microsoft公式ドキュメント: https://msdn.microsoft.com/en-us/library/system.data.sqlclient.sqlconnection.clearallpools(v=vs.110).aspx
- 著者: Chrissy LeMaire (@cl)
- コード内TODOコメント: https://jamessdixon.wordpress.com/2013/01/22/ado-net-and-connection-pooling

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Clear-DbaConnectionPool.ps1 | `public/Clear-DbaConnectionPool.ps1` | シンプルなコマンド構造、SQL Serverへの接続ではなくクライアント側の操作 |

**読解のコツ**: このコマンドはSQL Serverへは接続せず、クライアントコンピュータの.NET接続プールを操作する点が他のdbatools関数と異なる。

#### Step 2: processブロック - ローカル/リモート分岐

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Clear-DbaConnectionPool.ps1 | `public/Clear-DbaConnectionPool.ps1` | 64-88行目：IsLocalhostプロパティによる分岐処理 |

**主要処理フロー**:
1. **67行目**: 各コンピュータに対するループ
2. **69行目**: IsLocalhostプロパティでローカル/リモート判定
3. **70-75行目**: リモートコンピュータの場合の処理
4. **76-82行目**: ローカルコンピュータの場合の処理

#### Step 3: ClearAllPoolsの呼び出し

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Clear-DbaConnectionPool.ps1 | `public/Clear-DbaConnectionPool.ps1` | 72行目, 74行目, 79行目, 81行目：ScriptBlockでClearAllPools()呼び出し |

**読解のコツ**: `[Microsoft.Data.SqlClient.SqlConnection]::ClearAllPools()`は静的メソッドとして呼び出される。Invoke-Command2を使用してローカル/リモート両方で同じロジックを実行。

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

```
Clear-DbaConnectionPool
    │
    ├─ Test-Bound (dbatools内部関数)
    │      └─ Credential指定確認
    │
    ├─ Invoke-Command2 (dbatools内部関数)
    │      └─ リモート/ローカルコマンド実行
    │      │
    │      └─ ScriptBlock
    │             └─ [Microsoft.Data.SqlClient.SqlConnection]::ClearAllPools()
    │
    └─ Stop-Function (dbatools内部関数)
           └─ エラーハンドリング
```

### データフロー図

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

ComputerName ───▶ IsLocalhost判定 ─────────▶ 分岐
                        │
Credential ─────▶ Invoke-Command2 ─────────▶ ClearAllPools()
                        │
                 エラー処理 ───────────────▶ (出力なし)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Clear-DbaConnectionPool.ps1 | `public/Clear-DbaConnectionPool.ps1` | ソース | メインコマンド実装 |
| Clear-DbaConnectionPool.Tests.ps1 | `tests/Clear-DbaConnectionPool.Tests.ps1` | テスト | Pester v5テストファイル |
| Invoke-Command2.ps1 | `private/functions/Invoke-Command2.ps1` | ソース | リモート/ローカルコマンド実行ヘルパー |
