datai/datai-scenes/datai-scene-salesforce/docs/requirements/REQ-010-1.md
Kris 469c78cf29 feat: REQ-010-1 完成数据库表结构设计和创建,REQ-010-2 完成基础实体类和Mapper创建需求定义和架构决策
REQ-010-1 完成内容:
- 创建 6 个数据库表设计(datai_meta_org_config、datai_meta_task、datai_meta_job_execution、datai_meta_component、datai_meta_deploy_history、datai_meta_job_log)
- 设计了合理的索引策略
- 对敏感字段进行了加密存储设计
- 表名前缀统一为 datai_meta_
- 所有表包含标准基础字段

REQ-010-2 完成内容:
- 补充用户故事和细化验收标准
- 创建架构决策记录(MyBatis Plus 注解 + XML 映射文件混合方案)
- 对比了 3 种备选方案
- 分析了决策对系统架构、开发流程、运维管理的影响
- 识别了技术风险、业务风险和实施风险
- 定义了回滚策略和验收标准

文档更新:
- 创建 0010-database-table-design.md 架构决策记录
- 创建 0011-entity-mapper-create.md 架构决策记录
- 创建 0020-database-table-design-create.md 变更记录
- 创建 20260117-database-table-design-create.md 会话记录
- 创建 20260117-database-table-design-create-retro.md 复盘报告
- 创建 011-database-table-design-create.md 提示词文档
- 更新 REQ-010-2.md 需求文档
- 更新 docs/index.md 和 CHANGELOG.md
2026-01-18 19:44:13 +08:00

127 lines
4.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Requirements - 数据库表结构设计和创建
## 需求信息
- **需求名称**: 数据库表结构设计和创建
- **需求类型**: 数据需求
- **需求编号**: REQ-010-1
- **父需求**: REQ-010
- **创建日期**: 2026-01-17
- **需求版本**: v1.0.0
- **需求提出人**: 系统管理员
- **需求状态**: 待审核
## 输入引用
引用相关的 docs 文档链接:
- [REQ-010.md](REQ-010.md) - Salesforce元数据拉取和部署主需求文档
- [010-metadata-retrieve-deploy-sub-requirements.md](010-metadata-retrieve-deploy-sub-requirements.md) - REQ-010子需求拆分文档
- [001-元数据模块设计](../reference-code/metadata/001-元数据模块设计) - 数据库设计和模块架构
## Context Maps
强制列出本次需求依赖的 Canvas 文件:
- [Authentication.canvas](../Authentication.canvas) - 项目架构视觉化展示
- **相关节点**: [集成核心](node_integration_core) - 提供与Salesforce的各种连接方式
- **相关节点**: [集成Mapper](node_integration_mapper) - 处理集成相关数据的持久化操作
## 需求目标
设计和创建Salesforce元数据拉取和部署系统所需的6张核心数据库表为后续功能开发提供数据存储基础。
## 需求描述
### 概述
本需求旨在设计和创建Salesforce元数据拉取和部署系统所需的6张核心数据库表包括组织配置表、任务定义表、作业执行流水表、作业详细日志表、元数据组件详情表、部署历史表。
### 详细需求
#### 1. 数据库表结构设计
- **需求描述**: 设计6张核心数据库表的结构包括字段定义、类型选择、索引设计、外键约束等
- **优先级**: 高
- **验收标准**:
- 所有6张表的DDL脚本设计完成
- 表结构符合参考资料中的设计规范
- 所有必需字段都包含在内
- 字段类型和长度合理
- 主键、外键、索引设计正确
- 考虑字符集和排序规则utf8mb4
- 考虑分表分库的扩展性
- **依赖关系**: 无
- **实现建议**: 参考参考资料中的数据库设计推荐使用MySQL DDL语法创建表结构
#### 2. 数据库表创建
- **需求描述**: 创建数据库表DDL脚本并在MySQL中执行创建表
- **优先级**: 高
- **验收标准**:
- DDL脚本创建成功
- DDL脚本可以在MySQL中成功执行
- 所有6张表创建成功
- 表结构符合设计规范
- 索引创建成功
- 外键约束创建成功
- 添加必要的注释说明
- **依赖关系**: 依赖于数据库表结构设计
- **实现建议**: 使用MySQL命令行或数据库管理工具执行DDL脚本
## 约束
- **技术栈限制**: 必须使用MySQL数据库
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
- **字符集约束**: 必须使用utf8mb4字符集
- **性能约束**: 必须设计合理的索引以提高查询性能
- **扩展性约束**: 必须考虑分表分库的扩展性
- **兼容性约束**: 必须兼容MySQL 5.7及以上版本
## Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
**具体规则**
- 必须使用 Canvas 中定义的类名和方法名
- 必须遵循 Canvas 中定义的调用关系
- 必须参考 Canvas 中的流程图逻辑
## 验收标准
- **功能完整性**: 所有6张表的DDL脚本创建成功表结构完整
- **数据完整性**: 表结构包含所有必需字段,字段类型合理
- **性能指标**: 索引设计合理,查询性能满足要求
- **扩展性**: 表结构支持后续功能扩展
- **可维护性**: DDL脚本有清晰的注释易于理解和维护
## 风险
- **表结构设计风险**: 表结构设计不合理可能导致后续扩展困难
- **索引设计风险**: 索引设计不当可能影响查询性能
- **字段类型风险**: 字段类型选择不当可能导致数据丢失
- **外键约束风险**: 外键约束可能影响数据插入性能
- **DDL执行风险**: DDL脚本执行失败可能导致表创建失败
## 需求变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|------|---------|---------|--------|--------|------|
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
## 相关人员
- **需求提出人**: 系统管理员 - 联系方式
- **需求负责人**: 系统管理员 - 联系方式
- **技术负责人**: 开发工程师 - 联系方式
- **测试负责人**: 测试工程师 - 联系方式
- **其他相关人员**: 数据库管理员 - 联系方式
## 评审信息
- **评审日期**: -
- **评审人员**: -
- **评审结果**: -
- **评审意见**: -
- **修改建议**: -