# 機能設計書 71-Invoke-DbaDbDbccCheckConstraint

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Invoke-DbaDbDbccCheckConstraint` コマンドレットに関する機能設計書です。このコマンドは、SQL Serverデータベースの制約違反をチェックするためのDBCC CHECKCONSTRAINTSコマンドを実行します。

### 本機能の処理概要

**業務上の目的・背景**：データベースにおける制約（CHECK制約、FOREIGN KEY制約など）は、データ整合性を維持するための重要な仕組みです。しかし、大量データの一括インポート、制約の一時無効化後の再有効化、またはデータベース移行後に、制約違反が存在する可能性があります。本機能は、DBAがデータ品質問題を特定し、修正するための重要なツールを提供します。

**機能の利用シーン**：
- 大量データのバルクインポート後のデータ検証
- 制約を一時的に無効化（WITH NOCHECK）した後のデータ整合性確認
- データベース移行・復元後の整合性検証
- 定期的なデータ品質監査

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 対象データベースの抽出（指定がない場合は全データベース）
3. DBCC CHECKCONSTRAINTSコマンドの動的構築
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 | 対象データベース名 | ワイルドカード対応 |
| Object | string | No | テーブル名、制約名、またはID | 数値の場合はIDとして処理 |
| AllConstraints | switch | No | 無効化された制約も含めて検査 | - |
| AllErrorMessages | switch | No | 全違反行を返す（制限なし） | - |
| NoInformationalMessages | switch | No | 情報メッセージを抑制 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なインスタンス名 |
| Database | string | データベース名 |
| Cmd | string | 実行されたDBCCコマンド |
| Output | string | DBCC出力メッセージ |
| Table | string | 違反行を含むテーブル名（違反時） |
| Constraint | string | 違反した制約名（違反時） |
| Where | string | 違反行を特定するWHERE句（違反時） |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. beginブロック：DBCCコマンドテンプレートの構築
   └─ WITH句オプション（ALL_CONSTRAINTS, ALL_ERRORMSGS, NO_INFOMSGS）の追加
2. processブロック：各インスタンスの処理
   └─ Connect-DbaInstanceでサーバー接続
3. データベースフィルタリング
   └─ -Databaseパラメータによる絞り込み
4. 各データベースに対する処理
   └─ アクセス可能性チェック
5. DBCCコマンドの構築
   └─ Objectパラメータの解析（数値ID or 名前）
6. ShouldProcessによる確認
   └─ WhatIfサポート
7. Invoke-DbaQueryでコマンド実行
   └─ MessagesToOutputで出力取得
8. 結果の解析と出力
   └─ 違反なし：単一オブジェクト出力
   └─ 違反あり：各違反行ごとにオブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[DBCCコマンドテンプレート構築]
    B --> C{WITH句オプション?}
    C -->|AllConstraints| D[WITH ALL_CONSTRAINTS追加]
    C -->|AllErrorMessages| E[, ALL_ERRORMSGS追加]
    C -->|NoInformationalMessages| F[, NO_INFOMSGS追加]
    D --> G[インスタンスループ開始]
    E --> G
    F --> G
    C -->|なし| 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[DBCCコマンド構築]
    P --> Q[Invoke-DbaQuery実行]
    Q --> R{結果タイプ?}
    R -->|null/String| S[情報出力]
    R -->|DataRow/Array| T[違反行ループ]
    T --> U[違反オブジェクト出力]
    S --> V{次のDB?}
    U --> V
    O --> V
    V -->|Yes| M
    V -->|No| W{次のインスタンス?}
    W -->|Yes| G
    W -->|No| X[終了]
    J --> W
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-71-01 | デフォルト動作 | オブジェクト未指定時は全テーブルの有効な制約をチェック | Object未指定 |
| BR-71-02 | 数値ID処理 | Objectが数値の場合、クォートなしでDBCCに渡す | Object =~ '^\d+$' |
| BR-71-03 | 違反上限 | デフォルトで制約あたり200件の違反行を返す | AllErrorMessages未指定 |
| BR-71-04 | 無効制約 | AllConstraintsで無効化制約も検査対象 | AllConstraints指定 |

### 計算ロジック

- 特になし（DBCCコマンドの結果をそのまま返す）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC CHECKCONSTRAINTS | 指定テーブル/全テーブル | SELECT（読み取り） | 制約違反の検出 |

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

#### sys.check_constraints / sys.foreign_keys

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | 制約定義 | DBCC内部で参照 | 制約検証に使用 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

- DBCC CHECKCONSTRAINTSは読み取り専用操作のためトランザクション不要
- 実行中は共有ロックを取得

## パフォーマンス要件

- 大きなテーブルでは実行に時間がかかる可能性あり
- AllErrorMessagesを指定すると大量の出力が発生する可能性あり

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

- sysadminまたはdb_ownerロールが必要
- SqlCredentialパラメータで安全な認証情報の受け渡しをサポート
- Windows認証、SQL認証、Active Directory認証に対応

## 備考

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

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Invoke-DbaDbDbccCheckConstraint.ps1 | `public/Invoke-DbaDbDbccCheckConstraint.ps1` | コマンド全体の構造、パラメータ定義、ヘルプドキュメント |

**読解のコツ**: PowerShellの高度な関数構造（`[CmdletBinding()]`、`param`ブロック、`begin`/`process`ブロック）を理解することが重要。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Invoke-DbaDbDbccCheckConstraint.ps1 | `public/Invoke-DbaDbDbccCheckConstraint.ps1` | 140-163行目：StringBuilderを使用したDBCCコマンドの動的構築 |

**主要処理フロー**:
1. **140-143行目**: StringBuilderの初期化とベースコマンド設定
2. **144-147行目**: AllConstraintsオプションの追加
3. **148-155行目**: AllErrorMessagesオプションの追加（WITH有無の判定）
4. **156-162行目**: NoInformationalMessagesオプションの追加

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Invoke-DbaDbDbccCheckConstraint.ps1 | `public/Invoke-DbaDbDbccCheckConstraint.ps1` | 165-244行目：インスタンス・データベースの反復処理と結果出力 |

**主要処理フロー**:
- **166-172行目**: Connect-DbaInstanceによるサーバー接続
- **174-178行目**: データベースの取得とフィルタリング
- **183-185行目**: アクセス可能性チェック
- **188-197行目**: Objectパラメータに基づくクエリ構築（数値ID vs 名前）
- **199-205行目**: ShouldProcessとクエリ実行
- **207-240行目**: 結果の解析と出力オブジェクト生成

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

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

### データフロー図

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

SqlInstance ───▶ Connect-DbaInstance ───▶ $server
                        │
Database ───────▶ フィルタリング ─────────▶ $dbs
                        │
Object ─────────▶ クエリ構築 ─────────────▶ $query
                        │
                 Invoke-DbaQuery ─────────▶ $results
                        │
                 結果解析 ─────────────────▶ PSCustomObject
                                              │
                                              ├─ ComputerName
                                              ├─ InstanceName
                                              ├─ SqlInstance
                                              ├─ Database
                                              ├─ Cmd
                                              ├─ Output
                                              ├─ Table
                                              ├─ Constraint
                                              └─ Where
```

### 関連ファイル一覧

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