# 機能設計書 263-Get-DbaDbMailLog

## 概要

本ドキュメントは、SQL ServerのDatabase Mailイベントログを取得するGet-DbaDbMailLogコマンドレットの機能設計を記述する。

### 本機能の処理概要

Get-DbaDbMailLogは、SQL Serverのmsdb.dbo.sysmail_event_logテーブルからDatabase Mailイベントログを取得するPowerShellコマンドレットである。メール送信試行、失敗、システムイベントに関する詳細情報を取得でき、Database Mail問題の診断、メール配信ステータスの監視、構成問題の特定に活用される。

**業務上の目的・背景**：Database Mailは、SQL Serverからの自動通知やアラート送信に不可欠な機能である。本コマンドは、メール配信失敗の原因調査、SMTPサーバー接続問題の診断、Database Mail全般の動作監視といった業務課題を解決する。イベントタイプ（Error、Warning、Success、Information、Internal）でフィルタリングすることで、問題の特定を効率化できる。

**機能の利用シーン**：
- メール配信障害発生時のエラーログ確認
- SMTPサーバー接続問題のトラブルシューティング
- Database Mail初期設定時の動作確認
- 定期的な監視・監査レポートの作成
- 特定期間のイベント履歴分析

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. msdb.dbo.sysmail_event_logテーブルへのSELECTクエリ実行
3. Since（日時）およびType（イベントタイプ）によるフィルタリング
4. 結果をPSCustomObjectとしてパイプライン出力

**関連システム・外部連携**：msdbデータベースのsysmail_event_logシステムテーブルに直接T-SQLクエリを発行する。SMOではなくT-SQLを使用して効率的なデータ取得を実現。

**権限による制御**：msdbデータベースへの読み取りアクセス権限が必要。sysadminサーバーロールまたはDatabaseMailUserRoleデータベースロールのメンバーシップが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 52 | データベースメール | 補助機能 | メールログの取得 |

## 機能種別

データ取得（SELECT）/ ログ・履歴参照

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 接続先SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証用資格情報 | Windows/SQL認証対応 |
| Since | DateTime | No | 指定日時以降のログのみ取得 | 有効なDateTime値 |
| Type | string[] | No | イベントタイプでフィルタ | Error/Warning/Success/Information/Internal |
| EnableException | switch | No | 例外を直接スローするかどうか | - |

### 入力データソース

- SqlInstance: ユーザー指定（パイプライン入力対応）
- Since/Type: オプションのフィルタ条件

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホスト名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| LogId | int | ログエントリの一意識別子 |
| EventType | string | イベントタイプ（Error/Warning/Success/Information/Internal） |
| LogDate | DateTime | イベント発生日時 |
| Description | string | イベントの詳細説明・エラーメッセージ |
| ProcessId | int | 関連プロセスID |
| MailItemId | int | 関連メールアイテムID |
| AccountId | int | Database MailアカウントID |
| LastModDate | DateTime | 最終更新日時 |
| LastModUser | string | 最終更新ユーザー |
| Login | string | 最終更新ユーザー（LastModUserと同じ） |

### 出力先

パイプライン出力（PSCustomObject型）

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ SqlInstanceが必要

2. 各インスタンスへの接続
   └─ Connect-DbaInstanceで接続確立

3. SQLクエリの構築
   └─ 基本SELECT文の作成
   └─ WHERE句の動的生成（Since、Type指定時）

4. クエリ実行
   └─ server.Query()メソッドでT-SQL実行

5. 結果の出力
   └─ Select-DefaultViewで既定表示プロパティを設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[foreachインスタンスループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function継続]
    D -->|Yes| F[基本SQL構築]
    F --> G{Since/Type指定?}
    G -->|Yes| H[WHERE句追加]
    G -->|No| I[クエリ実行]
    H --> I
    I --> J[Select-DefaultView]
    J --> K[結果出力]
    K --> L{次のインスタンス?}
    L -->|Yes| B
    L -->|No| M[終了]
    E --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 日時フィルタ | log_dateがSince以降のレコードを取得 | Sinceパラメータ指定時 |
