# 機能設計書 681-Find-DbaView

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Find-DbaView` コマンドレットに関する機能設計書です。データベースビューの定義内で特定のテキストパターンや正規表現を検索し、マッチするビューを特定するための機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：データベース管理において、ビュー定義内の特定のテーブル参照、列名、ビジネスロジック、またはセキュリティ上問題となるパターン（メールアドレス、社会保障番号等）を検索する必要が頻繁に発生します。スキーマ変更前の影響分析、コードレビュー、セキュリティ監査など、様々な場面でビュー定義の検索が必要となります。

**機能の利用シーン**：
- テーブル名変更前に、そのテーブルを参照しているビューを特定する場合
- データベース内で個人情報（PII）を含む可能性のあるビューを検索する場合
- 特定のビジネスロジックや計算式を含むビューを調査する場合
- トラブルシューティング時に特定のコード構造を持つビューを検索する場合

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへ接続
2. 対象データベース内のビューを取得（システムビュー除外オプション対応）
3. 各ビューのTextBody（定義本文）に対してパターンマッチングを実行
4. マッチしたビューの情報と、マッチした行番号・内容を返却

**関連システム・外部連携**：SQL Server Management Objects (SMO) を使用してSQL Serverインスタンスと通信します。SQL Server 2005以上をサポートします。

**権限による制御**：ビュー定義を取得するためには、対象データベースへのVIEW DEFINITION権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 42 | ビュー管理 | 補助機能 | ビューの検索 |

## 機能種別

データ検索（ビュー定義のパターン検索）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL/AD認証対応 |
| Database | object[] | No | 検索対象データベース | ワイルドカード対応 |
| ExcludeDatabase | object[] | No | 除外するデータベース | 複数指定可能 |
| Pattern | string | Yes | 検索パターン（正規表現） | 正規表現構文 |
| IncludeSystemObjects | switch | No | システムビューを含める | デフォルト: $false |
| IncludeSystemDatabases | switch | No | システムDBを含める | デフォルト: $false |
| EnableException | switch | No | 例外を有効化 | デフォルト: $false |

### 入力データソース

- SQL Serverインスタンスのsys.views および sys.sql_modules システムビュー
- SMO View.TextBody プロパティ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | サーバー名 |
| SqlInstance | string | インスタンス名 |
| Database | string | データベース名 |
| DatabaseId | int | データベースID |
| Schema | string | ビューのスキーマ |
| Name | string | ビュー名 |
| Owner | string | ビューの所有者 |
| IsSystemObject | bool | システムオブジェクトかどうか |
| CreateDate | DateTime | 作成日時 |
| LastModified | DateTime | 最終変更日時 |
| ViewTextFound | string | マッチした行（行番号付き） |
| View | SMO.View | SMOビューオブジェクト（非表示） |
| ViewFullText | string | ビュー定義全文（非表示） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 初期化（begin）
   └─ SQLクエリの構築とカウンター初期化
2. インスタンス接続（process）
   └─ Connect-DbaInstance による接続確立
3. バージョンチェック
   └─ SQL Server 2005未満は警告を出力してスキップ
4. データベース取得
   └─ システムDBフィルタリング適用
5. ビュー検索ループ
   └─ 各DBのビューに対してパターンマッチング実行
6. 結果出力
   └─ マッチしたビュー情報をパイプラインに出力
7. 終了処理（end）
   └─ 検索完了メッセージの出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQLクエリ構築]
    B --> C{各インスタンスをループ}
    C --> D[Connect-DbaInstance]
    D --> E{バージョン >= SQL 2005?}
    E -->|No| F[警告出力してスキップ]
    E -->|Yes| G[データベース取得]
    G --> H{システムDB含める?}
    H -->|Yes| I[全DBを取得]
    H -->|No| J[システムDBを除外]
    I --> K[DBフィルタ適用]
    J --> K
    K --> L{各データベースをループ}
    L --> M{システムオブジェクト含める?}
    M -->|No| N[SQL実行でビュー取得]
    M -->|Yes| O[SMOでビュー取得]
    N --> P{TextBodyがパターンにマッチ?}
    O --> P
    P -->|Yes| Q[結果オブジェクト作成・出力]
    P -->|No| R[次のビューへ]
    Q --> R
    R --> L
    L -->|完了| C
    C -->|完了| S[終了]
    F --> C
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | バージョン制限 | SQL Server 2005以上が必要 | 常時 |
| BR-002 | システムオブジェクト除外 | デフォルトでis_ms_shipped=0のビューのみ | IncludeSystemObjects未指定時 |
| BR-003 | システムDB除外 | デフォルトでシステムDBを除外 | IncludeSystemDatabases未指定時 |
| BR-004 | 正規表現パターン | Patternは正規表現として評価される | 常時 |

### 計算ロジック

マッチした行の抽出:
```powershell
$viewText = $vw.TextBody.split($eol)
$vwTextFound = $viewText | Select-String -Pattern $Pattern | ForEach-Object {
    "(LineNumber: $($_.LineNumber)) $($_.ToString().Trim())"
}
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ビュー一覧取得 | sys.views, sys.sql_modules | SELECT | ビュー定義の取得 |

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

