# 帳票設計書 14-Export-DbaXESession

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Export-DbaXESession` コマンドに関する帳票設計書です。このコマンドは、拡張イベントセッションのT-SQL作成スクリプトを生成する機能を提供します。

### 本帳票の処理概要

Export-DbaXESessionは、SQL Server拡張イベント（Extended Events / XE）セッションの定義をT-SQL CREATE EVENT SESSION文としてエクスポートするコマンドです。イベント、アクション、ターゲット、構成設定を含む完全なセッション定義を出力します。

**業務上の目的・背景**：拡張イベントはSQL Server 2008以降の主要な診断・監視機能です。本番環境で構築した監視セッションを開発・テスト環境に移行したり、災害復旧時にセッション定義を再構築したりする必要があります。また、コンプライアンス対応として監視設定をドキュメント化する要件も存在します。本コマンドにより、手動でのセッション再作成を不要とし、一貫した監視環境を維持できます。

**帳票の利用シーン**：
- 拡張イベントセッションの環境間移行（開発→本番）
- 災害復旧用のセッション定義バックアップ
- 監視設定のバージョン管理・ドキュメント化
- デプロイメントスクリプトの作成
- 複数サーバーへの一括セッション展開準備

**主要な出力内容**：
1. CREATE EVENT SESSION文
2. イベント定義（ADD EVENT句）
3. アクション定義（ACTION句）
4. ターゲット定義（ADD TARGET句）
5. セッションオプション（WITH句）

**帳票の出力タイミング**：PowerShellコンソールまたはスクリプトからコマンド実行時に即座に出力されます。

**帳票の利用者**：データベース管理者（DBA）、パフォーマンスエンジニア、セキュリティ管理者

## 帳票種別

スクリプトファイル（T-SQL形式）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| N/A | PowerShellコンソール | コマンドライン | Export-DbaXESession コマンド実行 |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | SQL（T-SQLスクリプト） |
| 用紙サイズ | N/A（テキストファイル） |
| 向き | N/A |
| ファイル名 | {ServerName}-{timestamp}-xe.sql（自動生成時） |
| 出力方法 | ファイル保存 / コンソール出力（Passthru） |
| 文字コード | UTF-8（デフォルト、変更可能） |

### SQL固有設定

| 項目 | 内容 |
|-----|------|
| バッチ区切り | GO（BatchSeparatorで変更可能） |
| コメント | 作成者・日時情報（NoPrefixで除外可能） |
| IF NOT EXISTS | なし |

## 帳票レイアウト

### レイアウト概要

T-SQLスクリプトとして出力されます。

```
┌─────────────────────────────────────┐
│      ヘッダーコメント（オプション）    │
│   /* Created by ... */              │
├─────────────────────────────────────┤
│      CREATE EVENT SESSION文          │
│   ┌───────────────────────────────┐ │
│   │   ADD EVENT句                 │ │
│   │   ACTION句                    │ │
│   │   ADD TARGET句                │ │
│   │   WITH句（オプション）         │ │
│   └───────────────────────────────┘ │
├─────────────────────────────────────┤
│      GO（バッチ区切り）              │
└─────────────────────────────────────┘
```

### ヘッダー部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | 作成者情報 | スクリプト作成者 | 環境変数 | /* Created by {user} ... */ |
| 2 | 作成日時 | スクリプト生成日時 | Get-Date | 日時形式 |
| 3 | ツール情報 | dbatools参照URL | 固定 | https://dbatools.io/... |

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | セッション名 | XEセッション名 | Session.Name | T-SQL | 可変 |
| 2 | イベント定義 | 収集イベント | ScriptCreate() | T-SQL | 可変 |
| 3 | アクション定義 | イベントアクション | ScriptCreate() | T-SQL | 可変 |
| 4 | ターゲット定義 | 出力ターゲット | ScriptCreate() | T-SQL | 可変 |
| 5 | セッションオプション | WITH句設定 | ScriptCreate() | T-SQL | 可変 |

### フッター部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | GO | バッチ区切り | BatchSeparator設定 | GO |

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| SqlInstance | 対象SQL Serverインスタンス | Yes（InputObjectがない場合） |
| Session | 対象セッション名（ワイルドカード対応） | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | セッション名 | 取得順 |

### 改ページ条件

N/A（テキストファイル出力のため）

## データベース参照仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| sys.server_event_sessions | セッション一覧 | XEStore経由 |
| sys.server_event_session_events | イベント定義 | XEStore経由 |
| sys.server_event_session_actions | アクション定義 | XEStore経由 |
| sys.server_event_session_targets | ターゲット定義 | XEStore経由 |

### テーブル別参照項目詳細

#### XEStore Session

| 参照項目（カラム名） | 帳票項目との対応 | 取得条件 | 備考 |
|-------------------|----------------|---------|------|
| Name | セッション名 | Session パラメータ | スクリプト対象 |
| ScriptCreate() | T-SQL全体 | - | SMOメソッド |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| N/A | 計算処理なし | - | - |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Export-DbaXESession実行] --> B{SqlInstance/InputObject?}
    B -->|SqlInstance| C[Get-DbaXESession]
    B -->|InputObject| D[InputObject使用]
    C --> E[Session取得]
    D --> E
    E --> F[ループ: 各セッション]
    F --> G[ScriptCreate実行]
    G --> H[SessionCollection追加]
    H --> I{次セッション?}
    I -->|Yes| F
    I -->|No| J[end処理]
    J --> K{NoPrefix?}
    K -->|No| L[ヘッダー追加]
    K -->|Yes| M[ヘッダーなし]
    L --> N[BatchSeparator適用]
    M --> N
    N --> O{Passthru?}
    O -->|Yes| P[コンソール出力]
    O -->|No| Q[ファイル保存]
    P --> R[終了]
    Q --> R
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| 入力エラー | SqlInstance/InputObject両方なし | "You must pipe in a Credential or specify a SqlInstance" | パラメータ指定 |
| ファイル存在エラー | ファイル存在時にNoClobber指定 | "File already exists. If you want to overwrite..." | NoClobber除去 or Append使用 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 1〜50セッション |
| 目標出力時間 | 10秒以内 |
| 同時出力数上限 | 制限なし |

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

- SQL Server 2008以上が必要
- VIEW SERVER STATE権限が必要
- セッション定義には機密性の高いフィルター条件が含まれる可能性

## 備考

- BatchSeparatorで区切り文字をカスタマイズ可能
- NoPrefixでヘッダーコメント除外
- Appendで既存ファイルに追記
- NoClobberで上書き防止
- 複数サーバーからの出力をAppendで結合可能

---

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

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

### 推奨読解順序

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

XEセッションオブジェクトとScriptCreate()の仕組みを理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | パラメータ定義（行119-137）でSession, BatchSeparator等を確認 |

**読解のコツ**: Microsoft.SqlServer.Management.XEvent名前空間のSessionオブジェクトを理解する

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | beginブロック（行138-148）で初期化 |
| 2-2 | Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | processブロック（行149-173）でセッション収集 |

**主要処理フロー**:
1. **行142-146**: 実行ユーザー取得（Windows/Linux対応）
2. **行157-159**: SqlInstanceからGet-DbaXESession呼び出し
3. **行161-172**: SessionCollection構築
4. **行165**: ScriptCreate().GetScript()でT-SQL取得

#### Step 3: スクリプト生成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | endブロック（行175-218） |

**主要処理フロー**:
- **行180-184**: prefix生成（NoPrefix未指定時）
- **行186-192**: BatchSeparator適用
- **行194-216**: 出力処理（Passthru/File）

#### Step 4: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | ファイル出力（行199-216） |

**主要処理フロー**:
- **行200**: instanceArray でインスタンス重複チェック
- **行204**: Get-ExportFilePathでパス決定
- **行205-206**: NoClobberチェック
- **行208**: Out-Fileでファイル出力

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

```
Export-DbaXESession
    │
    ├─ Test-ExportDirectory (begin)
    │      └─ パス存在確認
    │
    ├─ Get-DbaXESession
    │      └─ XEセッション取得
    │
    ├─ Session.ScriptCreate()
    │      └─ T-SQL生成
    │
    ├─ Get-ExportFilePath
    │      └─ 出力ファイルパス決定
    │
    └─ Out-File
           └─ ファイル出力
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaXESession ───────────▶ Session Objects
                            │
Session ───────────▶ Filter Sessions ────────────▶ Target Sessions
                            │
                            ▼
                     ScriptCreate() ─────────────▶ T-SQL Script
                            │
                            ▼
NoPrefix ──────────▶ Add/Skip Header ────────────▶ Script with Header
                            │
BatchSeparator ────▶ Add Separators ─────────────▶ Complete Script
                            │
                            ▼
Path/FilePath ─────▶ Out-File ───────────────────▶ .sql File
    or
Passthru ──────────▶ Console Output ─────────────▶ String Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaXESession.ps1 | `public/Export-DbaXESession.ps1` | ソース | メイン処理 |
| Export-DbaXESession.Tests.ps1 | `tests/Export-DbaXESession.Tests.ps1` | テスト | 単体テスト |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | セッション取得 |
| Get-ExportFilePath.ps1 | `private/Get-ExportFilePath.ps1` | ソース | 出力パス決定 |
| Test-ExportDirectory.ps1 | `private/Test-ExportDirectory.ps1` | ソース | ディレクトリ検証 |
