# 機能設計書 675-Copy-DbaInstanceTrigger

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Copy-DbaInstanceTrigger` コマンドレットの機能設計を記載する。この機能はSQL Serverインスタンス間でサーバーレベルトリガーをコピーする移行・標準化機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：サーバーレベルトリガーはログオンイベント、DDL変更、サーバー起動などのインスタンス全体のイベントに応答する重要なセキュリティ・監査機構である。サーバー移行、災害復旧環境の構築、複数サーバー間でのセキュリティポリシー標準化において、これらのトリガーを効率的にコピーする必要がある。

**機能の利用シーン**：
- SQL Serverインスタンスの移行時にサーバートリガーを新環境へ移行
- 災害復旧サイトの構築時にプライマリサイトと同じトリガー構成を複製
- 複数サーバー間でセキュリティ監査トリガーを標準化
- 開発環境から本番環境へのトリガー展開

**主要な処理内容**：
1. ソースSQL Serverインスタンスへの接続（SQL Server 2005以上必須）
2. サーバートリガーの取得
3. 各宛先インスタンスへの接続とバージョン確認
4. 既存トリガーの確認（Force指定時は削除して再作成）
5. トリガー定義のスクリプト化とGOバッチ分割
6. 宛先サーバーでのトリガー作成実行
7. コピー結果のステータス出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)ライブラリを使用してトリガー定義をスクリプト化し、宛先サーバーで実行。

**権限による制御**：ソース・宛先の両方でsysadmin権限が必要。サーバーレベルトリガーへのアクセスと作成には高い権限が求められる。

## 関連画面

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

## 機能種別

データ移行 / DDL操作 / サーバー構成複製

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Source | DbaInstanceParameter | Yes | コピー元SQL Serverインスタンス | SQL Server 2005以上 |
| SourceSqlCredential | PSCredential | No | ソース接続用代替認証情報 | 有効な資格情報 |
| Destination | DbaInstanceParameter[] | Yes | コピー先SQL Serverインスタンス（複数可） | SQL Server 2005以上 |
| DestinationSqlCredential | PSCredential | No | 宛先接続用代替認証情報 | 有効な資格情報 |
| ServerTrigger | Object[] | No | コピー対象トリガー名（指定がなければ全て） | 存在するトリガー名 |
| ExcludeServerTrigger | Object[] | No | 除外するトリガー名 | 存在するトリガー名 |
| Force | Switch | No | 既存トリガーを削除して再作成 | - |
| EnableException | Switch | No | 例外有効化 | - |

### 入力データソース

- PowerShellコマンドラインパラメータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| SourceServer | String | コピー元サーバー名 |
| DestinationServer | String | コピー先サーバー名 |
| Name | String | トリガー名 |
| Type | String | 常に"Server Trigger" |
| Status | String | コピー結果（Successful/Skipped/Failed） |
| Notes | String | 追加情報（エラーメッセージ等） |
| DateTime | DbaDateTime | 処理日時 |

### 出力先

- PowerShellパイプライン（PSCustomObject with MigrationObject TypeName）

## 処理フロー

### 処理シーケンス

```
1. begin{}ブロック
   └─ ソースサーバー接続（MinimumVersion 9）
   └─ サーバートリガー取得（$server.Triggers）
2. process{}ブロック
   └─ 各宛先インスタンスループ
       └─ 宛先サーバー接続（MinimumVersion 9）
       └─ バージョン確認（宛先 >= ソース）
       └─ 各トリガーループ
           └─ フィルタリング（ServerTrigger/ExcludeServerTrigger）
           └─ 既存確認
               └─ 存在 & Force: Drop→Create
               └─ 存在 & !Force: スキップ
               └─ 未存在: Create
           └─ ステータスオブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ソースサーバー接続]
    B --> C{接続成功?}
    C -->|No| D[エラー終了]
    C -->|Yes| E[サーバートリガー取得]
    E --> F[各宛先ループ開始]
    F --> G[宛先サーバー接続]
    G --> H{接続成功?}
    H -->|No| I[エラー継続]
    H -->|Yes| J{バージョン確認}
    J -->|宛先 < ソース| K[エラー終了]
    J -->|OK| L[各トリガーループ]
    L --> M{フィルタ対象?}
    M -->|除外| L
    M -->|対象| N{宛先に存在?}
    N -->|Yes| O{Force指定?}
    O -->|No| P[Status=Skipped]
    O -->|Yes| Q[既存Drop]
    Q --> R{Drop成功?}
    R -->|No| S[Status=Failed]
    R -->|Yes| T[トリガー作成]
    N -->|No| T
    T --> U{作成成功?}
    U -->|Yes| V[Status=Successful]
    U -->|No| W[Status=Failed]
    P --> X[ステータス出力]
    S --> X
    V --> X
    W --> X
    X --> L
    L -->|完了| F
    F -->|完了| Y[終了]
    I --> F
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン | ソース・宛先ともSQL Server 2005以上必須 | 接続時 |
| BR-002 | バージョン互換性 | 宛先バージョンはソース以上が必要 | 宛先接続後 |
| BR-003 | 既存スキップ | Force未指定時、既存トリガーはスキップ | 既存確認時 |
| BR-004 | 強制上書き | Force指定時、既存トリガーを削除して再作成 | Force指定時 |
| BR-005 | GOバッチ分割 | スクリプトはGOで分割して順次実行 | 作成時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象オブジェクト | 操作種別 | 概要 |
|-----|-----------------|---------|------|
| トリガー取得 | sys.server_triggers | SELECT | ソースからの定義取得 |
| トリガー削除 | サーバートリガー | DROP TRIGGER | Force時の既存削除 |
| トリガー作成 | サーバートリガー | CREATE TRIGGER | 宛先での作成 |
| トリガー有効化 | サーバートリガー | ENABLE TRIGGER | 作成後の有効化 |

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