#### sys.views, sys.sql_modules

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | object_id, name, definition | is_ms_shipped条件付き | システムオブジェクト除外可能 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンス接続失敗 | Stop-Functionで警告出力、次のインスタンスへ継続 |
| VersionError | バージョン警告 | SQL Server 2000以下 | 警告メッセージ出力、スキップ |

### リトライ仕様

リトライ処理なし（接続エラー時は次のインスタンスへ継続）

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

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

## パフォーマンス要件

- 大量のビューが存在する場合、IncludeSystemObjectsを指定すると処理時間が増加
- SQLクエリによる事前フィルタリングにより、SMO列挙を最小化

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

- VIEW DEFINITION権限が必要
- 認証情報はSecureStringとして扱われる
- 接続にはConnect-DbaInstanceを使用し、MFA対応

## 備考

- 出力のViewTextFoundプロパティには、マッチした行が行番号付きで結合されて格納される
- ViewおよびViewFullTextプロパティはデフォルトビューでは非表示

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Find-DbaView.ps1 | `public/Find-DbaView.ps1` | 出力されるPSCustomObjectの構造（177-191行目） |

**読解のコツ**: PowerShellのPSCustomObjectは、ハッシュテーブル形式で定義されるカスタムオブジェクト。Select-DefaultViewで表示プロパティを制御している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Find-DbaView.ps1 | `public/Find-DbaView.ps1` | paramブロックでパラメータ定義を確認（104-115行目） |

**主要処理フロー**:
1. **117-123行目**: beginブロックでSQLクエリ構築と初期化
2. **125-130行目**: インスタンス接続処理
3. **132-135行目**: バージョンチェック（SQL 2005未満は警告）
4. **137-149行目**: データベースフィルタリング処理
5. **159-193行目**: 非システムオブジェクト時のSQL実行パス
6. **194-226行目**: システムオブジェクト含む場合のSMO列挙パス

#### Step 3: ビュー検索ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Find-DbaView.ps1 | `public/Find-DbaView.ps1` | パターンマッチングと結果構築（171-192行目） |

**主要処理フロー**:
- **118行目**: SQLクエリ定義（sys.views と sys.sql_modules の結合）
- **119行目**: システムオブジェクト除外条件の追加
- **171行目**: TextBodyに対する-match演算子によるパターンマッチング
- **174-175行目**: Select-Stringによる行単位のマッチング抽出

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

```
Find-DbaView
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ $db.ExecuteWithResults($sql)
    │      └─ sys.views/sys.sql_modules からビュー情報取得
    │
    ├─ $db.Views（SMO列挙）
    │      └─ IncludeSystemObjects時のみ使用
    │
    └─ Select-DefaultView
           └─ 出力プロパティのフィルタリング
```

### データフロー図

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

SqlInstance ───────▶ Connect-DbaInstance ────▶ Server Object
      │
Pattern ───────────▶ SQL実行/SMO列挙 ─────────▶ View一覧
      │                    │
      └─────────────────▶ -match パターン検索 ─▶ マッチ行抽出
                           │
                           └──────────────────▶ PSCustomObject
                                                 (ViewTextFound等)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Find-DbaView.ps1 | `public/Find-DbaView.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続ユーティリティ |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力フォーマット制御 |
