# 機能設計書 72-Invoke-DbaDbDbccCleanTable

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Invoke-DbaDbDbccCleanTable` コマンドレットに関する機能設計書です。このコマンドは、テーブルやインデックス付きビューから削除された可変長列のディスク領域を回収するDBCC CLEANTABLEコマンドを実行します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverでは、可変長列（varchar、nvarchar、varbinary、text、ntext、image、xml、CLRユーザー定義型）を削除しても、その領域は即座に回収されません。本機能は、DBCC CLEANTABLEコマンドを実行して未使用領域を物理的に削除し、テーブルサイズを削減してパフォーマンスを向上させます。

**機能の利用シーン**：
- テーブル構造変更後の領域回収
- 大きな可変長列の削除後のディスク領域最適化
- データベースメンテナンス作業の一環としての領域整理
- ストレージコスト削減のための定期的なクリーンアップ

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 対象データベースとテーブル/ビューの特定
3. DBCC CLEANTABLEコマンドの動的構築
4. バッチサイズを指定した段階的なクリーンアップ実行
5. 実行結果の出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)、Invoke-DbaQueryを使用してT-SQLを実行

**権限による制御**：db_ownerロールまたはsysadminロールのメンバーシップが必要

## 関連画面

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

## 機能種別

データ保守 / DBCC操作 / 領域管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Database | string[] | No | 対象データベース名 | 複数指定可能 |
| Object | string[] | No（実質必須） | テーブル名またはオブジェクトID | 必須チェックあり |
| BatchSize | int | No | バッチあたりの処理行数 | 正の整数 |
| NoInformationalMessages | switch | No | 情報メッセージを抑制 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- PowerShellコマンドライン引数
- パイプライン入力（SqlInstance）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なインスタンス名 |
| Database | string | データベース名 |
| Object | string | 処理対象テーブル/ビュー名 |
| Cmd | string | 実行されたDBCCコマンド |
| Output | string | DBCC出力メッセージ |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック：DBCCコマンドテンプレートの構築
   └─ DBCC CLEANTABLE(#options#) の基本形を準備
   └─ NoInformationalMessages時にWITH NO_INFOMSGSを追加
2. processブロック：Objectパラメータの必須チェック
   └─ 未指定の場合はStop-Functionで終了
3. 各インスタンスの処理
   └─ Connect-DbaInstanceでサーバー接続
4. データベースフィルタリング
   └─ -Databaseパラメータによる絞り込み
5. 各データベース・各オブジェクトに対する処理
   └─ アクセス可能性チェック
6. DBCCコマンドの構築
   └─ 数値IDの場合：クォートなし
   └─ 名前の場合：シングルクォートで囲む
   └─ BatchSize指定時：第3引数として追加
7. ShouldProcessによる確認とコマンド実行
8. 結果の出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[DBCCコマンドテンプレート構築]
    B --> C{NoInformationalMessages?}
    C -->|Yes| D[WITH NO_INFOMSGS追加]
    C -->|No| E{Object指定あり?}
    D --> E
    E -->|No| F[Stop-Function終了]
    E -->|Yes| G[インスタンスループ開始]
    G --> H[Connect-DbaInstance]
    H --> I{接続成功?}
    I -->|No| J[Stop-Function]
    I -->|Yes| K[データベース取得]
    K --> L[データベースフィルタリング]
    L --> M[各データベースループ]
    M --> N{アクセス可能?}
    N -->|No| O[スキップ]
    N -->|Yes| P[各オブジェクトループ]
    P --> Q{数値ID?}
    Q -->|Yes| R[クォートなしで設定]
    Q -->|No| S[クォート付きで設定]
    R --> T{BatchSize指定?}
    S --> T
    T -->|Yes| U[BatchSize追加]
    T -->|No| V[コマンド確定]
    U --> V
    V --> W[Invoke-DbaQuery実行]
    W --> X[結果出力]
    X --> Y{次のオブジェクト?}
    Y -->|Yes| P
    Y -->|No| Z{次のDB?}
    Z -->|Yes| M
    Z -->|No| AA{次のインスタンス?}
    AA -->|Yes| G
    AA -->|No| AB[終了]
    O --> Z
    J --> AA
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-72-01 | Object必須 | Objectパラメータは実質必須 | 常時 |
| BR-72-02 | 数値ID処理 | Objectが数値の場合、クォートなしでDBCCに渡す | Object =~ '^\d+$' |
| BR-72-03 | 名前処理 | Objectが文字列の場合、シングルクォートで囲む | Object !~ '^\d+$' |
| BR-72-04 | BatchSize | 指定された場合、第3引数として追加 | BatchSize指定時 |
| BR-72-05 | 高確認 | ConfirmImpactがHighに設定 | 常時 |

### 計算ロジック

- BatchSizeはそのまま整数値としてDBCCコマンドに渡される

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC CLEANTABLE | 指定テーブル/ビュー | 更新（物理構造変更） | 未使用領域の回収 |

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

#### 指定されたユーザーテーブル/インデックス付きビュー

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DBCC CLEANTABLE | 物理ページ構造 | 削除された可変長列の領域を回収 | 排他ロック取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| MissingParameter | パラメータエラー | Objectが未指定 | Stop-Functionでメッセージ表示後終了 |
| ConnectionError | 接続エラー | SQL Serverに接続できない | Stop-Functionで処理継続 |
| AccessError | アクセスエラー | データベースがアクセス不可 | スキップして次のDBへ |
| ExecutionError | 実行エラー | DBCCコマンド実行失敗 | Stop-Functionで処理継続 |

### リトライ仕様

- リトライ機能なし（手動で再実行が必要）

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

- DBCC CLEANTABLEは内部でトランザクションを管理
- BatchSizeを指定することで、小さなトランザクションで分割実行可能
- 処理中は対象テーブルに排他ロックを取得

## パフォーマンス要件

- 大きなテーブルでは実行に時間がかかる可能性あり
- 本番環境ではBatchSizeの指定（5000-10000程度）を推奨
- BatchSize未指定時は単一トランザクションで処理（高速だがロック時間が長い）

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

- db_ownerまたはsysadminロールが必要
- SqlCredentialパラメータで安全な認証情報の受け渡しをサポート
- ConfirmImpact = 'High'により確認プロンプトがデフォルトで表示

## 備考

- SQL Server 2000以降で使用可能
- Microsoft公式ドキュメント: https://docs.microsoft.com/en-us/sql/t-sql/database-console-commands/dbcc-cleantable-transact-sql

---

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

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

### 推奨読解順序

#### Step 1: コマンドの全体構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Invoke-DbaDbDbccCleanTable.ps1 | `public/Invoke-DbaDbDbccCleanTable.ps1` | コマンド全体の構造、パラメータ定義、ConfirmImpact = 'High'の意味 |

**読解のコツ**: `ConfirmImpact = 'High'`が設定されているため、`$ConfirmPreference`の設定によっては確認プロンプトが表示される。

#### Step 2: beginブロック - コマンド構築ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Invoke-DbaDbDbccCleanTable.ps1 | `public/Invoke-DbaDbDbccCleanTable.ps1` | 115-121行目：シンプルなコマンドテンプレート構築 |

**主要処理フロー**:
1. **116-117行目**: StringBuilderの初期化とベースコマンド
2. **118-120行目**: NoInformationalMessagesオプションの追加

#### Step 3: processブロック - 必須パラメータチェック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Invoke-DbaDbDbccCleanTable.ps1 | `public/Invoke-DbaDbDbccCleanTable.ps1` | 123-126行目：Objectの必須チェック |

**読解のコツ**: `Test-Bound -Not`でパラメータが指定されていないことを検出し、`Stop-Function`で適切なエラーメッセージを表示して終了。

#### Step 4: processブロック - メイン処理ロジック

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Invoke-DbaDbDbccCleanTable.ps1 | `public/Invoke-DbaDbDbccCleanTable.ps1` | 127-187行目：インスタンス・データベース・オブジェクトの三重ループ |

**主要処理フロー**:
- **148-159行目**: オプション構築（数値ID vs 名前、BatchSize）
- **161行目**: プレースホルダー置換
- **164-166行目**: ShouldProcessとクエリ実行
- **171-183行目**: 結果の出力

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

```
Invoke-DbaDbDbccCleanTable
    │
    ├─ Test-Bound (dbatools内部関数)
    │      └─ パラメータバインド確認
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ Invoke-DbaQuery
    │      └─ DBCC CLEANTABLEの実行
    │
    └─ Stop-Function (dbatools内部関数)
           └─ エラーハンドリング
```

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ $server
                        │
Database ───────▶ フィルタリング ─────────▶ $dbs
                        │
Object ─────────▶ オプション構築 ─────────▶ $options
                        │
BatchSize ──────▶ オプション追加 ─────────▶ $options
                        │
                 クエリ構築 ───────────────▶ $query
                        │
                 Invoke-DbaQuery ─────────▶ $results
                        │
                 結果出力 ─────────────────▶ PSCustomObject
                                              │
                                              ├─ ComputerName
                                              ├─ InstanceName
                                              ├─ SqlInstance
                                              ├─ Database
                                              ├─ Object
                                              ├─ Cmd
                                              └─ Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Invoke-DbaDbDbccCleanTable.ps1 | `public/Invoke-DbaDbDbccCleanTable.ps1` | ソース | メインコマンド実装 |
| Invoke-DbaDbDbccCleanTable.Tests.ps1 | `tests/Invoke-DbaDbDbccCleanTable.Tests.ps1` | テスト | Pester v5テストファイル |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続関数 |
| Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | ソース | クエリ実行関数 |
