# 機能設計書 662-Get-DbaStartupProcedure

## 概要

本ドキュメントは、SQL Server起動時に自動実行されるよう設定されたストアドプロシージャを取得するGet-DbaStartupProcedure機能の設計仕様を記述したものである。

### 本機能の処理概要

Get-DbaStartupProcedureは、masterデータベースからSQL Serverの起動時に自動実行されるよう構成されたストアドプロシージャを取得する機能である。

**業務上の目的・背景**：スタートアッププロシージャは、アプリケーション設定の初期化、キャッシュテーブルの事前投入、またはSQL Serverサービス開始時に毎回実行する必要があるタスクに使用される。サーバー構成の監査、起動問題のトラブルシューティング、または重要な初期化プロシージャが適切に構成されているかの確認のために、これらのプロシージャを特定する必要がある。

**機能の利用シーン**：
- サーバー構成監査時のスタートアッププロシージャ確認
- 起動時のパフォーマンス問題調査
- 新環境へのマイグレーション時の構成確認
- Central Management Serverを使用した複数サーバーの一括チェック

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. EnumStartupProcedures()メソッドによるスタートアッププロシージャ一覧取得
3. masterデータベースからStoredProcedureオブジェクトの取得
4. 指定されたプロシージャ名によるフィルタリング（オプション）
5. 結果オブジェクトへのメタデータ付加とパイプライン出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してSQL ServerのEnumStartupProcedures()を呼び出し、スタートアッププロシージャを列挙する。

**権限による制御**：masterデータベースおよびシステムプロシージャへの読み取りアクセス権限が必要。sysadmin権限推奨。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール | 主画面 | コマンド実行とテキスト出力表示 |

## 機能種別

データ参照（SELECT） / サーバー構成情報取得

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL/AD認証対応 |
| StartupProcedure | string[] | No | 確認対象のプロシージャ名 | schema.procedure形式対応 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstance: パイプラインまたはパラメータから取得（必須）
- StartupProcedure: オプションのフィルタ条件

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Database | string | データベース名（常に"master"） |
| Schema | string | スキーマ名 |
| ObjectId | int | オブジェクトID |
| CreateDate | DateTime | 作成日時 |
| DateLastModified | DateTime | 最終更新日時 |
| Name | string | ストアドプロシージャ名 |
| ImplementationType | string | 実装タイプ（T-SQL/CLR） |
| Startup | bool | スタートアッププロシージャフラグ（常にtrue） |

### 出力先

パイプライン出力（Microsoft.SqlServer.Management.Smo.StoredProcedure型オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. 各SqlInstanceに対してループ処理開始
   └─ Connect-DbaInstanceで接続確立
2. 接続エラー時の処理
   └─ Stop-FunctionでエラーをContinue
3. EnumStartupProcedures()呼び出し
   └─ サーバーからスタートアッププロシージャ一覧を取得
4. 各スタートアッププロシージャに対する処理
   └─ StartupProcedureパラメータ指定時はフィルタリング
5. masterデータベースからStoredProcedureオブジェクト取得
   └─ Item(Name, Schema)メソッドで取得
6. NoteProperty追加と出力
   └─ Select-DefaultViewでフォーマット
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function -Continue]
    D -->|Yes| F[EnumStartupProcedures]
    E --> G{次のInstance?}
    F --> H{結果あり?}
    H -->|No| G
    H -->|Yes| I[各startupProcループ]
    I --> J{StartupProcedure指定?}
    J -->|Yes| K[Get-ObjectNameParts解析]
    J -->|No| L[returnProc = true]
    K --> M{名前一致?}
    M -->|No| N[Continue]
    M -->|Yes| L
    N --> O{次のProc?}
    L --> P[masterからSP取得]
    P --> Q[NoteProperty追加]
    Q --> R[Select-DefaultView出力]
    R --> O
    O -->|Yes| I
    O -->|No| G
    G -->|Yes| B
    G -->|No| S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-662-1 | master固定 | スタートアッププロシージャは常にmasterデータベースから取得 | 常時 |
