docs(database): 规范脚本顺序并补全字段注释

2026-06-01 02:10:34 +08:00
parent d92496854d
commit 6fe1209801
70 changed files with 695 additions and 178 deletions
--- a/docs/数据库设计/0.数据库与枚举总览.md
+++ b/docs/数据库设计/0.数据库与枚举总览.md
@@ -8,7 +8,7 @@

 | 脚本位置 | 作用 |
 |----------|------|
-| `script/sql/` | 可执行的模块化建表或初始化脚本 |
+| `script/` | 可执行的模块化建表或初始化脚本 |
 | `docs/MODEL_PROVIDER_SCHEMA.sql` | 模型平台 schema 汇总 |
 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | Studio 原型 schema 汇总 |

@@ -16,7 +16,7 @@

 ## 3. 必须保持不变的内容

-`script/sql/enum.sql` 中 `sys_enum` 表结构不变：
+`script/sql/1.enum.sql` 中 `sys_enum` 表结构不变：

 - `catalog`
 - `type`
@@ -37,13 +37,13 @@ Java 枚举契约 `PersistableSysEnumDefinition` 的格式不变。后续如果

 | 脚本 | 内容 |
 |------|------|
-| `script/sql/studio_project.sql` | Studio 项目空间表 |
-| `script/sql/workflow.sql` | Workflow 定义、版本、运行、步骤日志 |
-| `script/sql/mcp.sql` | MCP Server 与能力表 |
-| `script/sql/skill.sql` | Skill 定义与版本表 |
-| `script/sql/agent_session.sql` | Agent 会话与消息表 |
-| `script/sql/agent_capability_binding.sql` | Agent/Workflow 与 MCP/Skill/知识能力绑定表 |
-| `script/sql/studio_enum.sql` | Studio 相关枚举初始化 |
+| `script/sql/11.studio_project.sql` | Studio 项目空间表 |
+| `script/sql/12.workflow.sql` | Workflow 定义、版本、运行、步骤日志 |
+| `script/sql/14.mcp.sql` | MCP Server 与能力表 |
+| `script/sql/15.skill.sql` | Skill 定义与版本表 |
+| `script/sql/13.agent_session.sql` | Agent 会话与消息表 |
+| `script/sql/16.agent_capability_binding.sql` | Agent/Workflow 与 MCP/Skill/知识能力绑定表 |
+| `script/sql/18.studio_enum.sql` | Studio 相关枚举初始化 |

 ## 5. 校验规则

@@ -52,3 +52,6 @@ Java 枚举契约 `PersistableSysEnumDefinition` 的格式不变。后续如果
 - 需要跨模块引用的字段必须在文档中说明外键关系。
 - JSON 扩展字段统一使用 `JSONB`。
 - 枚举初始化脚本必须使用 `ON CONFLICT (catalog, type, name) DO UPDATE`，与现有脚本风格一致。
+
+
+
--- a/docs/数据库设计/2.知识资产数据库设计.md
+++ b/docs/数据库设计/2.知识资产数据库设计.md
@@ -13,11 +13,11 @@

 ## 2. 脚本清单

- `script/sql/rag_store.sql`
- `script/sql/rag_document.sql`
- `script/sql/rag_document_parse_result.sql`
- `script/sql/rag_chunk.sql`
- `script/sql/rag_chunk_embedding.sql`
+- `script/sql/3.rag_store.sql`
+- `script/sql/4.rag_document.sql`
+- `script/sql/5.rag_document_parse_result.sql`
+- `script/sql/6.rag_chunk.sql`
+- `script/sql/7.rag_chunk_embedding.sql`
 - `docs/MODEL_PROVIDER_SCHEMA.sql` 中的 `rag_store_model_config`

 ## 3. 枚举组
@@ -35,3 +35,6 @@
 - `rag_chunk` 使用 `(document_id, chunk_index)` 保证同文档切片序号唯一。
 - `rag_chunk_embedding` 使用 `(chunk_id, embedding_model)` 防止同模型重复写入。
 - RAG 现有脚本与本文档一致，本轮不调整 `sys_enum` 格式。
+
+
+
--- a/docs/数据库设计/3.模型与路由数据库设计.md
+++ b/docs/数据库设计/3.模型与路由数据库设计.md
@@ -33,5 +33,8 @@
 ## 4. 脚本

 - `docs/MODEL_PROVIDER_SCHEMA.sql` 是完整 schema 快照。
- `script/sql/model_provider.sql` 是后续执行入口。
+- `script/sql/9.model_provider.sql` 是后续执行入口。
 - 若模型枚举变更，需要同步 Java 枚举、初始化测试和 SQL 枚举脚本。
+
+
+
--- a/docs/数据库设计/4.Workflow数据库设计.md
+++ b/docs/数据库设计/4.Workflow数据库设计.md
@@ -20,8 +20,8 @@

 ## 3. 脚本

