# 機能設計書 443-Get-DbaReplArticle

## 概要

本ドキュメントは、SQL Serverパブリケーションからレプリケーションアーティクルの詳細情報を取得するdbatools PowerShellコマンドレット `Get-DbaReplArticle` の機能設計を記述する。

### 本機能の処理概要

Get-DbaReplArticleは、SQL Serverレプリケーションパブリケーション内のアーティクル（テーブル、ビュー、ストアドプロシージャ）に関する包括的な情報を取得するコマンドレットである。

**業務上の目的・背景**：レプリケーション環境において、どのオブジェクトがパブリケーションに含まれているかを把握することは、トラブルシューティングや構成の監査に不可欠である。この機能により、データベース管理者は各アーティクルの詳細（名前、タイプ、スキーマ、ソースオブジェクト、パーティショニング設定など）を効率的に確認できる。

**機能の利用シーン**：
- レプリケーション問題のトラブルシューティング時に、どのオブジェクトがレプリケートされているかを確認する場面
- レプリケーション設定のドキュメント化やコンプライアンス監査を行う場面
- 特定のスキーマやオブジェクトがレプリケーションに含まれているかを検証する場面
- 環境間でレプリケーション構成を比較する場面

**主要な処理内容**：
1. Add-ReplicationLibraryを呼び出してレプリケーションライブラリをロード
2. Connect-DbaInstanceで各SQL Serverインスタンスに接続
3. アクセス可能なデータベースを取得し、フィルタリング
4. Get-DbaReplPublicationを呼び出して各データベースのパブリケーションを取得
5. パブリケーション、スキーマ、名前でアーティクルをフィルタリング
6. 各アーティクルにメタデータ（ComputerName, InstanceName, SqlInstance）を追加
7. Select-DefaultViewで既定のプロパティを選択して出力

**関連システム・外部連携**：
- SQL Server Replication Management Objects (RMO) を使用
- Get-DbaReplPublicationに依存してパブリケーション情報を取得

**権限による制御**：
- SQL Serverインスタンスへのアクセス権限が必要
- データベースへの読み取りアクセス権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLIコマンド | 主画面 | PowerShellコマンドラインから直接実行 |

## 機能種別

データ取得 / 情報参照

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象のSQL Serverインスタンス | 有効なSQL Serverインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | Get-Credentialで取得した有効な認証情報 |
| Database | object[] | No | フィルタリング対象のデータベース名 | 有効なデータベース名 |
| Publication | object[] | No | フィルタリング対象のパブリケーション名 | 有効なパブリケーション名 |
| Schema | string[] | No | フィルタリング対象のスキーマ名 | 有効なスキーマ名 |
| Name | string[] | No | フィルタリング対象のアーティクル名 | 有効なアーティクル名 |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

PowerShellコマンドライン引数、パイプライン入力（SqlInstanceパラメータ）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| DatabaseName | string | パブリケーションを含むデータベース名 |
| PublicationName | string | アーティクルを含むパブリケーション名 |
| Name | string | アーティクル名 |
| Type | string | レプリケートされるオブジェクトのタイプ（Table, View, StoredProcedure） |
| VerticalPartition | bool | 垂直パーティショニング（列フィルタリング）が有効かどうか |
| SourceObjectOwner | string | ソースオブジェクトのスキーマ名 |
| SourceObjectName | string | ソーステーブル、ビュー、またはストアドプロシージャの名前 |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Replication.Articleオブジェクト）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ Add-ReplicationLibraryでライブラリをロード
2. processブロック
   └─ Test-FunctionInterruptで中断チェック
   └─ 各SqlInstanceに対してループ
       └─ Connect-DbaInstanceで接続
       └─ IsAccessible=trueのデータベースを取得
       └─ Databaseパラメータでフィルタリング
       └─ 各データベースに対してループ
           └─ Get-DbaReplPublicationでパブリケーション取得
           └─ Publicationパラメータでフィルタリング
           └─ publications.Articlesからアーティクルを取得
           └─ Schema, Nameでフィルタリング
           └─ 各アーティクルにメタデータを追加
           └─ Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Add-ReplicationLibrary]
    B --> C{Test-FunctionInterrupt?}
    C -->|Yes| D[終了]
    C -->|No| E[SqlInstanceループ]
    E --> F[Connect-DbaInstance]
    F --> G{接続成功?}
    G -->|No| H[Stop-Function]
    G -->|Yes| I[アクセス可能DBを取得]
    I --> J{Databaseフィルタ?}
    J -->|Yes| K[DBフィルタリング]
    J -->|No| L[全DB取得]
    K --> M[各DBループ]
    L --> M
    M --> N[Get-DbaReplPublication]
    N --> O{Publicationフィルタ?}
    O -->|Yes| P[Pubフィルタリング]
    O -->|No| Q[全Pub取得]
    P --> R[Articlesを取得]
    Q --> R
    R --> S{Schemaフィルタ?}
    S -->|Yes| T[Schemaフィルタリング]
    S -->|No| U[全Article]
    T --> V{Nameフィルタ?}
    U --> V
    V -->|Yes| W[Nameフィルタリング]
    V -->|No| X[メタデータ追加]
    W --> X
    X --> Y[Select-DefaultView]
    Y --> Z{次のDB?}
    Z -->|Yes| M
    Z -->|No| AA{次のInstance?}
    H --> AA
    AA -->|Yes| E
    AA -->|No| D
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | アクセス可能DBのみ処理 | IsAccessible=trueのデータベースのみを処理対象とする | 常時 |
| BR-002 | パブリケーション経由取得 | アーティクルはGet-DbaReplPublicationを経由して取得 | 常時 |
| BR-003 | スキーマフィルタ | SourceObjectOwnerでフィルタリング | Schemaパラメータ指定時 |

