# 機能設計書 682-Get-DbaDbView

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaDbView` コマンドレットに関する機能設計書です。SQL Serverデータベース内のビューをメタデータと共に取得し、ドキュメント化や分析に活用するための機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：データベース管理者やデベロッパーは、データベース内のビュー構成を把握し、ドキュメント化、影響分析、または監査目的でビュー一覧を取得する必要があります。各データベースには400以上のシステムビューが存在する可能性があるため、ユーザー定義ビューのみを効率的にフィルタリングする機能が重要です。

**機能の利用シーン**：
- データベースアーキテクチャのドキュメント化作業
- 複数サーバーにわたるビュー構成の監査
- ビューの作成日・変更日の追跡による変更管理
- 特定スキーマ内のビュー一覧の取得
- Get-DbaDatabase と連携した柔軟なビュー取得

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスまたはパイプラインからのデータベースオブジェクトを処理
2. データベース内のビューコレクションを取得
3. フィルタリング条件（スキーマ、ビュー名、システムビュー除外）を適用
4. 各ビューにインスタンス情報を付加して出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 42 | ビュー管理 | 主機能 | ビューの取得 |

## 機能種別

データ取得（ビューメタデータの一覧取得）

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- SQL Server SMO Database.Views コレクション
- Get-DbaDatabase からのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | コンピュータ名（追加プロパティ） |
| InstanceName | string | インスタンス名（追加プロパティ） |
| SqlInstance | string | 完全インスタンス名（追加プロパティ） |
| Database | string | データベース名（追加プロパティ） |
| Schema | string | ビューのスキーマ |
| CreateDate | DateTime | ビュー作成日時 |
| DateLastModified | DateTime | 最終変更日時 |
| Name | string | ビュー名 |
| IsSystemObject | bool | システムオブジェクトかどうか |
| IsEncrypted | bool | 暗号化されているかどうか |
| IsBound | bool | バインドされているかどうか |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.View オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. 初期化（begin）
   └─ View パラメータの3部構成名解析
2. データベース取得（process）
   └─ SqlInstance指定時はGet-DbaDatabase呼び出し
3. ビューコレクション取得
   └─ ClearAndInitialize で必要プロパティのみロード
4. フィルタリング適用
   └─ ビュー名、スキーマ、システムビューのフィルタ
5. プロパティ追加
   └─ ComputerName等のNotePropertyを追加
6. 出力
   └─ Select-DefaultViewで既定プロパティを設定して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Viewパラメータあり?}
    B -->|Yes| C[3部構成名を解析]
    B -->|No| D[process開始]
    C --> D
    D --> E{SqlInstance指定?}
    E -->|Yes| F[Get-DbaDatabase呼び出し]
    E -->|No| G[InputObjectを使用]
    F --> H[各データベースをループ]
    G --> H
    H --> I[Views.ClearAndInitialize]
    I --> J{fqtns指定あり?}
    J -->|Yes| K[指定ビューをフィルタ]
    J -->|No| L[全ビューを取得]
    K --> M{データベースアクセス可能?}
    L --> M
    M -->|No| N[警告出力してスキップ]
    M -->|Yes| O{ビュー存在?}
    N --> H
    O -->|No| P[メッセージ出力してスキップ]
    O -->|Yes| Q{Schemaフィルタあり?}
    P --> H
    Q -->|Yes| R[スキーマでフィルタ]
    Q -->|No| S[次へ]
    R --> S
    S --> T{ExcludeSystemView?}
    T -->|Yes| U[システムビュー除外]
    T -->|No| V[各ビューをループ]
    U --> V
    V --> W[Add-MemberでNoteProperty追加]
    W --> X[Select-DefaultViewで出力]
    X --> V
    V -->|完了| H
    H -->|完了| Y[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 3部構成名解析 | Viewパラメータはdatabase.schema.view形式をサポート | Viewパラメータ指定時 |
| BR-002 | SMO初期化最適化 | ClearAndInitializeで必要プロパティのみロード | 常時 |
| BR-003 | アクセシビリティチェック | IsAccessible=falseのDBはスキップ | 常時 |
| BR-004 | システムビュー除外 | ExcludeSystemView時はIsSystemObject=trueを除外 | ExcludeSystemView指定時 |

### 計算ロジック

3部構成名の解析:
```powershell
$fqtn = Get-ObjectNameParts -ObjectName $v
# Database, Schema, Name に分解
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ビュー一覧取得 | sys.views等 | SELECT | SMO経由でビューメタデータ取得 |

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

