Kris
2e6f087732
- 完成REQ-010-17（性能优化和限流处理）的所有6个阶段 - 创建ADR文档：0026-performance-optimization.md - 创建Prompt文档：027-performance-optimization.md - 创建会话记录：20260119-performance-optimization.md - 创建变更记录：20260119-performance-optimization.md - 创建复盘报告：20260119-performance-optimization-retro.md - 更新index.md和CHANGELOG.md - 完成REQ-010-2（基础实体类和Mapper创建）的前3个阶段 - 更新ADR文档：0011-entity-mapper-create.md - 创建Prompt文档：002-entity-mapper-create.md - 更新index.md 所有文档均按照SSOT方法论创建，包括需求定义、架构决策、提示词资产化、执行会话、变更记录和闭环复盘。
172 lines
6.9 KiB
Markdown
172 lines
6.9 KiB
Markdown
# 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元数据拉取和部署系统所需的9张核心数据库表，为后续功能开发提供数据存储基础。
|
||
|
||
## 需求描述
|
||
|
||
### 概述
|
||
|
||
本需求旨在设计和创建Salesforce元数据拉取和部署系统所需的9张核心数据库表，包括组织配置表、元数据包定义明细表、元数据组件索引表、元数据版本内容表、任务定义表、作业执行流水表、作业详细日志表、部署历史表、部署组件结果明细表。
|
||
|
||
### 详细需求
|
||
|
||
#### 1. 数据库表结构设计
|
||
|
||
- **需求描述**: 设计9张核心数据库表的结构，包括字段定义、类型选择、索引设计、外键约束等
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 所有9张表的DDL脚本设计完成
|
||
- 表结构符合参考资料中的设计规范
|
||
- 所有必需字段都包含在内
|
||
- 字段类型和长度合理
|
||
- 主键、外键、索引设计正确
|
||
- 考虑字符集和排序规则（utf8mb4）
|
||
- 考虑分表分库的扩展性
|
||
- **依赖关系**: 无
|
||
- **实现建议**: 参考参考资料中的数据库设计推荐，使用MySQL DDL语法创建表结构
|
||
|
||
#### 2. 数据库表创建
|
||
|
||
- **需求描述**: 创建数据库表DDL脚本，并在MySQL中执行创建表
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- DDL脚本创建成功
|
||
- DDL脚本可以在MySQL中成功执行
|
||
- 所有9张表创建成功
|
||
- 表结构符合设计规范
|
||
- 索引创建成功
|
||
- 外键约束创建成功
|
||
- 添加必要的注释说明
|
||
- **依赖关系**: 依赖于数据库表结构设计
|
||
- **实现建议**: 使用MySQL命令行或数据库管理工具执行DDL脚本
|
||
|
||
#### 3. 新增表结构设计
|
||
|
||
基于参考资料 `005-源数据拉取数据库设计方案.md`，需要新增以下 3 张表：
|
||
|
||
##### 3.1 datai_meta_package_item (元数据包定义明细表)
|
||
|
||
- **需求描述**: 为了避免手动拼写 `package.xml`，需要将"我要拉取什么"结构化存储。此表通常与 Task 或特定的"发布包"关联
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 表结构设计完成
|
||
- 包含所有必需字段（id、group_id、metadata_type、member_name、description）
|
||
- 字段类型和长度合理
|
||
- 索引设计正确
|
||
- **依赖关系**: 无
|
||
- **实现建议**: 参考参考资料中的字段设计
|
||
|
||
##### 3.2 datai_meta_component_version (元数据版本内容表)
|
||
|
||
- **需求描述**: 这是实现"Java 版 Git"的核心表。每次拉取如果内容发生变化，就在此增加一条记录
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 表结构设计完成
|
||
- 包含所有必需字段（id、component_id、version_number、content_hash、content_body、is_binary、commit_message、job_execution_id、created_at）
|
||
- 字段类型和长度合理
|
||
- 索引设计正确
|
||
- content_hash 字段使用 VARCHAR 存储 SHA-256 哈希值
|
||
- content_body 字段使用 LONGTEXT 存储实际代码内容
|
||
- **依赖关系**: 依赖于 datai_meta_component 表
|
||
- **实现建议**: 参考参考资料中的字段设计
|
||
|
||
##### 3.3 datai_meta_deploy_component_result (部署组件结果明细表)
|
||
|
||
- **需求描述**: CI/CD 最重要的部分，告知用户具体哪个文件失败了
|
||
- **优先级**: 高
|
||
- **验收标准**:
|
||
- 表结构设计完成
|
||
- 包含所有必需字段（id、deploy_history_id、component_name、component_type、file_name、is_success、is_changed、line_number、column_number、problem、problem_type）
|
||
- 字段类型和长度合理
|
||
- 索引设计正确
|
||
- line_number 和 column_number 字段用于记录错误位置
|
||
- problem 字段使用 TEXT 存储具体报错信息
|
||
- **依赖关系**: 依赖于 datai_meta_deploy_history 表
|
||
- **实现建议**: 参考参考资料中的字段设计
|
||
|
||
## 约束
|
||
|
||
- **技术栈限制**: 必须使用MySQL数据库
|
||
- **数据库约束**: 必须使用MyBatis Plus作为持久层框架
|
||
- **字符集约束**: 必须使用utf8mb4字符集
|
||
- **性能约束**: 必须设计合理的索引以提高查询性能
|
||
- **扩展性约束**: 必须考虑分表分库的扩展性
|
||
- **兼容性约束**: 必须兼容MySQL 5.7及以上版本
|
||
|
||
## Rule Set
|
||
|
||
"请严格参考 @Authentication.canvas 中的状态机转移逻辑，不要自行发挥。"
|
||
|
||
**具体规则**：
|
||
- 必须使用 Canvas 中定义的类名和方法名
|
||
- 必须遵循 Canvas 中定义的调用关系
|
||
- 必须参考 Canvas 中的流程图逻辑
|
||
|
||
## 验收标准
|
||
|
||
- **功能完整性**: 所有9张表的DDL脚本创建成功，表结构完整
|
||
- **数据完整性**: 表结构包含所有必需字段，字段类型合理
|
||
- **性能指标**: 索引设计合理，查询性能满足要求
|
||
- **扩展性**: 表结构支持后续功能扩展
|
||
- **可维护性**: DDL脚本有清晰的注释，易于理解和维护
|
||
|
||
## 风险
|
||
|
||
- **表结构设计风险**: 表结构设计不合理可能导致后续扩展困难
|
||
- **索引设计风险**: 索引设计不当可能影响查询性能
|
||
- **字段类型风险**: 字段类型选择不当可能导致数据丢失
|
||
- **外键约束风险**: 外键约束可能影响数据插入性能
|
||
- **DDL执行风险**: DDL脚本执行失败可能导致表创建失败
|
||
|
||
## 需求变更记录
|
||
|
||
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 | 状态 |
|
||
|------|---------|---------|--------|--------|------|
|
||
| 2026-01-17 | 创建需求文档 | 初始需求 | 系统管理员 | - | 待审核 |
|
||
| 2026-01-17 | 优化需求文档 | 基于参考资料 `005-源数据拉取数据库设计方案.md` 优化表设计，从 6 张表增加到 9 张表 | SSOT Architect | - | 待审核 |
|
||
|
||
## 相关人员
|
||
|
||
- **需求提出人**: 系统管理员 - 联系方式
|
||
- **需求负责人**: 系统管理员 - 联系方式
|
||
- **技术负责人**: 开发工程师 - 联系方式
|
||
- **测试负责人**: 测试工程师 - 联系方式
|
||
- **其他相关人员**: 数据库管理员 - 联系方式
|
||
|
||
## 评审信息
|
||
|
||
- **评审日期**: -
|
||
- **评审人员**: -
|
||
- **评审结果**: -
|
||
- **评审意见**: -
|
||
- **修改建议**: -
|