# 通知設計書 74-ループ開始

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzIndexプロシージャにおいて、データベースのループ処理を開始した際に出力される情報通知「ループ開始」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzIndexストアドプロシージャ内で、対象データベースを順次処理するループ処理が開始されたことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzIndexは、複数のデータベースを対象にインデックス分析を行うことができる。サーバー上のすべてのデータベース、または特定のデータベースを順次処理する必要があり、この通知は、その反復処理が開始されたことを管理者に知らせる。特に大量のデータベースを持つサーバーでは、処理の進捗を把握するための重要な情報となる。

**通知の送信タイミング**：sp_BlitzIndexプロシージャのメイン処理フェーズにおいて、対象データベースリストのカーソルを開き、ループ処理を開始する直前に送信される。具体的にはsp_BlitzIndex.sqlの行1199で出力される。

**通知の受信者**：SQL Server Management Studio（SSMS）やその他のクライアントツールでsp_BlitzIndexを実行している管理者・DBA。メッセージタブに情報として表示される。

**通知内容の概要**：「Starting loop through databases」という固定メッセージが出力される。これにより、データベース反復処理が開始されたことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。多数のデータベースを持つサーバーでは、このフェーズ以降に各データベースの処理が順次行われるため、管理者は全体の処理進捗を把握できる。

## 通知種別

コンソール出力（RAISERROR WITH NOWAIT）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAIT指定により即時出力） |
| 優先度 | 低（情報レベル：severity 0） |
| リトライ | 無し |

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。特定の宛先決定ロジックは存在しない。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | クライアントのメッセージストリーム |
| メッセージレベル | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Starting loop through databases
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | ループ処理開始 | カーソル宣言後、OPEN前 | データベースリストのカーソルを使用してループを開始する直前 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | sp_BlitzIndex実行時は常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzIndex開始] --> B[パラメータ検証・初期化]
    B --> C[DaysUptime計算完了]
    C --> D["RAISERROR('Starting loop through databases',0,1) WITH NOWAIT"]
    D --> E[DECLARE c1 CURSOR]
    E --> F[OPEN c1]
    F --> G[FETCH NEXT FROM c1]
    G --> H{FETCH_STATUS = 0?}
    H -->|Yes| I[データベース処理]
    H -->|No| J[CLOSE c1]
    I --> G
    J --> K[DEALLOCATE c1]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #DatabaseList | 処理対象データベースリスト | カーソルのソース |
| #Ignore_Databases | 除外データベースリスト | LEFT JOIN で除外判定 |
| sys.databases | データベースIDの取得 | ループ内で参照 |

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

#### #DatabaseList
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| DatabaseName | 処理対象データベース名 | secondary_role_allow_connections_descがNOでない |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 本通知時点では更新処理は行わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は情報出力のみでエラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzIndex実行時に常に出力）

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

- 本通知は固定の情報メッセージであり、機密情報を含まない
- VIEW SERVER STATE権限を持つユーザーのみがsp_BlitzIndexを実行可能

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- ループ内では、各データベース名が個別にRAISERRORで出力される（行1218）
- カーソルはLOCAL FAST_FORWARD指定により、効率的に処理される

---

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

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

### 推奨読解順序

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

ループ対象となるデータベースリストの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | #DatabaseListテーブルの構造と投入データを確認 |
| 1-2 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | #Ignore_Databasesテーブルの構造を確認 |

**読解のコツ**: #DatabaseListへのデータ投入ロジックを追跡し、どのデータベースが処理対象となるかを理解する。

#### Step 2: カーソル宣言とループ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 行1199-1212のカーソル宣言部分 |

**主要処理フロー**:
1. **行1199**: `RAISERROR (N'Starting loop through databases',0,1) WITH NOWAIT;`
2. **行1200-1208**: カーソルc1の宣言（LOCAL FAST_FORWARD）
3. **行1210**: `OPEN c1;`
4. **行1211**: `FETCH NEXT FROM c1 INTO @DatabaseName;`
5. **行1212**: `WHILE @@FETCH_STATUS = 0`

#### Step 3: ループ内処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 行1214-1270のループ内初期処理 |

**主要処理フロー**:
- **行1216-1218**: 改行と現在のデータベース名の出力
- **行1220-1224**: sys.databasesからデータベースID取得
- **行1230-1269**: パラメータ検証と初期化

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

```
sp_BlitzIndex（エントリーポイント）
    │
    ├─ 一時テーブル作成
    │
    ├─ #DatabaseListにデータ投入
    │
    ├─ @DaysUptime計算
    │
    ├─ RAISERROR('Starting loop through databases') ← 本通知
    │
    ├─ DECLARE CURSOR c1
    │
    ├─ OPEN c1
    │
    └─ WHILE @@FETCH_STATUS = 0
           ├─ RAISERROR(@DatabaseName)
           ├─ データ収集処理
           ├─ 分析処理
           └─ FETCH NEXT
```

### データフロー図

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

#DatabaseList            ───▶ カーソル宣言               ───▶ クライアントメッセージ
  │                             │                                 「Starting loop through databases」
  │                             │
  └─ DatabaseName        ───▶ WHILE ループ               ───▶ 各DB名のメッセージ出力
                                │
                                └─ データベースごとの処理
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | ソース | メインプロシージャ。ループ開始通知を出力（行1199） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行22522） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行15427） |
