# 機能設計書 100-Get-DbaDbCheckConstraint

## 概要

本ドキュメントは、SQL Serverデータベースのチェック制約を取得するGet-DbaDbCheckConstraintコマンドの機能設計書である。

### 本機能の処理概要

Get-DbaDbCheckConstraintは、SQL Serverデータベースのテーブルに定義されているチェック制約の詳細情報を取得する機能である。各チェック制約の名前、定義式、有効/無効状態などを包括的に取得する。

**業務上の目的・背景**：チェック制約はデータの整合性を保証する重要なデータベースオブジェクトである。本機能はマイグレーション計画、スキーマ監査、データベース設計のドキュメント化、および無効化されている制約の検出に活用される。

**機能の利用シーン**：データベーススキーマの監査、マイグレーション前の制約棚卸し、無効化された制約の検出、レプリケーション対象外制約の確認、およびデータ検証ルールの文書化時に利用される。

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続を確立
2. アクセス可能なデータベースの各テーブルを列挙
3. オプションでシステムテーブルを除外
4. 各テーブルのChecksコレクションからチェック制約を取得
5. メタデータを付加して出力

**関連システム・外部連携**：SQL Server SMO（Table.Checks）を使用してsys.check_constraintsの制約情報にアクセス。

**権限による制御**：データベースへのアクセス権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドラインインターフェース | 主画面 | PowerShellコンソールまたはスクリプトから実行 |

## 機能種別

データ取得（SMO経由でのチェック制約情報読み取り）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Database | Object[] | No | 対象データベース名（複数指定可能） | - |
| ExcludeDatabase | Object[] | No | 除外するデータベース名 | - |
| ExcludeSystemTable | Switch | No | システムテーブルのチェック制約を除外 | - |
| EnableException | Switch | No | 例外処理を有効化 | - |

### 入力データソース

SQL Server SMO Table.Checksコレクション（sys.check_constraintsビューに対応）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverホストのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Database | String | チェック制約を含むデータベース名 |
| Parent | Table | チェック制約が定義されているテーブルオブジェクト |
| ID | Int32 | チェック制約の一意識別子 |
| CreateDate | DateTime | チェック制約作成日時 |
| DateLastModified | DateTime | チェック制約最終変更日時 |
| Name | String | チェック制約名 |
| IsEnabled | Boolean | チェック制約が有効かどうか |
| IsChecked | Boolean | INSERT/UPDATE時に制約がチェックされるか |
| NotForReplication | Boolean | レプリケーション操作で制約を無視するか |
| Text | String | チェック制約の定義式（検証ロジック） |
| State | String | SMOオブジェクト状態 |
| DatabaseId | Int32 | データベースの一意識別子 |

### 出力先

PowerShellパイプラインに直接出力される

## 処理フロー

### 処理シーケンス

