# 機能設計書 194-New-DbaScriptingOption

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`New-DbaScriptingOption`機能の設計仕様を記載する。この機能は、T-SQLスクリプト生成を制御するためのSMO ScriptingOptionsオブジェクトを作成する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverオブジェクト（テーブル、ストアドプロシージャ、ビュー等）をT-SQLスクリプトとしてエクスポートする際、含める要素（インデックス、トリガー、権限、依存関係、バッチ区切り等）を細かく制御する必要がある。本機能は、Export-DbaScriptなどのスクリプティングコマンドで使用できるScriptingOptionsオブジェクトを生成し、デプロイメントスクリプトの作成において柔軟な制御を可能にする。

**機能の利用シーン**：
- データベースオブジェクトのスクリプト出力時の細かい制御
- デプロイメントスクリプトの生成（DROP文含める/含めない等）
- 依存関係を含めたオブジェクト移行スクリプトの作成
- バージョン互換性を考慮したスクリプト生成

**主要な処理内容**：
1. Microsoft.SqlServer.Management.Smo.ScriptingOptionsオブジェクトをNew-Objectで作成
2. 作成されたオブジェクトをそのまま返却

**関連システム・外部連携**：SMO（SQL Server Management Objects）のScriptingOptionsクラス。Export-DbaScript等のdbatoolsスクリプティングコマンド。

**権限による制御**：オブジェクト生成のみのため、特別な権限は不要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 217 | スクリプティングオプション | 主機能 | スクリプティングオプションの作成 |

## 機能種別

オブジェクト生成 / ユーティリティ

## 入力仕様

### 入力パラメータ

本機能にはパラメータはない。

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| （なし） | - | - | - | - |

### 入力データソース

パラメータ入力なし。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ScriptingOptions | Microsoft.SqlServer.Management.Smo.ScriptingOptions | スクリプティングオプションオブジェクト |

### 主要なプロパティ

| プロパティ名 | 型 | 説明 |
|-------------|-----|------|
| ScriptDrops | bool | DROP文を含めるかどうか |
| WithDependencies | bool | 依存オブジェクトを含めるかどうか |
| AgentAlertJob | bool | SQLエージェントアラート・ジョブ情報を含めるか |
| AgentNotify | bool | SQLエージェント通知を含めるか |
| Indexes | bool | インデックスを含めるかどうか |
| Triggers | bool | トリガーを含めるかどうか |
| Permissions | bool | 権限を含めるかどうか |
| TargetServerVersion | ServerVersion | 対象SQL Serverバージョン |

### 出力先

PowerShellパイプラインへの出力。

## 処理フロー

### 処理シーケンス

```
1. New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions実行
2. 作成されたオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[New-Object ScriptingOptions]
    B --> C[ScriptingOptions返却]
    C --> D[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルト値使用 | SMOのデフォルト値でオブジェクト生成 | 常時 |

### 計算ロジック

特に計算処理はない。

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

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

データベース操作はない。オブジェクト生成のみ。

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

該当なし。

## エラー処理

### エラーケース一覧

本機能は単純なオブジェクト生成のため、通常のエラーケースは発生しない。

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | SMOアセンブリ未ロード | dbatools正常インストール確認 |

### リトライ仕様

本機能にリトライ機能はない。

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

データベース操作がないため、トランザクションは関与しない。

## パフォーマンス要件

特になし。単一オブジェクト生成の軽量な操作。

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

特になし。オブジェクト生成のみでセンシティブな操作は行わない。

## 備考

- 返却されたオブジェクトのプロパティを変更してからExport-DbaScript等に渡す
- ScriptingOptionsの全プロパティについてはMicrosoft公式ドキュメント参照
- https://msdn.microsoft.com/en-us/library/microsoft.sqlserver.management.smo.scriptingoptions.aspx

---

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

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

### 推奨読解順序

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

SMO ScriptingOptionsクラスの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | SMO ScriptingOptions Class | Microsoft.SqlServer.Management.Smo | プロパティ群の構造 |

**読解のコツ**: ScriptingOptionsは数十のbooleanプロパティを持ち、それぞれがスクリプト出力の特定の側面を制御する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaScriptingOption.ps1 | `public/New-DbaScriptingOption.ps1` | 関数定義全体 |

**主要処理フロー**:
1. **50行目**: SuppressMessageAttribute（ShouldProcess警告抑制）
2. **51行目**: param()ブロック（パラメータなし）
3. **52行目**: New-Objectでオブジェクト生成・返却

#### Step 3: 使用例を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaScriptingOption.ps1 | `public/New-DbaScriptingOption.ps1` | EXAMPLEセクション |

**使用パターン**:
- **40-45行目**: オプションオブジェクト作成後、プロパティを設定してExport-DbaScriptに渡す

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

```
New-DbaScriptingOption
    │
    └─ New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
           └─ ScriptingOptionsオブジェクト返却
```

### データフロー図

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

（なし） ──────────────────▶ New-Object ScriptingOptions ──▶ ScriptingOptions Object
                                                                  │
                                                                  ▼
                                                           プロパティ設定可能
                                                           (ScriptDrops, Indexes等)
                                                                  │
                                                                  ▼
                                                           Export-DbaScript等で使用
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaScriptingOption.ps1 | `public/New-DbaScriptingOption.ps1` | ソース | メイン関数定義 |
| Export-DbaScript.ps1 | `public/Export-DbaScript.ps1` | ソース | ScriptingOption使用先 |
| New-DbaDbTransfer.ps1 | `public/New-DbaDbTransfer.ps1` | ソース | ScriptingOption使用先 |
