# 機能設計書 526-Remove-DbaTrace

## 概要

本ドキュメントは、SQL Server トレースを停止・削除する `Remove-DbaTrace` コマンドの機能設計書です。

### 本機能の処理概要

アクティブな SQL Server トレースを停止し、トレース定義をサーバーから完全に削除する PowerShell コマンドです。sp_trace_setstatus を使用してトレースを停止（ステータス0）してから削除（ステータス2）します。

**業務上の目的・背景**：トラブルシューティングやパフォーマンス分析で作成したトレースは、作業完了後に適切にクリーンアップする必要があります。不要なトレースはサーバーリソースを消費し、ディスク領域を浪費する可能性があります。本コマンドは、トレースの停止と削除を一括で行い、サーバーのクリーンな状態を維持します。

**機能の利用シーン**：
- トラブルシューティング完了後のトレースクリーンアップ
- サーバーリソースの解放
- 不要なトレースの一括削除
- メンテナンス作業の一環としてのトレース整理

**主要な処理内容**：
1. トレースオブジェクトの取得（パラメータまたはパイプライン）
2. デフォルトトレースの保護チェック
3. sp_trace_setstatus でトレース停止（ステータス 0）
4. トレース存在確認後、sp_trace_setstatus で削除（ステータス 2）
5. 結果の出力

**関連システム・外部連携**：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 | string | ステータスメッセージ（"Stopped, closed and deleted"） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 入力オブジェクトの取得
   └─ -InputObject がない場合、Get-DbaTrace で取得
2. 各トレースの処理ループ
   └─ 入力検証（id と Parent プロパティ確認）
   └─ サーバーオブジェクトとトレース ID 取得
3. デフォルトトレースチェック
   └─ デフォルトトレースの場合はエラーで継続
4. トレース停止
   └─ sp_trace_setstatus traceid, 0 実行
5. トレース存在確認
   └─ Get-DbaTrace で確認
6. トレース削除
   └─ 存在する場合、sp_trace_setstatus traceid, 2 実行
7. 結果出力
   └─ PSCustomObject で結果を返す
```

### フローチャート

```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| I
    J -->|Yes| K[sp_trace_setstatus 0 実行]
    K --> L{トレース存在?}
    L -->|Yes| M[sp_trace_setstatus 2 実行]
    L -->|No| N[結果出力]
    M --> N
    G --> O{次のトレース?}
    I --> O
    N --> O
    O -->|Yes| E
    O -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトトレース保護 | デフォルトトレースは削除できない | 常時 |
| BR-002 | 2段階削除 | 停止（0）してから削除（2）の2段階処理 | 常時 |
| BR-003 | 存在確認後削除 | 停止後、存在する場合のみ削除実行 | 常時 |
| BR-004 | 入力検証 | id と Parent プロパティが必要 | 常時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| トレース停止 | sys.traces | UPDATE (間接) | sp_trace_setstatus でステータス変更 |
| トレース削除 | sys.traces | DELETE (間接) | sp_trace_setstatus でトレース削除 |
| トレース確認 | sys.traces | SELECT | Get-DbaTrace で存在確認 |

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

#### sp_trace_setstatus

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライなし

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

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

## パフォーマンス要件

- トレースの停止・削除は即座に完了
- トレース数に比例した処理時間

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

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

## 備考

- デフォルトトレースを無効にするには Set-DbaSpConfigure を使用
- SupportsShouldProcess で -WhatIf/-Confirm をサポート

---

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

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

### 推奨読解順序

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

出力は PSCustomObject で、削除結果を含みます。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaTrace.ps1 | `public/Remove-DbaTrace.ps1` | 出力オブジェクトの構造（114-120行目） |

**読解のコツ**: Status プロパティは固定値 "Stopped, closed and deleted" です。

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

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

**主要処理フロー**:
1. **77-85行目**: パラメータ定義
2. **86-127行目**: process ブロックでトレース削除処理

#### Step 3: 削除ロジックを理解する

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

**主要処理フロー**:
- **99-103行目**: デフォルトトレースチェック
- **105-106行目**: sp_trace_setstatus クエリ構築
- **110-113行目**: 停止と削除の2段階処理

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

```
Remove-DbaTrace
    │
    ├─ Get-DbaTrace
    │      └─ InputObject がない場合のトレース取得
    │
    ├─ Get-DbaTrace (Default)
    │      └─ デフォルトトレース取得
    │
    ├─ $server.Query("sp_trace_setstatus $traceid, 0")
    │      └─ トレース停止
    │
    ├─ Get-DbaTrace (確認)
    │      └─ トレース存在確認
    │
    └─ $server.Query("sp_trace_setstatus $traceid, 2")
           └─ トレース削除
```

### データフロー図

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

SqlInstance/Id ──▶ Get-DbaTrace ─────────▶ Trace Objects
    or
InputObject ────▶ Default Check ─────────▶ Protection
                         │
                  sp_trace_setstatus 0 ──▶ Stop
                         │
                  Existence Check ───────▶ Verify
                         │
                  sp_trace_setstatus 2 ──▶ Delete
                         │
                  PSCustomObject ────────▶ Result
```

### 関連ファイル一覧

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