- `script/sql/studio_project.sql`
- `script/sql/workflow.sql`
+- `script/sql/11.studio_project.sql`
+- `script/sql/12.workflow.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`

 ## 4. JSON 字段
@@ -31,3 +31,5 @@
 - `workflow_run_step.input_json` 与 `output_json` 保存节点级输入输出摘要。

 JSON 字段只保存运行必要摘要，不保存敏感密钥。
+
+
--- a/docs/数据库设计/5.Agent会话数据库设计.md
+++ b/docs/数据库设计/5.Agent会话数据库设计.md
@@ -26,7 +26,10 @@

 ## 4. 脚本

- `script/sql/agent_definition.sql`
- `script/sql/agent_session.sql`
- `script/sql/agent_capability_binding.sql`
+- `script/sql/8.agent_definition.sql`
+- `script/sql/13.agent_session.sql`
+- `script/sql/16.agent_capability_binding.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`
+
+
+
--- a/docs/数据库设计/6.MCP数据库设计.md
+++ b/docs/数据库设计/6.MCP数据库设计.md
@@ -15,6 +15,8 @@

 ## 3. 脚本

- `script/sql/mcp.sql`
+- `script/sql/14.mcp.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`
- `script/sql/studio_enum.sql`
+- `script/sql/18.studio_enum.sql`
+
+
--- a/docs/数据库设计/7.Skill数据库设计.md
+++ b/docs/数据库设计/7.Skill数据库设计.md
@@ -15,6 +15,8 @@

 ## 3. 脚本

- `script/sql/skill.sql`
+- `script/sql/15.skill.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`
- `script/sql/studio_enum.sql`
+- `script/sql/18.studio_enum.sql`
+
+
--- a/docs/数据库设计/8.运行观测数据库设计.md
+++ b/docs/数据库设计/8.运行观测数据库设计.md
@@ -23,7 +23,10 @@

 索引分散在：

- `script/sql/workflow.sql`
- `script/sql/model_provider.sql`
- `script/sql/agent_session.sql`
+- `script/sql/12.workflow.sql`
+- `script/sql/9.model_provider.sql`
+- `script/sql/13.agent_session.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`
+
+
+
--- a/docs/数据库设计/9.模块一致性校验.md
+++ b/docs/数据库设计/9.模块一致性校验.md
@@ -9,7 +9,7 @@
 - `数据库设计/`
 - `前端实现文档/`
 - `后端实现文档/`
- `script/sql/*.sql`
+- `script/*.sql`
 - `docs/MODEL_PROVIDER_SCHEMA.sql`
 - `docs/STUDIO_PROTOTYPE_SCHEMA.sql`

@@ -21,17 +21,17 @@

 | 模块 | 汇总 schema | 模块化脚本 | 结论 |
 |------|-------------|------------|------|
-| 模型与路由 | `docs/MODEL_PROVIDER_SCHEMA.sql` | `script/sql/model_provider.sql` | 已补齐 `rag_store_model_config.store_id` 外键 |
-| Studio 项目 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/studio_project.sql` | 表、唯一约束、索引一致 |
-| Workflow | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/workflow.sql` | 定义、版本、运行、步骤表一致 |
-| Agent 会话 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/agent_session.sql` | 会话和消息表一致 |
-| 能力绑定 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/agent_capability_binding.sql` | 唯一约束和索引一致 |
-| MCP | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/mcp.sql` | Server 与 Capability 表一致 |
-| Skill | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/skill.sql` | 定义与版本表一致 |
+| 模型与路由 | `docs/MODEL_PROVIDER_SCHEMA.sql` | `script/sql/9.model_provider.sql` | 已补齐 `rag_store_model_config.store_id` 外键 |
+| Studio 项目 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/11.studio_project.sql` | 表、唯一约束、索引一致 |
+| Workflow | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/12.workflow.sql` | 定义、版本、运行、步骤表一致 |
+| Agent 会话 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/13.agent_session.sql` | 会话和消息表一致 |
+| 能力绑定 | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/16.agent_capability_binding.sql` | 唯一约束和索引一致 |
+| MCP | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/14.mcp.sql` | Server 与 Capability 表一致 |
+| Skill | `docs/STUDIO_PROTOTYPE_SCHEMA.sql` | `script/sql/15.skill.sql` | 定义与版本表一致 |

 ## 4. 枚举一致性

-`script/sql/studio_enum.sql` 保持 `sys_enum` 既有格式：
+`script/sql/18.studio_enum.sql` 保持 `sys_enum` 既有格式：

 - `catalog`
 - `type`
@@ -75,5 +75,8 @@
 - Java 枚举类。
 - `SysEnumDataInitTests` 初始化入口。
 - `EnumDefinitionTests` 稳定性断言。
- `script/sql/studio_enum.sql` 初始化数据。
+- `script/sql/18.studio_enum.sql` 初始化数据。
 - 前端字典或常量映射。
+
+
+