# 機能設計書 187-New-DbaCustomError

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `New-DbaCustomError` コマンドレットの機能設計書である。このコマンドレットは、SQL Serverのsys.messagesテーブルにカスタムエラーメッセージを作成し、アプリケーションおよびストアドプロシージャで標準化されたエラー処理を実現する機能を提供する。

### 本機能の処理概要

本機能は、sp_addmessageを使用してSQL Serverのsys.messagesテーブルにカスタムエラーメッセージを作成する。これにより、定義する各カスタムメッセージに対してsp_addmessageを手動で実行する必要がなくなる。カスタムエラーメッセージは、アプリケーション開発およびデータベースメンテナンスのワークフローにおいて、一貫性のある意味のあるエラーレポートを提供するために不可欠である。

**業務上の目的・背景**：一般的なSQL Serverエラーの代わりに、「Customer record not found」や「Data validation failed for field X」のような特定のメッセージを定義することで、開発者とDBAの両方にとってトラブルシューティングがはるかに容易になる。複数のアプリケーションや環境で一貫したエラーメッセージを使用することで、運用品質が向上する。

**機能の利用シーン**：
- アプリケーション固有のエラーメッセージの定義
- ストアドプロシージャでの標準化されたエラー処理
- 複数インスタンスへの一括エラーメッセージ登録
- 多言語対応のエラーメッセージ作成
- 監査・ログ記録が必要なエラーの設定

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続（Azure非サポート）
2. 指定された言語の確認
3. SMO UserDefinedMessageオブジェクトの作成
4. メッセージプロパティの設定（ID、重大度、テキスト、言語、ログ）
5. Create()メソッドによるメッセージの登録
6. 作成されたメッセージの取得と返却

**関連システム・外部連携**：SQL Server sys.messages、sp_addmessage、sys.syslanguages

**権限による制御**：ALTER ANY MESSAGE権限またはsysadminサーバーロールが必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 223 | カスタムエラー | 主機能 | カスタムエラーの作成 |

## 機能種別

CRUD操作（カスタムエラーメッセージの作成）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス | 必須、パイプラインから入力可能 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | - |
| MessageID | int32 | No | カスタムエラーメッセージのID | ValidateRange: 50001-2147483647 |
| Severity | int32 | No | 重大度レベル | ValidateRange: 1-25 |
| MessageText | string | No | エラーメッセージテキスト | ValidateLength: 0-255 |
| Language | string | No | メッセージの言語 | デフォルトはEnglish |
| WithLog | switch | No | Windowsアプリケーションログへの記録を有効化 | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- ユーザー入力（パラメータ指定）
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ID | int | メッセージ識別子（50001-2147483647） |
| Language | string | メッセージの言語 |
| Severity | int | 重大度レベル（1-25） |
| Text | string | エラーメッセージテキスト |
| IsLogged | bool | ログ記録が有効かどうか |
| CreateDate | datetime | メッセージの作成日時 |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.UserDefinedMessageオブジェクト）

## 処理フロー

### 処理シーケンス