### 計算ロジック

特になし（フィルタリングのみ）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| アーティクル情報取得 | レプリケーションシステムテーブル | SELECT | RMO経由で読み取り専用アクセス |

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

本機能は読み取り専用操作のため、データベースへの書き込みは行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverインスタンスへの接続失敗 | 接続情報を確認し再試行 |
| - | DatabaseError | データベース一覧取得失敗 | インスタンスの状態を確認 |
| - | ArticleError | アーティクル取得失敗 | レプリケーション構成を確認 |

### リトライ仕様

自動リトライは行わない。Stop-Functionで処理を停止し、-Continueで次のインスタンスの処理を継続する。

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

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

## パフォーマンス要件

データベース数とパブリケーション数に依存するが、通常は数秒以内に完了する。

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

- 認証情報はPSCredentialとして安全に処理される
- レプリケーション構成情報の読み取りにはdb_ownerまたは同等の権限が必要

## 備考

- 出力には追加のプロパティ（DestinationObjectOwner, DestinationObjectNameなど）がSelect-Object *で取得可能
- パブリケーションが存在しないデータベースはスキップされる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Add-ReplicationLibrary.ps1 | `private/functions/Add-ReplicationLibrary.ps1` | レプリケーションライブラリのロード |

**読解のコツ**: Microsoft.SqlServer.Replication.Articleオブジェクトの構造を理解することが重要。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaReplArticle.ps1 | `public/Get-DbaReplArticle.ps1` | メインのコマンドレット実装 |

**主要処理フロー**:
1. **117-118行目**: beginブロックでライブラリロード
2. **123-128行目**: Connect-DbaInstanceで接続
3. **130-137行目**: データベースのフィルタリング
4. **139-156行目**: パブリケーションとアーティクルの取得、フィルタリング
5. **158-163行目**: メタデータ追加と出力

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaReplPublication.ps1 | `public/Get-DbaReplPublication.ps1` | パブリケーション取得 |
| 3-2 | Connect-DbaInstance | - | SQL Server接続 |

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

```
Get-DbaReplArticle
    │
    ├─ Add-ReplicationLibrary (begin)
    │
    ├─ Connect-DbaInstance (process)
    │
    └─ Get-DbaReplPublication
           └─ Connect-ReplicationDB
                  └─ Add-ReplicationLibrary
```

### データフロー図

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

SqlInstance ──────────────────▶ Connect-DbaInstance ──────────────────▶ Server
                                      │
Database ─────────────────────▶ データベースフィルタ ──────────────────▶ Databases
                                      │
Publication ──────────────────▶ Get-DbaReplPublication ───────────────▶ Publications
                                      │
Schema, Name ─────────────────▶ アーティクルフィルタ ──────────────────▶ Articles
                                      │
                               メタデータ追加
                                      │
                               Select-DefaultView
                                      │
                                      ▼
                               Articleオブジェクト（10プロパティ）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaReplArticle.ps1 | `public/Get-DbaReplArticle.ps1` | ソース | メインコマンドレット実装 |
| Get-DbaReplPublication.ps1 | `public/Get-DbaReplPublication.ps1` | ソース | パブリケーション取得 |
| Add-ReplicationLibrary.ps1 | `private/functions/Add-ReplicationLibrary.ps1` | ソース | レプリケーションライブラリのロード |
| Get-DbaReplArticle.Tests.ps1 | `tests/Get-DbaReplArticle.Tests.ps1` | テスト | ユニットテスト |
