# 機能設計書 557-Get-DbaDbccUserOption

## 概要

本ドキュメントは、SQL Serverの現在のセッションレベルSETオプションを取得する機能について、その処理内容、入出力仕様、および実装詳細を記述した機能設計書である。

### 本機能の処理概要

Get-DbaDbccUserOptionは、SQL Serverインスタンスに対してDBCC USEROPTIONSを実行し、現在のセッションレベル設定（ANSIオプション、分離レベル、日付形式、言語、タイムアウト値など）を取得するPowerShellコマンドレットである。アプリケーションの接続問題のトラブルシューティングや、環境間での設定比較に有用である。

**業務上の目的・背景**：SQL Serverへの接続は、様々なセッションレベル設定（ANSI_NULLS、QUOTED_IDENTIFIER、DATE_FORMAT等）の影響を受ける。異なる環境やアプリケーションで異なる動作が発生する場合、これらの設定の違いが原因であることが多い。本機能は、現在の接続のセッション設定を確認し、問題の原因特定やデプロイメント時の設定検証を支援する。

**機能の利用シーン**：
- アプリケーション接続問題のトラブルシューティング
- 環境間のセッション設定比較
- デプロイメント時の設定検証
- ANSIオプションの確認

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. DBCC USEROPTIONS WITH NO_INFOMSGSの実行
3. Optionパラメータによる特定オプションのフィルタリング
4. 結果をPSCustomObjectとして出力

**関連システム・外部連携**：
- T-SQLのDBCC USEROPTIONSコマンドを使用
- Connect-DbaInstanceによる接続管理

**権限による制御**：DBCC USEROPTIONSの実行には特別な権限は不要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングに該当なし |

## 機能種別

データ取得（T-SQL実行）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス。パイプライン入力対応 | 有効なSQL Serverインスタンス名 |
| SqlCredential | PSCredential | No | 接続に使用する代替資格情報 | - |
| Option | string[] | No | 取得するオプション名（ValidateSetで検証） | ansi_null_dflt_on, ansi_nulls, ansi_padding, ansi_warnings, arithabort, concat_null_yields_null, datefirst, dateformat, isolation level, language, lock_timeout, quoted_identifier, textsize |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- SQL Serverインスタンス（DBCC USEROPTIONS実行）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverが稼働するコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Option | string | セッションオプション名 |
| Value | string | オプションの現在値 |

### 出力先

- PowerShellパイプライン（PSCustomObject型）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ クエリ文字列の構築（DBCC USEROPTIONS WITH NO_INFOMSGS）

2. processブロック
   └─ foreach ($instance in $SqlInstance) ループ

3. SQL Serverへの接続
   └─ Connect-DbaInstanceによる接続確立

4. クエリ実行
   └─ $server.Query()でDBCC USEROPTIONS実行

5. 結果処理
   └─ Optionパラメータ指定時はフィルタリング
   └─ PSCustomObjectとして出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[beginブロック: クエリ構築]
    B --> C[processブロック開始]
    C --> D{各インスタンスをループ}
    D --> E[Connect-DbaInstance]
    E --> F{接続成功?}
    F -->|No| G[Stop-Function / Continue]
    G --> D
    F -->|Yes| H[$server.Query実行]
    H --> I{クエリ成功?}
    I -->|No| J[Stop-Function / Continue]
    J --> D
    I -->|Yes| K{各行をループ}
    K --> L{Optionフィルタ?}
    L -->|No| M[PSCustomObject出力]
    L -->|Yes| N{オプション名一致?}
    N -->|Yes| M
    N -->|No| K
    M --> K
    K -->|完了| D
    D -->|完了| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パイプライン入力 | SqlInstanceパラメータはパイプラインからの入力を受け付ける | 常時 |
| BR-002 | Optionフィルタ | Optionパラメータで指定されたオプションのみ返却 | Option指定時 |
| BR-003 | ValidateSet | Optionパラメータは13種類の有効な値のみ受け付ける | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| セッション情報取得 | - | DBCC | DBCC USEROPTIONSでセッション設定取得 |

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

#### DBCC USEROPTIONS

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| 実行 | Set Option, Value | 全セッションオプション | NO_INFOMSGSオプション付き |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで警告、次のインスタンスへ継続 |
| - | クエリエラー | DBCCコマンド実行失敗 | Stop-Functionで警告、次のインスタンスへ継続 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- DBCC USEROPTIONSは軽量なコマンドであり、即座に結果を返す
- 複数インスタンスへの並列実行は未サポート

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

- DBCC USEROPTIONSの実行に特別な権限は不要
- セッション情報のみを返却し、機密データは含まない

## 備考

- Get-DbaInstanceUserOptionとの違い: こちらは現在のセッション設定、後者はインスタンスのデフォルト設定
- 返却される13のオプション: ansi_null_dflt_on, ansi_nulls, ansi_padding, ansi_warnings, arithabort, concat_null_yields_null, datefirst, dateformat, isolation level, language, lock_timeout, quoted_identifier, textsize

---

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

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

### 推奨読解順序

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

出力PSCustomObjectの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbccUserOption.ps1 | `public/Get-DbaDbccUserOption.ps1` | 出力型（.OUTPUTS）セクション（31-42行目） |

**読解のコツ**: DBCC USEROPTIONSは2列（Set Option, Value）を返すシンプルな結果セット。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbccUserOption.ps1 | `public/Get-DbaDbccUserOption.ps1` | function宣言とparamブロック（76-84行目） |

**主要処理フロー**:
1. **76-84行目**: パラメータ定義（ValidateSetでOption検証）
2. **85-88行目**: beginブロックでクエリ構築
3. **89行目**: processブロック開始

#### Step 3: クエリ構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbccUserOption.ps1 | `public/Get-DbaDbccUserOption.ps1` | beginブロック（85-88行目） |

**主要処理フロー**:
- **86行目**: StringBuilderの作成
- **87行目**: "DBCC USEROPTIONS WITH NO_INFOMSGS"をAppend

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbccUserOption.ps1 | `public/Get-DbaDbccUserOption.ps1` | クエリ実行と結果処理（99-116行目） |

**主要処理フロー**:
- **100-101行目**: $server.Query($query)でDBCC実行
- **105-114行目**: 結果ループとフィルタリング
- **106行目**: Option未指定または一致時に出力
- **107-113行目**: PSCustomObject生成

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

```
Get-DbaDbccUserOption
    │
    ├─ StringBuilder.Append
    │      └─ "DBCC USEROPTIONS WITH NO_INFOMSGS"
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Query()
    │      └─ DBCC USEROPTIONS実行
    │
    └─ PSCustomObject出力
```

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ SMO Server
                        │
                        ▼
              $server.Query() ───▶ DBCC USEROPTIONS
                        │
                        ▼
              結果セット（Option, Value）
                        │
                        ▼
              Optionフィルタ（指定時）
                        │
                        ▼
              PSCustomObject ───▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbccUserOption.ps1 | `public/Get-DbaDbccUserOption.ps1` | ソース | メイン実装 |
| Get-DbaInstanceUserOption.ps1 | `public/Get-DbaInstanceUserOption.ps1` | ソース | インスタンスデフォルト設定取得（関連機能） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
