backend/generate/database/mongo/Doc/README.md

1.3 KiB
Raw Blame History

MongoDB 資料庫文檔

本目錄包含 MongoDB 資料庫的結構文檔和相關說明。

文件說明

DATABASE_SCHEMA.md

完整的資料庫結構文檔,包含:

  • 所有集合Collection的結構定義

    • 欄位名稱、類型、必填性、說明
    • 索引定義和用途
    • 枚舉值說明
  • 索引總覽

    • 所有集合的索引列表
    • 索引類型和唯一性說明
  • 關聯關係

    • 集合之間的關聯圖
    • 一對一、一對多、多對多關係說明
  • 資料類型說明

    • 時間戳記格式差異
    • 枚舉類型定義

集合列表

Member 模組

  • account - 用戶帳號認證資訊
  • account_uid_binding - 帳號與 UID 綁定關係
  • user_info - 用戶個人資料
  • count - 自增 ID 計數器

Permission 模組

  • permission - 權限實體
  • role - 角色實體
  • role_permission - 角色權限關聯表
  • user_role - 用戶角色關聯表

使用方式

  1. 查看集合結構:打開 DATABASE_SCHEMA.md,搜尋集合名稱
  2. 了解索引:查看「索引總覽」章節
  3. 了解關聯:查看「關聯關係」章節
  4. 了解枚舉值:查看各集合的「枚舉值」說明

更新說明

當資料庫結構發生變更時,請更新 DATABASE_SCHEMA.md 文檔,確保文檔與實際結構保持一致。