# 機能設計書 96-Get-DbaConnection

## 概要

本ドキュメントは、SQL Serverのdm_exec_connections DMVから接続情報を取得するGet-DbaConnectionコマンドの機能設計書である。

### 本機能の処理概要

Get-DbaConnectionは、SQL Serverインスタンスへのアクティブなクライアント接続に関する詳細情報をdm_exec_connections動的管理ビュー（DMV）から取得する機能である。

**業務上の目的・背景**：SQL Serverインスタンスへの接続状況を把握することは、セキュリティ監査、パフォーマンス分析、およびトラブルシューティングにおいて重要である。本機能は各接続のプロトコル、認証方式、読み書き統計、ネットワーク情報などを包括的に取得し、接続の監視と分析を可能にする。

**機能の利用シーン**：アクティブな接続の監視、認証方式の監査（Windows認証 vs SQL認証）、ネットワーク接続の分析、接続の読み書きパフォーマンス確認、および特定クライアントIPからの接続調査時に利用される。

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続を確立（SQL Server 2005以降必須）
2. dm_exec_connections DMVに対するT-SQLクエリを実行
3. 接続情報を含む結果セットを返却

**関連システム・外部連携**：SQL Server DMV（sys.dm_exec_connections）にアクセス。

**権限による制御**：VIEW SERVER STATE権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドラインインターフェース | 主画面 | PowerShellコンソールまたはスクリプトから実行 |

## 機能種別

データ取得（DMVからのSELECT操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能、SQL Server 2005以降 |
| SqlCredential | PSCredential | No | 代替認証情報（Credential, Credエイリアス） | - |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

SQL Server sys.dm_exec_connections 動的管理ビュー

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが稼働しているコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| SessionId | Int32 | セッションID |
| MostRecentSessionId | Int32 | 最新のセッションID |
| ConnectTime | DateTime | 接続確立日時 |
| Transport | String | ネットワークトランスポートプロトコル |
| ProtocolType | String | プロトコルタイプ |
| ProtocolVersion | Int32 | プロトコルバージョン |
| EndpointId | Int32 | エンドポイントID |
| EncryptOption | String | 暗号化ステータス |
| AuthScheme | String | 認証方式（WINDOWS/SQL） |
| NodeAffinity | Int32 | NUMAノードアフィニティ |
| Reads | Int32 | 読み取り操作数 |
| Writes | Int32 | 書き込み操作数 |
| LastRead | DateTime | 最終読み取り日時 |
| LastWrite | DateTime | 最終書き込み日時 |
| PacketSize | Int32 | ネットワークパケットサイズ（バイト） |
| ClientNetworkAddress | String | クライアントIPアドレス |
| ClientTcpPort | Int32 | クライアントTCPポート |
| ServerNetworkAddress | String | サーバーIPアドレス |
| ServerTcpPort | Int32 | サーバーTCPポート |
| ConnectionId | Int32 | 接続ID |
| ParentConnectionId | Int32 | 親接続ID |
| MostRecentSqlHandle | Binary | 最新のSQLハンドル |

### 出力先

PowerShellパイプラインに直接出力される

## 処理フロー

### 処理シーケンス

```
1. Begin処理：T-SQLクエリの定義
   └─ dm_exec_connectionsを照会するSELECTステートメントを準備
2. Process処理：各インスタンスに対してループ
   └─ Connect-DbaInstanceで接続（MinimumVersion 9 = SQL 2005）
3. クエリの実行
   └─ $server.Query()でT-SQLを実行
4. 結果の出力
   └─ 結果セットをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[T-SQLクエリ定義]
    B --> C{各SqlInstanceをループ}
    C --> D[Connect-DbaInstance MinimumVersion 9]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function]
    F --> C
    E -->|Yes| G[$server.Query実行]
    G --> H{クエリ成功?}
    H -->|No| I[Stop-Function]
    I --> C
    H -->|Yes| J[結果出力]
    J --> C
    C -->|完了| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-96-1 | SQL Server 2005以降必須 | dm_exec_connectionsはSQL 2005で導入 | 接続時にMinimumVersion 9をチェック |
| BR-96-2 | サーバー全体の接続情報 | インスタンスレベルで全接続を取得 | 常時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 接続情報取得 | sys.dm_exec_connections | SELECT | DMVから接続情報を取得 |

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

#### sys.dm_exec_connections

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | session_id, most_recent_session_id, connect_time, net_transport, etc. | 全カラムを取得 | 読み取り専用DMV |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionでエラー記録、次インスタンスに継続 |
| - | クエリエラー | DMVアクセス権限なし等 | Stop-Functionでエラー記録、次インスタンスに継続 |
| - | バージョンエラー | SQL Server 2005未満 | Connect-DbaInstanceで拒否 |

### リトライ仕様

リトライ機構は実装されていない。

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

読み取り専用操作のため、トランザクション制御は不要。

## パフォーマンス要件

DMVへのクエリは軽量な操作。複数インスタンスに対しては順次処理される。

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

- VIEW SERVER STATE権限が必要
- SqlCredentialによる代替認証情報の使用をサポート
- Windows認証、SQL認証、Active Directory認証をサポート

## 備考

- SQL Server 2005（バージョン9）以降が必須
- Azure SQL Databaseでは現在のデータベース接続情報のみ取得

---

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

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

### 推奨読解順序

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

出力されるオブジェクトはT-SQLクエリ結果のDataRowである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaConnection.ps1 | `public/Get-DbaConnection.ps1` | 84-94行目のSELECTステートメント |

**読解のコツ**: カラム名のエイリアス（AS）が出力プロパティ名になる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaConnection.ps1 | `public/Get-DbaConnection.ps1` | 関数全体の構造（begin/process） |

**主要処理フロー**:
1. **74-81行目**: パラメータ定義
2. **83-95行目**: begin block（T-SQLクエリ定義）
3. **97-112行目**: process block（クエリ実行）
4. **100行目**: Connect-DbaInstance -MinimumVersion 9

#### Step 3: クエリ実行を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaConnection.ps1 | `public/Get-DbaConnection.ps1` | 105-111行目のクエリ実行部分 |

**主要処理フロー**:
- **106行目**: Write-Messageでデバッグログ
- **107行目**: $server.Query($sql)でクエリ実行

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

```
Get-DbaConnection
    │
    ├─ begin
    │      └─ T-SQLクエリ定義
    │
    └─ process
           ├─ Connect-DbaInstance (MinimumVersion 9)
           │
           └─ $server.Query($sql)
                  └─ dm_exec_connections からSELECT
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance  ───▶ SMO Server オブジェクト
                           │
                           ▼
                    $server.Query()
                           │
                           ▼
                    dm_exec_connections
                           │
                           ▼
                    DataRow[]           ───▶ 接続情報
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaConnection.ps1 | `public/Get-DbaConnection.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
