# バッチ設計書 3-message-transforms.ps1

## 概要

本ドキュメントは、dbatoolsモジュールのメッセージング用型変換ルールを登録するスクリプト「message-transforms.ps1」の設計仕様を記載したものである。

### 本バッチの処理概要

本スクリプトは、dbatoolsモジュールのWrite-Messageコマンドレットで使用される型変換ルールを登録する。DbaInstanceParameter、SMO Server、SqlExceptionの3種類のオブジェクトに対して、ログ出力時に適切な文字列表現に変換するためのScriptBlockを定義する。これにより、ログメッセージに含まれるSQL Server接続情報やエラー情報が、一貫性のある読みやすい形式で出力される。

**業務上の目的・背景**：dbatoolsモジュールでは、多数のSQL Server管理コマンドが様々な型のオブジェクトを扱う。ログやメッセージ出力時に、これらのオブジェクトを人間が読みやすい形式に変換する必要がある。例えば、SQL Server接続オブジェクトは接続文字列ではなくサーバー名として表示したい、例外オブジェクトは内部例外まで辿ってSqlExceptionを取り出したい、といった要件がある。本スクリプトはこれらの型変換ルールを一元的に管理し、モジュール全体で一貫したログ出力形式を実現する。

**バッチの実行タイミング**：dbatoolsモジュールのインポート時に一度だけ実行される。Register-DbaMessageTransformコマンドレットにより変換ルールが登録される。

**主要な処理内容**：
1. DbaInstanceParameter型の変換ルール登録：FullSmoNameプロパティを返す
2. SMO Server型の変換ルール登録：DbaInstanceParameterにキャストしてFullSmoNameを返す
3. 全例外型の変換ルール登録：InnerExceptionを辿りSqlExceptionがあれば返す

**前後の処理との関連**：本スクリプトはモジュール初期化時にdbatools.psm1から呼び出される。登録された変換ルールはWrite-Messageコマンドレット（logfilescript.ps1やその他のコマンドで使用）でログ出力時に適用される。

**影響範囲**：dbatoolsモジュール全体のメッセージ出力形式に影響する。全てのWrite-Message呼び出しで、登録された型変換が適用される。

## バッチ種別

モジュール初期化 / 型変換ルール登録

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 1回（モジュールインポート時） |
| 実行時刻 | モジュールインポート時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | dbatoolsモジュールのインポート |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| dbatoolsモジュールのロード | dbatools.psm1のロード処理中であること |
| .NET Frameworkランタイム | Dataplat.Dbatools.dllが利用可能であること |
| Register-DbaMessageTransform | 内部コマンドが利用可能であること |

### 実行可否判定

モジュールインポート時に無条件で実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトは直接パラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| なし | - | 外部データソースは使用しない |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| MessageTransform登録 | 内部レジストリ | dbatoolsの内部型変換レジストリに登録 |

### 出力ファイル仕様

本スクリプトはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. DbaInstanceParameter型変換の登録
   └─ TargetType: 'Dataplat.Dbatools.Parameter.DbaInstanceParameter'
   └─ 変換処理: $args[0].FullSmoNameを返す
2. SMO Server型変換の登録
   └─ TargetType: 'Microsoft.SqlServer.Management.Smo.Server'
   └─ 変換処理: DbaInstanceParameterにキャスト後、FullSmoNameを返す
3. 全例外型変換の登録
   └─ ExceptionTypeFilter: '*'（全例外型にマッチ）
   └─ 変換処理: InnerExceptionを辿りSqlExceptionを検索、見つかれば返す
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[DbaInstanceParameter変換登録]
    B --> C[SMO Server変換登録]
    C --> D[例外型変換登録]
    D --> E[スクリプト終了]
```

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

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

本スクリプトはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型不明エラー | 指定した型が存在しない | モジュールロード失敗 |
| - | 登録エラー | Register-DbaMessageTransformが失敗 | モジュールロード失敗 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

初期化スクリプトのため、エラー発生時はモジュールのインポート自体が失敗する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 3件の変換ルール登録 |
| 目標処理時間 | 数ミリ秒 |
| メモリ使用量上限 | 無視できる程度 |

## 排他制御

モジュール初期化時に一度だけ実行されるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 本スクリプト自体はログ出力しない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- 本スクリプトはprivate/scripts/配下に配置されている
- Register-DbaMessageTransformはdbatoolsの内部コマンドである
- SqlExceptionの検出では、Microsoft.Data.SqlClient.SqlExceptionを対象とする
- InnerExceptionを再帰的に辿ることで、ラップされた例外からもSqlExceptionを抽出可能