#### Database.Views（SMOコレクション）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | Name, Schema, IsSystemObject, CreateDate, DateLastModified | ClearAndInitializeで指定 | 効率的なプロパティ読み込み |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ParseError | 解析警告 | 3部構成名の解析失敗 | Write-Messageで警告、スキップ |
| AccessError | アクセス警告 | データベースアクセス不可 | Write-Messageで警告、スキップ |
| NotFoundError | 情報メッセージ | 指定ビューが存在しない | Write-Messageでメッセージ出力 |

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

- ClearAndInitializeにより必要プロパティのみをSQLクエリで取得
- 大規模環境では ExcludeSystemView を使用して400以上のシステムビューを除外推奨

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

- VIEW DEFINITION権限またはデータベースアクセス権が必要
- 認証情報はSecureStringとして扱われる

## 備考

- SMO Viewオブジェクトをそのまま返却するため、追加のプロパティ（TextBody等）へのアクセスも可能
- Select-DefaultViewで既定の表示プロパティが設定される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbView.ps1 | `public/Get-DbaDbView.ps1` | SMO Viewオブジェクトに追加されるNoteProperty（212-215行目） |

**読解のコツ**: SMOのViewオブジェクトにAdd-MemberでNotePropertyを追加し、dbatools標準の出力形式に整えている。

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

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

**主要処理フロー**:
1. **131-152行目**: beginブロックでViewパラメータの3部構成名解析
2. **158-160行目**: SqlInstance指定時のGet-DbaDatabase呼び出し
3. **167行目**: ClearAndInitializeによる効率的なプロパティ読み込み
4. **169-186行目**: 指定されたビュー名でのフィルタリング
5. **201-206行目**: スキーマおよびシステムビューのフィルタリング
6. **210-218行目**: NoteProperty追加と出力

#### Step 3: SMO最適化を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbView.ps1 | `public/Get-DbaDbView.ps1` | ClearAndInitializeの使用（167行目） |

**主要処理フロー**:
- **167行目**: `$db.Views.ClearAndInitialize('', [string[]]('Name', 'Schema', 'IsSystemObject', 'CreateDate', 'DateLastModified'))` - 必要なプロパティのみを1クエリで取得

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

```
Get-DbaDbView
    │
    ├─ Get-ObjectNameParts（begin）
    │      └─ 3部構成名の解析
    │
    ├─ Get-DbaDatabase（SqlInstance指定時）
    │      └─ データベースオブジェクト取得
    │
    ├─ $db.Views.ClearAndInitialize
    │      └─ SMOビューコレクションの効率的初期化
    │
    ├─ Add-Member
    │      └─ NotePropertyの追加
    │
    └─ Select-DefaultView
           └─ 既定表示プロパティの設定
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaDatabase ─────────▶ Database[]
      │                    │
      └─ or ──────────────▶ InputObject
                           │
Database[] ─────────────▶ Views.ClearAndInitialize ─▶ View[]
                           │
View[] ─────────────────▶ フィルタリング ───────────▶ View[]
                           │                        (フィルタ済み)
View[] ─────────────────▶ Add-Member ──────────────▶ View[]
                           │                        (プロパティ追加済み)
View[] ─────────────────▶ Select-DefaultView ──────▶ 出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbView.ps1 | `public/Get-DbaDbView.ps1` | ソース | メイン機能実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベース取得 |
| Get-ObjectNameParts.ps1 | `internal/functions/Get-ObjectNameParts.ps1` | ソース | 3部構成名解析ユーティリティ |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力フォーマット制御 |
