# 機能設計書 426-Get-DbaDbQueryStoreOption

## 概要

本ドキュメントは、dbatools PowerShellモジュールの`Get-DbaDbQueryStoreOption`コマンドレットに関する機能設計書である。このコマンドレットは、SQL Serverデータベースからquery Store構成設定を取得する機能を提供する。

### 本機能の処理概要

`Get-DbaDbQueryStoreOption`は、SQL ServerインスタンスのユーザーデータベースからQuery Store構成設定を取得するコマンドレットである。キャプチャモード、ストレージ制限、クリーンアップポリシー、保持設定などの完全なQuery Store構成情報を返却する。

**業務上の目的・背景**：Query StoreはSQL Server 2016で導入されたクエリパフォーマンス分析機能であり、クエリプラン、実行統計、待機統計を自動的に収集・保存する。Query Storeの設定は、パフォーマンス監視の品質、プラン回帰の検出能力、ストレージ消費量に直接影響する。本機能により、DBAは環境全体のQuery Store構成を監査し、最適でない設定のデータベースを特定し、一貫したQuery Storeポリシーを確保できる。

**機能の利用シーン**：
- 環境全体のQuery Store構成を監査する場合
- 最適でない設定のデータベースを特定する場合
- パフォーマンス問題のトラブルシューティング前に設定を確認する場合
- Query Store設定の標準化状況を検証する場合
- Copy-DbaDbQueryStoreOptionの前処理として設定を確認する場合

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続する（MinimumVersion 13）
2. ユーザーデータベースのリストを取得する
3. 各データベースのQueryStoreOptionsオブジェクトを取得する
4. SQL Serverバージョンに応じた追加プロパティを取得する
5. インスタンス識別情報を付加して結果を出力する

**関連システム・外部連携**：SQL Server Query Store機能と連携し、sys.database_query_store_optionsシステムビューのデータにアクセスする。

**権限による制御**：データベースへのVIEW DATABASE STATE権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SQL Server Management Studio - Query Store | 参照画面 | SSMS上でのQuery Store設定表示に相当 |

## 機能種別

データ取得（SELECT相当）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス。パイプライン入力可能。 | 有効なSQL Server接続文字列 |
| SqlCredential | PSCredential | No | 代替資格情報。Windows認証、SQL Server認証、AD認証をサポート。 | 有効なPSCredentialオブジェクト |
| Database | object[] | No | 取得対象データベース。ワイルドカード対応。 | なし |
| ExcludeDatabase | object[] | No | 除外するデータベース。 | なし |
| EnableException | switch | No | 例外をスローするモードを有効化。 | なし |

### 入力データソース

- SQL Serverインスタンス直接指定（SqlInstanceパラメータ）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（コンピュータ\インスタンス形式） |
| Database | string | データベース名 |
| ActualState | string | 現在のQuery Store状態（ReadWrite, ReadOnly, Off） |
| DataFlushIntervalInSeconds | int | ストレージへのデータフラッシュ間隔（秒） |
| StatisticsCollectionIntervalInMinutes | int | 統計収集間隔（分） |
| MaxStorageSizeInMB | int | Query Storeの最大ストレージサイズ（MB） |
| CurrentStorageSizeInMB | int | 現在のストレージ使用量（MB） |
| QueryCaptureMode | string | クエリキャプチャモード（All, Auto, None, Custom） |
| SizeBasedCleanupMode | string | サイズベースクリーンアップモード（Off, Auto） |
| StaleQueryThresholdInDays | int | 古いクエリの閾値（日数） |

### SQL Server 2017以降の追加プロパティ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| MaxPlansPerQuery | int | クエリあたりの最大プラン数 |
| WaitStatsCaptureMode | string | 待機統計キャプチャモード（Off, On） |