#### サーバートリガー

| 操作 | 項目 | 更新値・取得条件 | 備考 |
|-----|------|-----------------|------|
| Script() | トリガー定義 | SMO Script()メソッド | CREATE文生成 |
| Drop() | - | SMO Drop()メソッド | Force時のみ |
| Query() | CREATE/ENABLE文 | $sql実行 | GOで分割実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続エラー | SQL Server接続不可 | 接続情報確認 |
| - | バージョンエラー | SQL Server 2005未満 | バージョンアップグレード |
| - | 互換性エラー | 宛先バージョン < ソース | 宛先のアップグレード |
| - | 権限エラー | sysadmin権限不足 | 権限付与 |
| - | Drop失敗 | トリガー削除不可 | 依存関係確認 |
| - | Create失敗 | トリガー作成不可 | 構文・権限確認 |

### リトライ仕様

リトライ機能は実装されていない。エラー発生時はFailed状態で継続処理。

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

各DDL操作は個別に実行。明示的トランザクション制御は行わない。

## パフォーマンス要件

特定のパフォーマンス要件なし。

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

- ソース・宛先の両方でsysadmin権限が必要
- SqlCredentialパラメータで資格情報を安全に渡すことが可能
- ConfirmImpact=Mediumで確認プロンプト

## 備考

- サーバートリガーはログオン監査、DDL変更防止等に使用される重要なセキュリティ機構
- スクリプト内のCREATE、ENABLE TRIGGERはGOで分割して実行

---

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

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

### 推奨読解順序

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

出力オブジェクト（MigrationObject）の構造を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Copy-DbaInstanceTrigger.ps1 | `public/Copy-DbaInstanceTrigger.ps1` | 141-149行目: ステータスオブジェクト構造 |

**読解のコツ**: Select-DefaultViewでMigrationObjectタイプ名が付与され、標準的な移行結果形式で出力される。

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

begin{}ブロックでのソース接続とトリガー取得を確認。

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

**主要処理フロー**:
1. **113行目**: Connect-DbaInstance -MinimumVersion 9（SQL 2005以上）
2. **118行目**: $sourceServer.Triggersでトリガー取得
3. **120行目**: Force時のConfirmPreference設定

#### Step 3: コピーロジックを理解する

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

**主要処理フロー**:
- **128行目**: 宛先接続（MinimumVersion 9）
- **132-135行目**: バージョン互換性チェック
- **151-153行目**: ServerTrigger/ExcludeServerTriggerフィルタ
- **155-178行目**: 既存確認とForce処理
- **180-199行目**: トリガー作成（Script→GO分割→Query実行）

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

```
Copy-DbaInstanceTrigger
    │
    ├─ [begin] 初期化
    │      └─ Connect-DbaInstance (Source, MinimumVersion 9)
    │
    └─ [process] コピー処理
           ├─ Connect-DbaInstance (Destination, MinimumVersion 9)
           │
           └─ 各トリガーループ
                  ├─ [既存 & Force]
                  │      └─ $destServer.Triggers[$name].Drop()
                  │
                  └─ [作成]
                         ├─ $trigger.Script()
                         ├─ GOバッチ分割
                         └─ $destServer.Query($query)
```

### データフロー図

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

Source ─────────────────────▶ Connect-DbaInstance ─▶ $sourceServer
SourceSqlCredential ────────┘                              │
                                                           ▼
                                               $sourceServer.Triggers
                                                           │
                                                           ▼
Destination ────────────────▶ Connect-DbaInstance ─▶ $destServer
DestinationSqlCredential ───┘                              │
                                                           ▼
                                               [各トリガーループ]
                                                           │
                                    ┌──────────────────────┼──────────────────────┐
                                    ▼                      ▼                      ▼
                              [既存&Force]           [既存&!Force]            [未存在]
                                    │                      │                      │
                                    ▼                      ▼                      │
                              Drop()                  Skipped                    │
                                    │                      │                      │
                                    └──────────────────────┼──────────────────────┘
                                                           │
                                                           ▼
                                                    Script() → GO分割
                                                           │
                                                           ▼
                                                    Query()実行
                                                           │
                                                           ▼
                                               PSCustomObject (MigrationObject)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Copy-DbaInstanceTrigger.ps1 | `public/Copy-DbaInstanceTrigger.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | 接続処理 |
| Get-ErrorMessage.ps1 | `private/functions/Get-ErrorMessage.ps1` | ソース | エラーメッセージ取得 |
| Copy-DbaInstanceTrigger.Tests.ps1 | `tests/Copy-DbaInstanceTrigger.Tests.ps1` | テスト | 単体テスト |
