# 機能設計書 99-Get-DbaDbAssembly

## 概要

本ドキュメントは、SQL ServerデータベースのCLRアセンブリを取得するGet-DbaDbAssemblyコマンドの機能設計書である。

### 本機能の処理概要

Get-DbaDbAssemblyは、SQL Serverデータベースに登録されているCommon Language Runtime（CLR）アセンブリの詳細情報を取得する機能である。セキュリティ監査、バージョン追跡、および未承認コードの特定に役立つ。

**業務上の目的・背景**：CLRアセンブリはデータベース内でカスタム.NETコードを実行可能にするため、セキュリティリスクとなる可能性がある。本機能はアセンブリのセキュリティレベル、所有者、作成日、バージョン情報などをインベントリ化し、セキュリティコンプライアンス監査や不正なコードの検出に活用される。

**機能の利用シーン**：CLRアセンブリのセキュリティ監査、マイグレーション前のアセンブリ棚卸し、Unsafeアセンブリの検出、アセンブリバージョンの追跡、および特定アセンブリの調査時に利用される。

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続を確立
2. アクセス可能なデータベースのAssembliesコレクションを列挙
3. オプションでデータベース名またはアセンブリ名でフィルタ
4. 各アセンブリにメタデータを付加して出力

**関連システム・外部連携**：SQL Server SMO（Database.Assemblies）を使用してsys.assembliesのアセンブリ情報にアクセス。

**権限による制御**：データベースへのアクセス権限が必要。アセンブリメタデータの読み取りにはVIEW DEFINITION権限が推奨される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドラインインターフェース | 主画面 | PowerShellコンソールまたはスクリプトから実行 |

## 機能種別

データ取得（SMO経由でのアセンブリ情報読み取り）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Database | String[] | No | 対象データベース名（ワイルドカード対応） | - |
| Name | String[] | No | 対象アセンブリ名（完全一致） | - |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

SQL Server SMO Database.Assembliesコレクション（sys.assembliesビューに対応）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverホストのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Database | String | アセンブリを含むデータベース名 |
| ID | Int32 | アセンブリの一意識別子 |
| Name | String | アセンブリ名 |
| Owner | String | アセンブリの所有者 |
| SecurityLevel | String | セキュリティレベル（Safe, ExternalAccess, Unsafe） |
| CreateDate | DateTime | アセンブリ作成日時 |
| IsSystemObject | Boolean | システムオブジェクトかどうか |
| Version | String | アセンブリバージョン情報 |
| DatabaseId | Int32 | データベースの一意識別子 |

### 出力先

PowerShellパイプラインに直接出力される

## 処理フロー

### 処理シーケンス

```
1. Process処理：各インスタンスに対してループ
   └─ Connect-DbaInstanceでSQL Serverに接続
2. アクセス可能なデータベースの取得
   └─ IsAccessibleでフィルタ
3. データベースフィルタリング（オプション）
   └─ Databaseパラメータで指定されたデータベースのみ
4. Assembliesコレクションの取得
   └─ 各データベースのAssembliesを列挙
5. アセンブリフィルタリング（オプション）
   └─ Nameパラメータで指定されたアセンブリのみ
6. メタデータの付加と出力
   └─ Add-Memberでプロパティを追加、Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各SqlInstanceをループ}
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    E --> B
    D -->|Yes| F[IsAccessible DBを取得]
    F --> G{Database指定あり?}
    G -->|Yes| H[Databaseでフィルタ]
    G -->|No| I{各DBをループ}
    H --> I
    I --> J[Assemblies取得]
    J --> K{Name指定あり?}
    K -->|Yes| L[Nameでフィルタ]
    K -->|No| M{各Assemblyをループ}
    L --> M
    M --> N[Add-Member]
    N --> O[Select-DefaultView]
    O --> M
    M -->|完了| I
    I -->|完了| B
    B -->|完了| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-99-1 | アクセス可能DBのみ | IsAccessible=trueのデータベースのみ処理 | 常時 |
| BR-99-2 | セキュリティレベル | Safe, ExternalAccess, Unsafeの3段階 | アセンブリ毎 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| アセンブリ情報取得 | sys.assemblies | SELECT | SMO経由でアセンブリメタデータを取得 |

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

#### sys.assemblies

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | assembly_id, name, principal_id, permission_set, create_date, etc. | 全アセンブリ | SMO Assemblies経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionでエラー記録、次インスタンスに継続 |
| - | アセンブリ取得エラー | 権限不足等 | Stop-Functionでエラー記録、次DBに継続 |

### リトライ仕様

リトライ機構は実装されていない。

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

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

## パフォーマンス要件

SMO経由でのメタデータ取得は軽量な操作。

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

- データベースへのアクセス権限が必要
- VIEW DEFINITION権限でアセンブリメタデータの完全な読み取りが可能
- Unsafeアセンブリの検出はセキュリティ監査に重要

## 備考

- CLRアセンブリはSQL Server 2005以降でサポート
- セキュリティレベルがUnsafeのアセンブリは特に注意が必要

---

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

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

### 推奨読解順序

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

出力されるオブジェクトはSMOのAssemblyオブジェクトに追加プロパティを付与したものである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbAssembly.ps1 | `public/Get-DbaDbAssembly.ps1` | 44-68行目の.OUTPUTSセクション |

**読解のコツ**: AssemblySecurityLevel as SecurityLevelでプロパティ名が変換される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbAssembly.ps1 | `public/Get-DbaDbAssembly.ps1` | 85-93行目のparam block |

**主要処理フロー**:
1. **85-93行目**: パラメータ定義
2. **95-127行目**: process block（メイン処理）
3. **102行目**: IsAccessibleでフィルタ

#### Step 3: フィルタリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbAssembly.ps1 | `public/Get-DbaDbAssembly.ps1` | 103-111行目のフィルタ処理 |

**主要処理フロー**:
- **103-104行目**: Databaseパラメータでのフィルタ
- **109-110行目**: Nameパラメータでのフィルタ

#### Step 4: メタデータ付加を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbAssembly.ps1 | `public/Get-DbaDbAssembly.ps1` | 114-120行目のAdd-Member処理 |

**主要処理フロー**:
- **114-118行目**: ComputerName, InstanceName, SqlInstance, Database, DatabaseIdを追加
- **120行目**: Select-DefaultViewで出力整形

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

```
Get-DbaDbAssembly
    │
    ├─ Connect-DbaInstance (接続確立)
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Databases (DBリスト取得)
    │      └─ Where-Object IsAccessible
    │
    └─ $db.Assemblies (アセンブリ取得)
           │
           ├─ Add-Member (ComputerName)
           ├─ Add-Member (InstanceName)
           ├─ Add-Member (SqlInstance)
           ├─ Add-Member (Database)
           ├─ Add-Member (DatabaseId)
           │
           └─ Select-DefaultView (出力整形)
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance  ───▶ SMO Server
Database             │
Name                 ▼
                Databases取得
                (IsAccessibleフィルタ)
                     │
                     ▼
                Databaseフィルタ
                (オプション)
                     │
                     ▼
                Assemblies取得
                     │
                     ▼
                Nameフィルタ
                (オプション)
                     │
                     ▼
                メタデータ付加
                     │
                     ▼
              Select-DefaultView ───▶ Assembly オブジェクト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbAssembly.ps1 | `public/Get-DbaDbAssembly.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