```
1. processブロック処理
   └─ 各SqlInstanceを処理
2. インスタンス接続
   └─ Connect-DbaInstance（AzureUnsupported）
3. 言語確認
   └─ sys.syslanguagesから言語情報を取得
4. 言語検証
   └─ 指定言語がインスタンスにインストールされているか確認
5. ShouldProcess確認
6. UserDefinedMessageオブジェクト作成
   └─ SMOオブジェクトのインスタンス化
7. プロパティ設定
   └─ ID、Language、Severity、Text、IsLogged
8. Create()メソッド実行
9. 作成されたメッセージの取得
   └─ server.UserDefinedMessagesからフィルタ
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各SqlInstanceを処理]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    D -->|Yes| F[sys.syslanguagesクエリ]
    F --> G{言語存在?}
    G -->|No| H[Stop-Function: 言語未インストール]
    G -->|Yes| I{ShouldProcess?}
    I -->|No| J[スキップ]
    I -->|Yes| K[UserDefinedMessage作成]
    K --> L[プロパティ設定]
    L --> M[Create実行]
    M --> N{成功?}
    N -->|No| O[Stop-Function]
    N -->|Yes| P[作成メッセージ取得]
    P --> Q[結果出力]
    E --> Q
    H --> Q
    J --> Q
    O --> Q
    Q --> R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Azure非サポート | Azure SQL Databaseはサポート対象外 | 常時 |
| BR-002 | MessageID範囲 | カスタムメッセージIDは50001以上 | 常時 |
| BR-003 | 英語版先行 | 非英語メッセージを追加する前に同一重大度の英語版が必要 | 非英語言語時 |
| BR-004 | 言語確認 | 指定言語がインスタンスにインストールされている必要あり | Language指定時 |
| BR-005 | デフォルト言語 | Language未指定時はサーバーのデフォルト言語を使用 | Language未指定時 |

### 計算ロジック

| 重大度レベル | 意味 |
|-------------|------|
| 1-10 | 情報メッセージ |
| 11-16 | ユーザーが修正可能なエラー |
| 17-19 | 非致命的なリソースエラー |
| 20-25 | 致命的なシステムエラー |

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 言語確認 | sys.syslanguages | SELECT | 言語情報の取得 |
| デフォルト言語取得 | sys.configurations | SELECT | サーバーデフォルト言語の取得 |
| メッセージ作成 | sys.messages | INSERT | カスタムエラーメッセージの登録 |

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

#### sys.syslanguages

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name, alias, msglangid | name = '$Language' OR alias = '$Language' | 言語確認クエリ |

#### sys.messages

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | message_id, severity, text, language_id, is_event_logged | パラメータ値 | SMO経由で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | 接続情報確認 |
| - | 言語未インストール | 指定言語がインスタンスに存在しない | 利用可能な言語を確認 |
| - | 作成失敗 | メッセージ作成中のエラー | 権限確認、重複ID確認 |

### リトライ仕様

リトライ処理は実装されていない。

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

SMO Create()メソッドは内部的にトランザクションを管理。

## パフォーマンス要件

単一メッセージの作成は即座に完了。

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

- ALTER ANY MESSAGE権限またはsysadminロールが必要
- Azure SQL Databaseは非サポート
- WithLogを有効にするとWindowsイベントログにも記録される

## 備考

- 非英語メッセージを追加する場合、先に同一重大度の英語版を作成する必要がある
- printf形式のパラメータプレースホルダー（%s、%d等）を使用可能
- 作成後のメッセージ変更はRemove-DbaCustomError後に再作成が必要

---

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

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

### 推奨読解順序

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

パラメータ定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | New-DbaCustomError.ps1 | `public/New-DbaCustomError.ps1` | 114-128行目のparamブロック |

**読解のコツ**: MessageIDとSeverityにはValidateRangeが設定されている。MessageTextは255文字制限。Languageのデフォルトは'English'。

#### Step 2: 言語確認処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaCustomError.ps1 | `public/New-DbaCustomError.ps1` | 138-148行目の言語確認処理 |

**主要処理フロー**:
- **138行目**: sys.syslanguagesへのクエリで言語情報取得
- **140-143行目**: 言語が存在しない場合のエラー処理

#### Step 3: メッセージ作成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaCustomError.ps1 | `public/New-DbaCustomError.ps1` | 150-177行目のメッセージ作成処理 |

**主要処理フロー**:
- **153行目**: SMO UserDefinedMessageオブジェクト作成
- **154-155行目**: ParentとIDプロパティ設定
- **157-161行目**: 言語設定（指定またはデフォルト）
- **163-168行目**: Severity、Text、IsLoggedプロパティ設定
- **170行目**: Create()メソッド実行
- **173行目**: 作成されたメッセージの取得

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

```
New-DbaCustomError
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続（AzureUnsupported）
    │
    ├─ $server.Query()
    │      └─ sys.syslanguages, sys.configurationsへのクエリ
    │
    ├─ New-Object UserDefinedMessage
    │      └─ SMOオブジェクト作成
    │
    ├─ $userDefinedMessage.Create()
    │      └─ メッセージ作成（sp_addmessage内部呼び出し）
    │
    └─ $server.UserDefinedMessages
           └─ 作成されたメッセージの取得
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance ──────────▶ $server
MessageID ────────────▶ UserDefinedMessage.ID
Severity ─────────────▶ UserDefinedMessage.Severity
MessageText ──────────▶ UserDefinedMessage.Text
Language ─────────────▶ 言語確認クエリ
                              │
                              ▼
                       UserDefinedMessage.Create()
                              │
                              ▼
                       server.UserDefinedMessages ───▶ パイプライン出力
                       (フィルタ: ID, Language)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaCustomError.ps1 | `public/New-DbaCustomError.ps1` | ソース | メイン機能の実装 |
| Get-DbaCustomError.ps1 | `public/Get-DbaCustomError.ps1` | ソース | カスタムエラーの取得 |
| Remove-DbaCustomError.ps1 | `public/Remove-DbaCustomError.ps1` | ソース | カスタムエラーの削除 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
