# 通知設計書 43-出力サーバー不存在

## 概要

本ドキュメントは、sp_BlitzIndex、sp_BlitzCache、sp_Blitzストアドプロシージャにおいて、指定された出力サーバー（リンクサーバー）が存在しない場合に発生するエラー通知の設計を記載する。

### 本通知の処理概要

本通知は、出力先としてリンクサーバーを指定した場合に、そのサーバーがsys.serversシステムビューに登録されていない（つまり、リンクサーバーとして構成されていない）場合にエラーメッセージを出力し、処理を中断する機能を提供する。

**業務上の目的・背景**：First Responder Kitの各ストアドプロシージャは、分析結果をリモートのリンクサーバー上のテーブルに出力する機能を提供している。この機能を使用する際、指定されたサーバーがリンクサーバーとして正しく構成されていることを事前に確認する必要がある。存在しないサーバーへの出力を試みると処理が失敗するため、早期にエラーを検出してユーザーに通知することで、トラブルシューティングを容易にする。

**通知の送信タイミング**：@OutputServerNameパラメータが指定された場合、出力先の検証フェーズにおいてsys.serversシステムビューを確認し、指定されたサーバー名が登録されていない場合に送信される。

**通知の受信者**：ストアドプロシージャを実行したSQL Serverクライアントセッション。RAISERRORステートメントによりクライアントに直接エラーメッセージが返される。

**通知内容の概要**：エラーメッセージには、指定された出力サーバーが見つからなかったことが明示される。

**期待されるアクション**：ユーザーは通知内容を確認し、(1) リンクサーバーの名前が正しいか確認、(2) リンクサーバーが正しく構成されているか確認（sp_addlinkedserver等）、(3) サーバー名を修正して再実行、のいずれかのアクションを取る。

## 通知種別

RAISERRORによるSQL Serverエラーメッセージ（クライアント通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（Severity 16） |
| リトライ | なし |

### 送信先決定ロジック

ストアドプロシージャを実行したクライアントセッションに対して、RAISERRORステートメントにより直接エラーメッセージを送信する。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 16 |
| 状態 | 0 |
| 形式 | テキスト |

### 本文テンプレート

```
The specified output server was not found
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzIndex/sp_BlitzCache/sp_Blitz実行 | @OutputServerNameがNOT NULLかつsys.serversに該当サーバーが存在しない | 出力先検証フェーズで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @OutputServerNameがNULLの場合 | ローカルサーバーへの出力のため検証不要 |
| 指定サーバーがsys.serversに存在する場合 | 正常ケースのため通知不要 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ストアドプロシージャ実行開始] --> B{@OutputServerNameがNOT NULL?}
    B -->|No| C[ローカル出力処理へ]
    B -->|Yes| D{一時テーブル出力?}
    D -->|Yes| E[別エラー: リンクサーバー制限]
    D -->|No| F{sys.serversにサーバーが存在?}
    F -->|Yes| G[リンクサーバーDB確認へ]
    F -->|No| H[RAISERROR: 出力サーバー不存在]
    H --> I[処理中断]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.servers | リンクサーバーの存在確認 | server_idとnameカラムを使用 |

### テーブル別参照項目詳細

#### sys.servers

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| server_id | サーバー存在確認 | WHERE QUOTENAME([name]) = @OutputServerName |
| name | サーバー名照合 | QUOTENAME関数で括弧付き形式に変換して比較 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | なし | エラー発生時は即座に処理中断するため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力サーバー不存在 | @OutputServerNameがsys.serversに存在しない | エラーメッセージを出力（処理は継続される場合あり） |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（プロシージャ実行時に即時送信）

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

- サーバー名のみをエラーメッセージに含めず、固定メッセージとすることでセキュリティリスクを低減
- sys.serversへのアクセス権限が必要

## 備考

- @OutputServerNameはQUOTENAME関数により角括弧で囲まれた形式（例: [ServerName]）で渡されることが想定される
- 同じエラーメッセージがsp_BlitzIndex、sp_BlitzCache、sp_Blitzの複数のプロシージャで使用される
- リンクサーバーが存在しても、そのサーバー上のデータベースが存在しない場合は別のエラー（出力データベース不存在）が発生する

---

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

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

### 推奨読解順序

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

出力先関連のパラメータ定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | @OutputServerName、@OutputDatabaseName、@OutputSchemaName、@OutputTableNameパラメータの定義 |
| 1-2 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 同様のパラメータ定義 |

**読解のコツ**: 出力関連パラメータはすべてNVARCHAR型で定義され、QUOTENAME関数で括弧付き形式に変換されることを確認する。

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

sp_BlitzIndexでの出力サーバー検証ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 出力先検証セクション（行3630-3665） |

**主要処理フロー**:
1. **行3636-3640**: 検証用変数の宣言（@ValidOutputServer, @ValidOutputLocation等）
2. **行3642**: @OutputServerNameがNOT NULLの場合のIF分岐開始
3. **行3644-3646**: 一時テーブル出力のチェック（別エラー）
4. **行3648**: sys.serversでのサーバー存在確認
5. **行3661-3663**: サーバーが存在しない場合のRAISERROR

#### Step 3: sp_BlitzCacheでの実装

sp_BlitzCacheでの同様の検証ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 出力先検証セクション（行7620-7637） |

**主要処理フロー**:
- **行7621**: sys.serversでのサーバー存在確認（EXISTS句）
- **行7623-7632**: サーバーが存在する場合のデータベース確認処理
- **行7634-7637**: サーバーが存在しない場合のRAISERROR

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

```
sp_BlitzIndex / sp_BlitzCache / sp_Blitz
    │
    ├─ パラメータ初期化
    │
    ├─ 出力先検証（@OutputServerName != NULL の場合）
    │      │
    │      ├─ 一時テーブルチェック
    │      │      └─ 一時テーブルの場合 → 別エラー
    │      │
    │      ├─ sys.servers確認
    │      │      │
    │      │      ├─ 存在する場合
    │      │      │      └─ データベース存在確認へ
    │      │      │
    │      │      └─ 存在しない場合
    │      │             └─ RAISERROR（本通知）
    │      │
    │      └─ 以降の処理へ
    │
    └─ メイン処理
```

### データフロー図

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

@OutputServerName ───▶ NULL判定 ───▶ sys.servers照会
                                           │
                                           ▼
                                   ┌─────────────────┐
                                   │ EXISTS確認       │
                                   │ QUOTENAME(name)  │
                                   │ = @OutputServer  │
                                   └─────────────────┘
                                           │
                           ┌───────────────┴───────────────┐
                           ▼                               ▼
                    [存在する]                       [存在しない]
                         │                               │
                         ▼                               ▼
                   DB確認処理へ              RAISERROR → クライアント
                                             "The specified output
                                              server was not found"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | ソース | インデックス分析プロシージャ、通知発生元（行3663） |
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | キャッシュ分析プロシージャ、通知発生元（行7636） |
| sp_Blitz.sql | `sp_Blitz.sql` | ソース | 総合診断プロシージャ、通知発生元（行10473） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトインストーラー（同一ロジック含む） |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure用インストーラー（同一ロジック含む） |
