# 機能設計書 73-Invoke-DbaDbDbccUpdateUsage

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Invoke-DbaDbDbccUpdateUsage` コマンドレットに関する機能設計書です。このコマンドは、SQL Serverカタログビューのページ数と行数の不整合を修正するDBCC UPDATEUSAGEコマンドを実行します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverの内部カウンターが不正確になると、sp_spaceusedなどのシステムプロシージャが誤ったデータベースサイズやテーブルサイズを報告します。これにより、キャパシティプランニングやトラブルシューティングが困難になります。本機能は、DBCC UPDATEUSAGEコマンドを実行してカタログビューのメタデータ不整合を検出・修正します。

**機能の利用シーン**：
- sp_spaceusedの結果が実際のファイルサイズと一致しない場合
- バルク操作後のスペース使用量レポートの修正
- データベース復元後のメタデータ整合性回復
- インデックス再構築後のカタログ情報の更新
- 定期的なデータベースメンテナンス

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 対象データベース、テーブル、インデックスの特定
3. DBCC UPDATEUSAGEコマンドの動的構築
4. コマンドの実行と結果の取得
5. 更新結果の出力

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

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

## 関連画面

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

## 機能種別

データ保守 / DBCC操作 / メタデータ修正

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| Database | string[] | No | 対象データベース名またはID | 名前とID両方対応 |
| Table | string | No | 対象テーブル名またはオブジェクトID | 名前とID両方対応 |
| Index | string | No | 対象インデックス名またはID | Table指定時のみ有効 |
| NoInformationalMessages | switch | No | 情報メッセージを抑制 | - |
| CountRows | switch | No | 行数も再計算 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック：DBCCコマンドテンプレートの構築
   └─ DBCC UPDATEUSAGE(#options#) の基本形を準備
   └─ NoInformationalMessages時にWITH NO_INFOMSGSを追加
   └─ CountRows時にWITH COUNT_ROWSを追加（または追加で連結）
2. processブロック：各インスタンスの処理
   └─ Connect-DbaInstanceでサーバー接続
3. データベースフィルタリング
   └─ -Databaseパラメータによる絞り込み（名前またはID）
4. 各データベースに対する処理
   └─ アクセス可能性チェック
5. DBCCコマンドの構築（複雑な条件分岐）
   └─ Table + Index の組み合わせ
   └─ 数値ID vs 名前の判定
6. ShouldProcessによる確認とコマンド実行
7. 結果の出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[DBCCコマンドテンプレート構築]
    B --> C{NoInformationalMessages?}
    C -->|Yes| D[WITH NO_INFOMSGS追加]
    C -->|No| E{CountRows?}
    D --> F{CountRows?}
    F -->|Yes| G[, COUNT_ROWS追加]
    F -->|No| H[インスタンスループ開始]
    E -->|Yes| I[WITH COUNT_ROWS追加]
    E -->|No| H
    G --> H
    I --> H
    H --> J[Connect-DbaInstance]
    J --> K{接続成功?}
    K -->|No| L[Stop-Function]
    K -->|Yes| M[データベース取得]
    M --> N[データベースフィルタリング]
    N --> O[各データベースループ]
    O --> P{アクセス可能?}
    P -->|No| Q[スキップ]
    P -->|Yes| R{Table指定?}
    R -->|Yes| S{Index指定?}
    R -->|No| T[DB名のみでコマンド構築]
    S -->|Yes| U[Table+Indexでコマンド構築]
    S -->|No| V[Tableのみでコマンド構築]
    T --> W[Invoke-DbaQuery実行]
    U --> W
    V --> W
    W --> X[結果ループ出力]
    X --> Y{次のDB?}
    Y -->|Yes| O
    Y -->|No| Z{次のインスタンス?}
    Z -->|Yes| H
    Z -->|No| AA[終了]
    Q --> Y
    L --> Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-73-01 | DB指定時の動作 | Table未指定時はデータベース全体を更新 | Table未指定 |
| BR-73-02 | Table指定時の動作 | Index未指定時はテーブル全体を更新 | Index未指定 |
| BR-73-03 | 数値ID処理 | Table/Indexが数値の場合、クォートなしでDBCCに渡す | 値 =~ '^\d+$' |
| BR-73-04 | 名前処理 | Table/Indexが文字列の場合、シングルクォートで囲む | 値 !~ '^\d+$' |
| BR-73-05 | CountRows | 指定時に行数も物理的にカウントして更新 | CountRows指定時 |
| BR-73-06 | 高確認 | ConfirmImpactがHighに設定 | 常時 |

### 計算ロジック

- DBCC UPDATEUSAGEは実際のページ割り当てを読み取り、カタログビューを更新する

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC UPDATEUSAGE | sys.allocation_units等 | UPDATE | ページ数・行数メタデータの修正 |

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

#### システムカタログビュー

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | used_pages, data_pages | 実際のページ割り当てに基づく | 内部カウンターの修正 |
| UPDATE | rows (CountRows時) | 物理的に行をカウント | 時間がかかる |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

- DBCC UPDATEUSAGEは内部でトランザクションを管理
- 処理中は対象オブジェクトに共有ロックを取得

## パフォーマンス要件

- 大きなデータベースでは実行に時間がかかる可能性あり
- CountRowsオプションを指定すると、全行を物理的にカウントするため処理時間が大幅に増加
- 本番環境ではオフピーク時間帯での実行を推奨

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

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

## 備考

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

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Invoke-DbaDbDbccUpdateUsage.ps1 | `public/Invoke-DbaDbDbccUpdateUsage.ps1` | コマンド全体の構造、パラメータ定義（Table, Index, CountRows） |

**読解のコツ**: Table/Indexパラメータの組み合わせによる複雑な条件分岐に注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Invoke-DbaDbDbccUpdateUsage.ps1 | `public/Invoke-DbaDbDbccUpdateUsage.ps1` | 124-139行目：WITH句の条件付き構築 |

**主要処理フロー**:
1. **126-127行目**: StringBuilderの初期化とベースコマンド
2. **128-132行目**: NoInformationalMessages + CountRowsの組み合わせ
3. **133-137行目**: CountRowsのみの場合

#### Step 3: processブロック - データベースフィルタリング

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Invoke-DbaDbDbccUpdateUsage.ps1 | `public/Invoke-DbaDbDbccUpdateUsage.ps1` | 150-154行目：名前とIDの両方でフィルタリング |

**読解のコツ**: `($_.Name -In $Database) -or ($_.ID -In $Database)`で名前・ID両方に対応。

#### Step 4: processブロック - 複雑なクエリ構築

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Invoke-DbaDbDbccUpdateUsage.ps1 | `public/Invoke-DbaDbDbccUpdateUsage.ps1` | 163-189行目：Table/Indexの組み合わせ処理 |

**主要処理フロー**:
- **165-179行目**: Table + Indexの組み合わせ（4パターン）
- **180-186行目**: Tableのみの場合（2パターン）
- **187-189行目**: DBのみの場合

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

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

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ $server
                        │
Database ───────▶ フィルタリング ─────────▶ $dbs
                    (名前 or ID)
                        │
Table ──────────▶ クエリ構築 ─────────────▶ $query
    │                   │
Index ──────────▶ クエリ構築 ─────────────┘
                        │
                 Invoke-DbaQuery ─────────▶ $results
                        │
                 結果ループ出力 ───────────▶ PSCustomObject[]
                                              │
                                              ├─ ComputerName
                                              ├─ InstanceName
                                              ├─ SqlInstance
                                              ├─ Database
                                              ├─ Cmd
                                              └─ Output
```

### 関連ファイル一覧

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