### SQL Server 2019以降の追加プロパティ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| CustomCapturePolicyExecutionCount | int | カスタムキャプチャポリシー実行カウント閾値 |
| CustomCapturePolicyTotalCompileCPUTimeMS | int | カスタムキャプチャポリシーコンパイルCPU時間閾値（ms） |
| CustomCapturePolicyTotalExecutionCPUTimeMS | int | カスタムキャプチャポリシー実行CPU時間閾値（ms） |
| CustomCapturePolicyStaleThresholdHours | int | カスタムキャプチャポリシー古い閾値（時間） |

### 出力先

- PowerShellパイプライン（標準出力）
- Microsoft.SqlServer.Management.Smo.QueryStoreOptionsオブジェクトとして出力

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ ExcludeDatabaseにmaster, tempdb, modelを追加
2. processブロック
   ├─ 各SqlInstanceの処理
   │   ├─ Connect-DbaInstanceで接続（MinimumVersion 13）
   │   ├─ Get-DbaDatabase（ExcludeDatabase、Database、IsAccessibleフィルター）
   │   └─ 各データベースの処理
   │       ├─ QueryStoreOptionsオブジェクトの取得
   │       ├─ バージョンに応じたT-SQL追加クエリ実行
   │       ├─ インスタンス識別情報の追加
   │       └─ Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ExcludeDBにシステムDB追加]
    B --> C[各インスタンスを処理]
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    F --> G{次のインスタンス?}
    E -->|Yes| H[Get-DbaDatabase]
    H --> I[各DBを処理]
    I --> J[QueryStoreOptions取得]
    J --> K{バージョン判定}
    K -->|v13| L[基本プロパティのみ]
    K -->|v14| M[Invoke-DbaQuery v14用]
    K -->|v15+| N[Invoke-DbaQuery v15用]
    L --> O[Add-Member でプロパティ追加]
    M --> O
    N --> O
    O --> P[Select-DefaultView]
    P --> Q{次のDB?}
    Q -->|Yes| I
    Q -->|No| G
    G -->|Yes| C
    G -->|No| Z[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | システムDB除外 | master, tempdb, modelは自動的に除外 | すべての実行 |
| BR-002 | アクセス可能DB限定 | IsAccessible=trueのDBのみ処理 | すべての実行 |
| BR-003 | 最低バージョン要件 | SQL Server 2016（Version 13）以降が必要 | すべての実行 |
| BR-004 | バージョン別プロパティ | バージョンに応じた追加プロパティを取得 | v14以上 |

### 計算ロジック

バージョン別のQuery Storeプロパティ取得:

**SQL Server 2016 (v13):**
- SMO QueryStoreOptionsオブジェクトのプロパティのみ

**SQL Server 2017 (v14):**
- T-SQLクエリでmax_plans_per_query, wait_stats_capture_mode_descを追加取得

**SQL Server 2019以降 (v15+):**
- T-SQLクエリで上記に加えてcapture_policy_*系カラムを追加取得

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| Query Store設定取得 | sys.database_query_store_options | SELECT | Query Store構成の取得 |

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

#### sys.database_query_store_options

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | max_plans_per_query | v14以上で取得 | MaxPlansPerQuery |
| SELECT | wait_stats_capture_mode_desc | v14以上で取得 | WaitStatsCaptureMode |
| SELECT | capture_policy_execution_count | v15以上で取得 | CustomCapturePolicyExecutionCount |
| SELECT | capture_policy_stale_threshold_hours | v15以上で取得 | CustomCapturePolicyStaleThresholdHours |
| SELECT | capture_policy_total_compile_cpu_time_ms | v15以上で取得 | CustomCapturePolicyTotalCompileCPUTimeMS |
| SELECT | capture_policy_total_execution_cpu_time_ms | v15以上で取得 | CustomCapturePolicyTotalExecutionCPUTimeMS |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | 接続情報を確認する |
| - | ConnectionError | SQL Server 2014以前のバージョン | SQL Server 2016以降を使用する |

### リトライ仕様

リトライ処理は実装されていない。エラー時は-Continueで次のインスタンスを処理。

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

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

## パフォーマンス要件

特に規定なし。軽量なメタデータ取得処理。

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

- SQL Server認証、Windows認証、Azure AD認証をサポート
- 接続資格情報はPSCredentialオブジェクトで安全に管理
- MFAサポートが必要な場合はConnect-DbaInstanceの事前使用を推奨
- VIEW DATABASE STATE権限が必要

## 備考

- SQL Server 2016以降（Version 13以上）が必要（Query Store機能導入バージョン）
- 著者はEnrico van de Laar、Klaas Vandenberghe、Tracy Boggiano
- SMOでは取得できないプロパティはInvoke-DbaQueryでT-SQL直接実行

---

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

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

### 推奨読解順序

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

Query Store設定オブジェクトの構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbQueryStoreOption.ps1 | `public/Get-DbaDbQueryStoreOption.ps1` | .OUTPUTSセクション（9-38行目）で出力オブジェクトの構造を理解 |

**読解のコツ**: 出力はMicrosoft.SqlServer.Management.Smo.QueryStoreOptionsオブジェクトにカスタムプロパティを追加したもの。バージョンによって追加プロパティが異なる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbQueryStoreOption.ps1 | `public/Get-DbaDbQueryStoreOption.ps1` | パラメータ定義（90-99行目）で入力の受け取り方を確認 |

**主要処理フロー**:
1. **100-102行目**: beginブロックでシステムDB除外設定
2. **104-107行目**: インスタンス接続（MinimumVersion 13）
3. **113行目**: Get-DbaDatabase呼び出し
4. **115-142行目**: 各データベースの処理とバージョン分岐

#### Step 3: バージョン別処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbQueryStoreOption.ps1 | `public/Get-DbaDbQueryStoreOption.ps1` | バージョン分岐ロジック（119-142行目） |

**主要処理フロー**:
- **119-120行目**: SQL Server 2017 (v14)のT-SQLクエリ
- **121-122行目**: SQL Server 2019以降 (v15+)のT-SQLクエリ
- **125-128行目**: インスタンス情報の追加
- **130-141行目**: バージョン別出力プロパティ選択

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

```
Get-DbaDbQueryStoreOption
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続（MinimumVersion 13）
    │
    ├─ Get-DbaDatabase
    │      └─ データベースリスト取得
    │
    ├─ Invoke-DbaQuery (v14+)
    │      └─ 追加プロパティ取得
    │
    ├─ Add-Member
    │      └─ カスタムプロパティ追加
    │
    └─ Select-DefaultView
           └─ 出力プロパティの制限
```

### データフロー図

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

SqlInstance ───────▶ Connect-DbaInstance
                            │
                            ▼
                    Get-DbaDatabase
                            │
                            ▼
                   db.QueryStoreOptions ───────▶ $qso
                            │
                            ▼
                {v14+? Invoke-DbaQuery}
                            │
                            ▼
                  Add-Member（プロパティ追加）
                            │
                            ▼
                    Select-DefaultView ───────▶ QueryStoreOptions[]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbQueryStoreOption.ps1 | `public/Get-DbaDbQueryStoreOption.ps1` | ソース | メイン機能の実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベース取得 |
| Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | ソース | T-SQLクエリ実行 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Select-DefaultView.ps1 | `private/Select-DefaultView.ps1` | ソース | 出力プロパティの制限 |
| Copy-DbaDbQueryStoreOption.ps1 | `public/Copy-DbaDbQueryStoreOption.ps1` | ソース | 本機能を利用するコマンド |
| Set-DbaDbQueryStoreOption.ps1 | `public/Set-DbaDbQueryStoreOption.ps1` | ソース | 関連コマンド（設定変更） |
| Test-DbaDbQueryStore.ps1 | `public/Test-DbaDbQueryStore.ps1` | ソース | 本機能を利用するコマンド |
