# 機能設計書 676-Find-DbaTrigger

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Find-DbaTrigger` コマンドレットの機能設計を記載する。この機能はサーバー、データベース、オブジェクトレベルのトリガーコード内で特定のテキストパターンや正規表現を検索する。

### 本機能の処理概要

**業務上の目的・背景**：スキーマ変更前に特定オブジェクトを参照するトリガーを見つける、ハードコードされた値を更新する、コンプライアンス要件でトリガーコードを監査するなどの場面で、トリガー定義内のテキスト検索が必要となる。本機能は3つのレベル（サーバー、データベース、オブジェクト）のトリガーを横断的に検索し、マッチした行と行番号を返すことで、パターンがどこに存在するかを正確に特定できる。

**機能の利用シーン**：
- スキーマ変更前の影響調査（特定テーブル/カラムを参照するトリガーの特定）
- ハードコードされたサーバー名やデータベース名の更新前調査
- セキュリティ監査（特定パターンを含むトリガーの検出）
- コードレビュー（特定コーディングパターンの検出）
- メールアドレスパターンなどの正規表現検索

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. TriggerLevelに応じた検索範囲の決定
3. サーバーレベルトリガーの検索（Database未指定時）
4. データベースレベルDDLトリガーの検索
5. オブジェクトレベルDMLトリガー（テーブル/ビュー）の検索
6. パターンマッチと行番号付き結果の生成

**関連システム・外部連携**：SQL Server Management Objects (SMO)でトリガー定義を取得し、PowerShellのSelect-Stringで正規表現検索を実行。

**権限による制御**：トリガー定義を読み取るためのVIEW DEFINITION権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン | 主画面 | PowerShellコンソールまたはスクリプトから実行 |

## 機能種別

検索 / 監査 / コード分析

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 接続先SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効な資格情報 |
| Database | Object[] | No | 検索対象データベース | 存在するDB名 |
| ExcludeDatabase | Object[] | No | 除外するデータベース | 存在するDB名 |
| Pattern | String | Yes | 検索パターン（正規表現対応） | 有効な正規表現 |
| TriggerLevel | String | No | 検索レベル（All/Server/Database/Object） | 指定値のみ |
| IncludeSystemObjects | Switch | No | システムトリガーを含む | - |
| IncludeSystemDatabases | Switch | No | システムデータベースを含む | - |
| EnableException | Switch | No | 例外有効化 | - |

### 入力データソース

- PowerShellコマンドラインパラメータ
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverコンピュータ名 |
| SqlInstance | String | インスタンス名 |
| TriggerLevel | String | トリガーレベル（Server/Database/Object） |
| Database | String | データベース名（Server以外） |
| DatabaseId | Int | データベースID（Server以外） |
| Object | Object | 親オブジェクト（Objectレベルのみ） |
| Name | String | トリガー名 |
| IsSystemObject | Boolean | システムオブジェクトフラグ |
| CreateDate | DateTime | 作成日時 |
| LastModified | DateTime | 最終更新日時 |
| TriggerTextFound | String | マッチした行（行番号付き） |
| Trigger | Object | SMOトリガーオブジェクト（非表示） |
| TriggerFullText | String | トリガー完全定義（非表示） |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin{}ブロック
   └─ SQL文の準備（データベーストリガー、テーブルトリガー）
2. process{}ブロック
   └─ 各インスタンスループ
       └─ サーバー接続
       └─ バージョン確認（SQL Server 2005以上）
       └─ サーバーレベルトリガー検索（Database未指定&TriggerLevel適合時）
       └─ データベース一覧取得（システムDB含む/含まない）
       └─ 各データベースループ
           └─ データベーストリガー検索（TriggerLevel適合時）
           └─ オブジェクトトリガー検索（TriggerLevel適合時）
               └─ テーブルトリガー
               └─ ビュートリガー
3. end{}ブロック
   └─ 総検索数ログ出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各インスタンスループ]
    B --> C[サーバー接続]
    C --> D{バージョン >= 2005?}
    D -->|No| E[警告→次へ]
    D -->|Yes| F{Database指定?}
    F -->|No| G{TriggerLevel: Server/All?}
    G -->|Yes| H[サーバートリガー検索]
    G -->|No| I[スキップ]
    F -->|Yes| I
    H --> I
    I --> J[データベース一覧取得]
    J --> K{IncludeSystemDatabases?}
    K -->|Yes| L[全DB]
    K -->|No| M[ユーザーDBのみ]
    L --> N[Database/ExcludeDatabase適用]
    M --> N
    N --> O[各DBループ]
    O --> P{TriggerLevel: Database/All?}
    P -->|Yes| Q[DBトリガー検索]
    P -->|No| R[スキップ]
    Q --> S{TriggerLevel: Object/All?}
    R --> S
    S -->|Yes| T[オブジェクトトリガー検索]
    S -->|No| O
    T --> O
    O -->|完了| B
    B -->|完了| U[総検索数出力]
    U --> V[終了]
    E --> B
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン | SQL Server 2005以上必須 | 接続時 |
| BR-002 | Database指定時サーバー除外 | Database指定時はサーバーレベルトリガー検索をスキップ | Database指定時 |
| BR-003 | システムオブジェクト除外 | IncludeSystemObjects未指定時はis_ms_shipped=0フィルタ | デフォルト |
| BR-004 | システムDB除外 | IncludeSystemDatabases未指定時はIsSystemObject=falseフィルタ | デフォルト |
| BR-005 | 正規表現対応 | Patternは正規表現として評価（-match演算子） | 検索時 |

### 計算ロジック

**行番号付きマッチ結果生成**:
```powershell
$triggerText.split($eol) | Select-String -Pattern $Pattern |
    ForEach-Object { "(LineNumber: $($_.LineNumber)) $($_.ToString().Trim())" }
