# 機能設計書 97-Get-DbaCustomError

## 概要

本ドキュメントは、SQL Serverのユーザー定義エラーメッセージを取得するGet-DbaCustomErrorコマンドの機能設計書である。

### 本機能の処理概要

Get-DbaCustomErrorは、SQL Serverインスタンスに登録されているカスタムエラーメッセージ（sp_addmessageで追加されたユーザー定義メッセージ）を取得する機能である。これらのメッセージはsys.messagesシステムカタログに格納されている。

**業務上の目的・背景**：アプリケーションのビジネスロジック検証やカスタムエラー処理のために、ユーザー定義エラーメッセージが使用される。本機能はこれらのカスタムエラーをインベントリ化し、マイグレーション、トラブルシューティング、コンプライアンス監査の際に役立つ。

**機能の利用シーン**：マイグレーション前のカスタムエラーメッセージの棚卸し、複数インスタンス間でのエラーメッセージ構成の比較、アプリケーションエラーのトラブルシューティング、およびカスタムエラー定義の文書化時に利用される。

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続を確立
2. SMO経由でUserDefinedMessagesコレクションにアクセス
3. 各カスタムエラーメッセージにメタデータを付加
4. 結果をパイプラインに出力

**関連システム・外部連携**：SQL Server SMO（UserDefinedMessages）を使用してsys.messagesのユーザー定義メッセージにアクセス。

**権限による制御**：SQL Serverへの接続権限が必要。

## 関連画面

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

## 機能種別

データ取得（SMO経由でのシステムカタログ読み取り）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能、複数指定可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

SQL Server SMO Server.UserDefinedMessagesコレクション（sys.messagesビューに対応）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverホストのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| ID | Int32 | カスタムエラーメッセージID（50001-2147483647） |
| Text | String | エラーメッセージテキスト（最大255文字） |
| LanguageID | Int32 | 言語ID（sys.syslanguagesの数値識別子） |
| Language | String | 言語名（例：English, Japanese） |
| Severity | Int32 | エラー重大度レベル（1-25） |
| IsLogged | Boolean | Windows/SQL Serverエラーログに記録されるか |

### 出力先

PowerShellパイプラインに直接出力される

## 処理フロー

### 処理シーケンス

```
1. Process処理：各インスタンスに対してループ
   └─ Connect-DbaInstanceでSQL Serverに接続
2. UserDefinedMessagesコレクションの取得
   └─ $server.UserDefinedMessagesで全カスタムエラーを取得
3. メタデータの付加
   └─ Add-MemberでComputerName, InstanceName, SqlInstanceを追加
4. 結果の出力
   └─ Select-DefaultViewで既定プロパティのみ表示
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各SqlInstanceをループ}
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    E --> B
    D -->|Yes| F[UserDefinedMessages取得]
    F --> G{各customErrorをループ}
    G --> H[Add-Member ComputerName]
    H --> I[Add-Member InstanceName]
    I --> J[Add-Member SqlInstance]
    J --> K[Select-DefaultView]
    K --> G
    G -->|完了| B
    B -->|完了| L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-97-1 | カスタムエラーID範囲 | ユーザー定義メッセージIDは50001以上 | 常時 |
| BR-97-2 | システムメッセージ除外 | 50000以下のシステムメッセージは含まない | 常時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| カスタムエラー取得 | sys.messages | SELECT | SMO経由でユーザー定義メッセージを取得 |

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

#### sys.messages

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | message_id, text, language_id, severity, is_event_logged | message_id > 50000 | SMO UserDefinedMessages経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionでエラー記録、次インスタンスに継続 |

### リトライ仕様

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

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

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

## パフォーマンス要件

SMO経由でのメタデータ取得は軽量な操作。

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

- SQL Serverへの接続権限が必要
- SqlCredentialによる代替認証情報の使用をサポート

## 備考

- カスタムエラーメッセージはsp_addmessageまたはSSMSで追加される
- 同一メッセージIDに対して複数言語のメッセージが存在する可能性がある

---

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

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

### 推奨読解順序

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

出力されるオブジェクトはSMOのUserDefinedMessageオブジェクトに追加プロパティを付与したものである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaCustomError.ps1 | `public/Get-DbaCustomError.ps1` | 36-56行目の.OUTPUTSセクション |

**読解のコツ**: Add-Memberで追加されるプロパティに注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaCustomError.ps1 | `public/Get-DbaCustomError.ps1` | 68-74行目のparam block |

**主要処理フロー**:
1. **68-74行目**: パラメータ定義
2. **76-92行目**: process block（メイン処理）
3. **84行目**: $server.UserDefinedMessagesで全カスタムエラー取得

#### Step 3: メタデータ付加を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaCustomError.ps1 | `public/Get-DbaCustomError.ps1` | 85-89行目のAdd-Member処理 |

**主要処理フロー**:
- **85行目**: ComputerNameを追加（$customError.Parent.ComputerName）
- **86行目**: InstanceNameを追加（$customError.Parent.ServiceName）
- **87行目**: SqlInstanceを追加（$customError.Parent.DomainInstanceName）
- **89行目**: Select-DefaultViewで出力整形

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

```
Get-DbaCustomError
    │
    ├─ Connect-DbaInstance (接続確立)
    │      └─ SQL Server SMO接続
    │
    └─ $server.UserDefinedMessages
           │
           ├─ Add-Member (ComputerName)
           ├─ Add-Member (InstanceName)
           ├─ Add-Member (SqlInstance)
           │
           └─ Select-DefaultView (出力整形)
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance  ───▶ SMO Server オブジェクト
                           │
                           ▼
                    UserDefinedMessages
                    コレクション取得
                           │
                           ▼
                    メタデータ付加
                    (Add-Member)
                           │
                           ▼
              Select-DefaultView ───▶ UserDefinedMessage
                                      オブジェクト配列
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaCustomError.ps1 | `public/Get-DbaCustomError.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