| BR-662-2 | プロシージャ名フィルタ | StartupProcedure指定時、名前とスキーマの両方が一致するもののみ返す | StartupProcedure指定時 |
| BR-662-3 | 解析失敗時継続 | Get-ObjectNamePartsで解析できないプロシージャ名はスキップ | StartupProcedure指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 取得 | sys.procedures (SMO経由) | SELECT | スタートアッププロシージャ取得 |

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

#### EnumStartupProcedures (SMO)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | Name, Schema | Startup = true のプロシージャ | サーバーメソッド呼び出し |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | Stop-Function -Continue で次インスタンスへ |
| - | Verbose | プロシージャ名解析失敗 | Verboseメッセージ出力後継続 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- EnumStartupProcedures()は軽量なサーバーメソッド呼び出し
- スタートアッププロシージャは通常少数のため、パフォーマンス影響は最小限

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

- SqlCredentialパラメータで認証情報を安全に受け渡し
- Windows認証、SQL認証、AD認証に対応
- MFAサポートはConnect-DbaInstance経由で利用可能

## 備考

- Get-DbaRegServerと連携することで、Central Management Server配下の全サーバーのスタートアッププロシージャを一括確認可能
- SMOのStoredProcedureオブジェクトをそのまま返すため、追加のプロパティもSelect-Object *で参照可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | DbaInstanceParameter | `internal/types/` | SQL Serverインスタンス指定の型定義 |

**読解のコツ**: EnumStartupProceduresの戻り値はDataTableで、Name列とSchema列を含む。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaStartupProcedure.ps1 | `public/Get-DbaStartupProcedure.ps1` | メイン処理の流れを把握 |

**主要処理フロー**:
1. **93-98行目**: 各インスタンスへの接続処理
2. **101行目**: EnumStartupProcedures()呼び出し
3. **103-104行目**: 結果の存在チェックとmaster DB取得
4. **106-125行目**: StartupProcedureフィルタリング処理
5. **126行目**: StoredProcedureオブジェクト取得
6. **128-135行目**: NoteProperty追加とデフォルトビュー出力

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-ObjectNameParts | `internal/functions/` | プロシージャ名解析 |
| 3-2 | Connect-DbaInstance | `public/Connect-DbaInstance.ps1` | 接続確立処理 |

**主要処理フロー**:
- **Get-ObjectNameParts**: schema.name形式を解析してSchemaとNameに分解

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

```
Get-DbaStartupProcedure
    │
    ├─ Connect-DbaInstance (接続)
    │
    ├─ $server.EnumStartupProcedures() (一覧取得)
    │
    ├─ Get-ObjectNameParts (名前解析)
    │      └─ フィルタリング用
    │
    ├─ $db.StoredProcedures.Item() (SP取得)
    │
    ├─ Add-Member (プロパティ追加)
    │
    └─ Select-DefaultView (出力フォーマット)
```

### データフロー図

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

SqlInstance ───────┐
                   │
SqlCredential ─────┼──▶ Connect-DbaInstance ───▶ Server
                   │
                   └──▶ EnumStartupProcedures() ▶ DataTable
                              │
                              ▼
StartupProcedure ─────▶ Filter (Name/Schema) ──▶ Matched Rows
                              │
                              ▼
                        Item(Name, Schema) ────▶ StoredProcedure
                              │
                              ▼
                        Add-Member ─────────────▶ 拡張SP
                              │
                              ▼
                        Select-DefaultView ────▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaStartupProcedure.ps1 | `public/Get-DbaStartupProcedure.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | 接続確立 |
| Get-ObjectNameParts.ps1 | `internal/functions/` | ソース | オブジェクト名解析 |
| Select-DefaultView.ps1 | `internal/functions/` | ソース | 出力フォーマット |