```
1. Process処理：各インスタンスに対してループ
   └─ Connect-DbaInstanceでSQL Serverに接続
2. アクセス可能なデータベースの取得
   └─ IsAccessibleでフィルタ
3. データベースフィルタリング
   └─ Database/ExcludeDatabase パラメータで指定されたデータベースのみ
4. 各テーブルの処理
   └─ ExcludeSystemTableでシステムテーブルを除外（オプション）
5. Checksコレクションの取得
   └─ 各テーブルのChecksコレクションを列挙
6. メタデータの付加と出力
   └─ Add-Memberでプロパティを追加、Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各SqlInstanceをループ}
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    E --> B
    D -->|Yes| F[IsAccessible DBを取得]
    F --> G{Database指定あり?}
    G -->|Yes| H[Databaseでフィルタ]
    G -->|No| I[ExcludeDBでフィルタ]
    H --> I
    I --> J{各DBをループ}
    J --> K{IsAccessible?}
    K -->|No| L[Warning出力]
    L --> J
    K -->|Yes| M{各Tableをループ}
    M --> N{ExcludeSystemTable AND IsSystemObject?}
    N -->|Yes| M
    N -->|No| O{Checks.Count > 0?}
    O -->|No| P[Verbose出力]
    P --> M
    O -->|Yes| Q{各Checkをループ}
    Q --> R[Add-Member]
    R --> S[Select-DefaultView]
    S --> Q
    Q -->|完了| M
    M -->|完了| J
    J -->|完了| B
    B -->|完了| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-100-1 | アクセス可能DBのみ | IsAccessible=trueのデータベースのみ処理 | 常時 |
| BR-100-2 | システムテーブル除外 | ExcludeSystemTable指定時はIsSystemObject=trueを除外 | ExcludeSystemTable指定時 |
| BR-100-3 | 空Checksスキップ | Checks.Count=0のテーブルはVerbose出力のみ | 常時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| チェック制約取得 | sys.check_constraints | SELECT | SMO経由で制約メタデータを取得 |

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

#### sys.check_constraints

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | object_id, name, parent_object_id, definition, is_disabled, etc. | 全チェック制約 | SMO Table.Checks経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionでエラー記録、次インスタンスに継続 |
| - | DB非アクセス | データベースにアクセス不可 | Warning出力、次DBに継続 |

### リトライ仕様

リトライ機構は実装されていない。

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

読み取り専用操作のため、トランザクション制御は不要。

## パフォーマンス要件

SMO経由でのメタデータ取得は軽量な操作。多数のテーブルを持つ大規模データベースでは時間がかかる場合がある。

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

- データベースへのアクセス権限が必要
- SqlCredentialによる代替認証情報の使用をサポート

## 備考

- チェック制約はデータの整合性を保証する重要なオブジェクト
- NotForReplication=trueの制約はレプリケーション時に無視される

---

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

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

### 推奨読解順序

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

出力されるオブジェクトはSMOのCheckオブジェクトに追加プロパティを付与したものである。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | 47-75行目の.OUTPUTSセクション |

**読解のコツ**: Textプロパティにチェック制約の実際の検証ロジックが格納される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | 102-111行目のparam block |

**主要処理フロー**:
1. **102-111行目**: パラメータ定義
2. **113-160行目**: process block（メイン処理）
3. **121行目**: IsAccessibleでフィルタ

#### Step 3: フィルタリング処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | 123-128行目のDB フィルタ処理 |
| 3-2 | Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | 137-139行目のシステムテーブル除外 |

**主要処理フロー**:
- **123-124行目**: Databaseパラメータでのフィルタ
- **126-127行目**: ExcludeDatabaseパラメータでのフィルタ
- **137-139行目**: ExcludeSystemTableによるシステムテーブル除外

#### Step 4: チェック制約取得を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | 141-156行目のChecks処理 |

**主要処理フロー**:
- **141-144行目**: Checks.Count=0の場合のVerbose出力
- **146-155行目**: 各チェック制約へのメタデータ付加と出力

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

```
Get-DbaDbCheckConstraint
    │
    ├─ Connect-DbaInstance (接続確立)
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Databases (DBリスト取得)
    │      └─ Where-Object IsAccessible
    │
    ├─ Database/ExcludeDatabase フィルタ
    │
    └─ $db.Tables (テーブルリスト)
           │
           ├─ ExcludeSystemTable フィルタ
           │
           └─ $tbl.Checks (チェック制約取得)
                  │
                  ├─ Add-Member (ComputerName)
                  ├─ Add-Member (InstanceName)
                  ├─ Add-Member (SqlInstance)
                  ├─ Add-Member (Database)
                  ├─ Add-Member (DatabaseId)
                  │
                  └─ Select-DefaultView (出力整形)
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance  ───▶ SMO Server
Database             │
ExcludeDB            ▼
ExcludeSystem   Databases取得
Table          (IsAccessibleフィルタ)
                     │
                     ▼
                DB/ExcludeDB フィルタ
                     │
                     ▼
                Tables取得
                     │
                     ▼
                SystemTable除外
                (オプション)
                     │
                     ▼
                Checks取得
                     │
                     ▼
                メタデータ付加
                     │
                     ▼
              Select-DefaultView ───▶ Check オブジェクト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbCheckConstraint.ps1 | `public/Get-DbaDbCheckConstraint.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
