# バッチ設計書 6-cmdlets.ps1

## 概要

本ドキュメントは、dbatoolsモジュールのコンパイル済みCmdletを登録するスクリプト「cmdlets.ps1」の設計仕様を記載したものである。

### 本バッチの処理概要

本スクリプトは、dbatoolsモジュールのハイブリッドモジュールサポートの一環として、C#で実装されたコンパイル済みCmdletをPowerShellセッションに登録する。Write-Message、Select-DbaObject、Set-DbatoolsConfigの3つのCmdletをインポートし、PowerShell関数と同様に使用できるようにする。

**業務上の目的・背景**：dbatoolsモジュールは、パフォーマンスや機能要件から一部のコマンドをC#で実装している。これらのCmdletはDataplat.Dbatools.dllにコンパイルされており、PowerShell関数よりも高速に動作する。特にWrite-Messageは頻繁に呼び出されるメッセージング機能であり、パフォーマンスが重要である。本スクリプトは、これらのコンパイル済みCmdletをPowerShellモジュールとして利用可能にするための登録処理を行う。

**バッチの実行タイミング**：dbatoolsモジュールのインポート時に一度だけ実行される。

**主要な処理内容**：
1. 共通パラメータ（ヘルプファイルパス、モジュール参照）の設定
2. Write-Message Cmdletの登録
3. Select-DbaObject Cmdletの登録
4. Set-DbatoolsConfig Cmdletの登録

**前後の処理との関連**：本スクリプトはモジュール初期化時にdbatools.psm1から呼び出される。Dataplat.Dbatools.dllが事前にロードされている必要がある。登録されたCmdletは、他のdbatools関数やスクリプトから使用される。

**影響範囲**：dbatoolsモジュールのメッセージング、オブジェクト選択、設定管理機能に影響する。

## バッチ種別

モジュール初期化 / Cmdlet登録

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 1回（モジュールインポート時） |
| 実行時刻 | モジュールインポート時 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | dbatoolsモジュールのインポート |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| dbatoolsモジュールのロード | dbatools.psm1のロード処理中であること |
| Dataplat.Dbatools.dll | コンパイル済みアセンブリがロードされていること |
| Import-DbaCmdlet | 内部コマンドが利用可能であること |

### 実行可否判定

モジュールインポート時に無条件で実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本スクリプトは直接パラメータを受け取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| $PSModuleRoot | 文字列 | モジュールルートディレクトリパス |
| ExecutionContext.SessionState.Module | PSModuleInfo | 現在のモジュールオブジェクト |
| Dataplat.Dbatools.dll | .NETアセンブリ | コンパイル済みCmdlet実装 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| PowerShellセッション | Cmdlet登録 | Write-Message, Select-DbaObject, Set-DbatoolsConfig |

### 出力ファイル仕様

本スクリプトはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. 共通パラメータの設定
   ├─ HelpFile: $PSModuleRoot\en-us\dbatools.dll-Help.xml
   └─ Module: 現在のモジュールオブジェクト
2. Write-Message Cmdletの登録
   └─ Type: Dataplat.Dbatools.Commands.WriteMessageCommand
3. Select-DbaObject Cmdletの登録
   └─ Type: Dataplat.Dbatools.Commands.SelectDbaObjectCommand
4. Set-DbatoolsConfig Cmdletの登録
   └─ Type: Dataplat.Dbatools.Commands.SetDbatoolsConfigCommand
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[共通パラメータ設定]
    B --> C[Write-Message登録]
    C --> D[Select-DbaObject登録]
    D --> E[Set-DbatoolsConfig登録]
    E --> F[スクリプト終了]
```

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

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

本スクリプトはデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 型ロードエラー | Dataplat.Dbatools.dllがロードされていない | モジュールロード失敗 |
| - | Cmdlet登録エラー | Import-DbaCmdletが失敗 | モジュールロード失敗 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

初期化スクリプトのため、エラー発生時はモジュールのインポート自体が失敗する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 3件のCmdlet登録 |
| 目標処理時間 | 数ミリ秒 |
| メモリ使用量上限 | 無視できる程度 |

## 排他制御

モジュール初期化時に一度だけ実行されるため、排他制御は不要。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| なし | - | 本スクリプト自体はログ出力しない |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| なし | - | - |

## 備考

- 本スクリプトはprivate/scripts/配下に配置されている
- ハイブリッドモジュールとは、PowerShell関数とC# Cmdletを組み合わせたモジュール形態
- ヘルプファイルはen-us\dbatools.dll-Help.xmlに格納されている
- Import-DbaCmdletはdbatoolsの内部コマンドである

### 登録されるCmdlet一覧

| Cmdlet名 | 実装クラス | 用途 |
|----------|----------|------|
| Write-Message | Dataplat.Dbatools.Commands.WriteMessageCommand | ログ・メッセージ出力 |
| Select-DbaObject | Dataplat.Dbatools.Commands.SelectDbaObjectCommand | オブジェクト選択・変換 |
| Set-DbatoolsConfig | Dataplat.Dbatools.Commands.SetDbatoolsConfigCommand | dbatools設定値の変更 |
