# 機能設計書 306-New-DbaXESession

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `New-DbaXESession` コマンドレットの機能設計を記述する。このコマンドレットは、SQL Serverインスタンス上にプログラマティックに構成可能な新しい拡張イベント(Extended Events)セッションオブジェクトを作成する機能を提供する。

### 本機能の処理概要

`New-DbaXESession` は、SQL Serverインスタンス上に新しい拡張イベントセッションオブジェクトを作成するコマンドレットである。このコマンドレットはセッションの「雛形」を作成し、その後 `AddEvent()`、`AddAction()`、`AddTarget()` メソッドを使用してプログラマティックに構成できる。最終的に `Create()` メソッドを呼び出してサーバーにデプロイする。

**業務上の目的・背景**：多くの場合、事前定義されたテンプレート（Import-DbaXESessionTemplate）を使用するほうが簡便だが、完全にカスタマイズされた監視ソリューションをゼロから構築する場合は、本機能によるプログラマティックなアプローチが必要となる。スクリプト化された自動デプロイメントや、動的に構成を変更する必要がある場合に特に有用である。

**機能の利用シーン**：
- カスタム拡張イベントセッションをゼロから構築したい場合
- スクリプトで動的にイベント/アクション/ターゲットを追加したい場合
- テンプレートにない独自の監視構成を作成したい場合
- CI/CDパイプラインでXEセッションを自動デプロイしたい場合

**主要な処理内容**：
1. SQL Serverインスタンスへの接続（最小バージョン11）
2. XEStoreオブジェクトの初期化
3. CreateSessionメソッドでセッションオブジェクト作成
4. セッションオブジェクトを返却（後続でAddEvent等を呼び出す）

**関連システム・外部連携**：XEStoreのCreateSessionメソッドを使用。返却されたセッションオブジェクトに対して、イベント追加（AddEvent）、アクション追加（AddAction）、ターゲット追加（AddTarget）、サーバーへのデプロイ（Create）を実行。

**権限による制御**：sysadmin権限が必要。SQL Server 2012以降をサポート。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 84 | XEセッション管理 | 主機能 | 拡張イベントセッションの作成 |

## 機能種別

データ作成処理（CREATE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 接続先SQLインスタンス | SQL Server 2012以降 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | - |
| Name | string | Yes | セッション名 | SQL Server識別子命名規則 |
| WhatIf | switch | No | 実行せずに動作を表示 | - |
| Confirm | switch | No | 実行前に確認 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

ユーザー指定のパラメータのみ

## 出力仕様

### 出力データ

本コマンドレットはパイプラインに出力を返さない。XEStoreのCreateSessionメソッドでサーバー上にセッションが作成される。作成されたセッションを取得するには `Get-DbaXESession` を使用する。

| 項目名 | 型 | 説明 |
|--------|-----|------|
| （なし） | - | パイプライン出力なし |

### 出力先

SQL Serverインスタンス上にXEセッションオブジェクトが作成される

## 処理フロー

### 処理シーケンス

```
1. 各インスタンスを処理
2. SQL Serverインスタンスへの接続
   └─ Connect-DbaInstance（MinimumVersion 11）
3. ShouldProcess確認
4. SqlStoreConnectionの作成
5. XEStoreオブジェクトの初期化
6. CreateSessionメソッド呼び出し
   └─ 指定された名前でセッション作成
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各SqlInstanceを処理]
    B --> C{接続試行}
    C -->|失敗| D[Stop-Function]
    C -->|成功| E{ShouldProcess?}
    D --> B
    E -->|No| B
    E -->|Yes| F[SqlConnectionObject取得]
    F --> G[SqlStoreConnection作成]
    G --> H[XEStore初期化]
    H --> I[CreateSession呼び出し]
    I --> B
    B --> J{次のインスタンス?}
    J -->|Yes| B
    J -->|No| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-306-01 | 最小バージョン制限 | SQL Server 2012（バージョン11）以降が必要 | 常時 |
| BR-306-02 | SupportsShouldProcess | WhatIf/Confirmによる確認処理 | 常時 |
| BR-306-03 | セッション名必須 | Nameパラメータは必須 | 常時 |

### 計算ロジック

なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 作成 | XEセッション | CREATE | 拡張イベントセッション作成（XEStore経由） |

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

#### 拡張イベントセッション

| 操作 | 項目 | 更新値・取得条件 | 備考 |
|-----|-----|-----------------|------|
| CREATE | セッション | 指定されたName | XEStore.CreateSession経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL接続失敗 | Stop-Functionで継続 |

### リトライ仕様

なし

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

なし（XEStore API経由）

## パフォーマンス要件

- インスタンス数に比例した処理時間

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

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

## 備考

- 本コマンドレットはセッションの「雛形」を作成するのみ
- イベント/アクション/ターゲットの追加は返却されたオブジェクトのメソッドで行う
- 最終的に session.Create() でサーバーにデプロイする必要がある
- 多くの場合、Import-DbaXESessionTemplate のほうが簡便

---

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

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

### 推奨読解順序

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

出力がない点と、使用方法（AddEvent, Create等）を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | New-DbaXESession.ps1 | `public/New-DbaXESession.ps1` | OUTPUTSセクション（34-38行目） |
| 1-2 | New-DbaXESession.ps1 | `public/New-DbaXESession.ps1` | EXAMPLEセクション（50-56行目） |

**読解のコツ**: EXAMPLEを見ると、返却されたセッションオブジェクトに対してAddEvent()、AddAction()、Create()を呼び出す使用方法がわかる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaXESession.ps1 | `public/New-DbaXESession.ps1` | process ブロック（68-84行目） |

**主要処理フロー**:
1. **69行目**: foreach でインスタンスをループ
2. **70-74行目**: Connect-DbaInstance で接続（MinimumVersion 11）
3. **76行目**: ShouldProcess による確認
4. **77-79行目**: SqlStoreConnection と XEStore の作成
5. **81行目**: CreateSession の呼び出し

#### Step 3: セッション作成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaXESession.ps1 | `public/New-DbaXESession.ps1` | XEStore.CreateSession（81行目） |

**主要処理フロー**:
- **77行目**: SqlConnectionObjectを取得
- **78行目**: SqlStoreConnectionを生成
- **79行目**: XEStoreを生成
- **81行目**: CreateSession(Name)を呼び出し

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

```
New-DbaXESession
    │
    ├─ Connect-DbaInstance
    │      └─ -MinimumVersion 11
    │
    ├─ $Pscmdlet.ShouldProcess
    │
    ├─ New-Object SqlStoreConnection
    │
    ├─ New-Object XEStore
    │
    └─ $store.CreateSession($Name)
```

### データフロー図

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

SqlInstance ─────────────▶ Connect-DbaInstance ────▶ Server Object
                                  │
                                  ▼
                          SqlConnectionObject
                                  │
                                  ▼
                          New SqlStoreConnection
                                  │
                                  ▼
                          New XEStore
                                  │
Name ────────────────────▶ CreateSession($Name) ───▶ （パイプライン出力なし）
                                                      サーバー上にセッション作成
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaXESession.ps1 | `public/New-DbaXESession.ps1` | ソース | メインコマンドレット |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続（依存先） |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | 作成後のセッション取得 |
