# 機能設計書 527-Start-DbaTrace

## 概要

本ドキュメントは、停止状態の SQL Server トレースを開始する `Start-DbaTrace` コマンドの機能設計書です。

### 本機能の処理概要

定義済みで現在停止状態にある SQL Server トレースを開始する PowerShell コマンドです。sp_trace_setstatus でステータスを 1 に設定してトレースを有効化します。

**業務上の目的・背景**：SQL Server トレースは、パフォーマンス監視、監査、トラブルシューティングのために作成されますが、必要に応じて停止・開始を制御する必要があります。本コマンドは、事前に定義されたトレースを PowerShell から開始することで、自動化スクリプトやメンテナンス作業の一環としてトレースを制御できます。

**機能の利用シーン**：
- 定期的なパフォーマンスモニタリングの開始
- トラブルシューティング開始時のトレース有効化
- スケジュールされた監査トレースの開始
- メンテナンス後のトレース再開
- 複数サーバーでの一括トレース開始

**主要な処理内容**：
1. トレースオブジェクトの取得（パラメータまたはパイプライン）
2. デフォルトトレースの保護チェック
3. sp_trace_setstatus でトレース開始（ステータス 1）
4. Get-DbaTrace で結果を取得して出力

**関連システム・外部連携**：SQL Server Database Engine、sp_trace_setstatus システムストアドプロシージャ

**権限による制御**：ALTER TRACE 権限または sysadmin 固定サーバーロールのメンバーシップが必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SQL Server Profiler | 参照画面 | トレースの開始と同等の操作 |

## 機能種別

システム操作 / トレース管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象の SQL Server インスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効な資格情報オブジェクト |
| Id | int[] | No | 開始するトレース ID | 正の整数 |
| InputObject | object[] | No | パイプラインからのトレースオブジェクト | Get-DbaTrace からの出力 |
| EnableException | switch | No | 例外をスローする | - |

### 入力データソース

- Get-DbaTrace からのトレースオブジェクト
- または SqlInstance と Id パラメータの組み合わせ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Server をホストするコンピュータ名 |
| InstanceName | string | SQL Server インスタンス名 |
| SqlInstance | string | 完全な SQL Server インスタンス名 |
| Id | int | トレース ID |
| Status | int | トレースステータス |
| IsRunning | bool | トレースが実行中かどうか |
| Path | string | トレースファイルのパス |
| (その他) | - | Get-DbaTrace の全出力プロパティ |

### 出力先

- PowerShell パイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 入力オブジェクトの取得
   └─ -InputObject がない場合、Get-DbaTrace で取得
2. 各トレースの処理ループ
   └─ 入力検証（id と Parent プロパティ確認）
   └─ サーバーオブジェクトとトレース ID 取得
3. デフォルトトレースチェック
   └─ デフォルトトレースの場合はエラーで継続
   └─ Set-DbaSpConfigure の使用を案内
4. トレース開始
   └─ ShouldProcess 確認
   └─ sp_trace_setstatus traceid, 1 実行
5. 結果出力
   └─ Get-DbaTrace で最新状態を取得して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{InputObject あり?}
    B -->|No| C[Get-DbaTrace で取得]
    B -->|Yes| D[InputObject 使用]
    C --> E[各トレースをループ]
    D --> E
    E --> F{id と Parent あり?}
    F -->|No| G[エラー・スキップ]
    F -->|Yes| H{デフォルトトレース?}
    H -->|Yes| I[警告・スキップ]
    H -->|No| J{ShouldProcess?}
    J -->|No| K[スキップ]
    J -->|Yes| L[sp_trace_setstatus 1 実行]
    L --> M[Get-DbaTrace で結果取得]
    M --> N[結果出力]
    G --> O{次のトレース?}
    I --> O
    K --> O
    N --> O
    O -->|Yes| E
    O -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトトレース保護 | デフォルトトレースはこの関数では開始できない | 常時 |
| BR-002 | 入力検証 | id と Parent プロパティが必要 | 常時 |
| BR-003 | 結果取得 | 開始後に Get-DbaTrace で最新状態を取得 | 常時 |

### 計算ロジック

sp_trace_setstatus のステータス値：
- 0: 停止
- 1: 開始
- 2: クローズ・削除

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| トレース開始 | sys.traces | UPDATE (間接) | sp_trace_setstatus でステータス変更 |
| トレース確認 | sys.traces | SELECT | Get-DbaTrace で状態取得 |

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

#### sp_trace_setstatus

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| EXEC | traceid, status | traceid, 1 | システムストアドプロシージャ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 入力エラー | 不正な入力オブジェクト | Get-DbaTrace を使用 |
| - | 保護エラー | デフォルトトレースを開始しようとした | Set-DbaSpConfigure を使用 |
| - | 実行エラー | sp_trace_setstatus が失敗 | ALTER TRACE 権限を確認 |

### リトライ仕様

リトライなし

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

sp_trace_setstatus は内部的にトランザクション管理を行う

## パフォーマンス要件

- トレースの開始は即座に完了
- トレース数に比例した処理時間

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

- ALTER TRACE 権限または sysadmin が必要
- デフォルトトレースは保護されている

## 備考

- デフォルトトレースを有効にするには Set-DbaSpConfigure を使用
- SupportsShouldProcess で -WhatIf/-Confirm をサポート
- パイプラインで Get-DbaTrace と連携可能

---

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

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

### 推奨読解順序

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

出力は Get-DbaTrace と同じ形式です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Start-DbaTrace.ps1 | `public/Start-DbaTrace.ps1` | 結果出力（133行目） |

**読解のコツ**: Get-DbaTrace を呼び出して最新状態を返します。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Start-DbaTrace.ps1 | `public/Start-DbaTrace.ps1` | 関数定義とパラメータ |

**主要処理フロー**:
1. **101-109行目**: パラメータ定義
2. **110-140行目**: process ブロックでトレース開始処理

#### Step 3: 開始ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Start-DbaTrace.ps1 | `public/Start-DbaTrace.ps1` | 開始処理 |

**主要処理フロー**:
- **123-127行目**: デフォルトトレースチェック
- **129行目**: sp_trace_setstatus クエリ
- **130-133行目**: 実行と結果取得

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

```
Start-DbaTrace
    │
    ├─ Get-DbaTrace
    │      └─ InputObject がない場合のトレース取得
    │
    ├─ Get-DbaTrace (Default)
    │      └─ デフォルトトレース取得
    │
    ├─ $server.Query("sp_trace_setstatus $traceid, 1")
    │      └─ トレース開始
    │
    └─ Get-DbaTrace (結果)
           └─ 開始後の状態取得
```

### データフロー図

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

SqlInstance/Id ──▶ Get-DbaTrace ─────────▶ Trace Objects
    or
InputObject ────▶ Default Check ─────────▶ Protection
                         │
                  ShouldProcess ─────────▶ Confirmation
                         │
                  sp_trace_setstatus 1 ──▶ Start
                         │
                  Get-DbaTrace ──────────▶ Updated State
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Start-DbaTrace.ps1 | `public/Start-DbaTrace.ps1` | ソース | メイン関数定義 |
| Get-DbaTrace.ps1 | `public/Get-DbaTrace.ps1` | ソース | トレース情報取得 |
