SQL文件说明.md 7.3 KB

数据库 SQL 文件目录说明

📁 文件结构概览

基于业务域的数据库文件拆分,将原始的 hzdyjs_xg.sql 按业务模块进行分类,便于管理和维护。

docs/设计文档/database/
├── hzdyjs_xg.sql                    # 完整数据库文件(保留)
├── 01-workflow-module.sql           # 工作流模块
├── 02-code-generator-module.sql     # 代码生成模块
├── 03-logistics-module.sql          # 后勤管理模块
├── 04-job-scheduler-module.sql      # 任务调度模块
├── 05-system-management-module.sql  # 系统管理模块
├── 06-test-module.sql              # 测试模块
├── README.md                       # 数据库设计说明
├── mysql-database-standard.md      # MySQL数据库建设规范
├── database_msg.md                 # 数据库环境配置
└── SQL文件说明.md                  # 本文件

📊 业务域拆分详情

01. 工作流模块 (01-workflow-module.sql)

业务域: 工作流引擎相关功能
包含表: 8 张表

  • flow_category - 流程分类表
  • flow_definition - 流程定义表
  • flow_his_task - 历史任务表
  • flow_instance - 流程实例表
  • flow_node - 流程节点表
  • flow_skip - 流程跳转表
  • flow_task - 流程任务表
  • flow_user - 流程用户表

主要功能: 支持业务流程的定义、执行、跟踪和管理

02. 代码生成模块 (02-code-generator-module.sql)

业务域: 代码生成器相关功能
包含表: 2 张表

  • gen_table - 代码生成业务表
  • gen_table_column - 代码生成业务字段表

主要功能: 支持基于数据库表结构自动生成代码

03. 后勤管理模块 (03-logistics-module.sql)

业务域: 后勤服务管理相关功能
包含表: 10 张表

报告厅预约管理子模块

  • hq_hall_info - 报告厅信息表
  • hq_hall_reservation - 报告厅预约表

满意度调查子模块

  • hq_sat_answer - 答题答案表
  • hq_sat_category - 题目分类表
  • hq_sat_detail - 答题详情表
  • hq_sat_option - 评分选项表
  • hq_sat_question - 题库表
  • hq_sat_record - 答题记录表
  • hq_sat_survey - 问卷表
  • hq_sat_survey_question - 问卷题目关联表

主要功能: 校园后勤服务管理,包括场地预约和满意度调查

04. 任务调度模块 (04-job-scheduler-module.sql)

业务域: SnailJob 任务调度相关功能
包含表: 12 张表

  • sj_distributed_lock - 分布式锁表
  • sj_group_config - 组配置表
  • sj_namespace_config - 命名空间配置表
  • sj_notify_config - 通知配置表
  • sj_retry_dead_letter - 死信队列表
  • sj_retry_summary - 任务重试汇总统计表
  • sj_retry_task - 任务信息表
  • sj_retry_task_log - 重试日志表
  • sj_server_node - 服务器节点表
  • sj_system_user_permission - 系统用户权限表
  • sj_workflow_node - 工作流节点表
  • sj_workflow_task_batch - 工作流任务批次表

主要功能: 分布式任务调度、重试机制、工作流编排

05. 系统管理模块 (05-system-management-module.sql)

业务域: 系统核心管理功能
包含表: 21 张表

用户与权限管理

  • sys_user - 用户信息表
  • sys_role - 角色信息表
  • sys_menu - 菜单权限表
  • sys_dept - 部门表
  • sys_post - 岗位信息表
  • sys_user_role - 用户角色关联表
  • sys_user_post - 用户岗位关联表
  • sys_role_menu - 角色菜单关联表
  • sys_role_dept - 角色部门关联表

系统配置与日志

  • sys_config - 参数配置表
  • sys_dict_type - 字典类型表
  • sys_dict_data - 字典数据表
  • sys_notice - 通知公告表
  • sys_oper_log - 操作日志表
  • sys_logininfor - 系统访问记录表

文件与租户管理

  • sys_oss - OSS 对象存储表
  • sys_oss_config - 对象存储配置表
  • sys_client - 系统授权表
  • sys_tenant - 租户表
  • sys_tenant_package - 租户套餐表
  • sys_social - 社会化关系表

主要功能: 系统用户管理、权限控制、配置管理、日志记录等核心功能

06. 测试模块 (06-test-module.sql)

业务域: 测试和演示相关功能
包含表: 1 张表

  • test_tree - 测试树表

主要功能: 系统功能测试和演示,包含树形结构数据


🔧 使用指南

完整数据库部署

-- 执行完整数据库文件
SOURCE docs/设计文档/database/hzdyjs_xg.sql;

按模块部署

-- 按需执行指定模块
SOURCE docs/设计文档/database/01-workflow-module.sql;
SOURCE docs/设计文档/database/02-code-generator-module.sql;
SOURCE docs/设计文档/database/03-logistics-module.sql;
SOURCE docs/设计文档/database/04-job-scheduler-module.sql;
SOURCE docs/设计文档/database/05-system-management-module.sql;
SOURCE docs/设计文档/database/06-test-module.sql;

开发环境部署建议

  1. 必须模块: 01-工作流模块, 05-系统管理模块
  2. 按需模块: 其他模块根据具体业务需求选择性部署
  3. 测试模块: 仅在开发和测试环境中部署

📈 统计信息

模块 表数量 主要功能 依赖关系
工作流模块 8 流程管理 依赖系统管理模块
代码生成模块 2 代码生成 无特殊依赖
后勤管理模块 10 后勤服务 依赖系统管理模块
任务调度模块 12 任务调度 独立模块
系统管理模块 21 核心系统 核心基础模块
测试模块 1 测试演示 依赖系统管理模块
总计 54 完整系统 完整依赖链

⚠️ 注意事项

1. 模块依赖关系

  • 系统管理模块是其他模块的基础依赖,必须优先部署
  • 工作流模块和后勤管理模块依赖系统管理模块的用户和部门数据
  • 任务调度模块相对独立,可单独部署

2. 数据一致性

  • 所有模块都遵循统一的数据库设计规范
  • 使用逻辑删除,不进行物理删除
  • 统一的基础字段结构和索引设计
  • 不使用数据库外键约束,关联关系通过应用层维护

3. 版本管理

  • 拆分后的 SQL 文件保持与 hzdyjs_xg.sql 的内容一致性
  • 任何表结构变更都应同步更新对应的模块文件
  • 建议使用版本控制跟踪 SQL 文件的变更历史

4. 性能考虑

  • 每个模块都包含合理的索引设计
  • 支持分模块的数据库备份和恢复
  • 便于数据库性能调优和问题排查

🔄 维护说明

更新流程

  1. 修改 hzdyjs_xg.sql 主文件
  2. 同步更新对应的模块 SQL 文件
  3. 更新本说明文档的变更记录
  4. 在 docs/变更管理/code-adjust-record.md 中记录变更

文件命名规则

  • 使用两位数字前缀进行排序
  • 使用英文短横线分隔词语
  • 以 -module.sql 结尾表示模块文件

拆分原则

  • 按业务域进行逻辑分组
  • 保持模块的相对独立性
  • 考虑实际部署和维护需求
  • 遵循数据库设计规范