# 機能設計書 352-Get-DbaDbLogShipError

## 概要

本ドキュメントは、SQL Serverログシッピング環境で発生したエラー情報を取得する `Get-DbaDbLogShipError` コマンドの機能設計書である。

### 本機能の処理概要

本機能は、msdbデータベースのログシッピング監視エラー詳細テーブルから、バックアップ、コピー、リストア各操作で発生したエラー情報を取得し、トラブルシューティングを支援する。

**業務上の目的・背景**：ログシッピングはSQL Serverの災害復旧ソリューションとして広く利用されている。バックアップ、コピー、リストアの各フェーズで障害が発生した場合、原因特定のためにプライマリとセカンダリの両インスタンスのシステムテーブルを確認する必要がある。本機能により、エラー詳細を一括で取得でき、障害対応時間を短縮できる。

**機能の利用シーン**：
- ログシッピング障害発生時のトラブルシューティング
- 日次・週次のログシッピング健全性レポート作成
- 特定期間のエラー傾向分析
- プライマリまたはセカンダリ側のみのエラー確認

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. msdbの一時テーブルにログシッピングデータベースIDを収集
3. log_shipping_monitor_error_detailテーブルからエラー情報を取得
4. フィルタ条件（Database, Action, 日時範囲, Primary/Secondary）を適用
5. 結果をPSCustomObjectとしてパイプラインに出力

**関連システム・外部連携**：ログシッピング監視インスタンスのmsdbデータベースを参照。プライマリおよびセカンダリデータベースのエラー情報を統合取得。

**権限による制御**：sysadmin権限が必要。Express Editionはログシッピング非対応のため警告を出力してスキップ。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | PowerShellコンソール | 主画面 | コマンド実行および結果表示 |

## 機能種別

データ検索 / エラー情報取得

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | DbaInstanceParameter型変換 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効な資格情報 |
| Database | String[] | No | 対象データベース名（完全一致） | - |
| ExcludeDatabase | String[] | No | 除外データベース名（完全一致） | - |
| Action | String[] | No | フィルタ対象アクション | ValidateSet: Backup, Copy, Restore |
| DateTimeFrom | DateTime | No | エラー取得開始日時 | 有効なDateTime |
| DateTimeTo | DateTime | No | エラー取得終了日時 | 有効なDateTime |
| Primary | Switch | No | プライマリ側エラーのみ取得 | - |
| Secondary | Switch | No | セカンダリ側エラーのみ取得 | - |
| EnableException | Switch | No | 例外制御 | - |

### 入力データソース

- msdb.dbo.log_shipping_secondary_databases
- msdb.dbo.log_shipping_primary_databases
- msdb.dbo.log_shipping_monitor_error_detail

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが稼働するコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Database | String | エラー発生データベース名 |
| Instance | String | ロール（Primary / Secondary） |
| Action | String | 操作種別（Backup / Copy / Restore） |
| SessionID | Int | ログシッピングセッションID |
| SequenceNumber | Int | エラーシーケンス番号 |
| LogTime | DateTime | エラー記録日時 |
| Message | String | エラーメッセージ詳細 |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. インスタンス接続
   └─ Connect-DbaInstance（MinimumVersion 9 = SQL Server 2005以上）

2. Express Editionチェック
   └─ Express Editionの場合は警告出力してスキップ

3. T-SQLクエリ実行
   ├─ 一時テーブル#DatabaseIDを作成
   ├─ log_shipping_secondary_databasesからセカンダリDB情報取得
   ├─ log_shipping_primary_databasesからプライマリDB情報取得
   └─ log_shipping_monitor_error_detailと結合してエラー取得

4. 結果フィルタリング（PowerShell）
   ├─ Database フィルタ
   ├─ Action フィルタ
   ├─ DateTimeFrom フィルタ
   ├─ DateTimeTo フィルタ
   ├─ Primary フィルタ
   └─ Secondary フィルタ

5. 結果出力
   └─ PSCustomObjectとしてパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceループ開始]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[エラー出力、次へ]
    D -->|Yes| F{Express Edition?}
    F -->|Yes| G[警告出力、スキップ]
    F -->|No| H[T-SQLクエリ実行]
    H --> I{結果あり?}
    I -->|No| J[Verboseメッセージ出力]
    I -->|Yes| K[フィルタ適用]
    K --> L[PSCustomObject生成]
    L --> M[パイプライン出力]
    M --> N{次のインスタンス?}
    E --> N
    G --> N
    J --> N
    N -->|Yes| B
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | SQL Server 2005以上必須 | MinimumVersion 9で接続 | 常時 |
| BR-002 | Express Edition非対応 | 警告メッセージ出力してスキップ | EngineEditionがExpressの場合 |
| BR-003 | agent_type変換 | 0=Backup, 1=Copy, 2=Restore | T-SQL内CASE式 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| エラー取得 | msdb.dbo.log_shipping_monitor_error_detail | SELECT | エラー詳細取得 |
| DB ID取得 | msdb.dbo.log_shipping_secondary_databases | SELECT | セカンダリDB ID取得 |
| DB ID取得 | msdb.dbo.log_shipping_primary_databases | SELECT | プライマリDB ID取得 |

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

#### msdb.dbo.log_shipping_monitor_error_detail

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | agent_id, agent_type, session_id, sequence_number, log_time, message | #DatabaseIDとの結合 | agent_typeで操作種別判定 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンス接続失敗 | Stop-Function、次のインスタンスへ |
| ExpressEdition | 機能非対応 | Express Edition検出 | 警告出力、continue |

### リトライ仕様

リトライ処理なし。

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

読み取り専用操作。一時テーブル作成・削除はセッション内で完結。

## パフォーマンス要件

- 大量のエラーレコードがある場合、フィルタ条件の活用を推奨

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

- sysadmin権限が必要
- SqlCredentialパラメータで代替認証対応

## 備考

- SQL Server 2005以上で動作
- Express Editionは非対応

---

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

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

### 推奨読解順序

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

ログシッピング関連のmsdbテーブル構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbLogShipError.ps1 | `public/Get-DbaDbLogShipError.ps1` | T-SQLクエリ（139-196行目）でテーブル構造確認 |

**読解のコツ**: T-SQLクエリ内の一時テーブル#DatabaseIDがプライマリ/セカンダリの識別に使用される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbLogShipError.ps1 | `public/Get-DbaDbLogShipError.ps1` | 関数全体の処理フロー |

**主要処理フロー**:
1. **111-125行目**: パラメータ定義
2. **126-138行目**: インスタンス接続とExpress Editionチェック
3. **139-196行目**: T-SQLクエリ定義
4. **199-226行目**: 結果のフィルタリング処理
5. **228-241行目**: PSCustomObject生成と出力

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

```
Get-DbaDbLogShipError
    │
    ├─ Connect-DbaInstance (MinimumVersion 9)
    │
    ├─ $server.Query($query)
    │      └─ msdb一時テーブル作成・結合・削除
    │
    └─ Where-Object (各種フィルタ)
           └─ PSCustomObject出力
```

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance
                         │
                         ▼
              T-SQLクエリ実行
              (msdb参照)
                         │
                         ▼
              PowerShellフィルタ ───▶ PSCustomObject
              (Database/Action/DateTime/Primary/Secondary)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbLogShipError.ps1 | `public/Get-DbaDbLogShipError.ps1` | ソース | メイン関数 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
