From 92c3f5f7a1b63f0e9288f63b880d8ae00eb02853 Mon Sep 17 00:00:00 2001 From: XiaoLFeng Date: Sat, 25 May 2024 20:47:54 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0=E4=BA=BA=E5=91=98?= =?UTF-8?q?=E9=85=8D=E7=BD=AE=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 根据最近的代码更改，更新了人员配置信息，将曾昶雯的角色从"前端开发"改为"全栈开发"。 --- ...64\346\226\260\346\227\245\345\277\227.md" | 6 + ...76\350\256\241\346\226\207\346\241\243.md" | 134 +++++++++--------- 2 files changed, 72 insertions(+), 68 deletions(-) create mode 100644 "docs/\346\233\264\346\226\260\346\227\245\345\277\227.md" diff --git "a/docs/\346\233\264\346\226\260\346\227\245\345\277\227.md" "b/docs/\346\233\264\346\226\260\346\227\245\345\277\227.md" new file mode 100644 index 0000000..80e01cb --- /dev/null +++ "b/docs/\346\233\264\346\226\260\346\227\245\345\277\227.md" @@ -0,0 +1,6 @@ +# 更新日志 + +> 为了能够更好看清楚更新作者信息，请在这里填写更新日志以及更新内容简要 + +- 【2024/5/15】协同，规约添加和完善 +- 【2024/5/25】更新数据库文档 \ No newline at end of file diff --git "a/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\225\260\346\215\256\345\272\223\350\256\276\350\256\241\346\226\207\346\241\243.md" "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\225\260\346\215\256\345\272\223\350\256\276\350\256\241\346\226\207\346\241\243.md" index 5d7c0ab..f451b3c 100644 --- "a/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\225\260\346\215\256\345\272\223\350\256\276\350\256\241\346\226\207\346\241\243.md" +++ "b/docs/\350\256\276\350\256\241\346\226\207\346\241\243/\346\225\260\346\215\256\345\272\223\350\256\276\350\256\241\346\226\207\346\241\243.md" @@ -6,12 +6,12 @@ ### 数据列 -| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | -|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| -| id | char(36) | PRIMARY KEY | 主键，全局唯一标识符 | 否 | fy_info_pk | | | -| key | varchar | NOT NULL | 键，用于唯一标识信息项 | 否 | | | | -| value | varchar | NOT NULL | 值，存储对应键的具体信息 | 否 | | | | -| updated_at | timestamp | DEFAULT now() | 数据更新时间，自动设置为当前时间 | 否 | | | | +| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | +| ---------- | --------- | ------------- | -------------------------------- | -------- | ---------- | -------- | -------- | +| id | char(36) | PRIMARY KEY | 主键，全局唯一标识符 | 否 | fy_info_pk | | | +| key | varchar | NOT NULL | 键，用于唯一标识信息项 | 否 | | | | +| value | varchar | NOT NULL | 值，存储对应键的具体信息 | 否 | | | | +| updated_at | timestamp | DEFAULT now() | 数据更新时间，自动设置为当前时间 | 否 | | | | ### 索引 @@ -19,84 +19,62 @@ ## fy_permission -> **描述**：权限表，用于管理系统的权限分配，每个记录代表一个独立的权限，可以有层级关系。 +> **描述**：权限表，用于存储系统中的各种操作权限，每个权限项由一个唯一的标识符和描述组成。 ### 数据列 -| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | -|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| -| pid | bigserial | PRIMARY KEY | 主键，自增，用于唯一标识权限 | 否 | fy_permission_pk | | | -| permission | varchar | NOT NULL | 权限字段，用于唯一标识权限名称 | 否 | | | | -| description | varchar | NOT NULL | 权限描述，详细说明权限的含义 | 否 | | | | -| parent | bigint | FOREIGN KEY | 父权限，引用 pid 列，表示权限层级 | 是 | fy_permission_pid_fk | cascade | set_null | - -### 外键约束 - -- **fy_permission_fy_permission_pid_fk**: `parent` 列引用 `fy_permission` 表的 `pid` 列，更新时级联，删除时设置为 NULL +| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | +| ----------- | --------- | ----------- | ---------------------------------- | -------- | ---------------- | -------- | -------- | +| pid | bigserial | PRIMARY KEY | 主键，自增，用于唯一标识权限 | 否 | fy_permission_pk | | | +| permission | varchar | NOT NULL | 权限字段，表示具体的操作或功能 | 否 | | | | +| description | varchar | NOT NULL | 权限描述，详细说明权限的含义和作用 | 否 | | | | ### 索引 -- **fy_permission_permission_uindex**: `permission` 列的唯一索引，确保每个权限名称在整个表中是唯一的 +- **fy_permission_permission_uindex**: `permission` 列的唯一索引，确保每个权限的名称在整个表中是唯一的 ## fy_role -> **描述**：角色表，用于管理系统的用户角色，每个角色有自己的名称和描述。 +> **描述**：角色表，用于定义系统中的用户角色，每个角色有自己的名称、展示名、描述以及关联的权限。 ### 数据列 -| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | -|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| -| ruuid | varchar(32) | PRIMARY KEY | 主键，用于唯一标识角色 | 否 | fy_role_pk | | | -| name | varchar(30) | NOT NULL | 角色名字，用于区分不同的角色 | 否 | | | | -| display_name | varchar(30) | NOT NULL | 展示名字，用于用户界面的显示 | 否 | | | | -| description | varchar | NOT NULL | 角色描述，详细说明角色的权限和功能 | 否 | | | | -| updated_at | timestamp | DEFAULT now() | 更新时间，自动设置为当前时间 | 否 | | | | +| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | +| ------------ | ----------- | ------------- | ---------------------------------- | -------- | ---------- | -------- | -------- | +| ruuid | varchar(32) | PRIMARY KEY | 主键，用于唯一标识角色 | 否 | fy_role_pk | | | +| name | varchar(30) | NOT NULL | 角色名字，用于内部识别 | 否 | | | | +| display_name | varchar(30) | NOT NULL | 展示名字，用于用户界面显示 | 否 | | | | +| description | varchar | NOT NULL | 角色描述，详细说明角色的功能和权限 | 否 | | | | +| permissions | varchar | NOT NULL | 角色权限，以逗号分隔的权限列表 | 否 | | | | +| updated_at | timestamp | DEFAULT now() | 更新时间，自动设置为当前时间 | 否 | | | | ### 索引 -- **fy_role_role_uindex**: `name` 列的唯一索引，确保每个角色名称在整个表中是唯一的 - -## fy_vip - -> **描述**：付费会员表，用于管理付费用户的不同会员等级。 - -### 数据列 - -| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | -|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| -| vuuid | varchar(32) | PRIMARY KEY | 主键，用于唯一标识会员 | 否 | fy_vip_pk | | | -| name | varchar(30) | NOT NULL | 会员名称，用于区分不同的会员等级 | 否 | | | | -| display_name | varchar(30) | NOT NULL | 展示名字，用于用户界面的显示 | 否 | | | | -| description | varchar | NOT NULL | 会员描述，详细说明会员的权益和特点 | 否 | | | | -| updated_at | timestamp | DEFAULT now() | 更新时间，自动设置为当前时间 | 否 | | | | - -### 索引 - -- **fy_vip_name_uindex**: `name` 列的唯一索引，确保每个会员名称在整个表中是唯一的 +- **fy_role_role_uindex**: `name` 列的唯一索引，确保每个角色的名称在整个表中是唯一的 ## fy_user -> **描述**：用户表，存储用户的基本信息、联系信息、角色和付费会员状态。 +> **描述**：用户表，存储用户的基本信息、联系信息、角色、会员状态以及验证状态。 ### 数据列 -| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | -|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| -| uuid | varchar(32) | PRIMARY KEY | 用户主键，用于唯一标识用户 | 否 | fy_user_pk | | | -| username | varchar(40) | NOT NULL | 用户名，用于登录和识别用户 | 否 | | | | -| email | varchar(100) | NOT NULL | 邮箱，用于用户联系和验证 | 否 | | | | -| phone | varchar(11) | NOT NULL | 手机号码，用于用户联系和验证 | 否 | | | | -| password | varchar(60) | NOT NULL | 密码，用于用户身份验证 | 否 | | | | -| old_password | varchar(60) | | 旧密码，用于密码重置 | 是 | | | | -| avatar | varchar(64) | | 头像（非地址），用户个人资料图片 | 是 | | | | -| otp_auth | varchar(32) | NOT NULL | 2FA-OTPAuth，用于二次验证 | 否 | | | | -| mail_verify | boolean | DEFAULT false | 邮箱验证状态，是否已验证 | 否 | | | | -| phone_verify | boolean | DEFAULT false | 手机验证状态，是否已验证 | 否 | | | | -| basic_information | json | NOT NULL | 基础信息，可能包含用户扩展数据 | 否 | | | | -| role | integer | FOREIGN KEY | 用户角色，引用 fy_role 表的 ruuid | 否 | fy_user_fy_role_ruuid_fk | cascade | set_null | -| vip | varchar(32) | FOREIGN KEY | 付费会员，引用 fy_vip 表的 vuuid | 是 | fy_user_fy_vip_vuuid_fk | cascade | set_null | -| created_at | timestamp | DEFAULT now() | 创建时间，自动设置为当前时间 | 否 | | | | -| updated_at | timestamp | | 修改时间，可能为空 | 是 | | | | +| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | +| ----------------- | ------------ | ------------- | --------------------------------- | -------- | ------------ | -------- | -------- | +| uuid | varchar(32) | PRIMARY KEY | 用户主键，用于唯一标识用户 | 否 | fy_user_pk | | | +| username | varchar(40) | NOT NULL | 用户名，用于登录和识别 | 否 | | | | +| email | varchar(100) | NOT NULL | 邮箱，唯一，用于用户身份验证 | 否 | email_uindex | | | +| phone | varchar(11) | NOT NULL | 手机号码，唯一，用于用户身份验证 | 否 | phone_uindex | | | +| password | varchar(60) | NOT NULL | 密码，存储加密后的密码 | 否 | | | | +| old_password | varchar(60) | | 旧密码，用于密码重置 | 是 | | | | +| avatar | varchar(64) | | 头像（非地址） | 是 | | | | +| otp_auth | varchar(32) | NOT NULL | 2FA-OTPAuth，用于二次验证 | 否 | | | | +| mail_verify | boolean | DEFAULT false | 邮箱验证状态 | 否 | | | | +| phone_verify | boolean | DEFAULT false | 手机验证状态 | 否 | | | | +| basic_information | varchar | NOT NULL | 基础信息，可能包含 JSON 格式数据 | 否 | | | | +| role | varchar(32) | FOREIGN KEY | 用户角色，引用 fy_role 表的 ruuid | 否 | user_fk | cascade | set_null | +| vip | varchar(32) | FOREIGN KEY | 付费会员，引用 fy_vip 表的 vuuid | 是 | vip_fk | cascade | set_null | +| created_at | timestamp | DEFAULT now() | 创建时间 | 否 | | | | +| updated_at | timestamp | | 修改时间 | 是 | | | | ### 外键约束 @@ -105,10 +83,10 @@ ### 索引 -- **fy_user_email_uindex**: `email` 列的唯一索引 -- **fy_user_otp_auth_uindex**: `otp_auth` 列的唯一索引 -- **fy_user_phone_uindex**: `phone` 列的唯一索引 -- **fy_user_username_uindex**: `username` 列的唯一索引 +- **email_uindex**: `email` 列的唯一索引 +- **otp_auth_uindex**: `otp_auth` 列的唯一索引 +- **phone_uindex**: `phone` 列的唯一索引 +- **username_uindex**: `username` 列的唯一索引 ### 数据结构 @@ -120,4 +98,24 @@ userWechat: "xiao_lfeng", [等待完善]...... } -``` \ No newline at end of file +``` + +## fy_vip + +> **描述**：付费会员表，存储付费会员的详细信息，包括名称、展示名、价格以及描述。 + +### 数据列 + +| 列名 | 数据类型 | 约束 | 描述 | 是否为空 | 键约束 | 级联修改 | 级联删除 | +|-------------|--------------|-----------------|---------------------------------|----------|----------|----------|----------| +| vuuid | varchar(32) | PRIMARY KEY | 会员主键，用于唯一标识会员 | 否 | fy_vip_pk | | | +| name | varchar(30) | NOT NULL | 会员名称，用于内部识别 | 否 | | | | +| display_name | varchar(30) | NOT NULL | 展示名字，用于用户界面显示 | 否 | | | | +| price | decimal(10, 2) | NOT NULL | 价格，单位为货币单位，如元或美元 | 否 | | | | +| description | varchar | NOT NULL | 会员描述，详细说明会员的权益和服务 | 否 | | | | +| updated_at | timestamp | DEFAULT now() | 更新时间，自动设置为当前时间 | 否 | | | | + +### 索引 + +- **fy_vip_name_uindex**: `name` 列的唯一索引，确保每个会员的名称在整个表中是唯一的 +- \ No newline at end of file