# 機能設計書 304-Get-DbaXEStore

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaXEStore` コマンドレットの機能設計を記述する。このコマンドレットは、SQL Serverインスタンスから拡張イベント(Extended Events)ストアオブジェクトを取得し、XEセッションおよび構成の管理基盤を提供する。

### 本機能の処理概要

`Get-DbaXEStore` は、SQL Serverインスタンスから `Microsoft.SqlServer.Management.XEvent.XEStore` オブジェクトを取得するコマンドレットである。XEStoreはセッション管理、イベントパッケージ情報、実行中セッション数等へのアクセスを提供する拡張イベントの基盤オブジェクトである。

**業務上の目的・背景**：拡張イベントの監視ソリューションを構築したり、XE構成を環境全体で監査したりする際、XEStoreオブジェクトは最初のステップとなる。このオブジェクトを通じて、セッション、パッケージ、利用可能なイベント等すべてのXE機能にアクセスできる。本機能により、複数インスタンスに対するXE構成の一括管理が可能となる。

**機能の利用シーン**：
- 拡張イベント監視ソリューションの構築時に基盤オブジェクトを取得
- 環境全体のXEセッション構成を監査
- 実行中のセッション数を確認
- 利用可能なイベントパッケージを調査
- プログラマティックなXEセッション操作の基盤

**主要な処理内容**：
1. SQL Serverインスタンスへの接続（最小バージョン11 = SQL Server 2012）
2. SqlStoreConnectionオブジェクトの作成
3. XEStoreオブジェクトの初期化
4. メタデータ（ComputerName、InstanceName等）の付与
5. デフォルトビューでの出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) および Microsoft.SqlServer.Management.XEvent 名前空間を使用。

**権限による制御**：sysadmin権限が必要。SQL Server 2012（バージョン11）以降をサポート。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 88 | XEオブジェクト・ストア | 補助機能 | XEストアの取得 |

## 機能種別

データ取得処理（オブジェクト生成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 接続先SQLインスタンス | SQL Server 2012以降（MinimumVersion 11） |
| SqlCredential | PSCredential | No | 代替認証資格情報 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

SQL Serverインスタンスの接続情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQLインスタンスのコンピューター名 |
| InstanceName | String | SQLインスタンス名 |
| SqlInstance | String | 完全修飾インスタンス名 |
| ServerName | String | XEStoreのサーバー名 |
| Sessions | Collection | XEセッションコレクション |
| Packages | Collection | XEventパッケージコレクション |
| RunningSessionCount | Int | 実行中のセッション数 |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Management.XEvent.XEStore）

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ SqlInstance の確認
2. SQL Serverインスタンスへの接続
   └─ Connect-DbaInstance 呼び出し
   └─ MinimumVersion 11 の指定
3. SqlStoreConnectionの作成
   └─ SqlConnectionObjectからSqlStoreConnectionを生成
4. XEStoreオブジェクトの初期化
   └─ New-Object Microsoft.SqlServer.Management.XEvent.XEStore
5. メタデータの付与
   └─ ComputerName, InstanceName, SqlInstanceをNotePropertyとして追加
6. デフォルトビューでの出力
   └─ Select-DefaultView で表示プロパティを制限
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各SqlInstanceを処理]
    B --> C{接続試行}
    C -->|失敗| D[Stop-Function]
    C -->|成功| E[SqlConnectionObject取得]
    D --> B
    E --> F[SqlStoreConnection作成]
    F --> G[XEStore初期化]
    G --> H[Add-Member でメタデータ付与]
    H --> I[Select-DefaultView]
    I --> B
    B --> J{次のインスタンス?}
    J -->|Yes| B
    J -->|No| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-304-01 | 最小バージョン制限 | SQL Server 2012（バージョン11）以降が必要 | 常時 |
| BR-304-02 | 接続エラー時継続 | 接続エラー時は警告を出力し次のインスタンスを処理 | 複数インスタンス指定時 |

### 計算ロジック

なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 取得 | XEventストア | SELECT | XEStore情報取得（SMO経由） |

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

データベースへの直接クエリなし（SMO/XEvent API経由）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQLインスタンス接続失敗 | Stop-Functionで警告後継続 |
| - | VersionError | SQL Server 2012未満 | Connect-DbaInstanceでエラー |

### リトライ仕様

なし

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

なし（読み取り専用処理）

## パフォーマンス要件

- インスタンスごとに接続を確立するため、インスタンス数に比例した処理時間

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

- sysadmin権限が必要
- SqlCredentialによる代替認証をサポート

## 備考

- Get-DbaXESession、Get-DbaXEObject等の基盤となるコマンドレット
- SQL Server 2012以降が必要（MinimumVersion 11）

---

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

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

### 推奨読解順序

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

XEStoreオブジェクトの構造と、SMOとの関係を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaXEStore.ps1 | `public/Get-DbaXEStore.ps1` | 出力型（Microsoft.SqlServer.Management.XEvent.XEStore）の説明（32-46行目） |

**読解のコツ**: XEStoreオブジェクトはSessions、Packages、RunningSessionCount等のプロパティを持つ。これらを通じてXEの全機能にアクセスできる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaXEStore.ps1 | `public/Get-DbaXEStore.ps1` | process ブロック（65-81行目） |

**主要処理フロー**:
1. **66行目**: foreach でインスタンスをループ
2. **67-71行目**: Connect-DbaInstance で接続（MinimumVersion 11）
3. **73-75行目**: SqlStoreConnection と XEStore の作成
4. **77-79行目**: NoteProperty の追加
5. **80行目**: Select-DefaultView で出力

#### Step 3: オブジェクト生成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaXEStore.ps1 | `public/Get-DbaXEStore.ps1` | SqlStoreConnection/XEStore生成（73-75行目） |

**主要処理フロー**:
- **73行目**: SqlConnectionObjectを取得
- **74行目**: SqlStoreConnectionをNew-Objectで生成
- **75行目**: XEStoreをNew-Objectで生成

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

```
Get-DbaXEStore
    │
    ├─ Connect-DbaInstance
    │      └─ -MinimumVersion 11
    │
    ├─ New-Object SqlStoreConnection
    │
    ├─ New-Object XEStore
    │
    ├─ Add-Member
    │
    └─ Select-DefaultView
```

### データフロー図

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

SqlInstance ─────────────▶ Connect-DbaInstance ────▶ Server Object
                                  │
                                  ▼
                          SqlConnectionObject
                                  │
                                  ▼
                          New SqlStoreConnection
                                  │
                                  ▼
                          New XEStore ─────────────▶ XEStore Object
                                  │
                                  ▼
                          Add-Member ──────────────▶ Enriched XEStore
                                  │
                                  ▼
                          Select-DefaultView ──────▶ Pipeline Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaXEStore.ps1 | `public/Get-DbaXEStore.ps1` | ソース | メインコマンドレット |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続（依存先） |