```

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

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

| 操作 | 対象オブジェクト | 操作種別 | 概要 |
|-----|-----------------|---------|------|
| トリガー定義取得 | sys.sql_modules, sys.triggers | SELECT | 定義テキスト取得 |

### SQL文

**データベースDDLトリガー取得**:
```sql
SELECT tr.name, m.definition AS TextBody
FROM sys.sql_modules m, sys.triggers tr
WHERE m.object_id = tr.object_id AND tr.parent_class = 0
```

**オブジェクトDMLトリガー取得**:
```sql
SELECT OBJECT_SCHEMA_NAME(tr.parent_id) TableSchema,
       OBJECT_NAME(tr.parent_id) AS TableName,
       tr.name, m.definition AS TextBody
FROM sys.sql_modules m, sys.triggers tr
WHERE m.object_id = tr.object_id AND tr.parent_class = 1
  AND tr.is_ms_shipped = 0  -- IncludeSystemObjects未指定時
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続エラー | SQL Server接続不可 | 接続情報確認 |
| - | バージョンエラー | SQL Server 2005未満 | 警告後スキップ |
| - | 正規表現エラー | 無効なPattern | 正規表現構文確認 |

### リトライ仕様

リトライ機能は実装されていない。

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

読み取り専用操作のため、トランザクション制御なし。

## パフォーマンス要件

- IncludeSystemObjects指定時はパフォーマンスに大きく影響
- 大量データベース環境ではDatabase/ExcludeDatabase指定を推奨

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

- VIEW DEFINITION権限が必要
- SqlCredentialパラメータで資格情報を安全に渡すことが可能

## 備考

- 3レベル（Server/Database/Object）のトリガーを横断検索可能
- 正規表現対応でメールアドレスパターン等の高度な検索が可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造と検索用SQL文を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Find-DbaTrigger.ps1 | `public/Find-DbaTrigger.ps1` | 159-173行目: 出力オブジェクト構造（Serverレベル） |
| 1-2 | Find-DbaTrigger.ps1 | `public/Find-DbaTrigger.ps1` | 127-130行目: 検索用SQL文 |

**読解のコツ**: 3レベルで共通の出力構造だが、Database/DatabaseId/Objectはレベルによってnullになる。

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

begin{}ブロックでのSQL準備を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Find-DbaTrigger.ps1 | `public/Find-DbaTrigger.ps1` | 126-135行目: begin{}ブロック |

**主要処理フロー**:
1. **127行目**: データベースDDLトリガー用SQL
2. **129-130行目**: オブジェクトDMLトリガー用SQL（is_ms_shippedフィルタ）

#### Step 3: 検索ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Find-DbaTrigger.ps1 | `public/Find-DbaTrigger.ps1` | 136-361行目: process{}ブロック |

**主要処理フロー**:
- **150-176行目**: サーバーレベルトリガー検索
- **196-240行目**: データベースDDLトリガー検索（SQL使用）
- **242-284行目**: オブジェクトDMLトリガー検索（SQL使用）
- **286-356行目**: IncludeSystemObjects時のSMO直接アクセス

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

```
Find-DbaTrigger
    │
    ├─ [begin] SQL準備
    │
    └─ [process] 検索処理
           │
           ├─ Connect-DbaInstance
           │
           ├─ [Server Level] (Database未指定 & TriggerLevel適合)
           │      └─ $server.Triggers → TextBody -match $Pattern
           │
           ├─ [Database Level] (TriggerLevel適合)
           │      ├─ (!IncludeSystemObjects) $db.ExecuteWithResults($sqlDatabaseTriggers)
           │      └─ (IncludeSystemObjects) $db.Triggers
           │
           └─ [Object Level] (TriggerLevel適合)
                  ├─ (!IncludeSystemObjects) $db.ExecuteWithResults($sqlTableTriggers)
                  └─ (IncludeSystemObjects) $db.Tables.Triggers + $db.Views.Triggers
```

### データフロー図

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

SqlInstance ────────────────▶ Connect-DbaInstance ──▶ $server

Pattern ────────────────────▶ [Server Level]
                                    │
                              $server.Triggers
                                    │
                              TextBody -match $Pattern
                                    │
                                    ▼
                              [Database Level]
                                    │
                              ExecuteWithResults / $db.Triggers
                                    │
                              TextBody -match $Pattern
                                    │
                                    ▼
                              [Object Level]
                                    │
                              ExecuteWithResults / $db.Tables.Triggers
                                    │
                              TextBody -match $Pattern
                                    │
                                    ▼
                              Select-String -Pattern $Pattern
                                    │
                                    ▼
                              "(LineNumber: N) matched_text"
                                    │
                                    ▼
                              PSCustomObject
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Find-DbaTrigger.ps1 | `public/Find-DbaTrigger.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | 接続処理 |
| Find-DbaTrigger.Tests.ps1 | `tests/Find-DbaTrigger.Tests.ps1` | テスト | 単体テスト |
