# 通知設計書 91-シノニム作成

## 概要

本ドキュメントは、sp_BlitzLockストアドプロシージャにおける「シノニム作成」通知メッセージの設計を定義する。この通知は、デッドロック分析結果を外部データベースに出力する際に、シノニムオブジェクトの作成処理の進行状況を示す情報メッセージである。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzLockはSQL Serverのデッドロック情報を分析するストアドプロシージャである。分析結果を別のデータベースに永続化する場合、直接的なクロスデータベースINSERTではなく、シノニムを経由してデータを挿入する設計となっている。この通知は、シノニム作成処理の開始を管理者に通知し、処理の進行状況を可視化することで、デバッグやトラブルシューティングを支援する。

**通知の送信タイミング**：OutputDatabaseName、OutputSchemaName、OutputTableNameパラメータが指定され、外部データベースへの出力が有効な場合に、シノニム作成処理の直前に送信される。具体的には、DeadlockFindingsおよびDeadLockTbl用のシノニムが作成される前にそれぞれ通知される。

**通知の受信者**：SQLクライアント（SSMS、sqlcmd、アプリケーション）を通じてストアドプロシージャを実行している管理者またはオペレータ。RAISERROR WITH NOWAITにより即座にメッセージが出力される。

**通知内容の概要**：シノニム作成処理の開始を示すメッセージ。「Creating synonym DeadlockFindings」または「Creating synonym DeadLockTbl」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。エラーが発生した場合は、出力先データベースの存在確認、スキーマ・テーブルの存在確認、権限の確認などのトラブルシューティングを行う。

## 通知種別

RAISERROR情報メッセージ（SQLクライアント出力）

## 送信仕様

### 基本情報

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

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

RAISERROR WITH NOWAITによりSQL Serverクライアントへ即座にメッセージを送信。接続中のすべてのクライアントセッションで受信可能。

## 通知テンプレート

### メッセージ出力の場合

| 項目 | 内容 |
|-----|------|
| 出力形式 | RAISERRORメッセージ |
| 重大度 | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Creating synonym DeadlockFindings
Creating synonym DeadLockTbl
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | シノニム作成処理開始 | @OutputDatabaseName、@OutputSchemaName、@OutputTableNameが指定されている | 外部DB出力が有効な場合にシノニム作成を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 出力先パラメータ未指定 | @OutputDatabaseName等が未指定の場合は外部出力が行われないためシノニム作成も不要 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzLock実行開始] --> B{出力先DB指定あり?}
    B -->|No| C[クライアント出力のみ]
    B -->|Yes| D[出力テーブル作成/確認]
    D --> E{既存シノニムあり?}
    E -->|Yes| F[RAISERROR: Found synonym, dropping]
    F --> G[DROP SYNONYM実行]
    E -->|No| H[RAISERROR: Creating synonym]
    G --> H
    H --> I[CREATE SYNONYM実行]
    I --> J[デッドロックデータ挿入]
    J --> K[DROP SYNONYM実行]
    K --> L[終了]
    C --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.objects | シノニムの存在確認 | type_desc = 'SYNONYM'でフィルタ |
| sys.schemas | スキーマ名の確認 | dboスキーマを使用 |

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

#### sys.objects

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | シノニム名の確認 | name = N'DeadlockFindings' または name = N'DeadLockTbl' |
| schema_id | スキーマID | sys.schemasと結合 |
| type_desc | オブジェクト種別 | type_desc = N'SYNONYM' |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| dbo.DeadlockFindings（シノニム） | CREATE/DROP | 出力テーブルへの参照用シノニム |
| dbo.DeadLockTbl（シノニム） | CREATE/DROP | 出力テーブルへの参照用シノニム |

#### シノニム操作

| 操作 | オブジェクト名 | 参照先 | 備考 |
|-----|-----------------|-------|------|
| CREATE SYNONYM | dbo.DeadlockFindings | @OutputDatabaseName.@OutputSchemaName.@OutputTableFindings | デッドロック検出結果用 |
| CREATE SYNONYM | dbo.DeadLockTbl | @OutputDatabaseName.@OutputSchemaName.@OutputTableName | デッドロックデータ用 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| シノニム作成失敗 | 権限不足、無効なオブジェクト名 | 出力先データベース・スキーマ・テーブルの存在確認と権限確認 |
| 動的SQL実行エラー | 構文エラー、オブジェクト参照エラー | @Debugパラメータを1に設定してSQLを確認 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ストアドプロシージャ実行時に即座に送信）

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

- シノニム作成にはCREATE SYNONYM権限が必要
- 出力先データベースへのアクセス権限が必要
- RAISERRORメッセージには機密情報は含まれない

## 備考

- シノニムはデータ挿入完了後に自動的にDROPされる
- 既存のシノニムが存在する場合は事前に削除される
- @Debugパラメータを1に設定すると、生成されるSQLも出力される

---

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

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

### 推奨読解順序

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

シノニム作成通知は、出力先テーブルの参照構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 入力パラメータ @OutputDatabaseName, @OutputSchemaName, @OutputTableName の定義を確認 |

**読解のコツ**: パラメータ定義部分（行50-100付近）で出力先関連のパラメータを確認する。

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

シノニム作成処理のトリガー条件を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 出力先DB指定時の処理分岐を確認 |

**主要処理フロー**:
1. **行856-884**: DeadlockFindingsシノニムの存在確認とDROP/CREATE処理
2. **行886-914**: DeadLockTblシノニムの存在確認とDROP/CREATE処理

#### Step 3: シノニム作成処理の詳細

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 動的SQLによるCREATE SYNONYM文の組み立てを確認 |

**主要処理フロー**:
- **行869-870**: 既存シノニム検出時のRAISERRORとDROP SYNONYM
- **行873**: シノニム作成開始のRAISERRORメッセージ
- **行874-880**: CREATE SYNONYM文の動的SQL組み立て
- **行882-884**: sp_executesqlによるSQLの実行

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

```
sp_BlitzLock
    |
    +-- [出力先DB指定確認]
    |      |
    |      +-- [出力テーブル作成/存在確認]
    |
    +-- [DeadlockFindingsシノニム処理]
    |      |
    |      +-- sys.objects/sys.schemas参照（存在確認）
    |      +-- RAISERROR 'Found synonym DeadlockFindings, dropping'
    |      +-- DROP SYNONYM dbo.DeadlockFindings
    |      +-- RAISERROR 'Creating synonym DeadlockFindings'  <-- 本通知
    |      +-- sp_executesql (CREATE SYNONYM)
    |
    +-- [DeadLockTblシノニム処理]
           |
           +-- sys.objects/sys.schemas参照（存在確認）
           +-- RAISERROR 'Found synonym DeadLockTbl, dropping'
           +-- DROP SYNONYM dbo.DeadLockTbl
           +-- RAISERROR 'Creating synonym DeadLockTbl'  <-- 本通知
           +-- sp_executesql (CREATE SYNONYM)
```

### データフロー図

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

@OutputDatabaseName ──┐
@OutputSchemaName  ───┼──▶ CREATE SYNONYM文組立 ──▶ シノニムオブジェクト作成
@OutputTableName   ───┘         |
                                ▼
                        RAISERROR出力 ──────────▶ SQLクライアント
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzLock.sql | `sp_BlitzLock.sql` | ソース | デッドロック分析の本体プロシージャ。シノニム作成処理を含む |
