# 機能設計書 308-Remove-DbaXESession

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Remove-DbaXESession` コマンドレットの機能設計を記述する。このコマンドレットは、SQL Serverインスタンスから拡張イベント(Extended Events)セッションを削除する機能を提供する。

### 本機能の処理概要

`Remove-DbaXESession` は、SQL Serverインスタンスから拡張イベントセッションを削除するコマンドレットである。特定のセッションを名前で指定して削除するか、AllSessionsスイッチで全ユーザーセッションを一括削除できる。システムセッション（system_health、telemetry_xevents、AlwaysOn_health）は保護され、AllSessions使用時も削除されない。

**業務上の目的・背景**：監視要件の変更、テスト環境のクリーンアップ、不要になったトラブルシューティングセッションの削除等、XEセッションの管理には削除機能が不可欠である。本機能により、SQL Server組み込みの診断機能を保護しながら、ユーザー作成セッションを安全に削除できる。

**機能の利用シーン**：
- 不要になったXEセッションを削除したい場合
- テスト環境の全XEセッションをクリーンアップしたい場合
- 古い監視構成を削除して新しい構成をデプロイしたい場合
- Get-DbaXESessionでフィルタリングしたセッションを削除したい場合

**主要な処理内容**：
1. 対象セッションの取得（Get-DbaXESession）
2. セッションフィルタリング（Session指定またはAllSessions）
3. AllSessions時はシステムセッションを除外
4. ShouldProcess確認後、Dropメソッドでセッション削除
5. 削除結果をPSCustomObjectで出力

**関連システム・外部連携**：Get-DbaXESession でセッション一覧を取得し、SMOのDropメソッドでセッションを削除。

**権限による制御**：sysadmin権限が必要。システムセッションは自動的に保護される。

## 関連画面

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

## 機能種別

データ削除処理（DROP）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes（ParameterSet: Session/All） | 接続先SQLインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証資格情報 | - |
| Session | object[] | Yes（ParameterSet: Session） | 削除対象セッション名 | - |
| AllSessions | switch | Yes（ParameterSet: All） | 全ユーザーセッション削除 | - |
| InputObject | Microsoft.SqlServer.Management.XEvent.Session[] | Yes（ParameterSet: Object） | パイプライン入力セッション | - |
| WhatIf | switch | No | 実行せずに動作を表示 | - |
| Confirm | switch | No | 実行前に確認（ConfirmImpact: High） | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- ユーザー指定のセッション名
- Get-DbaXESessionからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQLインスタンスのコンピューター名 |
| InstanceName | String | SQLインスタンス名 |
| SqlInstance | String | 完全修飾インスタンス名 |
| Session | String | 削除されたセッション名 |
| Status | String | "Removed" |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータセット判定
   └─ InputObject: パイプライン入力
   └─ Session: 名前指定
   └─ AllSessions: 全ユーザーセッション
2. セッション取得（Get-DbaXESession）
3. フィルタリング
   └─ Session指定: 名前でフィルタ
   └─ AllSessions: システムセッション除外
4. Remove-XESessions内部関数呼び出し
   └─ 各セッションに対してShouldProcess確認
   └─ $xe.Drop()でセッション削除
5. 結果出力（PSCustomObject）
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{InputObject指定?}
    B -->|Yes| C[Get-DbaXESession]
    B -->|No| D[各インスタンスを処理]
    C --> E[Remove-XESessions]
    D --> F[Get-DbaXESession]
    F --> G{Session指定?}
    G -->|Yes| H[名前でフィルタ]
    G -->|No| I{AllSessions?}
    I -->|Yes| J[システムセッション除外]
    H --> E
    J --> E
    E --> K[各セッションを処理]
    K --> L{ShouldProcess?}
    L -->|Yes| M[xe.Drop]
    L -->|No| K
    M --> N{成功?}
    N -->|Yes| O[PSCustomObject出力]
    N -->|No| P[Stop-Function]
    O --> K
    P --> K
    K --> Q{次のセッション?}
    Q -->|Yes| K
    Q -->|No| R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-308-01 | システムセッション保護 | system_health、telemetry_xevents、AlwaysOn_healthは削除しない | AllSessions使用時 |
| BR-308-02 | 高確認レベル | ConfirmImpact: Highで確認を要求 | 常時 |
| BR-308-03 | パイプライン入力時の再取得 | InputObject.Parentから再度Get-DbaXESessionを呼び出し | InputObject使用時 |

### 計算ロジック

- システムセッションリスト: `@('AlwaysOn_health', 'system_health', 'telemetry_xevents')`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 削除 | XEセッション | DROP | 拡張イベントセッション削除 |

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

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

| 操作 | 項目 | 更新値・取得条件 | 備考 |
|-----|-----|-----------------|------|
| DROP | セッション | 指定されたセッション | SMO Drop()経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | DropError | セッション削除失敗 | Stop-Functionで継続 |

### リトライ仕様

なし

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

なし（各セッションを個別に削除）

## パフォーマンス要件

- セッション数に比例した処理時間

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

- sysadmin権限が必要
- システムセッションは自動的に保護される
- ConfirmImpact: Highで確認を要求

## 備考

- Get-DbaXESession と組み合わせて柔軟なフィルタリングが可能
- システムセッションは保護されるため安全に全削除が可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaXESession.ps1 | `public/Remove-DbaXESession.ps1` | OUTPUTSセクション（45-57行目） |

**読解のコツ**: 出力はシンプルなPSCustomObject。Status: "Removed" で削除成功を示す。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaXESession.ps1 | `public/Remove-DbaXESession.ps1` | begin ブロック（111-136行目） |
| 2-2 | Remove-DbaXESession.ps1 | `public/Remove-DbaXESession.ps1` | process ブロック（139-160行目） |

**主要処理フロー**:
1. **113-136行目**: Remove-XESessions内部関数の定義
2. **140-145行目**: InputObject処理
3. **147-159行目**: SqlInstance処理とフィルタリング

#### Step 3: 内部関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaXESession.ps1 | `public/Remove-DbaXESession.ps1` | Remove-XESessions関数（113-136行目） |

**主要処理フロー**:
- **117-134行目**: 各セッションを処理
- **121行目**: ShouldProcess確認
- **123行目**: Drop()呼び出し
- **124-129行目**: PSCustomObject出力

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

```
Remove-DbaXESession
    │
    ├─ Get-DbaXESession（InputObject処理時）
    │
    ├─ Get-DbaXESession（SqlInstance処理時）
    │
    ├─ Where-Object（Session/AllSessionsフィルタ）
    │
    └─ Remove-XESessions（内部関数）
           │
           ├─ $Pscmdlet.ShouldProcess
           │
           └─ $xe.Drop()
```

### データフロー図

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

InputObject ─────────────▶ Get-DbaXESession ───────▶ Session[]
                                  │
SqlInstance ─────────────▶ Get-DbaXESession
      │                          │
      ▼                          ▼
Session Filter ──────────▶ Where-Object Name -in
      │                          │
AllSessions Filter ──────▶ Where-Object Name -notin システムセッション
                                  │
                                  ▼
                          Remove-XESessions
                                  │
                                  ▼
                          ShouldProcess確認
                                  │
                                  ▼
                          $xe.Drop() ─────────────▶ PSCustomObject
                                                    (Status: "Removed")
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaXESession.ps1 | `public/Remove-DbaXESession.ps1` | ソース | メインコマンドレット |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | セッション取得（依存先） |