| BR-002 | タイプフィルタ | event_typeが指定値と一致するレコードを取得 | Typeパラメータ指定時（複数指定可） |
| BR-003 | タイプ正規化 | 小文字のevent_typeをPascalCaseに変換して出力 | 常時 |
| BR-004 | 説明整形 | descriptionから改行+閉じ括弧を除去 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ログ取得 | msdb.dbo.sysmail_event_log | SELECT | イベントログの読み取り |

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

#### msdb.dbo.sysmail_event_log

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | log_id, event_type, log_date, description, process_id, mailitem_id, account_id, last_mod_date, last_mod_user | WHERE log_date >= @Since AND/OR event_type IN (@Type) | オプションフィルタ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverに接続できない | 接続設定・資格情報を確認 |
| - | クエリエラー | SQLクエリ実行失敗 | 権限・Database Mail設定を確認 |

### リトライ仕様

なし（即時エラー終了、-Continue指定で次インスタンスへ継続）

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

読み取り専用操作のため、明示的なトランザクション制御なし

## パフォーマンス要件

- 大量のログデータがある場合、Sinceパラメータで期間を限定することを推奨
- Typeフィルタとの組み合わせで効率的なデータ取得が可能

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

- 資格情報はPSCredentialオブジェクトで安全に受け渡し
- Windows認証、SQL認証、AD Password認証、AD Integrated認証をサポート
- ログにはSMTPサーバー情報やエラー詳細が含まれる可能性があるため、出力の取り扱いに注意

## 備考

- Typeパラメータは複数値を指定可能（配列入力）
- 日時はISO 8601形式（yyyy-MM-ddTHH:mm:ss）でSQLに渡される

---

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

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

### 推奨読解順序

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

出力されるPSCustomObjectのプロパティ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMailLog.ps1 | `public/Get-DbaDbMailLog.ps1` | .OUTPUTSセクション（43-65行目）で出力プロパティを確認 |

**読解のコツ**: LogId、EventType、LogDate、Descriptionが主要な情報。Select-Object *でProcessIdやAccountIdも取得可能。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMailLog.ps1 | `public/Get-DbaDbMailLog.ps1` | パラメータ定義（85-94行目）とprocessブロック（95行目） |

**主要処理フロー**:
1. **86-87行目**: SqlInstanceパラメータ（パイプライン入力対応）
2. **90-92行目**: Since、Typeフィルタパラメータ
3. **96-102行目**: Connect-DbaInstanceでの接続処理

#### Step 3: SQLクエリ構築ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbMailLog.ps1 | `public/Get-DbaDbMailLog.ps1` | 動的SQL構築処理（104-141行目） |

**主要処理フロー**:
- **104-124行目**: 基本SELECTクエリ（sysmail_event_log）
- **108-115行目**: event_typeのCASE文でPascalCase変換
- **117行目**: descriptionからCHAR(10)+')'を除去
- **126-141行目**: Since/Type指定時のWHERE句動的生成
- **133-136行目**: 複数Typeのカンマ区切り結合とIN句生成

#### Step 4: クエリ実行と出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbMailLog.ps1 | `public/Get-DbaDbMailLog.ps1` | クエリ実行と結果整形（143-150行目） |

**主要処理フロー**:
- **143行目**: Write-MessageでデバッグログにSQL出力
- **146行目**: server.Query()メソッドでT-SQL実行
- **146行目**: Select-DefaultViewで既定表示プロパティを設定

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

```
Get-DbaDbMailLog
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    ├─ SQLクエリ構築
    │      ├─ 基本SELECT（sysmail_event_log）
    │      ├─ event_type CASE変換
    │      ├─ description整形
    │      └─ WHERE句動的生成（Since/Type）
    │
    ├─ server.Query()
    │      └─ T-SQL実行
    │
    └─ Select-DefaultView
           └─ 出力整形
```

### データフロー図

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

SqlInstance ────────▶ Connect-DbaInstance
                              │
                              ▼
Since ─────────────▶ WHERE句構築 ──────────▶ SQL実行
                              │
Type ──────────────▶         │
                              ▼
                     msdb.dbo.sysmail_event_log
                              │
                              ▼
                     event_type CASE変換
                              │
                              ▼
                     Select-DefaultView
                              │
                              ▼
                     [PSCustomObject]
                     - ComputerName
                     - LogDate
                     - EventType
                     - Description
                     - Login
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMailLog.ps1 | `public/Get-DbaDbMailLog.ps1` | ソース | メイン処理ロジック |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
