# 機能設計書 661-Get-DbaDbStoredProcedure

## 概要

本ドキュメントは、SQL Serverデータベースからストアドプロシージャの詳細なメタデータを取得するGet-DbaDbStoredProcedure機能の設計仕様を記述したものである。

### 本機能の処理概要

Get-DbaDbStoredProcedureは、SQL Serverインスタンス上の1つ以上のデータベースからストアドプロシージャを取得し、スキーマ、作成日、実装タイプなどの詳細情報を返す機能である。

**業務上の目的・背景**：データベース管理者（DBA）がSQL Server環境全体でストアドプロシージャのインベントリを管理し、ドキュメント作成やマイグレーション計画のためにデータベースオブジェクトを分析し、名前やスキーマで特定のプロシージャを検索する必要がある。この機能により、複数のインスタンスやデータベースにまたがるストアドプロシージャの一元管理が可能となる。

**機能の利用シーン**：
- 本番環境のストアドプロシージャ一覧の取得とドキュメント化
- マイグレーション前の影響調査
- 特定スキーマ内のプロシージャ検索
- ユーザー定義プロシージャのみの抽出（システムプロシージャ除外）

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. 対象データベースの決定（フィルタリング含む）
3. SMO（SQL Server Management Objects）を使用したストアドプロシージャメタデータの一括取得
4. 名前、スキーマによるフィルタリング処理
5. システムストアドプロシージャの除外オプション処理
6. 結果オブジェクトへのメタデータ付加とパイプライン出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してSQL Serverと連携し、ストアドプロシージャのメタデータを取得する。

**権限による制御**：対象データベースへの読み取りアクセス権限が必要。データベースがアクセス不可の場合は警告を出力してスキップする。

## 関連画面

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

## 機能種別

データ参照（SELECT） / メタデータ取得

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL/AD認証対応 |
| Database | object[] | No | 検索対象データベース | ワイルドカード対応 |
| ExcludeDatabase | object[] | No | 除外するデータベース | ワイルドカード対応 |
| ExcludeSystemSp | switch | No | システムSPを除外 | - |
| Name | string[] | No | 取得するSP名 | 2部/3部名前対応 |
| Schema | string[] | No | フィルタ対象スキーマ | 複数指定可能 |
| InputObject | Database[] | No | データベースオブジェクト | パイプライン入力可能 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstance: パイプラインまたはパラメータから取得
- InputObject: Get-DbaDatabase等からパイプライン入力
- Name: プロシージャ名の解析にGet-ObjectNameParts内部関数を使用

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ Nameパラメータの解析（Get-ObjectNameParts使用）
2. データベースオブジェクトの取得
   └─ SqlInstance指定時はGet-DbaDatabase呼び出し
3. 各データベースの処理ループ
   └─ アクセス可能性チェック
4. SMOによるストアドプロシージャ一括取得
   └─ ClearAndInitializeでメタデータ効率取得
5. フィルタリング処理
   └─ 名前、スキーマ、システムSP除外
6. 結果オブジェクトの構築と出力
   └─ NotePropertyの追加とデフォルトビュー設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Name指定あり?}
    B -->|Yes| C[Get-ObjectNamePartsで解析]
    B -->|No| D[全SP対象]
    C --> E{解析成功?}
    E -->|No| F[警告出力]
    E -->|Yes| G[fqtns配列に追加]
    D --> H[データベース取得]
    G --> H
    F --> H
    H --> I[各DBループ開始]
    I --> J{アクセス可能?}
    J -->|No| K[警告・スキップ]
    J -->|Yes| L[ClearAndInitialize実行]
    K --> M{次のDB?}
    L --> N[フィルタリング処理]
    N --> O[結果出力]
    O --> M
    M -->|Yes| I
    M -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-661-1 | アクセス不可DB除外 | IsAccessibleがfalseのDBはスキップ | 常時 |
| BR-661-2 | システムSP除外 | ExcludeSystemSp指定時、IsSystemObject=trueを除外 | ExcludeSystemSp指定時 |
| BR-661-3 | 名前解析失敗時継続 | 解析失敗した名前は警告後スキップ | Name指定時 |
| BR-661-4 | 3部名前DB一致 | 3部名前指定時、DB名が一致しない場合はスキップ | Name指定時 |

### 計算ロジック

特になし

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

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

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

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

#### sys.procedures (SMO経由)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | Schema, Name, ID, CreateDate, DateLastModified, ImplementationType, Startup, IsSystemObject | 全件または指定条件 | ClearAndInitializeで効率取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Warning | データベースアクセス不可 | 警告メッセージ出力後継続 |
| - | Warning | 名前解析失敗 | 警告メッセージ出力後継続 |
| - | Stop | 有効なプロシージャ名なし | Stop-Function実行 |
| - | Verbose | プロシージャ未発見 | Verboseメッセージ出力 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- ClearAndInitializeメソッドを使用して、必要なプロパティのみを1クエリで一括取得
- 大規模データベースでもメモリ効率的な処理が可能

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

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

## 備考

- SMOのStoredProcedureオブジェクトをそのまま返すため、追加のプロパティもSelect-Object *で参照可能
- パイプライン入力に対応しており、Get-DbaDatabase等との連携が容易

---

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

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

### 推奨読解順序

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

SMOのStoredProcedureオブジェクトとdbatools独自のパラメータ型を理解する。

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

**読解のコツ**: DbaInstanceParameterはdbatools独自の型で、様々な形式（文字列、SMOオブジェクト等）からSQL Server接続情報を抽出する。

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

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

**主要処理フロー**:
1. **149-171行目**: beginブロックでName解析処理
2. **173-176行目**: SqlInstance指定時のデータベース取得
3. **180-193行目**: データベースループとClearAndInitialize
4. **195-216行目**: 名前・スキーマによるフィルタリング
5. **222-236行目**: 結果オブジェクトの構築と出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-ObjectNameParts | `internal/functions/` | オブジェクト名の解析ロジック |
| 3-2 | Get-DbaDatabase | `public/Get-DbaDatabase.ps1` | データベース取得処理 |
| 3-3 | Select-DefaultView | `internal/functions/` | デフォルト表示プロパティ設定 |

**主要処理フロー**:
- **Get-ObjectNameParts**: 2部/3部名前を解析してDatabase、Schema、Nameに分解

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

```
Get-DbaDbStoredProcedure
    │
    ├─ Get-ObjectNameParts (Name解析)
    │
    ├─ Get-DbaDatabase (DB取得)
    │      └─ Connect-DbaInstance
    │
    ├─ $db.StoredProcedures.ClearAndInitialize (SMO一括取得)
    │
    ├─ Add-Member (プロパティ追加)
    │
    └─ Select-DefaultView (出力フォーマット)
```

### データフロー図

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

SqlInstance ───────────┐
                       │
SqlCredential ─────────┼──▶ Connect-DbaInstance ───▶ Server
                       │
Database ──────────────┤
                       │
ExcludeDatabase ───────┼──▶ Get-DbaDatabase ───────▶ Database[]
                       │
Name ──────────────────┼──▶ Get-ObjectNameParts ───▶ fqtns[]
                       │
Schema ────────────────┤
                       │
ExcludeSystemSp ───────┼──▶ Filter処理 ────────────▶ StoredProcedure[]
                       │
InputObject ───────────┘

StoredProcedure[] ──────▶ Add-Member ──────────────▶ 拡張StoredProcedure
                              │
                              └──▶ Select-DefaultView ▶ パイプライン出力
```

### 関連ファイル一覧

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