name: 07-design-03-database-design description: テーブル設計書の作成(テーブル設計)
テーブル設計書作成時の指示
- テーブル設計書作成時は、以下のルールに従ってドキュメントを作成してください。
- フォーマットは./assetsを参照してください。
作成するドキュメントの種類
以下の項目について、必要に応じて設計書を作成してください。
- テーブル定義(カラム、型、制約)
- インデックス設計
- マスタデータ仕様
- ファイル仕様(CSV/JSON など)
- モジュール単位のローカルデータ構造
- DTO / VO / Entity のフィールド仕様
- NOSQL定義書
共通ルール
- ドキュメントは
07_Design/03_DatabaseDesignフォルダに作成してください。 - すべての定義書を整理して掲載したHTMLを作成してください。ファイル名は
index.htmlとし、各設計書へのリンクや概要を掲載してください。
各ドキュメントの詳細ルール
1. テーブル定義(カラム、型、制約)
- RDBMSを利用する場合に作成してください。
- ファイル名:
{tablename}_Table_Definition.md - 記載項目:
- テーブル物理名、論理名
- カラム一覧(No, 物理名, 論理名, データ型, NULL許容, デフォルト値, PK, FK, 備考)
- 制約一覧(PK, FK, UNIQUE, CHECK等)
- 命名規則:
- テーブル名:
機能略称_テーブル用途(例: PRJ_USER_ACCOUNT) - カラム名:
小文字のスネークケース(例: user_id, created_at)
- テーブル名:
2. インデックス設計
- パフォーマンス要件に基づいてインデックスを設計してください。
- ファイル名:
{tablename}_Index_Definition.md - 記載項目:
- インデックス名
- 対象テーブル
- 対象カラム(順序含む)
- インデックスの種類(B-Tree, Hash等)
- ユニーク制約の有無
- 命名規則:
- インデックス名:
idx_テーブル名_カラム名(例: idx_user_account_user_id)
- インデックス名:
- フォーマット:
80_formats/index_definition_format.mdを参照してください。
3. ER図
- Mermaid記法を用いて図解を作成してください。
- ER図(
ER_Diagram.mmd): テーブル間のリレーションを表現
- ER図(
カラム論理名に関するルール(全般)
- すべての項目には物理名(英語)と論理名(日本語)を必ず設定してください。
- 論理名は業務上の意味を理解しやすい日本語名称を使用してください。